setuptools._vendor.importlib_resources.abc.TraversableResources

class documentation

class TraversableResources(ResourceReader): (source)

Known subclasses: setuptools._vendor.importlib_resources.readers.FileReader, setuptools._vendor.importlib_resources.readers.NamespaceReader, setuptools._vendor.importlib_resources.readers.ZipReader, setuptools._vendor.importlib_resources.simple.TraversableReader

View In Hierarchy

The required interface for providing traversable resources.

Method contents Return an iterable of entries in `package`.
Method files Return a Traversable object for the loaded package.
Method is_resource Return True if the named 'path' is a resource.
Method open_resource Return an opened, file-like object for binary reading.
Method resource_path Return the file system path to the specified resource.
def contents(self) -> Iterator[str]: (source)
overrides setuptools._vendor.importlib_resources.abc.ResourceReader.contents

Return an iterable of entries in `package`.

@abc.abstractmethod
def files(self) -> Traversable: (source)
overridden in setuptools._vendor.importlib_resources.readers.FileReader, setuptools._vendor.importlib_resources.readers.NamespaceReader, setuptools._vendor.importlib_resources.readers.ZipReader, setuptools._vendor.importlib_resources.simple.TraversableReader

Return a Traversable object for the loaded package.

def is_resource(self, path: StrPath) -> bool: (source)
overrides setuptools._vendor.importlib_resources.abc.ResourceReader.is_resource
overridden in setuptools._vendor.importlib_resources.readers.ZipReader

Return True if the named 'path' is a resource. Files are resources, directories are not.

def open_resource(self, resource: StrPath) -> io.BufferedReader: (source)
overrides setuptools._vendor.importlib_resources.abc.ResourceReader.open_resource
overridden in setuptools._vendor.importlib_resources.readers.ZipReader

Return an opened, file-like object for binary reading. The 'resource' argument is expected to represent only a file name. If the resource cannot be found, FileNotFoundError is raised.

def resource_path(self, resource: Any) -> NoReturn: (source)
overrides setuptools._vendor.importlib_resources.abc.ResourceReader.resource_path
overridden in setuptools._vendor.importlib_resources.readers.FileReader, setuptools._vendor.importlib_resources.readers.NamespaceReader

Return the file system path to the specified resource. The 'resource' argument is expected to represent only a file name. If the resource does not exist on the file system, raise FileNotFoundError.