Skip to content

Latest commit

 

History

History
728 lines (450 loc) · 9.17 KB

File metadata and controls

728 lines (450 loc) · 9.17 KB

TFSimilarity.callbacks.Path

PurePath subclass that can make system calls.

TFSimilarity.callbacks.Path(
    *args, **kwargs
)

Path represents a filesystem path but unlike PurePath, also offers methods to do system calls on path objects. Depending on your system, instantiating a Path will return either a PosixPath or a WindowsPath object. You can also instantiate a PosixPath or WindowsPath directly, but cannot instantiate a WindowsPath on a POSIX system or vice versa.

Attributes

anchor The concatenation of the drive and root, or ''.
drive The drive prefix (letter or UNC path), if any.
name The final path component, if any.
parent The logical parent of the path.
parents A sequence of this path's logical parents.
parts An object providing sequence-like access to the components in the filesystem path.
root The root of the path, if any.
stem The final path component, minus its last suffix.
suffix The final component's last suffix, if any.

This includes the leading period. For example: '.txt'

suffixes A list of the final component's suffixes, if any.

These include the leading periods. For example: ['.tar', '.gz']

Methods

absolute

absolute()

Return an absolute version of this path. This function works even if the path doesn't point to anything.

No normalization is done, i.e. all '.' and '..' will be kept along. Use resolve() to get the canonical path to a file.

as_posix

as_posix()

Return the string representation of the path with forward (/) slashes.

as_uri

as_uri()

Return the path as a 'file' URI.

chmod

chmod(
    mode
)

Change the permissions of the path, like os.chmod().

cwd

<b>python @classmethod</b>

cwd()

Return a new path pointing to the current working directory (as returned by os.getcwd()).

exists

exists()

Whether this path exists.

expanduser

expanduser()

Return a new path with expanded ~ and ~user constructs (as returned by os.path.expanduser)

glob

glob(
    pattern
)

Iterate over this subtree and yield all existing files (of any kind, including directories) matching the given relative pattern.

group

group()

Return the group name of the file gid.

home

<b>python @classmethod</b>

home()

Return a new path pointing to the user's home directory (as returned by os.path.expanduser('~')).

is_absolute

is_absolute()

True if the path is absolute (has both a root and, if applicable, a drive).

is_block_device

is_block_device()

Whether this path is a block device.

is_char_device

is_char_device()

Whether this path is a character device.

is_dir

is_dir()

Whether this path is a directory.

is_fifo

is_fifo()

Whether this path is a FIFO.

is_file

is_file()

Whether this path is a regular file (also True for symlinks pointing to regular files).

is_mount

is_mount()

Check if this path is a POSIX mount point

is_reserved

is_reserved()

Return True if the path contains one of the special names reserved by the system, if any.

is_socket

is_socket()

Whether this path is a socket.

is_symlink()

Whether this path is a symbolic link.

iterdir

iterdir()

Iterate over the files in this directory. Does not yield any result for the special paths '.' and '..'.

joinpath

joinpath(
    *args
)

Combine this path with one or several arguments, and return a new path representing either a subpath (if all arguments are relative paths) or a totally different path (if one of the arguments is anchored).

lchmod

lchmod(
    mode
)

Like chmod(), except if the path points to a symlink, the symlink's permissions are changed, rather than its target's.

lstat

lstat()

Like stat(), except if the path points to a symlink, the symlink's status information is returned, rather than its target's.

match

match(
    path_pattern
)

Return True if this path matches the given pattern.

mkdir

mkdir(
    mode=511, parents=False, exist_ok=False
)

Create a new directory at this given path.

open

open(
    mode=r, buffering=-1, encoding=None, errors=None, newline=None
)

Open the file pointed by this path and return a file object, as the built-in open() function does.

owner

owner()

Return the login name of the file owner.

read_bytes

read_bytes()

Open the file in bytes mode, read it, and close the file.

read_text

read_text(
    encoding=None, errors=None
)

Open the file in text mode, read it, and close the file.

relative_to

relative_to(
    *other
)

Return the relative path to another path identified by the passed arguments. If the operation is not possible (because this is not a subpath of the other path), raise ValueError.

rename

rename(
    target
)

Rename this path to the given path.

replace

replace(
    target
)

Rename this path to the given path, clobbering the existing destination if it exists.

resolve

resolve(
    strict=False
)

Make the path absolute, resolving all symlinks on the way and also normalizing it (for example turning slashes into backslashes under Windows).

rglob

rglob(
    pattern
)

Recursively yield all existing files (of any kind, including directories) matching the given relative pattern, anywhere in this subtree.

rmdir

rmdir()

Remove this directory. The directory must be empty.

samefile

samefile(
    other_path
)

Return whether other_path is the same or not as this file (as returned by os.path.samefile()).

stat

stat()

Return the result of the stat() system call on this path, like os.stat() does.

symlink_to(
    target, target_is_directory=False
)

Make this path a symlink pointing to the given path. Note the order of arguments (self, target) is the reverse of os.symlink's.

touch

touch(
    mode=438, exist_ok=True
)

Create this file with the given access mode, if it doesn't exist.

unlink()

Remove this file or link. If the path is a directory, use rmdir() instead.

with_name

with_name(
    name
)

Return a new path with the file name changed.

with_suffix

with_suffix(
    suffix
)

Return a new path with the file suffix changed. If the path has no suffix, add given suffix. If the given suffix is an empty string, remove the suffix from the path.

write_bytes

write_bytes(
    data
)

Open the file in bytes mode, write to it, and close the file.

write_text

write_text(
    data, encoding=None, errors=None
)

Open the file in text mode, write to it, and close the file.

__enter__

__enter__()

__eq__

__eq__(
    other
)

Return self==value.

__exit__

__exit__(
    t, v, tb
)

__ge__

__ge__(
    other
)

Return self>=value.

__gt__

__gt__(
    other
)

Return self>value.

__le__

__le__(
    other
)

Return self<=value.

__lt__

__lt__(
    other
)

Return self<value.

__rtruediv__

__rtruediv__(
    key
)

__truediv__

__truediv__(
    key
)