stouputils 1.17.0__py3-none-any.whl → 1.18.1__py3-none-any.whl

stouputils/parallel/subprocess.pyi

@@ -0,0 +1,64 @@
+from .capturer import CaptureOutput as CaptureOutput
+from collections.abc import Callable as Callable
+from typing import Any
+
+def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | None = None, no_join: bool = False, capture_output: bool = False, **kwargs: Any) -> R:
+    ''' Execute a function in a subprocess with positional and keyword arguments.
+
+\tThis is useful when you need to run a function in isolation to avoid memory leaks,
+\tresource conflicts, or to ensure a clean execution environment. The subprocess will
+\tbe created, run the function with the provided arguments, and return the result.
+
+\tArgs:
+\t\tfunc           (Callable):     The function to execute in a subprocess.
+\t\t\t(SHOULD BE A TOP-LEVEL FUNCTION TO BE PICKLABLE)
+\t\t*args          (Any):          Positional arguments to pass to the function.
+\t\ttimeout        (float | None): Maximum time in seconds to wait for the subprocess.
+\t\t\tIf None, wait indefinitely. If the subprocess exceeds this time, it will be terminated.
+\t\tno_join        (bool):         If True, do not wait for the subprocess to finish (fire-and-forget).
+\t\tcapture_output (bool):         If True, capture the subprocess\' stdout/stderr and relay it
+\t\t\tin real time to the parent\'s stdout. This enables seeing print() output
+\t\t\tfrom the subprocess in the main process.
+\t\t**kwargs       (Any):          Keyword arguments to pass to the function.
+
+\tReturns:
+\t\tR: The return value of the function.
+
+\tRaises:
+\t\tRuntimeError: If the subprocess exits with a non-zero exit code or times out.
+\t\tTimeoutError: If the subprocess exceeds the specified timeout.
+
+\tExamples:
+\t\t.. code-block:: python
+
+\t\t\t> # Simple function execution
+\t\t\t> run_in_subprocess(doctest_square, 5)
+\t\t\t25
+
+\t\t\t> # Function with multiple arguments
+\t\t\t> def add(a: int, b: int) -> int:
+\t\t\t.     return a + b
+\t\t\t> run_in_subprocess(add, 10, 20)
+\t\t\t30
+
+\t\t\t> # Function with keyword arguments
+\t\t\t> def greet(name: str, greeting: str = "Hello") -> str:
+\t\t\t.     return f"{greeting}, {name}!"
+\t\t\t> run_in_subprocess(greet, "World", greeting="Hi")
+\t\t\t\'Hi, World!\'
+
+\t\t\t> # With timeout to prevent hanging
+\t\t\t> run_in_subprocess(some_gpu_func, data, timeout=300.0)
+\t'''
+def _subprocess_wrapper[R](result_queue: Any, func: Callable[..., R], args: tuple[Any, ...], kwargs: dict[str, Any], _capturer: CaptureOutput | None = None) -> None:
+    """ Wrapper function to execute the target function and store the result in the queue.
+
+\tMust be at module level to be pickable on Windows (spawn context).
+
+\tArgs:
+\t\tresult_queue (multiprocessing.Queue | None):  Queue to store the result or exception (None if detached).
+\t\tfunc         (Callable):                      The target function to execute.
+\t\targs         (tuple):                         Positional arguments for the function.
+\t\tkwargs       (dict):                          Keyword arguments for the function.
+\t\t_capturer    (CaptureOutput | None):          Optional CaptureOutput instance for stdout capture.
+\t"""

stouputils/print.py

@@ -17,7 +17,7 @@ import os
 import sys
 import time
 from collections.abc import Callable, Iterable, Iterator
-from typing import IO, Any, TextIO, TypeVar, cast
+from typing import IO, Any, TextIO, cast
 
 # Colors constants
 RESET: str   = "\033[0m"
@@ -32,7 +32,6 @@ BOLD: str    = "\033[1m"
 
 # Constants
 BAR_FORMAT: str = "{l_bar}{bar}" + MAGENTA + "| {n_fmt}/{total_fmt} [{rate_fmt}{postfix}, {elapsed}<{remaining}]" + RESET
-T = TypeVar("T")
 
 # Enable colors on Windows 10 terminal if applicable
 if os.name == "nt":
@@ -443,7 +442,7 @@ def whatisit(
 		try:
 			if not isinstance(value, str | bytes | bytearray | dict | int | float):
 				import numpy as np
-				mini, maxi = np.min(value), np.max(value)
+				mini, maxi = np.min(value), np.max(value) # type: ignore
 				if mini != maxi:
 					metadata_parts.append(f"min: {mini}")
 					metadata_parts.append(f"max: {maxi}")

stouputils/print.pyi

@@ -1,5 +1,5 @@
 from collections.abc import Callable as Callable, Iterable, Iterator
-from typing import Any, IO, TextIO, TypeVar
+from typing import Any, IO, TextIO
 
 RESET: str
 RED: str
@@ -11,7 +11,6 @@ CYAN: str
 LINE_UP: str
 BOLD: str
 BAR_FORMAT: str
-T = TypeVar('T')
 previous_args_kwards: tuple[Any, Any]
 nb_values: int
 import_time: float

{stouputils-1.17.0.dist-info → stouputils-1.18.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stouputils
-Version: 1.17.0
+Version: 1.18.1
 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
@@ -25,6 +25,7 @@ Requires-Dist: mlflow ; extra == 'data-science'
 Requires-Dist: tensorflow ; extra == 'data-science'
 Requires-Dist: scikit-learn ; extra == 'data-science'
 Requires-Dist: pywavelets ; extra == 'data-science'
+Requires-Dist: mypy ; extra == 'docs'
 Requires-Dist: m2r2 ; extra == 'docs'
 Requires-Dist: myst-parser ; extra == 'docs'
 Requires-Dist: sphinx-copybutton ; extra == 'docs'

{stouputils-1.17.0.dist-info → stouputils-1.18.1.dist-info}/RECORD

@@ -21,8 +21,8 @@ stouputils/archive.py,sha256=uDrPFxbY_C8SwUZRH4FWnYSoJKkFWynCx751zP9AHaY,12144
 stouputils/archive.pyi,sha256=Z2BbQAiErRYntv53QC9uf_XPw3tx3Oy73wB0Bbil11c,3246
 stouputils/backup.py,sha256=AE5WKMLiyk0VkRUfhmNfO2EUeUbZY5GTFVIuI5z7axA,20947
 stouputils/backup.pyi,sha256=-SLVykkR5U8479T84zjNPVBNnV193s0zyWjathY2DDA,4923
-stouputils/collections.py,sha256=rAIz4acCxGjZkuvUrb3u5laD130TaNKbng3AITMWffY,9851
-stouputils/collections.pyi,sha256=g29fctQAjoJmx-CKh4S6buLSwH2SmivrTGYwc92KqxE,4323
+stouputils/collections.py,sha256=73799uJ5ryQoNBo7N4Cz41Q992QP_kSsw_hy33ZpDyw,11121
+stouputils/collections.pyi,sha256=jPzyaeesz1IqutuT69Bt4DFOguURjXbcYO2l2sifXRA,5448
 stouputils/continuous_delivery/__init__.py,sha256=JqPww29xZ-pp6OJDGhUj2dxyV9rgTTMUz0YDDVr9RaA,731
 stouputils/continuous_delivery/__init__.pyi,sha256=_Sz2D10n1CDEyY8qDFwXNKdr01HVxanY4qdq9aN19cc,117
 stouputils/continuous_delivery/cd_utils.py,sha256=fkaHk2V3j66uFAUsM2c_UddNhXW2KAQcrh7jVsH79pU,8594
@@ -33,10 +33,10 @@ stouputils/continuous_delivery/pypi.py,sha256=H19RwvJN6QS-qcqvjtIaSLfZTA398jXu-S
 stouputils/continuous_delivery/pypi.pyi,sha256=3zFRz3L_gF_JuSe1J3RZAKTVsFMFiqEdCJbwHRYBj7g,2478
 stouputils/continuous_delivery/pyproject.py,sha256=olD3QqzLfCLnTBw8IkSKSLBPWyeMv6uS7A0yGdFuIvQ,4802
 stouputils/continuous_delivery/pyproject.pyi,sha256=bMWwqyG0Auo46dt-dWGePQ9yJ8rSrgb7mnJTfbiS3TQ,2053
-stouputils/continuous_delivery/stubs.py,sha256=N0qPBORNYmGIhoY0h40JVvNIS9CS_ixHlxNWQN1bPRE,3514
+stouputils/continuous_delivery/stubs.py,sha256=4FweEA64tU9h4vQuVZqZVa1dXJn2g6ilp5g2GxR_bW8,3515
 stouputils/continuous_delivery/stubs.pyi,sha256=UrL2dowLC6hsiKe-gfWeVCudz7tKmt4rsiCL9gsBLv4,2392
-stouputils/ctx.py,sha256=KVVDmL3pAPX2WM_QzjsmctbG-YfjJ-4aWBSoI7eU_ws,15586
-stouputils/ctx.pyi,sha256=-7AJwD9bKzKBFsYlgyULPznstq3LvXRXe2r_2at72FI,9799
+stouputils/ctx.py,sha256=FcoUQoy9lNo-spzacCJPGezOTupNQn3F2Bf24wy8y8I,15521
+stouputils/ctx.pyi,sha256=iXlTfK9Rf1da5kTUGlRw7zwPMVzsfZ1jHmac7zlm6PQ,9770
 stouputils/data_science/config/get.py,sha256=smdWcu5bBlY38WGtC3GzIF2el-gpvSlDMRNsypmr0JM,1773
 stouputils/data_science/config/set.py,sha256=PBBnWhgSptWTPkMtq3N1UxmEz_E4ywUcl3daS43wA2M,4175
 stouputils/data_science/data_processing/image/__init__.py,sha256=ovzV48Bn0tyKXnAMMdujzwT89-1g-PK7GYNlHBrMt9Q,1889
@@ -111,8 +111,8 @@ stouputils/data_science/scripts/routine.py,sha256=FkTLzmcdm_qUp69D-dPAKJm2RfXZZL
 stouputils/data_science/utils.py,sha256=HFXI2RQZ53RbBOn_4Act2bi0z4xQlTtsuR5Am80v9JU,11084
 stouputils/decorators.py,sha256=Emgr0XfUOh-MBqkznVOCNmwdHf7o3h1AyIoQklxgULw,21838
 stouputils/decorators.pyi,sha256=vbPRsvox4dotqcln3StgE6iZ1cWCOeAn56M9zMpdw2U,10948
-stouputils/image.py,sha256=CWTpnBys9bBYa7fsGPP6FseYn2Ak0TMwcFg2YnbQLpc,16630
-stouputils/image.pyi,sha256=XeSfv23IJvEJUINNLw4hrdgVnrzP4rBcKv5jX_2c8jw,8466
+stouputils/image.py,sha256=E6RYfLhE19KGxn9VdgPCTYXVmOUNK8Qe3RrwSp9OiPs,16479
+stouputils/image.pyi,sha256=bGbNTG4piQ2PCLFqZCE360O8yE635cKX94SGK0aHNJ8,8311
 stouputils/installer/__init__.py,sha256=DBwI9w3xvw0NR_jDMxmURwPi1F79kPLe7EuNjmrxW_U,502
 stouputils/installer/__init__.pyi,sha256=ZB-8frAUOW-0pCEJL-e2AdbFodivv46v3EBYwEXCxRo,117
 stouputils/installer/common.py,sha256=UJr5u02h4LQZQdkmVOkJ3vvW_0-ROGgVMMh0PNoVS1A,2209
@@ -125,8 +125,8 @@ stouputils/installer/main.py,sha256=8wrx_cnQo1dFGRf6x8vtxh6-96tQ-AzMyvJ0S64j0io,
 stouputils/installer/main.pyi,sha256=r3j4GoMBpU06MpOqjSwoDTiSMOmbA3WWUA87970b6KE,3134
 stouputils/installer/windows.py,sha256=r2AIuoyAmtMEuoCtQBH9GWQWI-JUT2J9zoH28j9ruOU,4880
 stouputils/installer/windows.pyi,sha256=tHogIFhPVDQS0I10liLkAxnpaFFAvmFtEVMpPIae5LU,1616
-stouputils/io.py,sha256=4GfHaZF-xeyR4K6bj9k9ohgXjOCb966a5XyQUPz_oZw,17187
-stouputils/io.pyi,sha256=qKHshtvby6A2OMFLCF7KqIHmOyGkKONYBGENLM8H7Z8,9061
+stouputils/io.py,sha256=Q0Erzy7k8MTEw50s1O_CbuP2bh7oxt42tbcXcUeX97E,17782
+stouputils/io.pyi,sha256=zsId531UOFs-P5kc5cCl3W6oA0X47T_RD2HPDpElZX8,9308
 stouputils/lock/__init__.py,sha256=8EvKPwnd5oHAWP-2vs6ULUDCSNyUh-mw12nYvBqgVAc,1029
 stouputils/lock/__init__.pyi,sha256=qcTm6JcGXfwQB2dUCa2wFEInSwJF2pOrYnejSpvGd7k,120
 stouputils/lock/base.py,sha256=hjSXRzOLVTMNrxpf4QcmfCfdlSRHFT9e130Zz_cqxY8,20483
@@ -139,16 +139,24 @@ stouputils/lock/redis_fifo.py,sha256=AA_McheTa9SHEgO141oUZmi2oYXR_IwzqC5dBWvvPZE
 stouputils/lock/redis_fifo.pyi,sha256=qFMClixGyYePXi0D4A48RW6FRRDm8Fyf9KCcoxXE5yc,6493
 stouputils/lock/shared.py,sha256=G8Mcy7dXtNESyU7hSaeihNrCU4l98VhyQyO_vQYPJ7g,788
 stouputils/lock/shared.pyi,sha256=0CV6TpTaDEkcGA35Q-ijp8ckImZ32umlMA4U-8C_O-I,545
-stouputils/parallel.py,sha256=CJUhoB270QT6XXpg0fHOlJdwbvoFd6qFQhCAZDFZng4,21648
-stouputils/parallel.pyi,sha256=BTAtl4TFr71LgV3nVBY-yjpxUxlt9m6O2q82tNFHlbE,12420
-stouputils/print.py,sha256=q-qSkUGeyn-lBMU5GU36ccm_dTmWS2i_RMxMYUhncfY,24564
-stouputils/print.pyi,sha256=SRAAdObriW_LPcqvDGrCpjfGLrswRhIyJmCvC9_3OpM,10232
+stouputils/parallel/__init__.py,sha256=myD8KiVfPPKF26Xu8Clu0p-VaYDK74loMUjUkl6-9XU,1013
+stouputils/parallel/__init__.pyi,sha256=UtZKtl9i__OH0Edypap9oZUcTF1h91qfpItG1-x7TfE,97
+stouputils/parallel/capturer.py,sha256=lo7D1x2RGo9SHkr2sIrY6wL4V5wbsxngnmBMbn5-o_I,4177
+stouputils/parallel/capturer.pyi,sha256=DWa3biPFzrGJBmkaFhAWwhbX4gbKQAipBAOJm4_XBy8,1665
+stouputils/parallel/common.py,sha256=niDcAiEX3flX0ow91gXOB4umlOrR8PIYvpcKPClJHfM,4910
+stouputils/parallel/common.pyi,sha256=jbyftOYHKP2qaA8YC1f1f12-BDBkhfsQsnPdsR4oet8,2493
+stouputils/parallel/multi.py,sha256=tHJgcQJwsI6QeKEHoGJC4tsVK_6t1Fazkb06i1u-W_8,12610
+stouputils/parallel/multi.pyi,sha256=DWolZn1UoXxOfuw7LqEJcU8aQJsN-_DRhPGJlJCA5pQ,8021
+stouputils/parallel/subprocess.py,sha256=YD9mda-zMRpudlby4cLwLJxIY5BjPwn8K11eJ-3k-6E,5790
+stouputils/parallel/subprocess.pyi,sha256=9g5FDYfcnIikd9OOtDP1u_NPT2elk5YjUsQN9eIMSso,3145
+stouputils/print.py,sha256=PNyKvKheI7ior_-jQQ0Xu8ym7tSctheyHXTFykw2MKc,24552
+stouputils/print.pyi,sha256=0z-BFpOEZ48GBGcD08C4Be67cPKX4ZxSHqKyOLRS_M8,10205
 stouputils/py.typed,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
 stouputils/typing.py,sha256=TwvxrvxhBRkyHkoOpfyXebN13M3xJb8MAjKXiNIWjew,2205
 stouputils/typing.pyi,sha256=U2UmFZausMYpnsUQROQE2JOwHcjx2hKV0rJuOdR57Ew,1341
 stouputils/version_pkg.py,sha256=Jsp-s03L14DkiZ94vQgrlQmaxApfn9DC8M_nzT1SJLk,7014
 stouputils/version_pkg.pyi,sha256=QPvqp1U3QA-9C_CC1dT9Vahv1hXEhstbM7x5uzMZSsQ,755
-stouputils-1.17.0.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
-stouputils-1.17.0.dist-info/entry_points.txt,sha256=tx0z9VOnE-sfkmbFbA93zaBMzV3XSsKEJa_BWIqUzxw,57
-stouputils-1.17.0.dist-info/METADATA,sha256=l8yYMpNjDjypUTnO1zC1Xlp2s3QdqS_z8wqYYTMUu-4,13973
-stouputils-1.17.0.dist-info/RECORD,,
+stouputils-1.18.1.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+stouputils-1.18.1.dist-info/entry_points.txt,sha256=tx0z9VOnE-sfkmbFbA93zaBMzV3XSsKEJa_BWIqUzxw,57
+stouputils-1.18.1.dist-info/METADATA,sha256=PWMcVUM25QN5JXf9cDGGl-xPQQc3evJlWk8QX6FliFQ,14011
+stouputils-1.18.1.dist-info/RECORD,,