setuptools._vendor.importlib_resources._adapters.CompatibilityFiles.SpecPath

class documentation

class SpecPath(abc.Traversable): (source)

View In Hierarchy

Path tied to a module spec. Can be read and exposes the resource reader children.

Method __init__ Undocumented
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).
Property name The base name of this object without any parent references.
Instance Variable _reader Undocumented
Instance Variable _spec Undocumented

Inherited from Traversable:

Method __truediv__ Return Traversable child in self
Method is_dir Return True if self is a directory
Method read_bytes Read contents of self as bytes
Method read_text Read contents of self as text
def __init__(self, spec, reader): (source)

Undocumented

def is_file(self): (source)
overrides setuptools._vendor.importlib_resources.abc.Traversable.is_file

Return True if self is a file

def iterdir(self): (source)
overrides setuptools._vendor.importlib_resources.abc.Traversable.iterdir

Yield Traversable objects in self

def joinpath(self, other): (source)
overrides setuptools._vendor.importlib_resources.abc.Traversable.joinpath

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`` (``/``).

def open(self, mode='r', *args, **kwargs): (source)
overrides setuptools._vendor.importlib_resources.abc.Traversable.open

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.

@property
name = (source)
overrides setuptools._vendor.importlib_resources.abc.Traversable.name

The base name of this object without any parent references.

_reader = (source)

Undocumented

_spec = (source)

Undocumented