setuptools._vendor.importlib_resources.abc.Traversable

class documentation

class Traversable(Protocol): (source)

Known subclasses: setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.ChildPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.OrphanPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.SpecPath, setuptools._vendor.importlib_resources.readers.MultiplexedPath, setuptools._vendor.importlib_resources.simple.ResourceContainer, setuptools._vendor.importlib_resources.simple.ResourceHandle

View In Hierarchy

An object with a subset of pathlib.Path methods suitable for traversing directories and opening files. Any exceptions that occur when accessing the backing resource may propagate unaltered.

Method __truediv__ Return Traversable child in self
Method is_dir Return True if self is a directory
Method is_file Return True if self is a file
Method iterdir Yield Traversable objects in self
Method joinpath Return Traversable resolved with any descendants applied.
Method open mode may be 'r' or 'rb' to open as text or binary. Return a handle suitable for reading (same as pathlib.Path.open).
Method read_bytes Read contents of self as bytes
Method read_text Read contents of self as text
Property name The base name of this object without any parent references.
def __truediv__(self, child: StrPath) -> Traversable: (source)

Return Traversable child in self

@abc.abstractmethod
def is_dir(self) -> bool: (source)
overridden in setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.ChildPath, setuptools._vendor.importlib_resources.readers.MultiplexedPath, setuptools._vendor.importlib_resources.simple.ResourceContainer, setuptools._vendor.importlib_resources.simple.ResourceHandle

Return True if self is a directory

@abc.abstractmethod
def is_file(self) -> bool: (source)
overridden in setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.ChildPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.OrphanPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.SpecPath, setuptools._vendor.importlib_resources.readers.MultiplexedPath, setuptools._vendor.importlib_resources.simple.ResourceContainer, setuptools._vendor.importlib_resources.simple.ResourceHandle

Return True if self is a file

@abc.abstractmethod
def iterdir(self) -> Iterator[Traversable]: (source)
overridden in setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.ChildPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.OrphanPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.SpecPath, setuptools._vendor.importlib_resources.readers.MultiplexedPath, setuptools._vendor.importlib_resources.simple.ResourceContainer

Yield Traversable objects in self

def joinpath(self, *descendants: StrPath) -> Traversable: (source)
overridden in setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.ChildPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.OrphanPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.SpecPath, setuptools._vendor.importlib_resources.readers.MultiplexedPath, setuptools._vendor.importlib_resources.simple.ResourceHandle

Return Traversable resolved with any descendants applied. Each descendant should be a path segment relative to self and each may contain multiple levels separated by ``posixpath.sep`` (``/``).

@abc.abstractmethod
def open(self, mode='r', *args, **kwargs): (source)
overridden in setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.ChildPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.OrphanPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.SpecPath, setuptools._vendor.importlib_resources.readers.MultiplexedPath, setuptools._vendor.importlib_resources.simple.ResourceContainer, setuptools._vendor.importlib_resources.simple.ResourceHandle

mode may be 'r' or 'rb' to open as text or binary. Return a handle suitable for reading (same as pathlib.Path.open). When opening as text, accepts encoding parameters such as those accepted by io.TextIOWrapper.

def read_bytes(self) -> bytes: (source)
overridden in setuptools._vendor.importlib_resources.readers.MultiplexedPath

Read contents of self as bytes

def read_text(self, encoding: Optional[str] = None) -> str: (source)
overridden in setuptools._vendor.importlib_resources.readers.MultiplexedPath

Read contents of self as text

@property
@abc.abstractmethod
name: str = (source)
overridden in setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.ChildPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.OrphanPath, setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.SpecPath, setuptools._vendor.importlib_resources.readers.MultiplexedPath, setuptools._vendor.importlib_resources.simple.ResourceHandle

The base name of this object without any parent references.