comparison mercurial/templater.py @ 51678:0e16efe30866

typing: add a few trivial type hints to `mercurial/templater.py`

Since hg 3dbc7b1ecaba, pytype started inferring that the second value in the
tuple is `BinaryIO`, but still hasn't been able to figure out the rest of
`open_template()`.  We can be more precise.

51677:df6ce326936f

"""


import abc
import os

from .i18n import _
from .pycompat import (
    FileNotFoundError,
)

    '''return the directory used for template files, or None.'''
    path = os.path.normpath(os.path.join(resourceutil.datapath, b'templates'))
    return path if os.path.isdir(path) else None


def open_template(name, templatepath=None):
    """returns a file-like object for the given template, and its full path

    If the name is a relative path and we're in a frozen binary, the template
    will be read from the mercurial.templates package instead. The returned path
    will then be the relative path.

        name,
        resourceutil.open_resource(package_name, name_parts[-1]),
    )


def try_open_template(name, templatepath=None):
    try:
        return open_template(name, templatepath)
    except (EnvironmentError, ImportError):
        return None, None

51678:0e16efe30866

"""


import abc
import os

from typing import (
    BinaryIO,
    Optional,
    Tuple,
)

from .i18n import _
from .pycompat import (
    FileNotFoundError,
)

    '''return the directory used for template files, or None.'''
    path = os.path.normpath(os.path.join(resourceutil.datapath, b'templates'))
    return path if os.path.isdir(path) else None


def open_template(
    name: bytes, templatepath: Optional[bytes] = None
) -> Tuple[bytes, BinaryIO]:
    """returns a file-like object for the given template, and its full path

    If the name is a relative path and we're in a frozen binary, the template
    will be read from the mercurial.templates package instead. The returned path
    will then be the relative path.

        name,
        resourceutil.open_resource(package_name, name_parts[-1]),
    )


def try_open_template(
    name: bytes, templatepath: Optional[bytes] = None
) -> Tuple[Optional[bytes], Optional[BinaryIO]]:
    try:
        return open_template(name, templatepath)
    except (EnvironmentError, ImportError):
        return None, None