ocrd_utils.package_resources

Complexity

Total Complexity

2

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Importance

Changes

0

2 Functions

Rating	Name	Duplication	Size	Complexity
A	resource_string()	0	13	1
A	resource_filename()	0	13	1

import atexit
from contextlib import ExitStack
from pathlib import Path

try:
    from importlib.resources import path, read_binary
except ImportError:
    from importlib_resources import path, read_binary  # type: ignore

try:
    from importlib.metadata import distribution as get_distribution
except ImportError:
    from importlib_metadata import distribution as get_distribution

# See https://importlib-resources.readthedocs.io/en/latest/migration.html#pkg-resources-resource-filename
_file_manager = ExitStack()
atexit.register(_file_manager.close)


def resource_filename(package: str, resource: str) -> Path:
    """
    Reimplementation of the function with the same name from pkg_resources

    Using importlib for better performance

    package : str
        The package from where to start looking for resource (often __name__)
    resource : str
        The resource to look up
    """
    parent_package = package.rsplit('.',1)[0]
    return _file_manager.enter_context(path(parent_package, resource))


def resource_string(package: str, resource: str) -> bytes:
    """
    Reimplementation of the function with the same name from pkg_resources

    Using importlib for better performance

    package : str
        The package from where to start looking for resource (often __name__)
    resource : str
        The resource to look up
    """
    parent_package = package.rsplit('.',1)[0]
    return read_binary(parent_package, resource)


__all__ = ['resource_filename', 'resource_string', 'get_distribution']