fs.info¶

Container for filesystem resource informations.

class fs.info.Info(raw_info, to_datetime=<function epoch_to_datetime>)[source]¶

Resource information is returned by the following methods:

getinfo

scandir

filterdir

Parameters:	raw_info (dict) – A dict containing resource info. to_datetime (callable) – A callable that converts an epoch time to a datetime object. The default uses `epoch_to_datetime()`.

accessed¶

datetime – the resource last access time, or None.

Requires the "details" namespace.

Raises:	`MissingInfoNamespace` – if the `"details"` namespace is not in the Info.

copy(to_datetime=None)[source]¶: Create a copy of this resource info object.

created¶

datetime – the resource creation time, or None.

Requires the "details" namespace.

Raises:	`MissingInfoNamespace` – if the `"details"` namespace is not in the Info.

get(namespace, key, default=None)[source]¶

Get a raw info value.

Parameters:	namespace (str) – A namespace identifier. key (str) – A key within the namespace. default (object, optional) – A default value to return if either the namespace or the key within the namespace is not found.

Example

>>> info.get('access', 'permissions')
['u_r', 'u_w', '_wx']

gid¶

int – the group id of the resource, or None.

Requires the "access" namespace.

Raises:	`MissingInfoNamespace` – if the `"access"` namespace is not in the Info.

group¶

str – the group of the resource owner, or None.

Requires the "access" namespace.

Raises:	`MissingInfoNamespace` – if the `"access"` namespace is not in the Info.

has_namespace(namespace)[source]¶

Check if the resource info contains a given namespace.

Parameters:	namespace (str) – A namespace identifier.
Returns:	`True` if the namespace was found, `False` otherwise.
Return type:	bool

is_dir¶: bool – True if the resource references a directory.

is_file¶: bool – True if the resource references a file.

is_link¶: bool – True if the resource is a symlink.

is_writeable(namespace, key)[source]¶

Check if a given key in a namespace is writable.

Uses setinfo.

Parameters:	namespace (str) – A namespace identifier. key (str) – A key within the namespace.
Returns:	`True` if the key can be modified, `False` otherwise.
Return type:	bool

make_path(dir_path)[source]¶

Make a path by joining dir_path with the resource name.

Parameters:	dir_path (str) – A path to a directory.
Returns:	A path to the resource.
Return type:	str

metadata_changed¶

datetime – the resource metadata change time, or None.

Requires the "details" namespace.

Raises:	`MissingInfoNamespace` – if the `"details"` namespace is not in the Info.

modified¶

datetime – the resource last modification time, or None.

Requires the "details" namespace.

Raises:	`MissingInfoNamespace` – if the `"details"` namespace is not in the Info.

name¶: str – the resource name.

permissions¶

Permissions – the permissions of the resource, or None.

Requires the "access" namespace.

Raises:	`MissingInfoNamespace` – if the `"access"` namespace is not in the Info.

size¶

int – the size of the resource, in bytes.

Requires the "details" namespace.

Raises:	`MissingInfoNamespace` – if the `"details"` namespace is not in the Info.

stem¶

str – the name minus any suffixes.

Example

>>> info
<info 'foo.tar.gz'>
>>> info.stem
'foo'

suffix¶

str – the last component of the name (including dot), or an empty string if there is no suffix.

Example

>>> info
<info 'foo.py'>
>>> info.suffix
'.py'

suffixes¶

List – a list of any suffixes in the name.

Example

>>> info
<info 'foo.tar.gz'>
>>> info.suffixes
['.tar', '.gz']

target¶

str – the link target (if resource is a symlink), or None.

Requires the "link" namespace.

Raises:	`MissingInfoNamespace` – if the `"link"` namespace is not in the Info.

type¶

ResourceType – the type of the resource.

Requires the "details" namespace.

Raises:	`MissingInfoNamespace` – if the ‘details’ namespace is not in the Info.

uid¶

int – the user id of the resource, or None.

Requires the "access" namespace.

Raises:	`MissingInfoNamespace` – if the `"access"` namespace is not in the Info.

user¶

str – the owner of the resource, or None.

Requires the "access" namespace.

Raises:	`MissingInfoNamespace` – if the `"access"` namespace is not in the Info.