cs-deco

Assorted decorator functions.

Function `decorator(deco)`

Wrapper for decorator functions to support optional arguments. The actual decorator function ends up being called as:

deco(func, *da, **dkw)

allowing da and dkw to affect the bahviour of the decorator deco.

Examples:

@decorator
def deco(func, *da, kw=None):
  ... decorate func subject to the values of da and kw
@deco
def func1(...):
  ...
@deco('foo', arg2='bah')
def func2(...):
  ...

Function `fmtdoc(func)`

Decorator to replace a function's docstring with that string formatted against the function's module's dict.

This supports simple formatted docstrings:

ENVVAR_NAME = 'FUNC_DEFAULT'

@fmtdoc
def func():
    """Do something with os.environ[{ENVVAR_NAME}]."""
    print(os.environ[ENVVAR_NAME])

This gives func this docstring:

Do something with os.environ[FUNC_DEFAULT].

Warning: this decorator is intended for wiring "constants" into docstrings, not for dynamic values. Use for other types of values should be considered with trepidation.

Function `observable_class(property_names, only_unequal=False)`

Class decorator to make various instance attributes observable.

Parameters:

property_names: an interable of instance property names to set up as observable properties. As a special case a single str can be supplied of only one attribute is to be observed.
only_unequal: only call the observers if the new property value is not equal to the previous proerty value. This requires property values to be comparable for inequality. Default: False, meaning that all updates will be reported.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cs.deco-20190526.tar.gz (5.6 kB view details)

Uploaded May 26, 2019 Source

File details

Details for the file cs.deco-20190526.tar.gz.

File metadata

Download URL: cs.deco-20190526.tar.gz
Upload date: May 26, 2019
Size: 5.6 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for cs.deco-20190526.tar.gz
Algorithm	Hash digest
SHA256	`760523e13e332f3760c8c45749af5ce6d45556c3d424efe949990b777f4fb4b1`
MD5	`62b94b588709fc466e6f807dfe9c3fe0`
BLAKE2b-256	`b239d7c913a27fe17a10ade082d655846c6c9926221ceb68e7642048c7fcad3b`