Python logging for Humans
Project description
Alog
Python logging for Humans. Your goto logging module without panic on context swtich.
Warning: No more logger = logging.getLogger(__name__) in your every file.
>>> import alog
>>> alog.info("Hi.")
2016-08-18 20:44:30 INFO <stdin> Hi.
>>> def test():
... alog.info("Test 1")
... alog.error("Test 2")
...
>>> test()
2016-08-18 20:45:19 INFO <stdin:2> Test 1
2016-08-18 20:45:19 ERROR <stdin:3> Test 2
>>> alog.set_level("ERROR")
>>> test()
2016-08-18 20:45:41 ERROR <stdin:3> Test 2
If you’re new to logging, see Why should you use logging instead of print.
Installation
pip install alog
Features
Instant logging with expected defaults.
You can do logging instantly by reading a small piece of README. Alog comes with useful defaults:
A default logger.
Logging level: logging.INFO
Logging format:
"%(asctime)s %(levelname)-5.5s [parent_module.current_module:%(lineno)s]%(message)s", "%Y-%m-%d %H:%M:%S"
No more __name__ whenever you start to do logging in a module.
Alog builds the default module names on the fly.
Compatible with default Python logging module.
Alog is built upon default Python logging module. You can configure it by the same way of default Python logging module when it’s needed.
Comparing alog with Python default logging module
Comparing alog :
In [1]: import alog
In [2]: alog.info("Hello alog!")
2016-09-01 02:20:34 INFO <IPython> Hello alog!
with logging module:
In [1]: import logging
In [2]: logging.basicConfig(
...: level=logging.INFO,
...: format="%(asctime)s %(levelname)-5.5s "
...: "[%(name)s:%(lineno)s] %(message)s")
In [3]: # In every file you want to do log, otherwise %(names)s won't work.
In [4]: logger = logging.getLogger(__name__)
In [5]: logger.info("Hello log!")
2016-09-01 02:16:30 INFO [__main__:1] Hello log!
Why should you use logging instead of print
The main goal of logging is to figure out what was going on and to get the insights. print, by default, does only pure string output. No timestamp, no module hint, and no level control, comparing to a pretty logging record.
Lets start with aproject/models/user.py :
class User:
def __init__(self, user_id, username):
...
print(username)
...
What you got output of print :
>>> admin = User(1, "admin")
"admin"
Now use alog :
import alog
class User:
def __init__(self, user_id, username):
...
alog.info(username)
...
What you got output of alog.info :
>>> admin = User(1, "admin")
2016-09-01 01:32:58 INFO [models.user:6] admin
In the output of hundreds of lines, it helps (a lot).
What if you have used print a log? That’s as easy:
import alog
print = alog.info
... # A lot of print code no needed to change
0.9.10 (2017-03-27)
Default logging format asctime to “%Y-%m-%d %H:%M:%S” instead of “%Y-%m-%d,%H:%M:%S.%f”.
Update package info and usage (setup.py, README, …).
0.9.9 (2016-08-28)
Update to turn_thread_name and turn_process_id.
0.9.8 (2016-08-27)
Support showing_thread_name and showing_process_id.
Support global reset.
0.9.7 (2016-08-17)
Better paths log for None default root name.
0.9.6 (2016-08-16)
First public release.
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 alog-0.9.10-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08bb83f343958da71bc615b1dd0dd123763512cc4218f7786feb480667e82a36 |
|
MD5 | 4708ff0b6044a4979346e3330f439074 |
|
BLAKE2b-256 | b701a72d3dd465887fb37c629ef308fea3ea49e3ee3bb16c01a7f0bcf0bfd1f3 |