vcorelib.paths.find
index
/home/vkottler/src/vkottler/workspace/vcorelib/vcorelib/paths/find.py

A module implementing interfaces for finding files.

 
Modules
       
importlib_resources

 
Functions
       
find_file(path: Union[pathlib.Path, str, NoneType], *parts: Union[str, pathlib.Path], search_paths: Iterable[Union[pathlib.Path, str, NoneType]] = None, include_cwd: bool = False, relative_to: Union[pathlib.Path, str, NoneType] = None, package: str = None, package_subdir: str = 'data', logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = None, strict: bool = False) -> Optional[pathlib.Path]
Combines a few simple strategies to locate a file on disk.
find_package_file(parsed: urllib.parse.ParseResult, package_subdir: str, logger: Union[logging.Logger, logging.LoggerAdapter[Any], NoneType]) -> Optional[pathlib.Path]
Find a file from a package.
register_file_finder(scheme: str, finder: Callable[[urllib.parse.ParseResult, str, Union[logging.Logger, logging.LoggerAdapter[Any], NoneType]], Optional[pathlib.Path]]) -> None
Register a custom, runtime file finder (for URI paths).

 
Data
        FINDERS = {'package': <function find_package_file>}
FileFinder = typing.Callable[[urllib.parse.ParseResult, str, ....Any], NoneType]], typing.Optional[pathlib.Path]]
LoggerType = typing.Union[logging.Logger, logging.LoggerAdapter[typing.Any]]
Pathlike = typing.Union[pathlib.Path, str, NoneType]
__annotations__ = {'FINDERS': typing.Dict[str, typing.Callable[[urllib.parse.P...Any], NoneType]], typing.Optional[pathlib.Path]]]}