decorator 5.1.0__tar.gz → 5.2.0__tar.gz

{decorator-5.1.0 → decorator-5.2.0}/CHANGES.md

@@ -1,6 +1,31 @@
 HISTORY
 --------
 
+## Unreleased
+
+## 5.2.0 (2025-02-22)
+
+Changed the build procedure to use pyproject.toml and moved the tests
+outside of the generated wheel/tarball.
+
+Added official support for Python 3.11, 3.12, 3.13 (thanks to Hugo van
+Kemenade).
+
+Dropped official support for Python < 3.8: the module is
+expected to work on older Python versions, but I cannot test such
+versions on GitHub actions, so I cannot claim that it is officially
+supported.
+
+Dafu Wu provided support for decorating partial functions, i.e.
+functions wrapped by functools.partial.
+
+## 5.1.1 (2022-01-07)
+
+Sangwoo Shim contributed a fix so that cythonized functions can be decorated.
+Brian McFee pointed out an issue in the `decorator_apply` example and
+Wim Glenn pointed out that the "fix" in version 5.1 broke
+`decorator.contextmanager` even more. Both issues are now solved.
+
 ## 5.1.0 (2021-09-11)
 
 Added a function `decoratorx` using the `FunctionMaker` and thus
@@ -23,7 +48,7 @@ lacking dunder attributes, like `dict.__setitem__`.
 ## 5.0.7 (2021-04-14)
 
 The decorator module was not passing correctly the defaults inside the
-`*args` tuple, thanks to Dan Shult for the fix. Also fixed some mispellings
+`*args` tuple, thanks to Dan Shult for the fix. Also fixed some misspellings
 in the documentation and integrated codespell in the CI, thanks to 
 Christian Clauss.
 

{decorator-5.1.0 → decorator-5.2.0}/LICENSE.txt

@@ -1,13 +1,14 @@
-Copyright (c) 2005-2018, Michele Simionato
+Copyright (c) 2005-2025, Michele Simionato
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
 met:
 
-  Redistributions of source code must retain the above copyright
+* Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
-  Redistributions in bytecode form must reproduce the above copyright
+
+* Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in
   the documentation and/or other materials provided with the
   distribution.

{decorator-5.1.0 → decorator-5.2.0}/MANIFEST.in

@@ -1,2 +1,2 @@
 include README.rst LICENSE.txt CHANGES.md performance.sh documentation.pdf
-recursive-include src/tests *.py
+include src/decorator.py

decorator-5.2.0/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.2
+Name: decorator
+Version: 5.2.0
+Summary: Decorators for Humans
+Author-email: Michele Simionato <michele.simionato@gmail.com>
+License: BSD-2-Clause
+Keywords: decorators
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+
+Decorators for Humans
+=====================
+
+The goal of the decorator module is to make it easy to define
+signature-preserving function decorators and decorator factories.
+It also includes an implementation of multiple dispatch and other niceties
+(please check the docs). It is released under a two-clauses
+BSD license, i.e. basically you can do whatever you want with it but I am not
+responsible.
+
+Installation
+-------------
+
+If you are lazy, just perform
+
+ ``$ pip install decorator``
+
+which will install just the module on your system.
+
+If you prefer to install the full distribution from source, including
+the documentation, clone the `GitHub repo`_ or download the tarball_, unpack it and run
+
+ ``$ pip install .``
+
+in the main directory, possibly as superuser.
+
+.. _tarball: https://pypi.org/project/decorator/#files
+.. _GitHub repo: https://github.com/micheles/decorator
+
+Testing
+--------
+
+If you have the source code installation you can run the tests with
+
+ `$ python src/tests/test.py -v`
+
+or (if you have setuptools installed)
+
+ `$ python setup.py test`
+
+Notice that you may run into trouble if in your system there
+is an older version of the decorator module; in such a case remove the
+old version. It is safe even to copy the module `decorator.py` over
+an existing one, since we kept backward-compatibility for a long time.
+
+Repository
+---------------
+
+The project is hosted on GitHub. You can look at the source here:
+
+ https://github.com/micheles/decorator
+
+Documentation
+---------------
+
+The documentation has been moved to https://github.com/micheles/decorator/blob/master/docs/documentation.md
+
+From there you can get a PDF version by simply using the print
+functionality of your browser.
+
+Here is the documentation for previous versions of the module:
+
+https://github.com/micheles/decorator/blob/4.3.2/docs/tests.documentation.rst
+https://github.com/micheles/decorator/blob/4.2.1/docs/tests.documentation.rst
+https://github.com/micheles/decorator/blob/4.1.2/docs/tests.documentation.rst
+https://github.com/micheles/decorator/blob/4.0.0/documentation.rst
+https://github.com/micheles/decorator/blob/3.4.2/documentation.rst
+
+For the impatient
+-----------------
+
+Here is an example of how to define a family of decorators tracing slow
+operations:
+
+.. code-block:: python
+
+   from decorator import decorator
+
+   @decorator
+   def warn_slow(func, timelimit=60, *args, **kw):
+       t0 = time.time()
+       result = func(*args, **kw)
+       dt = time.time() - t0
+       if dt > timelimit:
+           logging.warning('%s took %d seconds', func.__name__, dt)
+       else:
+           logging.info('%s took %d seconds', func.__name__, dt)
+       return result
+
+   @warn_slow  # warn if it takes more than 1 minute
+   def preprocess_input_files(inputdir, tempdir):
+       ...
+
+   @warn_slow(timelimit=600)  # warn if it takes more than 10 minutes
+   def run_calculation(tempdir, outdir):
+       ...
+
+Enjoy!

{decorator-5.1.0 → decorator-5.2.0}/README.rst

@@ -82,7 +82,7 @@ operations:
        result = func(*args, **kw)
        dt = time.time() - t0
        if dt > timelimit:
-           logging.warn('%s took %d seconds', func.__name__, dt)
+           logging.warning('%s took %d seconds', func.__name__, dt)
        else:
            logging.info('%s took %d seconds', func.__name__, dt)
        return result

decorator-5.2.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "decorator"
+authors = [
+    {name = "Michele Simionato", email = "michele.simionato@gmail.com"},
+]
+description = "Decorators for Humans"
+readme = "README.rst"
+dynamic = ["version"]
+requires-python = ">=3.8"
+keywords = ["decorators"]
+license = {text = "BSD-2-Clause"}
+classifiers = [
+  'Development Status :: 5 - Production/Stable',
+  'Intended Audience :: Developers',
+  'License :: OSI Approved :: BSD License',
+  'Natural Language :: English',
+  'Operating System :: OS Independent',
+  'Programming Language :: Python',
+  'Programming Language :: Python :: 3.8',
+  'Programming Language :: Python :: 3.9',
+  'Programming Language :: Python :: 3.10',
+  'Programming Language :: Python :: 3.11',
+  'Programming Language :: Python :: 3.12',
+  'Programming Language :: Python :: 3.13',
+  'Programming Language :: Python :: Implementation :: CPython',
+  'Topic :: Software Development :: Libraries',
+  'Topic :: Utilities']
+
+[tool.setuptools.dynamic]
+version.attr = "decorator.__version__"

{decorator-5.1.0 → decorator-5.2.0}/setup.cfg

@@ -1,5 +1,5 @@
 [upload_docs]
-upload-dir = docs
+upload_dir = docs
 
 [egg_info]
 tag_build = 

decorator-5.2.0/src/decorator.egg-info/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.2
+Name: decorator
+Version: 5.2.0
+Summary: Decorators for Humans
+Author-email: Michele Simionato <michele.simionato@gmail.com>
+License: BSD-2-Clause
+Keywords: decorators
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+
+Decorators for Humans
+=====================
+
+The goal of the decorator module is to make it easy to define
+signature-preserving function decorators and decorator factories.
+It also includes an implementation of multiple dispatch and other niceties
+(please check the docs). It is released under a two-clauses
+BSD license, i.e. basically you can do whatever you want with it but I am not
+responsible.
+
+Installation
+-------------
+
+If you are lazy, just perform
+
+ ``$ pip install decorator``
+
+which will install just the module on your system.
+
+If you prefer to install the full distribution from source, including
+the documentation, clone the `GitHub repo`_ or download the tarball_, unpack it and run
+
+ ``$ pip install .``
+
+in the main directory, possibly as superuser.
+
+.. _tarball: https://pypi.org/project/decorator/#files
+.. _GitHub repo: https://github.com/micheles/decorator
+
+Testing
+--------
+
+If you have the source code installation you can run the tests with
+
+ `$ python src/tests/test.py -v`
+
+or (if you have setuptools installed)
+
+ `$ python setup.py test`
+
+Notice that you may run into trouble if in your system there
+is an older version of the decorator module; in such a case remove the
+old version. It is safe even to copy the module `decorator.py` over
+an existing one, since we kept backward-compatibility for a long time.
+
+Repository
+---------------
+
+The project is hosted on GitHub. You can look at the source here:
+
+ https://github.com/micheles/decorator
+
+Documentation
+---------------
+
+The documentation has been moved to https://github.com/micheles/decorator/blob/master/docs/documentation.md
+
+From there you can get a PDF version by simply using the print
+functionality of your browser.
+
+Here is the documentation for previous versions of the module:
+
+https://github.com/micheles/decorator/blob/4.3.2/docs/tests.documentation.rst
+https://github.com/micheles/decorator/blob/4.2.1/docs/tests.documentation.rst
+https://github.com/micheles/decorator/blob/4.1.2/docs/tests.documentation.rst
+https://github.com/micheles/decorator/blob/4.0.0/documentation.rst
+https://github.com/micheles/decorator/blob/3.4.2/documentation.rst
+
+For the impatient
+-----------------
+
+Here is an example of how to define a family of decorators tracing slow
+operations:
+
+.. code-block:: python
+
+   from decorator import decorator
+
+   @decorator
+   def warn_slow(func, timelimit=60, *args, **kw):
+       t0 = time.time()
+       result = func(*args, **kw)
+       dt = time.time() - t0
+       if dt > timelimit:
+           logging.warning('%s took %d seconds', func.__name__, dt)
+       else:
+           logging.info('%s took %d seconds', func.__name__, dt)
+       return result
+
+   @warn_slow  # warn if it takes more than 1 minute
+   def preprocess_input_files(inputdir, tempdir):
+       ...
+
+   @warn_slow(timelimit=600)  # warn if it takes more than 10 minutes
+   def run_calculation(tempdir, outdir):
+       ...
+
+Enjoy!

{decorator-5.1.0 → decorator-5.2.0}/src/decorator.egg-info/SOURCES.txt

@@ -3,15 +3,12 @@ LICENSE.txt
 MANIFEST.in
 README.rst
 performance.sh
+pyproject.toml
 setup.cfg
-setup.py
 src/decorator.py
 src/decorator.egg-info/PKG-INFO
 src/decorator.egg-info/SOURCES.txt
 src/decorator.egg-info/dependency_links.txt
-src/decorator.egg-info/not-zip-safe
 src/decorator.egg-info/pbr.json
 src/decorator.egg-info/top_level.txt
-src/tests/__init__.py
-src/tests/documentation.py
-src/tests/test.py
+tests/test.py

{decorator-5.1.0 → decorator-5.2.0}/src/decorator.py

@@ -1,6 +1,6 @@
 # #########################     LICENSE     ############################ #
 
-# Copyright (c) 2005-2021, Michele Simionato
+# Copyright (c) 2005-2025, Michele Simionato
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -37,10 +37,11 @@ import sys
 import inspect
 import operator
 import itertools
+import functools
 from contextlib import _GeneratorContextManager
 from inspect import getfullargspec, iscoroutinefunction, isgeneratorfunction
 
-__version__ = '5.1.0'
+__version__ = '5.2.0'
 
 DEF = re.compile(r'\s*def\s*([_\w][_\w\d]*)\s*\(')
 POS = inspect.Parameter.POSITIONAL_OR_KEYWORD
@@ -71,7 +72,7 @@ class FunctionMaker(object):
                 self.name = '_lambda_'
             self.doc = func.__doc__
             self.module = func.__module__
-            if inspect.isfunction(func):
+            if inspect.isroutine(func) or isinstance(func, functools.partial):
                 argspec = getfullargspec(func)
                 self.annotations = getattr(func, '__annotations__', {})
                 for a in ('args', 'varargs', 'varkw', 'defaults', 'kwonlyargs',
@@ -214,6 +215,8 @@ def decorate(func, caller, extras=(), kwsyntax=False):
     does. By default kwsyntax is False and the the arguments are untouched.
     """
     sig = inspect.signature(func)
+    if isinstance(func, functools.partial):
+        func = functools.update_wrapper(func, func.func)
     if iscoroutinefunction(caller):
         async def fun(*args, **kw):
             if not kwsyntax:
@@ -230,6 +233,7 @@ def decorate(func, caller, extras=(), kwsyntax=False):
             if not kwsyntax:
                 args, kw = fix(args, kw, sig)
             return caller(func, *(extras + args), **kw)
+
     fun.__name__ = func.__name__
     fun.__doc__ = func.__doc__
     fun.__wrapped__ = func
@@ -313,7 +317,7 @@ class ContextManager(_GeneratorContextManager):
 
     def __call__(self, func):
         def caller(f, *a, **k):
-            with self._recreate_cm():
+            with self.__class__(self.func, *self.args, **self.kwds):
                 return f(*a, **k)
         return decorate(func, caller)
 
@@ -419,8 +423,8 @@ def dispatch_on(*dispatch_args):
             """
             check(types)
             lst = []
-            for anc in itertools.product(*ancestors(*types)):
-                lst.append(tuple(a.__name__ for a in anc))
+            for ancs in itertools.product(*ancestors(*types)):
+                lst.append(tuple(a.__name__ for a in ancs))
             return lst
 
         def _dispatch(dispatch_args, *args, **kw):

{decorator-5.1.0/src → decorator-5.2.0}/tests/test.py

@@ -3,7 +3,8 @@ import doctest
 import unittest
 import decimal
 import inspect
-from asyncio import get_event_loop
+import functools
+import asyncio
 from collections import defaultdict, ChainMap, abc as c
 from decorator import dispatch_on, contextmanager, decorator
 try:
@@ -30,7 +31,7 @@ async def before_after(coro, *args, **kwargs):
 
 @decorator
 def coro_to_func(coro, *args, **kw):
-    return get_event_loop().run_until_complete(coro(*args, **kw))
+    return asyncio.run(coro(*args, **kw))
 
 
 class CoroutineTestCase(unittest.TestCase):
@@ -39,7 +40,7 @@ class CoroutineTestCase(unittest.TestCase):
         async def coro(x):
             return x
         self.assertTrue(inspect.iscoroutinefunction(coro))
-        out = get_event_loop().run_until_complete(coro('x'))
+        out = asyncio.run(coro('x'))
         self.assertEqual(out, '<before>x<after>')
 
     def test_coro_to_func(self):
@@ -509,5 +510,20 @@ class TestSingleDispatch(unittest.TestCase):
             h(u)
 
 
+@decorator
+def partial_before_after(func, *args, **kwargs):
+    return "<before>" + func(*args, **kwargs) + "<after>"
+
+
+class PartialTestCase(unittest.TestCase):
+    def test_before_after(self):
+        def origin_func(x, y):
+            return x + y
+        _func = functools.partial(origin_func, "x")
+        partial_func = partial_before_after(_func)
+        out = partial_func("y")
+        self.assertEqual(out, '<before>xy<after>')
+
+
 if __name__ == '__main__':
     unittest.main()

decorator-5.1.0/PKG-INFO

@@ -1,124 +0,0 @@
-Metadata-Version: 1.2
-Name: decorator
-Version: 5.1.0
-Summary: Decorators for Humans
-Home-page: https://github.com/micheles/decorator
-Author: Michele Simionato
-Author-email: michele.simionato@gmail.com
-License: new BSD License
-Description: Decorators for Humans
-        =====================
-        
-        The goal of the decorator module is to make it easy to define
-        signature-preserving function decorators and decorator factories.
-        It also includes an implementation of multiple dispatch and other niceties
-        (please check the docs). It is released under a two-clauses
-        BSD license, i.e. basically you can do whatever you want with it but I am not
-        responsible.
-        
-        Installation
-        -------------
-        
-        If you are lazy, just perform
-        
-         ``$ pip install decorator``
-        
-        which will install just the module on your system.
-        
-        If you prefer to install the full distribution from source, including
-        the documentation, clone the `GitHub repo`_ or download the tarball_, unpack it and run
-        
-         ``$ pip install .``
-        
-        in the main directory, possibly as superuser.
-        
-        .. _tarball: https://pypi.org/project/decorator/#files
-        .. _GitHub repo: https://github.com/micheles/decorator
-        
-        Testing
-        --------
-        
-        If you have the source code installation you can run the tests with
-        
-         `$ python src/tests/test.py -v`
-        
-        or (if you have setuptools installed)
-        
-         `$ python setup.py test`
-        
-        Notice that you may run into trouble if in your system there
-        is an older version of the decorator module; in such a case remove the
-        old version. It is safe even to copy the module `decorator.py` over
-        an existing one, since we kept backward-compatibility for a long time.
-        
-        Repository
-        ---------------
-        
-        The project is hosted on GitHub. You can look at the source here:
-        
-         https://github.com/micheles/decorator
-        
-        Documentation
-        ---------------
-        
-        The documentation has been moved to https://github.com/micheles/decorator/blob/master/docs/documentation.md
-        
-        From there you can get a PDF version by simply using the print
-        functionality of your browser.
-        
-        Here is the documentation for previous versions of the module:
-        
-        https://github.com/micheles/decorator/blob/4.3.2/docs/tests.documentation.rst
-        https://github.com/micheles/decorator/blob/4.2.1/docs/tests.documentation.rst
-        https://github.com/micheles/decorator/blob/4.1.2/docs/tests.documentation.rst
-        https://github.com/micheles/decorator/blob/4.0.0/documentation.rst
-        https://github.com/micheles/decorator/blob/3.4.2/documentation.rst
-        
-        For the impatient
-        -----------------
-        
-        Here is an example of how to define a family of decorators tracing slow
-        operations:
-        
-        .. code-block:: python
-        
-           from decorator import decorator
-        
-           @decorator
-           def warn_slow(func, timelimit=60, *args, **kw):
-               t0 = time.time()
-               result = func(*args, **kw)
-               dt = time.time() - t0
-               if dt > timelimit:
-                   logging.warn('%s took %d seconds', func.__name__, dt)
-               else:
-                   logging.info('%s took %d seconds', func.__name__, dt)
-               return result
-        
-           @warn_slow  # warn if it takes more than 1 minute
-           def preprocess_input_files(inputdir, tempdir):
-               ...
-        
-           @warn_slow(timelimit=600)  # warn if it takes more than 10 minutes
-           def run_calculation(tempdir, outdir):
-               ...
-        
-        Enjoy!
-        
-Keywords: decorators generic utility
-Platform: All
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Utilities
-Requires-Python: >=3.5

decorator-5.1.0/setup.py

@@ -1,37 +0,0 @@
-from setuptools import setup
-
-dic = dict(__file__=None)
-exec(open('src/decorator.py').read(), dic)  # extract the __version__
-VERSION = dic['__version__']
-
-
-if __name__ == '__main__':
-    setup(name='decorator',
-          version=VERSION,
-          description='Decorators for Humans',
-          long_description=open('README.rst').read(),
-          author='Michele Simionato',
-          author_email='michele.simionato@gmail.com',
-          url='https://github.com/micheles/decorator',
-          license="new BSD License",
-          package_dir={'': 'src'},
-          py_modules=['decorator'],
-          keywords="decorators generic utility",
-          platforms=["All"],
-          python_requires='>=3.5',
-          classifiers=['Development Status :: 5 - Production/Stable',
-                       'Intended Audience :: Developers',
-                       'License :: OSI Approved :: BSD License',
-                       'Natural Language :: English',
-                       'Operating System :: OS Independent',
-                       'Programming Language :: Python',
-                       'Programming Language :: Python :: 3.5',
-                       'Programming Language :: Python :: 3.6',
-                       'Programming Language :: Python :: 3.7',
-                       'Programming Language :: Python :: 3.8',
-                       'Programming Language :: Python :: 3.9',
-                       'Programming Language :: Python :: Implementation :: CPython',
-                       'Topic :: Software Development :: Libraries',
-                       'Topic :: Utilities'],
-          test_suite='tests',
-          zip_safe=False)