HDX Python Utilities
Project description
Usage
The library has detailed API documentation which can be found here: http://ocha-dap.github.io/hdx-python-utilities/. The code for the library is here: https://github.com/ocha-dap/hdx-python-utilities.
Configuring Logging
If you wish to change the logging configuration from the defaults, you will need to call setup_logging with arguments.
from hdx.utilities.easy_logging import setup_logging ... logger = logging.getLogger(__name__) setup_logging(KEYWORD ARGUMENTS)
KEYWORD ARGUMENTS can be:
Choose |
Argument |
Type |
Value |
Default |
---|---|---|---|---|
One of: |
logging_config_dict |
dict |
Logging configuration dictionary |
|
or |
logging_config_json |
str |
Path to JSON Logging configuration |
|
or |
logging_config_yaml |
str |
Path to YAML Logging configuration |
Library’s internal logging_configuration.yml |
One of: |
smtp_config_dict |
dict |
Email Logging configuration dictionary |
|
or |
smtp_config_json |
str |
Path to JSON Email Logging configuration |
|
or |
smtp_config_yaml |
str |
Path to YAML Email Logging configuration |
Do not supply smtp_config_dict, smtp_config_json or smtp_config_yaml unless you are using the default logging configuration!
If you are using the default logging configuration, you have the option to have a default SMTP handler that sends an email in the event of a CRITICAL error by supplying either smtp_config_dict, smtp_config_json or smtp_config_yaml. Here is a template of a YAML file that can be passed as the smtp_config_yaml parameter:
handlers: error_mail_handler: toaddrs: EMAIL_ADDRESSES subject: "RUN FAILED: MY_PROJECT_NAME"
Unless you override it, the mail server mailhost for the default SMTP handler is localhost and the from address fromaddr is noreply@localhost.
To use logging in your files, simply add the line below to the top of each Python file:
logger = logging.getLogger(__name__)
Then use the logger like this:
logger.debug('DEBUG message') logger.info('INFORMATION message') logger.warning('WARNING message') logger.error('ERROR message') logger.critical('CRITICAL error message')
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 hdx-python-utilities-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2368d2f3f849ac77a449f761ffd2b21713dc7515ba7b76a7325424a2ed74dc18 |
|
MD5 | 1bf48a551600e6be70fcbee8dce161ec |
|
BLAKE2b-256 | 2d0744a2a3852ff32b6d7268db281c3b82f7f6bddb99976c01c20b825e1fd570 |
Hashes for hdx_python_utilities-1.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19678d2eb026aedeed4f0a2b4ecd2e3328c2049df00b4cb94ab98b3856b21cf8 |
|
MD5 | b9bea3c638eb2fa119f0a82125c4b143 |
|
BLAKE2b-256 | 34ceb77dbd4863c150eaa054c55a28e4b81ee8a5c9307cab53ac27da17208ace |