Base

Generic base classes and functions for file operations.

Classes:

File()

Generic class for representing a file on a system.

class musify.file.base.File

Bases: Hashable

Generic class for representing a file on a system.

Attributes:

valid_extensions	Extensions of files that can be loaded by this class.
path	The path to the file.
folder	The parent folder of the file.
filename	The filename without extension.
ext	The file extension in lowercase.
size	The size of the file in bytes
date_created	datetime object representing when the file was created
date_modified	datetime object representing when the file was last modified

Methods:

get_filepaths(folder)	Get all files in a given folder that match this File object's valid filetypes recursively.
load(*args, **kwargs)	Load the file to this object
save([dry_run])	Save this object to file.

valid_extensions: frozenset[str]

Extensions of files that can be loaded by this class.

abstract property path: str

The path to the file.

property folder: str

The parent folder of the file.

property filename: str

The filename without extension.

property ext: str

The file extension in lowercase.

property size: int | None

The size of the file in bytes

property date_created: datetime | None

datetime object representing when the file was created

property date_modified: datetime | None

datetime object representing when the file was last modified

classmethod get_filepaths(folder)

Get all files in a given folder that match this File object’s valid filetypes recursively.

Return type:

set[str]

abstract load(*args, **kwargs)

Load the file to this object

Return type:

Any

abstract save(dry_run=True, *args, **kwargs)

Save this object to file.

Parameters:

dry_run (bool (default: True)) – Run function, but do not modify the file on the disk.

Return type:

Any