Skip to main content

Useful Python Tidbits

Project description

Ever find yourself copying and pasting small chunks of Python code between a bunch of your projects? The goal of this library is to reduce or eliminate that problem.

Yes, I realize that’s never going to happen. Contributions are very appreciated though, let’s see how close we can get.

Latest PyPI Version CircleCI Test Status Python Version Support

Installation

$ pip install --upgrade tidbits

Note that in an effort to keep this library generalized, optional dependencies are not included, ie. for the Sentry integration you will still need to

$ pip install raven

For convenience, these are bundled as extra dependencies, ie. you can do

$ pip install --upgrade tidbits[gcloud,sentry]

Usage

GCloud

> requires python-json-logger or tidbits[gcloud]

Have you ever run an app on Google Cloud and wondered why all your logs were marked as errors, regardless of log level? Well, most likely you weren’t formatting them correctly – Google Cloud expects JSON logs with “severity” rather than “levelname”, which you can set with:

from tidbits.gcloud.log import get_handler

logging.getLogger().addHandler(get_handler())
# or, even better, set all your loggers at once with tidbits.log

Log

Ever had to configure the loggers of all of your dependencies? This one’s for you.

from tidbits.log import get_all_loggers
from tidbits.log import get_all_base_loggers
from tidbits.log import set_handler
from tidbits.log import set_loglevel

import requests

get_all_loggers()
# ['requests', 'urllib3', 'urllib3.connection', 'urllib3.connectionpool', 'urllib3.poolmanager', 'urllib3.response', 'urllib3.util', 'urllib3.util.retry']

get_all_base_loggers()
# ['requests', 'urllib3']

set_handler(myCoolHandler, logger='applesauce')
# the "applesauce" logger uses this (and only this) handler
set_handler_globally(myCoolHandler)
# all loggers use this (and only this) handler
set_handler_globally(myCoolHandler, ignore={'aardvark', 'banana'})
# all loggers except those listed use this (and only this) handler

set_loglevel(debug=True)
# sets logging.getLogger() to DEBUG and all others to INFO
set_loglevel(debug=False)
# sets logging.getLogger() to INFO and all others to WARNING

Integrations

> requires raven or tidbits[sentry]

Do you use Sentry? I do. And every single project I use it in contains the same block for configuring it and instrumenting the error logger.

from tidbits.integration.sentry import SENTRY
from tidbits.integration.sentry import instrument_logger

try:
    {}['missing_key']
except Exception:
    # damn, I totally didn't expect an error here, better send it to Sentry
    SENTRY.captureException()

# creates events in Sentry for each error log
instrument_logger(level=logging.Error)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tidbits-0.4.1.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

tidbits-0.4.1-py2.py3-none-any.whl (6.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file tidbits-0.4.1.tar.gz.

File metadata

  • Download URL: tidbits-0.4.1.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for tidbits-0.4.1.tar.gz
Algorithm Hash digest
SHA256 4d1fa9c60e267ffa00d626de8bb7e9e1aff75e7027dc1ae1e982e6fb60fce516
MD5 ca742edff6ddf6e2e6254c1e0740be1f
BLAKE2b-256 32ac9e7d104388364fb4c93331297b1092fc2344b49083ae7a1a2e7c3aaff287

See more details on using hashes here.

File details

Details for the file tidbits-0.4.1-py2.py3-none-any.whl.

File metadata

  • Download URL: tidbits-0.4.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for tidbits-0.4.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 393d147fe79763f9ec746b5c2492d63227887b451901cb27fb6201d08bd741df
MD5 39162dc60c48fa8cfb946a4cd4aa97a5
BLAKE2b-256 da7046d164c3d70526374de339540602b998d02692263f373b2be39fd2b151cd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page