Metadata-Version: 1.1
Name: glog
Version: 0.3.1
Summary: Simple Google-style logging wrapper for Python.
Home-page: https://github.com/benley/python-glog
Author: Benjamin Staffin
Author-email: benley@gmail.com
License: BSD
Description: glog for Python
        ===============
        
        .. image:: https://travis-ci.org/benley/python-glog.svg?branch=master
            :target: https://travis-ci.org/benley/python-glog
        
        A simple Google-style logging wrapper for Python.
        
        This library attempts to greatly simplify logging in Python applications.
        Nobody wants to spend hours pouring over the PEP 282 logger documentation, and
        almost nobody actually needs things like loggers that can be reconfigured over
        the network.  We just want to get on with writing our apps.
        
        Styled somewhat after the twitter.common.log_ interface, which in turn was
        modeled after Google's internal python logger, which was `never actually
        released`_ to the wild, and which in turn was based on the `C++ glog library`_.
        
        Core benefits
        -------------
        
        - You and your code don't need to care about how logging works. Unless you
          want to, of course.
        
        - No more complicated setup boilerplate!
        
        - Your apps and scripts will all have a consistent log format, and the same
          predictable behaviours.
        
        This library configures the root logger, so nearly everything you import that
        uses the standard Python logging module will play along nicely.
        
        Behaviours
        ----------
        
        -  Messages are always written to stderr.
        
        -  Lines are prefixed with a google-style log prefix, of the form
        
        ``E0924 22:19:15.123456 19552 filename.py:87] Log message blah blah``
        
        Splitting on spaces, the fields are:
        
        1. The first character is the log level, followed by MMDD (month, day)
        2. HH:MM:SS.microseconds
        3. Process ID
        4. basename\_of\_sourcefile.py:linenumber]
        5. The body of the log message.
        
        Example use
        -----------
        
        .. code:: python
        
            import glog as log
        
            log.setLevel("INFO")  # Integer levels are also allowed.
            log.info("It works.")
            log.warn("Something not ideal")
            log.error("Something went wrong")
            log.fatal("AAAAAAAAAAAAAAA!")
        
        If your app uses gflags_, it will automatically gain a ``--verbosity`` flag,
        and you can skip calling ``log.setLevel``.  Just import glog and start logging.
        
        Check macros / assert helpers
        -----------------------------
        
        `Like the C++ version of glog`_, python-glog provides a set of check macros
        [1]_ that help document and enforce invariants.  These provide a detailed
        message indicating what values caused the assertion to fail, along with a stack
        trace identifying the code-path that caused the failure, hopefully making it
        easier to reproduce the error.  Failed checks raise the FailedCheckException.
        You may find these more convenient and/or more familiar than standard Python
        asserts, particularly if you are working in a mixed C++ and Python codebase.
        
        
        .. code:: python
        
            import glog as log
            import math
        
            def compute_something(a):
                log.check_eq(type(a), float) # require floating point types
                log.check_ge(a, 0) # require non-negative values
                value = math.sqrt(a)
                return value
        
            if __name__ == '__main__':
                compute_something(10)
        
        
        Provided check functions:
        
        .. code:: python
        
            check(condition)
            check_eq(obj1, obj2)
            check_ne(obj1, obj2)
            check_le(obj1, obj2)
            check_ge(obj1, obj2)
            check_lt(obj1, obj2)
            check_gt(obj1, obj2)
            check_notnone(obj1, obj2)
        
        
        Happy logging!
        
        .. _twitter.common.log: https://github.com/twitter/commons/tree/master/src/python/twitter/common/log
        
        .. _never actually released: https://groups.google.com/d/msg/google-glog/a_JcyJ4p8MQ/Xu-vDPiuCCYJ
        
        .. _C++ glog library: https://github.com/google/glog
        
        .. _gflags: https://github.com/google/python-gflags
        
        .. _Like the C++ version of glog: https://htmlpreview.github.io/?https://github.com/google/glog/master/doc/glog.html#check
        
        .. [1] Technically these are functions, not macros.  Python does not have
           syntactic macros in the sense that C++ and most lisp-like languages do.
        
Platform: any
Classifier: Programming Language :: Python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: System :: Logging
Classifier: Topic :: Software Development :: Libraries :: Python Modules
