Top-rated Python recipes tagged "meta:requires=functools"

LRU and LFU cache decorators (Python)

2010-08-01T01:19:23-07:00

Python recipe 498245 by Raymond Hettinger (shortcuts). Revision 6.

One-line decorator call adds caching to functions with hashable arguments and no keyword arguments. When the maximum size is reached, the least recently used entry or least frequently used entry is discarded -- appropriate for long-running processes which cannot allow caches to grow without bound. Includes built-in performance instrumentation.

Py2.6+ and Py3.0+ backport of Python 3.3's LRU Cache (Python)

2013-03-06T05:38:15-08:00

Python recipe 578078 by Raymond Hettinger (cache, lru). Revision 6.

Full-featured O(1) LRU cache backported from Python3.3. The full Py3.3 API is supported (thread safety, maxsize, keyword args, type checking, __wrapped__, and cache_info). Includes Py3.3 optimizations for better memory utilization, fewer dependencies, and fewer dict lookups.

Topological Sort (Python)

2012-09-27T12:21:23-07:00

Python recipe 578272 by Sam Denton (algorithm, sort, sorting, topological, toposort).

A topological sort (sometimes abbreviated topsort or toposort) or topological ordering of a directed graph is a linear ordering of its vertices such that, for every edge uv, u comes before v in the ordering. For instance, the vertices of the graph may represent tasks to be performed, and the edges may represent constraints that one task must be performed before another; in this application, a topological ordering is just a valid sequence for the tasks. A topological ordering is possible if and only if the graph has no directed cycles, that is, if it is a directed acyclic graph (DAG).

Smarter Default Arguments (Python)

2011-08-12T23:06:57-07:00

Python recipe 577786 by Eric Snow (default_arguments, deferred, function, functions). Revision 3.

Improved handling of mutable and deferred default arguments. After the recipe you'll find an explanation of what that means.

Works for 2.7 with minor tweaks (getfullargspec --> getargspec).

Simple caching decorator (Python)

2010-12-01T00:43:01-08:00

Python recipe 577479 by Raymond Hettinger (cache, memoization).

Memoizing decorator. Has the same API as the functools.lru_cache() in Py3.2 but without the LRU feature, so it takes less memory, runs faster, and doesn't need locks to keep the dictionary in a consistent state.

Method signature type checking decorator for Python 3 (Python)

2015-05-15T09:25:08-07:00

Python recipe 572161 by Dmitry Dvoinikov (checking, decorator, interface, method, signature, sysadmin, type). Revision 8.

This recipe allows nice and clean validation for method parameters/return values. It uses function annotations available in Python 3 for the actual signature specification.

Error logging with context manager and decorator (Python)

2007-09-19T06:52:58-07:00

Python recipe 531821 by Kent Johnson (shortcuts).

A context manager and decorator that wrap common exception trapping and handling code so they may be applied with just a single line of code in the client.

Guard against an exception in the wrong place (Python)

2017-06-25T17:17:43-07:00

Python recipe 580808 by Steven D'Aprano (context, exception, guard, manager). Revision 2.

Sometimes exception handling can obscure bugs unless you guard against a particular exception occurring in a certain place. One example is that accidentally raising StopIteration inside a generator will halt the generator instead of displaying a traceback. That was solved by PEP 479, which automatically has such StopIteration exceptions change to RuntimeError. See the discussion below for further examples.

Here is a class which can be used as either a decorator or context manager for guarding against the given exceptions. It takes an exception (or a tuple of exceptions) as argument, and if the wrapped code raises that exception, it is re-raised as another exception type (by default RuntimeError).

For example:

try:
    with exception_guard(ZeroDivisionError):
        1/0  # raises ZeroDivisionError
except RuntimeError:
    print ('ZeroDivisionError replaced by RuntimeError')


@exception_guard(KeyError)
def demo():
    return {}['key']  # raises KeyError

try:
    demo()
except RuntimeError:
    print ('KeyError replaced by RuntimeError')

Keyword-only arguments in Python 2.x (Python)

2015-09-22T18:16:40-07:00

Python recipe 578993 by Cara (arguments, decorator, keyword, keyword_only). Revision 10.

This is a decorator that makes some of a function's or method's arguments into keyword-only arguments. As much as it possible, it emulates the Python 3 handling of keyword-only arguments, including messages for TypeErrors. It's compatible with Python 3 so it can be used in code bases that support both versions.

Create on-the-fly class adapters with functools.partial (Python)

2014-05-29T18:48:28-07:00

Python recipe 578884 by Christoph Schueler (adapter, namedtuple, partial, pattern).

functools.partial could not only applied to functions it also works with classes. This opens some interesting perspectives, like on-the-fly creation of class adapters, as the following code illustrates.

lru_timestamp - cache entry aging for functools.lru_cache (Python)

2014-02-02T21:28:25-08:00

Python recipe 578817 by Peter Santoro (age, lru_cache).

Return a timestamp string for @lru_cache decorated functions.

The returned timestamp is used as the value of an extra parameter to @lru_cache decorated functions, allowing for more control over how often cache entries are refreshed. The lru_timestamp function should be called with the same refresh_interval value for a given @lru_cache decorated function. The returned timestamp is for the benefit of the @lru_cache decorator and is normally not used by the decorated function.

Positional arguments: refresh_interval -- in minutes (default 60), values less than 1 are coerced to 1, values more than 1440 are coerced to 1440

type Checking in Python using decorators (version 2.0) (Python)

2012-11-19T13:15:35-08:00

Python recipe 578330 by LL Snark (checking, debugging, decorators, type). Revision 2.

The two decorators checkparams and checkreturn allow you to check (at execution time) that function parameters or a function return value are the right type.

Cached Class (Python)

2012-01-06T02:24:08-08:00

Python recipe 577998 by Peter Donis (cache, decorators). Revision 5.

A class decorator that ensures that only one instance of the class exists for each distinct set of constructor arguments.

Note that if a decorated class is subclassed, each subclass is cached separately. (This is because each cached subclass is a different cls argument to the __new__ method.)

Pick random elements from a predefined list of choices (Python)

2011-06-14T17:46:41-07:00

Python recipe 577754 by Patrick Dobbs (choice, random, selection).

This (quick but strangely satisfying) recipe combines the use of random.choice with functools.partial from the standard library. It is a factory function returning random.choice pre-filled with its sequence of options.

namedtuple.abc - abstract base class + mix-in for named tuples (Python)

2011-04-02T02:07:00-07:00

Python recipe 577629 by Jan Kaliszewski (abc, collections, dry, inheritance, namedtuple, shortcuts). Revision 7.

If you need

to define named tuple subclasses (including reusable abstract ones), adding/overriding some methods, in a convenient way;
to have the named tuple ABC (abstract base class) for isinstance/issubclass tests;
or simply would like to define your named tuple classes in a class-syntax-based and DRY way (without repeating type names...)

-- this recipe is for you.

Trace decorator for debugging (Python)

2011-01-24T18:40:51-08:00

Python recipe 577551 by Kevin L. Sitze (classes, debug, debugging, decorators, functions, inspection, modules, trace). Revision 2.

This package provides a decorator for tracing function and method calls in your applications. The tracing capabilities are managed through the logging package, and several mechanisms are provided for controlling the destination of the trace output.

It also provides functionality for adding decorators to existing classes or modules.

dualmethod descriptor (Python)

2010-02-06T20:54:45-08:00

Python recipe 577030 by Steven D'Aprano (decorator, descriptor, method). Revision 3.

This descriptor can be used to decorate methods, similar to the built-ins classmethod and staticmethod. It enables the caller to call methods on either the class or an instance, and the first argument passed to the method will be the class or the instance respectively.

This differs from classmethods, which always passes the class, and staticmethods, which don't pass either.

Like all descriptors, you can only use this in new-style classes.

Docstring inheritance decorator (Python)

2009-07-28T13:42:32-07:00

Python recipe 576862 by Shai Berger (decorator, descriptor, docstring, inheritance, metaprogramming).

In many cases, a subclass overrides a method in a parent class, just to change its implementation; in such cases, it would be nice to preserve the overridden method's docstring. The decorator below can be used to achieve this without explicit reference to the parent class. It does this by replacing the function with a descriptor, which accesses the parent class when the method is accessed as an attribute.

Finding the percentile of the values (Python)

2011-04-25T03:41:08-07:00

Python recipe 511478 by Wai Yip Tung (algorithms). Revision 2.

This function find the percentile of a list of values. Note that the list must be sorted already.

typeparser (Python)

2007-04-15T04:24:53-07:00

Python recipe 511473 by Florian Leitner (algorithms). Revision 2.

Python type-string parser. The code evolved from a post in python-list on 11/22/05 by Fredrik Lundh on a dictionary parser. It parses a type-string to their type objects for all basic types. Raises SyntaxError and SemanticError on failures.

Supported types: * containers: defaultdict, deque, dict, list, tuple, set * basic types: Decimal, bool, float, int, long, str * None type

REQUIRES PYTHON >= 2.5