executiontime 0.3.0__tar.gz → 0.3.2__tar.gz

executiontime-0.3.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Timokasse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

executiontime-0.3.2/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: executiontime
+Version: 0.3.2
+Summary: A simple function decorator to display its execution time on the console or in the logs.
+License: MIT
+Keywords: testing,logging,time,performance,execution
+Author: Timokasse
+Author-email: Timokasse@users.noreply.github.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: French
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Requires-Dist: colorama (>=0.4.6,<0.5.0)
+Description-Content-Type: text/markdown
+
+# executiontime
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/Timokasse/executiontim/blob/master/LICENSE)
+
+This module provides a simple function decorator to display its execution time on the console or in the logs.
+
+## Installation
+
+Simply install the package with `pip`:
+
+```bash
+pip install executiontime
+```
+
+## Usage
+
+You simply need to decorate the function and specify a message template.
+
+```python
+from executiontime import printexecutiontime
+
+@printexecutiontime("My function's execution took {0}")
+def my_function():
+    pass
+
+if __name__ == '__main__':
+    my_function()
+```
+
+By default, the message will be displayed on the console. But it is also possible to specify a log function, for example.
+
+```python
+from logging import info, INFO, basicConfig
+from executiontime import printexecutiontime
+
+@printexecutiontime("My function's execution took {0}", display=info)
+def my_function():
+    pass
+
+if __name__ == '__main__':
+    basicConfig(level=INFO)
+    my_function()
+
+```
+
+It is also easy to add a little bit of color:
+
+```python
+from executiontime import printexecutiontime, LIGHTBLUE
+
+@printexecutiontime("My function's execution took {0}", color=LIGHTBLUE)
+def my_function():
+    pass
+
+if __name__ == '__main__':
+    my_function()
+```
+

{executiontime-0.3.0 → executiontime-0.3.2}/executiontime/__init__.py

@@ -2,6 +2,7 @@
 Defines the printexecutiontime decorator
 """
 from datetime import datetime
+from functools import wraps
 
 from colorama import Fore
 
@@ -22,7 +23,7 @@ RED = Fore.RED
 WHITE = Fore.WHITE
 YELLOW = Fore.YELLOW
 
-def printexecutiontime(message, display=print, color=None):
+def printexecutiontime(message, output=print, color=None):
     '''
     This function returns a decorator. This allows to have a decorator that accepts parameters.
     message: A string with a '{0}' placeholder for the time that will be sent to the console.
@@ -31,6 +32,7 @@ def printexecutiontime(message, display=print, color=None):
         '''
         The decorator itself returns a wrapper function that will replace the original one.
         '''
+        @wraps(function)
         def wrapper(*args, **kwargs):
             '''
             This wrapper calculates and displays the execution time of the function.
@@ -41,7 +43,7 @@ def printexecutiontime(message, display=print, color=None):
             msg = message.format(elapsed)
             if color:
                 msg = color + msg + Fore.RESET
-            display(msg)
+            output(msg)
             return value
         return wrapper
     return decorator

executiontime-0.3.2/pyproject.toml

@@ -0,0 +1,35 @@
+[tool.poetry]
+name = "executiontime"
+version = "0.3.2"
+description = "A simple function decorator to display its execution time on the console or in the logs."
+authors = ["Timokasse <Timokasse@users.noreply.github.com>"]
+license = "MIT"
+readme = "README.md"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: French",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Testing",
+]
+keywords = ["testing", "logging", "time", "performance", "execution"]
+packages = [
+    { include = "executiontime" }
+]
+
+[tool.poetry.dependencies]
+python = "^3.11"
+colorama = "^0.4.6"
+
+
+[tool.poetry.group.dev.dependencies]
+pylint = "^3.0.3"
+black = "^24.2.0"
+mypy = "^1.8.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

executiontime-0.3.0/MANIFEST.in

@@ -1,2 +0,0 @@
-include README.md
-

executiontime-0.3.0/PKG-INFO

@@ -1,78 +0,0 @@
-Metadata-Version: 2.1
-Name: executiontime
-Version: 0.3.0
-Summary: Utilities to show execution time during development of a module
-Home-page: https://github.com/Timokasse/executiontime
-Author: Timokasse
-Author-email: Timokasse@users.noreply.github.com
-License: MIT
-Download-URL: https://github.com/Timokasse/executiontime/tarball/0.1
-Description: # executiontime
-        
-        [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/Timokasse/executiontim/blob/master/LICENSE)
-        
-        This module provides a simple function decorator to display its execution time on the console or in the logs.
-        
-        ## Installation
-        
-        Simply install the package with `pip`:
-        
-        ```bash
-        pip install executiontime
-        ```
-        
-        ## Usage
-        
-        You simply need to decorate the function and specify a message template.
-        
-        ```python
-        from executiontime import printexecutiontime
-        
-        @printexecutiontime("My function's execution took {0}")
-        def my_function():
-            pass
-        
-        if __name__ == '__main__':
-            my_function()
-        ```
-        
-        By default, the message will be displayed on the console. But it is also possible to specify a log function, for example.
-        
-        ```python
-        from logging import info, INFO, basicConfig
-        from executiontime import printexecutiontime
-        
-        @printexecutiontime("My function's execution took {0}", display=info)
-        def my_function():
-            pass
-        
-        if __name__ == '__main__':
-            basicConfig(level=INFO)
-            my_function()
-        
-        ```
-        
-        It is also easy to add a little bit of color:
-        
-        ```python
-        from executiontime import printexecutiontime, LIGHTBLUE
-        
-        @printexecutiontime("My function's execution took {0}", color=LIGHTBLUE)
-        def my_function():
-            pass
-        
-        if __name__ == '__main__':
-            my_function()
-        ```
-        
-Keywords: testing,logging,time,performance,execution
-Platform: UNKNOWN
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: French
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Software Development :: Testing
-Description-Content-Type: text/markdown

executiontime-0.3.0/executiontime.egg-info/PKG-INFO

@@ -1,78 +0,0 @@
-Metadata-Version: 2.1
-Name: executiontime
-Version: 0.3.0
-Summary: Utilities to show execution time during development of a module
-Home-page: https://github.com/Timokasse/executiontime
-Author: Timokasse
-Author-email: Timokasse@users.noreply.github.com
-License: MIT
-Download-URL: https://github.com/Timokasse/executiontime/tarball/0.1
-Description: # executiontime
-        
-        [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/Timokasse/executiontim/blob/master/LICENSE)
-        
-        This module provides a simple function decorator to display its execution time on the console or in the logs.
-        
-        ## Installation
-        
-        Simply install the package with `pip`:
-        
-        ```bash
-        pip install executiontime
-        ```
-        
-        ## Usage
-        
-        You simply need to decorate the function and specify a message template.
-        
-        ```python
-        from executiontime import printexecutiontime
-        
-        @printexecutiontime("My function's execution took {0}")
-        def my_function():
-            pass
-        
-        if __name__ == '__main__':
-            my_function()
-        ```
-        
-        By default, the message will be displayed on the console. But it is also possible to specify a log function, for example.
-        
-        ```python
-        from logging import info, INFO, basicConfig
-        from executiontime import printexecutiontime
-        
-        @printexecutiontime("My function's execution took {0}", display=info)
-        def my_function():
-            pass
-        
-        if __name__ == '__main__':
-            basicConfig(level=INFO)
-            my_function()
-        
-        ```
-        
-        It is also easy to add a little bit of color:
-        
-        ```python
-        from executiontime import printexecutiontime, LIGHTBLUE
-        
-        @printexecutiontime("My function's execution took {0}", color=LIGHTBLUE)
-        def my_function():
-            pass
-        
-        if __name__ == '__main__':
-            my_function()
-        ```
-        
-Keywords: testing,logging,time,performance,execution
-Platform: UNKNOWN
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: French
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Software Development :: Testing
-Description-Content-Type: text/markdown

executiontime-0.3.0/executiontime.egg-info/SOURCES.txt

@@ -1,11 +0,0 @@
-MANIFEST.in
-README.md
-setup.cfg
-setup.py
-executiontime/__init__.py
-executiontime.egg-info/PKG-INFO
-executiontime.egg-info/SOURCES.txt
-executiontime.egg-info/dependency_links.txt
-executiontime.egg-info/not-zip-safe
-executiontime.egg-info/requires.txt
-executiontime.egg-info/top_level.txt

executiontime-0.3.0/executiontime.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

executiontime-0.3.0/executiontime.egg-info/not-zip-safe

@@ -1 +0,0 @@
-

executiontime-0.3.0/executiontime.egg-info/requires.txt

@@ -1 +0,0 @@
-colorama

executiontime-0.3.0/executiontime.egg-info/top_level.txt

@@ -1 +0,0 @@
-executiontime

executiontime-0.3.0/setup.cfg

@@ -1,7 +0,0 @@
-[metadata]
-description-file = README.md
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

executiontime-0.3.0/setup.py

@@ -1,48 +0,0 @@
-#!/usr/bin/env python3
-
-"""
-This allows to build the package and deploy it in PyPi:
-
-> pip install -r requirements.txt
-> rm -rf dist
-> ./setup.py sdist bdist_wheel
-> twine upload dist/*
-
-"""
-
-from pathlib import Path
-from setuptools import find_packages, setup
-
-HERE = Path(__file__).parent
-
-README = (HERE / "README.md").read_text()
-
-setup(
-    name = 'executiontime',
-    packages = find_packages(),
-    version = '0.3.0',
-    description = 'Utilities to show execution time during development of a module',
-    long_description = README,
-    long_description_content_type = "text/markdown",
-    classifiers = [
-        'Development Status :: 3 - Alpha',
-        'Environment :: Console',
-        'Intended Audience :: Developers',
-        'License :: OSI Approved :: MIT License',
-        'Natural Language :: French',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python :: 3',
-        'Topic :: Software Development :: Testing',
-    ],
-    author = 'Timokasse',
-    author_email = 'Timokasse@users.noreply.github.com',
-    url = 'https://github.com/Timokasse/executiontime',
-    download_url = 'https://github.com/Timokasse/executiontime/tarball/0.1', # I'll explain this in a second
-    keywords = ['testing', 'logging', 'time', 'performance', 'execution'],
-    license='MIT',
-    install_requires=[
-        'colorama'
-    ],
-    include_package_data=True,
-    zip_safe=False,
-)