executiontime 0.4.0__tar.gz → 0.4.1__tar.gz

{executiontime-0.4.0 → executiontime-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: executiontime
-Version: 0.4.0
+Version: 0.4.1
 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
@@ -40,6 +40,7 @@ pip install executiontime
 ## Usage
 
 You simply need to decorate the function and specify a message template.
+If you do not provide a message, one will be created for you based on the names of the decorated function and its module.
 
 ```python
 from executiontime import printexecutiontime
@@ -81,3 +82,11 @@ if __name__ == '__main__':
     my_function()
 ```
 
+## Changelog
+
+- v0.4.1
+  - The message is now optional and a default one is provided, based on the names of the decorated function and its module.
+- v0.4.0
+  - Refresh the dependencies
+  - Replace deprecated datetime.utcnow()
+

{executiontime-0.4.0 → executiontime-0.4.1}/README.md

@@ -15,6 +15,7 @@ pip install executiontime
 ## Usage
 
 You simply need to decorate the function and specify a message template.
+If you do not provide a message, one will be created for you based on the names of the decorated function and its module.
 
 ```python
 from executiontime import printexecutiontime
@@ -55,3 +56,11 @@ def my_function():
 if __name__ == '__main__':
     my_function()
 ```
+
+## Changelog
+
+- v0.4.1
+  - The message is now optional and a default one is provided, based on the names of the decorated function and its module.
+- v0.4.0
+  - Refresh the dependencies
+  - Replace deprecated datetime.utcnow()

{executiontime-0.4.0 → executiontime-0.4.1}/executiontime/__init__.py

@@ -29,10 +29,15 @@ P = ParamSpec("P")
 T = TypeVar("T")
 
 
-def printexecutiontime(message: str, output: Callable[..., None] = print, color: Optional[str] = None) -> Callable[[Callable[P, T]], Callable[P, T]]:
+def printexecutiontime(
+    message: Optional[str] = None, output: Callable[..., None] = print, color: Optional[str] = None
+) -> Callable[[Callable[P, T]], Callable[P, T]]:
     """
     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.
+        If none is provided, we will use a default message with the module's and functions's names.
+    output: A function to send the message. By default we use 'print' that sends the message to the console.
+    color: One of the constant string provided in this module to color the message.
     """
 
     def decorator(function: Callable[P, T]) -> Callable[P, T]:
@@ -48,7 +53,10 @@ def printexecutiontime(message: str, output: Callable[..., None] = print, color:
             start = datetime.now(tz=UTC)
             value = function(*args, **kwargs)
             elapsed = datetime.now(tz=UTC) - start
-            msg = message.format(elapsed)
+            if message is None:
+                msg = f"{function.__module__}.{function.__name__} executed in {elapsed}"
+            else:
+                msg = message.format(elapsed)
             if color:
                 msg = color + msg + Fore.RESET
             output(msg)

{executiontime-0.4.0 → executiontime-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "executiontime"
-version = "0.4.0"
+version = "0.4.1"
 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"