tfds.core.ReadOnlyPath

Protocol for read-only methods of pathlib.Path-like API.

Inherits From: PurePath, Protocol

tfds.core.ReadOnlyPath(
    *args, **kwargs
)

See pathlib.Path documentation.

parent

parents

Methods

as_posix

View source

as_posix() -> str

as_uri

View source

as_uri() -> str

exists

View source

@abc.abstractmethod
exists() -> bool

Returns True if self exists.

expanduser

View source

expanduser() -> tfds.typing.T

Returns a new path with expanded ~ and ~user constructs.

glob

View source

@abc.abstractmethod
glob(
    pattern: str
) -> Iterator[T]

Yielding all matching files (of any kind).

is_absolute

View source

is_absolute() -> bool

is_dir

View source

@abc.abstractmethod
is_dir() -> bool

Returns True if self is a dir.

is_file

View source

is_file() -> bool

Returns True if self is a file.

is_relative_to

View source

is_relative_to(
    *other
) -> bool

Return True if the path is relative to another path or False.

is_reserved

View source

is_reserved() -> bool

iterdir

View source

@abc.abstractmethod
iterdir() -> Iterator[T]

Iterates over the directory.

joinpath

View source

joinpath(
    *other
) -> tfds.typing.T

match

View source

match(
    path_pattern: str
) -> bool

open

View source

@abc.abstractmethod
open(
    mode: str = 'r',
    encoding: Optional[str] = None,
    errors: Optional[str] = None,
    **kwargs
) -> typing.IO[AnyStr]

Opens the file.

read_bytes

View source

read_bytes() -> bytes

Reads contents of self as bytes.

read_text

View source

read_text(
    encoding: Optional[str] = None
) -> str

Reads contents of self as bytes.

relative_to

View source

relative_to(
    *other
) -> tfds.typing.T

resolve

View source

@abc.abstractmethod
resolve(
    strict: bool = False
) -> tfds.typing.T

Returns the absolute path.

rglob

View source

rglob(
    pattern: str
) -> Iterator[T]

Yielding all matching files recursivelly (of any kind).

with_name

View source

with_name(
    name: str
) -> tfds.typing.T

with_suffix

View source

with_suffix(
    suffix: str
) -> tfds.typing.T

__ge__

View source

__ge__(
    other: "PurePath"
) -> bool

Return self>=value.

__gt__

View source

__gt__(
    other: "PurePath"
) -> bool

Return self>value.

__le__

View source

__le__(
    other: "PurePath"
) -> bool

Return self<=value.

__lt__

View source

__lt__(
    other: "PurePath"
) -> bool

Return self<value.

__rtruediv__

View source

__rtruediv__(
    key: tfds.core.PathLike
) -> tfds.typing.T

__truediv__

View source

__truediv__(
    key: tfds.core.PathLike
) -> tfds.typing.T