A common configuration-storage class with a .diag() method
Project description
A common configuration-storage class with a .diag() method
Description
This module provides four classes that may be used as base classes for
storing program runtime configuration with a verbose
boolean field.
The classes provide a .diag(func)
method that will check the object's
verbose
field and, if it is set to a true value, invoke the specified
function and output the message that it returns. If the message is not
expensive to format (e.g. it does not include stringifying elaborate
data structures), the .diag(msg)
method may be used instead.
The ConfigDiagUnfrozen
and ConfigDiagUnfrozenStdOut
classes are
normal dataclasses, while the ConfigDiag
and ConfigDiagStdOut
ones
are frozen.
The ConfigDiag
and ConfigDiagUnfrozen
classes will output any
diagnostic messages to the standard error stream, while
the ConfigDiagStdOut
and ConfigDiagUnfrozenStdOut
ones will output
the diagnostic messages to the standard output stream.
Example
Subclass the frozen ConfigDiag
class, add a program-specific field:
@dataclasses.dataclass(frozen=True)
class Config(cfg_diag.ConfigDiag):
"""Runtime configuration for the fribble program."""
path: pathlib.Path
Initialize this class from an argument parser object:
return Config(path=args.path, verbose=args.verbose)
Output a diagnostic message if requested:
cfg.diag_("This will either appear or it will not")
cfg.diag(lambda: f"Here's the thing: {thing!r}")
Contact
This module is developed in a GitHub repository. Contact the StorPool support team for information.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.