Top level module cache for dailylog-lib.

Top level module config for dailylog-lib.

class Config(**kwargs)[source]

Bases: Options

Class to manage the configuration.

set_default_log(log_fn)[source]

Set the default log file.

Return type:

None

Parameters

log_fnstr

Absolute path to the log file

classmethod update_config(config)[source]

Update configuration from version to current version.

Parameters:

config (StrAnyDict) – previous config verstion

Return type:

Dict[str, Any]

classmethod validate_path(path)[source]

Validate the file path exists or can be created.

Parameters:

path (Path) – files spec for log

Raises:

  • FileNotFoundError – when parent directory doesn’t exist or is not a directory

  • FilePermError – when parent directory is not writable

Return type:

None

default_log()[source]

Returns the path to the default log.

Return type:

str

Returns

str

Path to the default log

classmethod validate_existing_path(path)[source]

Validate existing path.

Parameters:

path (Path) – files spec for log

Raises:

  • FileNotFoundError – when path exists but is not a file

  • FilePermError – when path exists but is not writable

Return type:

None

Top level module exceptions for dailylog.

exception FilePermError[source]

Bases: Exception

Class for file permission errors.

Top level module options for dailylog-lib.

class Options(**kwargs)[source]

Bases: object

Class to manage the options.

is_debug()[source]

Return True if debug option is greater than 0.

Return type:

bool

is_test()[source]

Return True if test option is greater than 0.

Return type:

bool

is_verbose()[source]

Return True if verbose option is greater than 0.

Return type:

bool

config_path()[source]

Return the config file path.

Return type:

Path

cache_path()[source]

Return the cache file path.

Return type:

Path

classmethod validate_fn_absolute(file_key, file_name)[source]

Validate an absolute file name/path.

Parameters:

  • file_key (str) – key name of file “config | cache”

  • file_name (str) – path name of file to validate

Raises:

  • ValueError – when file_name is empty string

  • ValueError – when file_name is not absolute

Returns:

validate file name/path as a string

Return type:

str