xlwings-utils 25.1.2.post0__tar.gz → 25.1.3.post0__tar.gz

{xlwings_utils-25.1.2.post0 → xlwings_utils-25.1.3.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.1.2.post0
+Version: 25.1.3.post0
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -322,10 +322,33 @@ Then, the file can be copied to the pyodide file system with
 ```
 bl = block(xw.range((10,1),(50000,1)).decode_to_files())
 ```
+## Miscellaneous
+
+xlwings_utils provides a useful `timer` decorator that may be used to show the name, the entry time, the exit time and the duration of a xlwings script.
+
+To use this, put the decorator immediately after the `xw.script` decorator, like:
+
+```
+@xw.script
+@xwu.timer
+def MyScript(book: xw.Book):
+    ...
 ```
 
+This will print something like:
+
+```
+Done MyScript  11:51:13.24 - 11:51:20.28 (7.04s)
 ```
 
+
+
+
+
+
+
+
+
 ## Contact info
 
 You can contact Ruud van der Ham, the core developer, at ruud@salabim.org.

{xlwings_utils-25.1.2.post0 → xlwings_utils-25.1.3.post0}/README.md

@@ -309,10 +309,33 @@ Then, the file can be copied to the pyodide file system with
 ```
 bl = block(xw.range((10,1),(50000,1)).decode_to_files())
 ```
+## Miscellaneous
+
+xlwings_utils provides a useful `timer` decorator that may be used to show the name, the entry time, the exit time and the duration of a xlwings script.
+
+To use this, put the decorator immediately after the `xw.script` decorator, like:
+
+```
+@xw.script
+@xwu.timer
+def MyScript(book: xw.Book):
+    ...
 ```
 
+This will print something like:
+
+```
+Done MyScript  11:51:13.24 - 11:51:20.28 (7.04s)
 ```
 
+
+
+
+
+
+
+
+
 ## Contact info
 
 You can contact Ruud van der Ham, the core developer, at ruud@salabim.org.

{xlwings_utils-25.1.2.post0 → xlwings_utils-25.1.3.post0}/pyproject.toml

@@ -10,7 +10,7 @@ authors = [
     { name = "Ruud van der Ham", email = "rt.van.der.ham@gmail.com" },
 ]
 description = "xlwings_utils"
-version = "25.1.2.post0"
+version = "25.1.3.post0"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [

{xlwings_utils-25.1.2.post0 → xlwings_utils-25.1.3.post0}/xlwings_utils/xlwings_utils.py

@@ -5,7 +5,7 @@
 #  /_/\_\|_|  \_/\_/  |_||_| |_| \__, ||___/ _____  \__,_| \__||_||_||___/
 #                                |___/      |_____|
 
-__version__ = "25.1.2"
+__version__ = "25.1.3"
 
 
 from pathlib import Path
@@ -15,6 +15,8 @@ import math
 import base64
 import requests
 import json
+import datetime
+import functools
 
 Pythonista = sys.platform == "ios"
 
@@ -214,7 +216,7 @@ def write_dropbox(dropbox_path, contents):
     try:
         response.raise_for_status()
     except requests.exceptions.HTTPError as e:
-        raise FileNotFoundError(f"file {str(dropbox_path)} could not be written. Original message is {e}") from None    
+        raise FileNotFoundError(f"file {str(dropbox_path)} could not be written. Original message is {e}") from None
 
 
 def delete_from_dropbox(dropbox_path):
@@ -1041,6 +1043,29 @@ def trigger_macro(sheet):
     sheet["A1"].value = "=NOW()"
 
 
+def timer(func):
+    """
+    this decorator should be placed after the @xw.script decorator
+
+    it will show the name, entry time, exit time and the duration, like
+    Done MyScript  11:51:13.24 - 11:51:20.28 (7.04s)
+
+    """
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        now0 = datetime.datetime.now()
+        result = func(*args, **kwargs)
+        now1 = datetime.datetime.now()
+        t0 = now0.second + now0.microsecond / 1_000_000
+        t1 = now1.second + now1.microsecond / 1_000_000
+        print(
+            f"Done {func.__name__}  {now0:%H:%M:%S.}{int(now0.microsecond / 10000):02d} - {now1:%H:%M:%S.}{int(now1.microsecond / 10000):02d} ({t1 - t0:.2f}s)"
+        )
+        return result
+
+    return wrapper
+
+
 if __name__ == "__main__":
     ...
-

{xlwings_utils-25.1.2.post0 → xlwings_utils-25.1.3.post0}/xlwings_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.1.2.post0
+Version: 25.1.3.post0
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -322,10 +322,33 @@ Then, the file can be copied to the pyodide file system with
 ```
 bl = block(xw.range((10,1),(50000,1)).decode_to_files())
 ```
+## Miscellaneous
+
+xlwings_utils provides a useful `timer` decorator that may be used to show the name, the entry time, the exit time and the duration of a xlwings script.
+
+To use this, put the decorator immediately after the `xw.script` decorator, like:
+
+```
+@xw.script
+@xwu.timer
+def MyScript(book: xw.Book):
+    ...
 ```
 
+This will print something like:
+
+```
+Done MyScript  11:51:13.24 - 11:51:20.28 (7.04s)
 ```
 
+
+
+
+
+
+
+
+
 ## Contact info
 
 You can contact Ruud van der Ham, the core developer, at ruud@salabim.org.