__init__
- pydecipher.__init__.get_logging_options() Dict[str, bool | Path]
Retrieve the library-wide logging settings.
- Returns:
A dictionary of the logging settings.
- Return type:
Dict[str, Union[bool, pathlib.Path]]
- pydecipher.__init__.register(artifact_class: type) type
Register artifact classes as unpack-able (this is a decorator).
- Parameters:
artifact_class (type) –
pydecipher.main.unpack()will try to instantiate this class with the artifact passed into pydecipher to figure out what type of artifact is being analyzed.- Returns:
The class object argument, unchanged.
- Return type:
type
- pydecipher.__init__.set_logging_options(**kwargs)
Set the library-wide logging settings.
- Parameters:
**kwargs –
Arbitrary keyword arguments. These can be the following:
- verbose: bool
True will enable verbose logging.
- quiet: bool
True will silence all console logging.
- log_path: pathlib.Path
If a path object is passed in as the log_path, the running instance of pydecipher will continue logging to that file.
Notes
Quiet and verbose are mutually exclusive, but we don’t perform the check here again because this is enforced by argparse in
pydecipher.main._parse_args().