Mercurial > cpython-lru_cache-weakref

annotate Lib/functools.py @ 58765:2ba7677bfa95 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
testCopysign was defined twice in test_math; combine the definitions
author Mark Dickinson <dickinsm@gmail.com>
date Sat, 06 Feb 2010 23:11:25 +0000
parents b3abff17e2dd
children 787b969d37f0 1e6f268016e4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38668
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
1 """functools.py - Tools for working with functions and callable objects
38486
8ac603e570a0 When adding a module like functools, it helps to let SVN know about the file.
Nick Coghlan <ncoghlan@gmail.com>
parents:
diff changeset
2 """
8ac603e570a0 When adding a module like functools, it helps to let SVN know about the file.
Nick Coghlan <ncoghlan@gmail.com>
parents:
diff changeset
3 # Python module wrapper for _functools C module
8ac603e570a0 When adding a module like functools, it helps to let SVN know about the file.
Nick Coghlan <ncoghlan@gmail.com>
parents:
diff changeset
4 # to allow utilities written in Python to be added
8ac603e570a0 When adding a module like functools, it helps to let SVN know about the file.
Nick Coghlan <ncoghlan@gmail.com>
parents:
diff changeset
5 # to the functools module.
8ac603e570a0 When adding a module like functools, it helps to let SVN know about the file.
Nick Coghlan <ncoghlan@gmail.com>
parents:
diff changeset
6 # Written by Nick Coghlan <ncoghlan at gmail.com>
38668
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
7 # Copyright (C) 2006 Python Software Foundation.
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
8 # See C source code for _functools credits/copyright
38486
8ac603e570a0 When adding a module like functools, it helps to let SVN know about the file.
Nick Coghlan <ncoghlan@gmail.com>
parents:
diff changeset
9
48204
b3abff17e2dd Copy reduce() to _functools so to have functools.reduce() not raise a warning
Brett Cannon <bcannon@gmail.com>
parents: 42913
diff changeset
10 from _functools import partial, reduce
38668
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
11
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
12 # update_wrapper() and wraps() are tools to help write
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
13 # wrapper functions that can handle naive introspection
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
14
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
15 WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__doc__')
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
16 WRAPPER_UPDATES = ('__dict__',)
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
17 def update_wrapper(wrapper,
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
18 wrapped,
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
19 assigned = WRAPPER_ASSIGNMENTS,
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
20 updated = WRAPPER_UPDATES):
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
21 """Update a wrapper function to look like the wrapped function
38486
8ac603e570a0 When adding a module like functools, it helps to let SVN know about the file.
Nick Coghlan <ncoghlan@gmail.com>
parents:
diff changeset
22
38668
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
23 wrapper is the function to be updated
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
24 wrapped is the original function
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
25 assigned is a tuple naming the attributes assigned directly
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
26 from the wrapped function to the wrapper function (defaults to
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
27 functools.WRAPPER_ASSIGNMENTS)
40175
1586fab3c848 Typo fix
Andrew M. Kuchling <amk@amk.ca>
parents: 38668
diff changeset
28 updated is a tuple naming the attributes of the wrapper that
38668
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
29 are updated with the corresponding attribute from the wrapped
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
30 function (defaults to functools.WRAPPER_UPDATES)
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
31 """
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
32 for attr in assigned:
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
33 setattr(wrapper, attr, getattr(wrapped, attr))
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
34 for attr in updated:
40200
e3b9c6397723 [Bug #1576241] Let functools.wraps work with built-in functions
Andrew M. Kuchling <amk@amk.ca>
parents: 40175
diff changeset
35 getattr(wrapper, attr).update(getattr(wrapped, attr, {}))
38668
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
36 # Return the wrapper so this can be used as a decorator via partial()
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
37 return wrapper
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
38
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
39 def wraps(wrapped,
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
40 assigned = WRAPPER_ASSIGNMENTS,
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
41 updated = WRAPPER_UPDATES):
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
42 """Decorator factory to apply update_wrapper() to a wrapper function
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
43
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
44 Returns a decorator that invokes update_wrapper() with the decorated
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
45 function as the wrapper argument and the arguments to wraps() as the
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
46 remaining arguments. Default arguments are as for update_wrapper().
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
47 This is a convenience function to simplify applying partial() to
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
48 update_wrapper().
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
49 """
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
50 return partial(update_wrapper, wrapped=wrapped,
dee73fa8110f Add functools.update_wrapper() and functools.wraps() as described in PEP 356
Nick Coghlan <ncoghlan@gmail.com>
parents: 38496
diff changeset
51 assigned=assigned, updated=updated)