Skip to main content

Non-intrusive spinner through standard logging library

Project description

Latest PyPI version Build Status Demo session

This library helps to display loading spinners in CLI in non-intrusive manner. Applications/libraries don’t have to depend on any third-party API, but only need to log loading messages through Python’s standard logging library:

logger = logging.getLogger('myapp.logger')
logger.info('Loading data...', extra={'user_waiting': True})
# some long taking process goes here...
logger.info('Finished loading!', extra={'user_waiting': False})

At the outest code of the application, setup a SpinnerHandler:

from logging_spinner import SpinnerHandler

logger = logging.getLogger('myapp')
logger.setLevel(logging.INFO)
logger.addHandler(SpinnerHandler())

SpinnerHandler is only aware of log records with user_waiting extra field and displays them with a spinner.

See also sample.py code.

Author and license

Written by Hong Minhee and distributed under GPLv3 or later.

Changelog

Version 0.2.2

Released on June 22, 2017.

  • Fixed a ValueError raised when a log record with {'user_waiting': Flase} is made without any previous log records with {'user_waiting': True}.

Version 0.2.1

Released on May 21, 2017.

  • Fixed a bug that SpinerHandler had crashed when user_waiting log records show a spinner again after a previous spinner was hidden.

Version 0.2.0

Released on May 21, 2017.

  • logging_spinner.UserWaitingFilter was introduced to avoid duplicate prints of a log record with user_waiting extra field.

Version 0.1.0

Released on May 21, 2017. The initial release.

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

logging-spinner-0.2.2.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

logging_spinner-0.2.2-py2.py3-none-any.whl (5.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file logging-spinner-0.2.2.tar.gz.

File metadata

File hashes

Hashes for logging-spinner-0.2.2.tar.gz
Algorithm Hash digest
SHA256 d31ce3399a6f2aa87f72f90e8cacbdcb470ffbeeb33fc1bce084526ddd3e6e16
MD5 48c535d816a2b1a43451b94e66432761
BLAKE2b-256 e8e6b2cf8e992323ae9313cfea9be3fa10c07207052f19194f150555997bde27

See more details on using hashes here.

Provenance

File details

Details for the file logging_spinner-0.2.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for logging_spinner-0.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5371342fbd5aa498bd7de81f158b032c1a611b219d2e324d7cdecaaf3f0b0bea
MD5 46d83a60e83f9a7ea947670a60cd77d3
BLAKE2b-256 2bf373f854648cad03e23fdb0b6bbff293f2173d28f36839d65bc2315bec0533

See more details on using hashes here.

Provenance

Supported by

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