stouputils 1.16.3__tar.gz → 1.17.0__tar.gz

{stouputils-1.16.3 → stouputils-1.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stouputils
-Version: 1.16.3
+Version: 1.17.0
 Summary: Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more.
 Keywords: utilities,tools,helpers,development,python
 Author: Stoupy51
@@ -32,12 +32,14 @@ Requires-Dist: sphinx-design ; extra == 'docs'
 Requires-Dist: sphinx-treeview ; extra == 'docs'
 Requires-Dist: sphinx-breeze-theme ; extra == 'docs'
 Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
+Requires-Dist: redis[hiredis] ; extra == 'redis'
 Requires-Python: >=3.12
 Project-URL: Homepage, https://stoupy51.github.io/stouputils
 Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues
 Project-URL: Source, https://github.com/Stoupy51/stouputils
 Provides-Extra: data-science
 Provides-Extra: docs
+Provides-Extra: redis
 Description-Content-Type: text/markdown
 
 

{stouputils-1.16.3 → stouputils-1.17.0}/pyproject.toml

@@ -8,7 +8,7 @@ module-root = ""
 
 [project]
 name = "stouputils"
-version = "1.16.3"
+version = "1.17.0"
 description = "Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more."
 readme = "README.md"
 keywords = ["utilities", "tools", "helpers", "development", "python"]
@@ -53,6 +53,9 @@ data_science = [
     "scikit-learn",
     "PyWavelets",
 ]
+redis = [
+    "redis[hiredis]",
+]
 
 [project.urls]
 Homepage = "https://stoupy51.github.io/stouputils"

{stouputils-1.16.3 → stouputils-1.17.0}/stouputils/__init__.py

@@ -18,6 +18,7 @@ from .ctx import *
 from .decorators import *
 from .image import *
 from .io import *
+from .lock import *
 from .parallel import *
 from .print import *
 from .typing import *

{stouputils-1.16.3 → stouputils-1.17.0}/stouputils/__init__.pyi

@@ -8,6 +8,7 @@ from .ctx import *
 from .decorators import *
 from .image import *
 from .io import *
+from .lock import *
 from .parallel import *
 from .print import *
 from .typing import *

{stouputils-1.16.3 → stouputils-1.17.0}/stouputils/all_doctests.py

@@ -99,7 +99,7 @@ def launch_tests(root_dir: str, strict: bool = True, pattern: str = "*") -> int:
 		import fnmatch
 		modules_file_paths = [
 			path for path in modules_file_paths
-			if fnmatch.fnmatch(path.split(".")[-1], pattern)
+			if fnmatch.fnmatch(path, pattern)
 		]
 		if not modules_file_paths:
 			raise ValueError(f"No modules matching pattern '{pattern}' found in '{relative_path(root_dir)}'")

{stouputils-1.16.3 → stouputils-1.17.0}/stouputils/decorators.py

@@ -211,7 +211,7 @@ def timeout(
 	def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
 		# Check if we can use signal-based timeout (Unix only)
 		import os
-		use_signal: bool = os.name != 'nt'  # Not Windows
+		use_signal: bool = os.name != "nt"  # Not Windows
 
 		if use_signal:
 			try:

{stouputils-1.16.3 → stouputils-1.17.0}/stouputils/image.py

@@ -401,7 +401,7 @@ def numpy_to_obj(
 
 	# Apply marching cubes algorithm to extract mesh
 	verts, faces, _, _ = cast(
-        tuple[NDArray[np.floating], NDArray[np.integer], NDArray[np.floating], NDArray[np.floating]],
+        "tuple[NDArray[np.floating], NDArray[np.integer], NDArray[np.floating], NDArray[np.floating]]",
 		measure.marching_cubes(volume, level=threshold, step_size=step_size, allow_degenerate=False) # type: ignore
 	)
 

{stouputils-1.16.3 → stouputils-1.17.0}/stouputils/image.pyi

@@ -3,7 +3,7 @@ from .io import super_open as super_open
 from .print import debug as debug, info as info
 from PIL import Image
 from collections.abc import Callable
-from numpy.typing import NDArray
+from numpy.typing import NDArray as NDArray
 from typing import Any, TypeVar
 
 PIL_Image_or_NDArray = TypeVar('PIL_Image_or_NDArray', bound='Image.Image | NDArray[np.number]')

{stouputils-1.16.3 → stouputils-1.17.0}/stouputils/io.py

@@ -338,7 +338,7 @@ def super_copy(src: str, dst: str, create_dir: bool = True, symlink: bool = Fals
 		src         (str):  The source path
 		dst         (str):  The destination path
 		create_dir  (bool): Whether to create the directory if it doesn't exist (default: True)
-		symlink     (bool): Whether to create a symlink instead of copying (Linux only, default: True)
+		symlink     (bool): Whether to create a symlink instead of copying (Linux only)
 	Returns:
 		str: The destination path
 	"""

{stouputils-1.16.3 → stouputils-1.17.0}/stouputils/io.pyi

@@ -144,7 +144,7 @@ def super_copy(src: str, dst: str, create_dir: bool = True, symlink: bool = Fals
 \t\tsrc         (str):  The source path
 \t\tdst         (str):  The destination path
 \t\tcreate_dir  (bool): Whether to create the directory if it doesn't exist (default: True)
-\t\tsymlink     (bool): Whether to create a symlink instead of copying (Linux only, default: True)
+\t\tsymlink     (bool): Whether to create a symlink instead of copying (Linux only)
 \tReturns:
 \t\tstr: The destination path
 \t"""

stouputils-1.17.0/stouputils/lock/__init__.py

@@ -0,0 +1,36 @@
+""" Inter-process locks implementing First-In-First-Out (FIFO).
+
+Source:
+- https://en.wikipedia.org/wiki/File_locking
+- https://en.wikipedia.org/wiki/Starvation_%28computer_science%29
+- https://en.wikipedia.org/wiki/FIFO_and_LIFO_accounting
+
+Provides three classes:
+
+- LockFifo: basic cross-process lock using filesystem (POSIX via fcntl, Windows via msvcrt).
+- RLockFifo: reentrant per-(process,thread) lock built on top of LockFifo.
+- RedisLockFifo: distributed lock using redis (optional dependency).
+
+Usage
+-----
+>>> import stouputils as stp
+>>> with stp.LockFifo("some_directory/my.lock", timeout=5):
+...     pass
+
+>>> with stp.RLockFifo("some_directory/my_r.lock", timeout=5):
+...     pass
+
+>>> def _redis_example():
+...     with stp.RedisLockFifo("my_redis_lock", timeout=5):
+...         pass
+>>> import os
+>>> if os.name != "nt":
+...     _redis_example()
+"""
+# Imports
+from .base import *
+from .queue import *
+from .re_entrant import *
+from .redis_fifo import *
+from .shared import *
+

stouputils-1.17.0/stouputils/lock/__init__.pyi

@@ -0,0 +1,5 @@
+from .base import *
+from .queue import *
+from .re_entrant import *
+from .redis_fifo import *
+from .shared import *