Fileson module

Fileson class to manipulate Fileson databases.

class fileson.Fileson(*args, **kwargs)

File database with previous versions support based on LogDict.

The file format is fully compatible so you can use LogDict.create() to instantiate one. Special keys like :scan:, :checksum: used for metadata and additional files() and dirs() methods expose certain types of contents. Also, set() used to implement “set if changed” functionality.

dirs() → list

Return paths to dirs.

files() → list

Return paths to files.

classmethod load(dbfile: str) → fileson.Fileson

Overloaded class method to support f.fson~1 history syntax.

classmethod load_or_scan(db_or_dir: str, **kwargs) → fileson.Fileson

Load Fileson database or create one by scanning a directory.

This basically calls load() or creates a new instance and uses scan() after it (passing kwargs).

Parameters

db_or_dir (str) – Database or directory name

Returns

New class instance

Return type

Fileson

scan(directory: str, **kwargs) → None

Scan a directory for objects or changes.

Every invocation creates a new ‘run’, a version to Fileson database. Only changes need to be stored. You can then use for example genItems() and pick only objects that were changed on a given run.

Parameters

• directory (str) – Directory to scan

• **kwargs – Booleans ‘verbose’ and ‘strict’ control behaviour

set(key: Any, val: Any) → bool

Set key to val if there’s a change, in which case return True.

fileson.gmt_str(mtime: Optional[int] = None) → str

Convert st_mtime to GMT string.