Skip to main content

aiodec

Project description

https://img.shields.io/badge/stdlib--only-yes-green.svg https://travis-ci.org/cjrh/aiodec.svg?branch=master https://coveralls.io/repos/github/cjrh/aiodec/badge.svg?branch=master https://img.shields.io/pypi/pyversions/aiodec.svg https://img.shields.io/github/tag/cjrh/aiodec.svg https://img.shields.io/badge/install-pip%20install%20aiodec-ff69b4.svg https://img.shields.io/pypi/v/aiodec.svg https://img.shields.io/badge/calver-YYYY.MM.MINOR-22bfda.svg

aiodec

Decorators for asyncio

Contents

astopwatch

The astopwatch decorator is used in the following way:

from aiodec import astopwatch

@astopwatch
async def blah(x, y):
    return x + y

What does it do? This simple decorator will emit logs with the following message:

INFO:aiodec:Time taken: 0.0003 seconds

Not terribly special. Yet. You can also customize the log message:

from aiodec import astopwatch

@astopwatch(message_template='Time cost was $time_ sec', fmt='%.1g')
async def blah(x, y):
    return x + y

This outputs log messages with the following message:

INFO:aiodec:Time cost was 3e-4 sec

Two things: first, the template parameter used for the time cost is called $time_; second, you can customize the formatting of the seconds value. However, it can also do something a lot more interesting: it can include parameters from the wrapped function in the message:

from aiodec import astopwatch

@astopwatch(message_template='x=$x y=$y | $time_ seconds')
async def blah(x, y=2):
    return x + y


loop.run_until_complete(blah(1))

This outputs log messages with the following message:

INFO:aiodec:x=1 y=2 | 0.0003 seconds

Magic! Note that positional args and keyword args and default values are all handled correctly.

As you saw earlier, in addition to the function parameters, the special $time_ parameter will also be available. The other extra fields are:

  • $name_, which contains the __name__ of the wrapped function, and
  • $qualname_, which contains the __qualname__ of the wrapped function.

These three template parameters have a trailing underscore, to avoid collisions with any parameter names.

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

aiodec-2018.10.1.tar.gz (8.3 kB view hashes)

Uploaded source

Built Distribution

aiodec-2018.10.1-py2.py3-none-any.whl (16.1 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page