3.1.2 - Add 'reminder' option to log_time

.github/workflows/python-package.yml

@@ -70,7 +70,7 @@ jobs:
 
       - run: |
           mk python-release owner=vkottler \
-                            repo=vcorelib version=3.1.1
+                            repo=vcorelib version=3.1.2
         if: |
           matrix.python-version == '3.11'
           && matrix.system == 'ubuntu-latest'

README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=7ab5d1d2a66be7d073b2e54867f1a00b
+    hash=0a5055e578605ab71fde102b8a09f678
     =====================================
 -->
 
-# vcorelib ([3.1.1](https://pypi.org/project/vcorelib/))
+# vcorelib ([3.1.2](https://pypi.org/project/vcorelib/))
 
 [![python](https://img.shields.io/pypi/pyversions/vcorelib.svg)](https://pypi.org/project/vcorelib/)
 ![Build Status](https://github.com/vkottler/vcorelib/workflows/Python%20Package/badge.svg)

local/variables/package.yaml

@@ -1,4 +1,4 @@
 ---
 major: 3
 minor: 1
-patch: 1
+patch: 2

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
 name = "vcorelib"
-version = "3.1.1"
+version = "3.1.2"
 description = "A collection of core Python utilities."
 readme = "README.md"
 requires-python = ">=3.11"

tests/logging/test_logging.py

@@ -38,6 +38,6 @@ class LoggerMixinTest(
     inst = LoggerMixinTest()
     inst.logger.info("This is a test, %d %d %d.", 1, 2, 3)
 
-    with inst.log_time("Hello, %s! %d", "world", 5):
+    with inst.log_time("Hello, %s! %d", "world", 5, reminder=True):
         for _ in range(100):
             pass

vcorelib/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=80882171e67a9c4110c185bc462e89bf
+# hash=b823edee2e3d551b72d4f1a97a0bba32
 # =====================================
 
 """
@@ -10,7 +10,7 @@
 
 DESCRIPTION = "A collection of core Python utilities."
 PKG_NAME = "vcorelib"
-VERSION = "3.1.1"
+VERSION = "3.1.2"
 
 # vcorelib-specific content.
 DEFAULT_INDENT = 2

vcorelib/io/arbiter/base.py

@@ -97,9 +97,11 @@ def decode(
                 # external code to treat data files as templates.
                 result = self.decode_stream(
                     get_file_ext(path, maxsplit=maxsplit),
-                    preprocessor(path_fd)
-                    if preprocessor is not None
-                    else path_fd,
+                    (
+                        preprocessor(path_fd)
+                        if preprocessor is not None
+                        else path_fd
+                    ),
                     logger,
                     **kwargs,
                 )

vcorelib/logging/__init__.py

@@ -105,8 +105,17 @@ def log_time(
         message: str,
         *args,
         level: int = _INFO,
+        reminder: bool = False,
         **kwargs,
     ) -> _Iterator[None]:
         """A simple wrapper."""
-        with log_time(self.logger, message, *args, level=level, **kwargs):
+
+        with log_time(
+            self.logger,
+            message,
+            *args,
+            level=level,
+            reminder=reminder,
+            **kwargs,
+        ):
             yield

vcorelib/logging/time.py

@@ -17,10 +17,13 @@ def log_time(
     message: str,
     *args,
     level: int = _INFO,
+    reminder: bool = False,
     **kwargs,
 ) -> _Iterator[None]:
     """
     A simple context manager for conveniently logging time taken for a task.
     """
-    with TIMER.log(log, message, *args, level=level, **kwargs):
+    with TIMER.log(
+        log, message, *args, level=level, reminder=reminder, **kwargs
+    ):
         yield

vcorelib/math/time.py

@@ -141,10 +141,14 @@ def log(
         message: str,
         *args,
         level: int = _INFO,
+        reminder: bool = False,
         **kwargs,
     ) -> _Iterator[None]:
         """Log how long the caller's context took to execute."""
 
+        if reminder:
+            log.log(level, message + " is executing.", *args, **kwargs)
+
         with self.measure_ns() as token:
             yield
         result = self.result(token)