Configuring Logging in a File

If you configure logging in your application configuration (or some other) file you can do something like:

[loggers]
key = root

[handlers]
keys = console

[formatters]
keys = pyramid

[logger_root]
level = INFO
handlers = console

[handler_console]
class = StreamHandler
args = (sys.stderr,)
level = NOTSET
formatter = pyramid

[formatter_pyramid]
# NB: Here is the interesting part!
class = pyramid_log.Formatter
format = %(asctime)s %(request.method|no request)s %(request.path_qs|)s
         %(levelname)-5.5s [%(name)s] %(message)s

This will result in your log messages looking something like:

2014-10-01 17:55:02,001 GET /path?arg=foo
WARNI [myapp.views] This is some log message!

Refer to Pyramid’s chapter on logging and the documentation for the Python logging module’s configuration file format for more details on how this works.

Imperative Configuration

You can of course configure logging imperatively. For example, with:

import logging
from pyramid_log import Formatter

fmt = Formatter(
    '%(asctime)s %(request.client_addr|-)s'
    ' %(request.method|-)s %(request.path_qs|-)s: %(message)s')

logging.basicConfig()
root_logger = logging.getLogger()
for handler in root_logger.handlers:
    handler.setFormatter(fmt)

Then, a view can log a message like so:

log = logging.getLogger(__name__)

@view_config(name='persimmon')
def persimmon_view(request):
    log.warning("%s was called!", request.view_name)

Which will yield a log message like:

2014-10-01 17:55:02,001 192.168.1.1 GET /persimmon: persimmon was called

Accessing Dict-like Values

The dot notation can be used to access not only instance attributes, but also to access items in dict-like values. Attribute access is tried first; if there is no attribute of the given name, then the instances __getitem__ method is tried. For example, "%(request.matchdict.id)s" will get at request.matchdict['id'].

Numeric Fallback

Explicit fallback values are always interpreted as strings, however, if the fallback is used in a numeric context, an attempt will be made at conversion to the requested type. For example, if there is no request, "%+(request.status_code|555)d" will format to "+555".

If the fallback string can not be converted to a numeric value, then 0 (zero) is used in integer contexts and NaN is used in float contexts.

Default Fallback Values

If no fallback value is explicitly specified, then a default fallback value will be used if the requested attribute does not exist. The missing attribute name is included in the default fallback value. For example "%(request.method)s" will produce "<?request.method?>" if there is no current request.

Release 1.0.1 (2021-12-07)

A bit of code refactoring and cleanup in preparation for dropping python 2 support.

No API or functional changes.

Release 1.0 (2021-12-05)

This release adds support for python>=3.8 and pyramid>=2.

The 1.x releases will be the last to support running under python 2.7.

Release 0.2.1 (2017-12-17)

This release officially drops support for python 2.6, 3.2, 3.3 (and therefore pypy3) and adds support for python 3.5 and 3.6.

Other than changes in test configuration, there are no substantive changes from 0.2.

Release 0.2 (2014-10-09)

Release 0.1.1 (2014-10-02)

Release 0.1 (2014-10-02)

• Initial release