twisted.python.filepath

module documentation

Object-oriented filesystem path representation.

Interface	`IFilePath`	File path object.
Class	`AbstractFilePath`	Abstract implementation of an `IFilePath`; must be completed by a subclass.
Class	`FilePath`	I am a path on the filesystem that only permits 'downwards' access.
Class	`Permissions`	A class representing read/write/execute permissions. Instantiate with any portion of the file's mode that includes the permission bits.
Class	`RWX`	A class representing read/write/execute permissions for a single user category (i.e. user/owner, group, or other/world). Instantiate with three boolean values: readable? writable? executable?.
Exception	`InsecurePath`	Error that is raised when the path provided to `FilePath` is invalid.
Exception	`LinkError`	An error with symlinks - either that there are cyclical symlinks or that symlink are not supported on this platform.
Exception	`UnlistableError`	An exception which is used to distinguish between errors which mean 'this is not a directory you can list' and other, more catastrophic errors.
Type Variable	`OtherAnyStr`	Undocumented
Variable	`FileMode`	Undocumented
Function	`_asFilesystemBytes`	Return `path` as a string of `bytes` suitable for use on this system's filesystem.
Function	`_asFilesystemText`	Return `path` as a string of `unicode` suitable for use on this system's filesystem.
Function	`_coerceToFilesystemEncoding`	Return a `newpath` that is suitable for joining to `path`.
Function	`_secureEnoughString`	Compute a string usable as a new, temporary filename.
Constant	`_CREATE_FLAGS`	Undocumented
Type Variable	`_Self`	Undocumented

OtherAnyStr = ¶

Undocumented

Value

TypeVar('OtherAnyStr', str, bytes)

FileMode = ¶

Undocumented

def _asFilesystemBytes(path: bytes | str, encoding: str | None = '') -> bytes: ¶

Return path as a string of bytes suitable for use on this system's filesystem.

Parameters
path:`bytes` or `unicode`	The path to be made suitable.
encoding:`str \| None`	The encoding to use if coercing to `bytes`. If none is given, `sys.getfilesystemencoding` is used.
Returns
`bytes`	`bytes`

def _asFilesystemText(path: bytes | str, encoding: str | None = None) -> str: ¶

Return path as a string of unicode suitable for use on this system's filesystem.

Parameters
path:`bytes` or `unicode`	The path to be made suitable.
encoding:`str \| None`	The encoding to use if coercing to `unicode`. If none is given, `sys.getfilesystemencoding` is used.
Returns
`str`	`unicode`

def _coerceToFilesystemEncoding(path: AnyStr, newpath: bytes | str, encoding: str | None = None) -> AnyStr: ¶

Return a newpath that is suitable for joining to path.

Parameters
path:`AnyStr`	The path that it should be suitable for joining to.
newpath:`bytes \| str`	The new portion of the path to be coerced if needed.
encoding:`str \| None`	If coerced, the encoding that will be used.
Returns
`AnyStr`	Undocumented

def _secureEnoughString(path: AnyStr) -> AnyStr: ¶

Compute a string usable as a new, temporary filename.

Parameters
path:`AnyStr`	The path that the new temporary filename should be able to be concatenated with.
Returns
the type of `path`	A pseudorandom, 16 byte string for use in secure filenames.

_CREATE_FLAGS = ¶

Undocumented

Value

os.O_EXCL | os.O_CREAT | os.O_RDWR | O_BINARY

_Self = ¶

Undocumented

Value

TypeVar('_Self',
        bound='AbstractFilePath[Any]')