Quick and easy logging parameters for click commands.
Project description
Quick and easy logging parameters for click commands.
1 Installation
The click_logging_config package is available from PyPI. Installing into a virtual environment is recommended.
python3 -m venv .venv; .venv/bin/pip install click_logging_config
2 Getting Started
Using click_logging_config is intended to be very simple. A single decorator applied to your click command or group adds some click options specifically for managing logging context.
import click
import logging
from click_logging import logging_parameters
log = logging.getLogger(__name__)
def do_something()
pass
@click.command()
@click.option("--my-option", type=str)
# NOTE: Empty braces are required for hard-coded click-logging-config defaults.
@logging_parameters()
def my_command(my_option: str) -> None:
log.info("doing something")
try:
do_something(my_option)
except Exception as e:
log.critical(f"something bad happened, {str(e)}")
raise
Application of the @logging_parameters decorator must be applied immediately above your click command function and below any other click decorators such as arguments and options.
Having applied the decorator your command now has the following options available to it.
--log-console-enable / --log-console-disable
Enable or disable console logging.
[default: log-console-disable]
--log-console-json-enable / --log-console-json-disable
Enable or disable console JSON logging.
[default: log-console-json-disable]
--log-file-enable / --log-file-disable
Enable or disable file logging.
[default: log-file-enable]
--log-file-json-enable / --log-file-json-disable
Enable or disable file JSON logging.
[default: log-file-json-enable]
--log-file FILE The log file to write to. [default: this.log]
--log-level [critical|error|warning|info|debug|notset]
Select logging level to apply to all enabled
log sinks. [default: warning]
Note that the single log level configuration parameter applies to both console and file logging.
If you don’t like the click-logging-config internal defaults for the options you can define your own. The LoggingConfiguration class is derived from pydantic.BaseModel, so one easy way to define your defaults is using a dictionary. You only need to define values to want to change - any other value will continue using the internal defaults.
import pathlib
import click
import logging
from click_logging import logging_parameters, LoggingConfiguration
log = logging.getLogger(__name__)
MY_LOGGING_DEFAULTS = LoggingConfiguration.parse_obj(
{
"file_logging": {
# NOTE: file path must be specified using pathlib.Path
"log_file_path": pathlib.Path("some_other.log"),
},
"log_level": "info",
}
)
def do_something()
pass
@click.command()
@click.option("--my-option", type=str)
@logging_parameters(MY_LOGGING_DEFAULTS)
def my_command(my_option: str) -> None:
log.info("doing something")
try:
do_something(my_option)
except Exception as e:
log.critical(f"something bad happened, {str(e)}")
raise
Review the LoggingConfiguration class definition to understand all the default configuration parameters available.
3 Console logging
Console logging can be enabled or disabled, and there is an additional option to output line-by-line text based timestamped log entries, or JSON logging via the json_log_formatter framework. The format of text based log entries cannot be configured at this time and console logging is always emitted to stderr at this time.
4 File logging
File rotation on the file log is implemented as a “sensible default” - it cannot be disabled at this time, although you might be able to specify a maximum rotation of 1 to achieve the same end. The maximum rotation size can be specified as a configuration default. File logging itself can be enabled or disabled via defaults or the CLI options described above.
Similar to console logging the format can be as either text-based or JSON logging.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for click_logging_config-0.2.1.post2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0ee711a865c02cc9eef7769a72f2b61b8117151d83e79b2bf00445b134924fc |
|
MD5 | 0382db5e35afd261e2d55c403afde218 |
|
BLAKE2b-256 | 1fa93a67c56dcc63e593d03708058e698fe38a09d807501158e94d7e0aa35ddf |
Hashes for click_logging_config-0.2.1.post2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbc0d89034470c1b42eadc02c5d21ee8f0cf14978f0324ec657d17e2566ada31 |
|
MD5 | 2b3181cdec0771f075a163477878f283 |
|
BLAKE2b-256 | 6dd9932db6877aaa3e2230cf90c42cb2373497bdad130021366ad81c7a2bae4d |