stouputils 1.14.2__py3-none-any.whl → 1.14.3__py3-none-any.whl

stouputils/continuous_delivery/pypi.py

@@ -110,7 +110,7 @@ def pypi_full_routine_using_uv() -> None:
 	# Generate stubs unless '--no-stubs' is passed
 	if "--no-stubs" not in sys.argv and "--no_stubs" not in sys.argv:
 		from .stubs import stubs_full_routine
-		stubs_full_routine(package_name, output_directory=package_dir, clean_before=True)
+		stubs_full_routine(package_name, output_directory=os.path.dirname(package_dir) or ".", clean_before=True)
 
 	# Increment version in pyproject.toml
 	if "--no-bump" not in sys.argv and "--no_bump" not in sys.argv:

stouputils/continuous_delivery/pypi.pyi

@@ -47,6 +47,7 @@ def pypi_full_routine_using_uv() -> None:
 
 \tSteps:
 \t\t1. Generate stubs unless '--no-stubs' is passed
-\t\t2. Build the package using 'uv build'
-\t\t3. Upload the most recent file to PyPI using 'uv publish'
+\t\t2. Increment version in pyproject.toml (patch by default, minor if 'minor' is passed as last argument, 'major' if 'major' is passed)
+\t\t3. Build the package using 'uv build'
+\t\t4. Upload the most recent file to PyPI using 'uv publish'
 \t"""

stouputils/decorators.pyi

@@ -151,6 +151,16 @@ def simple_cache(func: Callable[..., Any] | None = None, *, method: Literal['str
 \t\t3
 \t\t>>> test2(3, 4)
 \t\t7
+
+\t\t>>> @simple_cache
+\t\t... def factorial(n: int) -> int:
+\t\t...     return n * factorial(n - 1) if n else 1
+\t\t>>> factorial(10)   # no previously cached result, makes 11 recursive calls
+\t\t3628800
+\t\t>>> factorial(5)    # no new calls, just returns the cached result
+\t\t120
+\t\t>>> factorial(12)   # two new recursive calls, factorial(10) is cached
+\t\t479001600
 \t'''
 def abstract(func: Callable[..., Any] | None = None, *, error_log: LogLevels = ...) -> Callable[..., Any]:
     """ Decorator that marks a function as abstract.

stouputils/parallel.pyi

@@ -10,7 +10,7 @@ CPU_COUNT: int
 T = TypeVar('T')
 R = TypeVar('R')
 
-def multiprocessing[T, R](func: Callable[..., R] | list[Callable[..., R]], args: Iterable[T], use_starmap: bool = False, chunksize: int = 1, desc: str = '', max_workers: int | float = ..., delay_first_calls: float = 0, color: str = ..., bar_format: str = ..., ascii: bool = False) -> list[R]:
+def multiprocessing[T, R](func: Callable[..., R] | list[Callable[..., R]], args: Iterable[T], use_starmap: bool = False, chunksize: int = 1, desc: str = '', max_workers: int | float = ..., delay_first_calls: float = 0, color: str = ..., bar_format: str = ..., ascii: bool = False, smooth_tqdm: bool = True, **tqdm_kwargs: Any) -> list[R]:
     ''' Method to execute a function in parallel using multiprocessing
 
 \t- For CPU-bound operations where the GIL (Global Interpreter Lock) is a bottleneck.
@@ -35,6 +35,8 @@ def multiprocessing[T, R](func: Callable[..., R] | list[Callable[..., R]], args:
 \t\tcolor\t\t\t\t(str):\t\t\t\tColor of the progress bar (Defaults to MAGENTA)
 \t\tbar_format\t\t\t(str):\t\t\t\tFormat of the progress bar (Defaults to BAR_FORMAT)
 \t\tascii\t\t\t\t(bool):\t\t\t\tWhether to use ASCII or Unicode characters for the progress bar
+\t\tsmooth_tqdm\t\t\t(bool):\t\t\t\tWhether to enable smooth progress bar updates by setting miniters and mininterval (Defaults to True)
+\t\t**tqdm_kwargs\t\t(Any):\t\t\t\tAdditional keyword arguments to pass to tqdm
 
 \tReturns:
 \t\tlist[object]:\tResults of the function execution
@@ -66,7 +68,7 @@ def multiprocessing[T, R](func: Callable[..., R] | list[Callable[..., R]], args:
 \t\t\t. )
 \t\t\t[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 \t'''
-def multithreading[T, R](func: Callable[..., R] | list[Callable[..., R]], args: Iterable[T], use_starmap: bool = False, desc: str = '', max_workers: int | float = ..., delay_first_calls: float = 0, color: str = ..., bar_format: str = ..., ascii: bool = False) -> list[R]:
+def multithreading[T, R](func: Callable[..., R] | list[Callable[..., R]], args: Iterable[T], use_starmap: bool = False, desc: str = '', max_workers: int | float = ..., delay_first_calls: float = 0, color: str = ..., bar_format: str = ..., ascii: bool = False, smooth_tqdm: bool = True, **tqdm_kwargs: Any) -> list[R]:
     ''' Method to execute a function in parallel using multithreading, you should use it:
 
 \t- For I/O-bound operations where the GIL is not a bottleneck, such as network requests or disk operations.
@@ -89,6 +91,8 @@ def multithreading[T, R](func: Callable[..., R] | list[Callable[..., R]], args:
 \t\tcolor\t\t\t\t(str):\t\t\t\tColor of the progress bar (Defaults to MAGENTA)
 \t\tbar_format\t\t\t(str):\t\t\t\tFormat of the progress bar (Defaults to BAR_FORMAT)
 \t\tascii\t\t\t\t(bool):\t\t\t\tWhether to use ASCII or Unicode characters for the progress bar
+\t\tsmooth_tqdm\t\t\t(bool):\t\t\t\tWhether to enable smooth progress bar updates by setting miniters and mininterval (Defaults to True)
+\t\t**tqdm_kwargs\t\t(Any):\t\t\t\tAdditional keyword arguments to pass to tqdm
 
 \tReturns:
 \t\tlist[object]:\tResults of the function execution
@@ -120,7 +124,7 @@ def multithreading[T, R](func: Callable[..., R] | list[Callable[..., R]], args:
 \t\t\t. )
 \t\t\t[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 \t'''
-def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | None = None, **kwargs: Any) -> R:
+def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | None = None, no_join: 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,
@@ -133,6 +137,7 @@ def run_in_subprocess[R](func: Callable[..., R], *args: Any, timeout: float | No
 \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\t**kwargs     (Any):          Keyword arguments to pass to the function.
 
 \tReturns:
@@ -170,10 +175,10 @@ def _subprocess_wrapper[R](result_queue: Any, func: Callable[..., R], args: tupl
 \tMust be at module level to be pickable on Windows (spawn context).
 
 \tArgs:
-\t\tresult_queue (multiprocessing.Queue):  Queue to store the result or exception.
-\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\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"""
 def _starmap[T, R](args: tuple[Callable[[T], R], list[T]]) -> R:
     """ Private function to use starmap using args[0](\\*args[1])

stouputils/print.pyi

@@ -15,7 +15,7 @@ previous_args_kwards: tuple[Any, Any]
 nb_values: int
 import_time: float
 
-def colored_for_loop[T](iterable: Iterable[T], desc: str = 'Processing', color: str = ..., bar_format: str = ..., ascii: bool = False, **kwargs: Any) -> Iterator[T]:
+def colored_for_loop[T](iterable: Iterable[T], desc: str = 'Processing', color: str = ..., bar_format: str = ..., ascii: bool = False, smooth_tqdm: bool = True, **kwargs: Any) -> Iterator[T]:
     ''' Function to iterate over a list with a colored TQDM progress bar like the other functions in this module.
 
 \tArgs:
@@ -24,7 +24,7 @@ def colored_for_loop[T](iterable: Iterable[T], desc: str = 'Processing', color:
 \t\tcolor\t\t(str):\t\t\t\tColor of the progress bar (Defaults to MAGENTA)
 \t\tbar_format\t(str):\t\t\t\tFormat of the progress bar (Defaults to BAR_FORMAT)
 \t\tascii\t\t(bool):\t\t\t\tWhether to use ASCII or Unicode characters for the progress bar (Defaults to False)
-\t\tverbose\t\t(int):\t\t\t\tLevel of verbosity, decrease by 1 for each depth (Defaults to 1)
+\t\tsmooth_tqdm\t(bool):\t\t\t\tWhether to enable smooth progress bar updates by setting miniters=1 and mininterval=0.0 (Defaults to True)
 \t\t**kwargs:\t\t\t\t\t\tAdditional arguments to pass to the TQDM progress bar
 
 \tYields:

{stouputils-1.14.2.dist-info → stouputils-1.14.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stouputils
-Version: 1.14.2
+Version: 1.14.3
 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

{stouputils-1.14.2.dist-info → stouputils-1.14.3.dist-info}/RECORD

@@ -29,8 +29,8 @@ stouputils/continuous_delivery/cd_utils.py,sha256=fkaHk2V3j66uFAUsM2c_UddNhXW2KA
 stouputils/continuous_delivery/cd_utils.pyi,sha256=nxTLQydVOSVIix88dRtBXjMrUPpI5ftiQYbLI_nMByQ,4848
 stouputils/continuous_delivery/github.py,sha256=Iva2XNm60Th78P_evnhCJHn0Q9-06udPlOZAxtZB5vw,19464
 stouputils/continuous_delivery/github.pyi,sha256=RHRsSroEsT0I1qeuq-Wg0JLdEEDttLrzgHZPVRtLZ0Q,6641
-stouputils/continuous_delivery/pypi.py,sha256=H62NlWKG_9OQcNpisEJ3DqtNnneVmcnVnv3NItdNvv0,5298
-stouputils/continuous_delivery/pypi.pyi,sha256=qmMeHDzezN_ZW-_jGRFbaccG_rkfELbmW9hUPU6vptY,2325
+stouputils/continuous_delivery/pypi.py,sha256=v7EVkF36mi1VtGiSRd-H4k9DQsdMmOnRYDgjdnCezOU,5322
+stouputils/continuous_delivery/pypi.pyi,sha256=fRAu8ocLNpEN6dhUTMuFxlmRgt3-LRjKPOJjFlUPrJ4,2463
 stouputils/continuous_delivery/pyproject.py,sha256=olD3QqzLfCLnTBw8IkSKSLBPWyeMv6uS7A0yGdFuIvQ,4802
 stouputils/continuous_delivery/pyproject.pyi,sha256=bMWwqyG0Auo46dt-dWGePQ9yJ8rSrgb7mnJTfbiS3TQ,2053
 stouputils/continuous_delivery/stubs.py,sha256=xUAcP21Y03PLEr7X6LrIBMvPeLI8Rp-EyaTLxocA0C4,3512
@@ -110,7 +110,7 @@ stouputils/data_science/scripts/preprocess_dataset.py,sha256=OLC2KjEtSMeyHHPpNOA
 stouputils/data_science/scripts/routine.py,sha256=FkTLzmcdm_qUp69D-dPAKJm2RfXZZLtPgje6lEopu2I,7662
 stouputils/data_science/utils.py,sha256=MQ5-S21W2uvtKiwUFsyKJdeN9s9y7MxuvjfjRbwKTD8,10799
 stouputils/decorators.py,sha256=bheT64aWNE22yQePB_5-JMQ4Ezm-1VcTg2WRZaJB2r4,21534
-stouputils/decorators.pyi,sha256=k7kAOPM6c2LkhskUatoiv95JmfnMcKIxJRvhZN63axM,10561
+stouputils/decorators.pyi,sha256=_ZPqr84G316gkj_cq_LZGuCMhSyGBWunvlxM5Cq9Hvo,10944
 stouputils/image.py,sha256=NtduEVzgbCuZhDRpDZHGTW7-wTs7MqoxUwSQcipvb08,16633
 stouputils/image.pyi,sha256=Dkf64KmXJTAEcbtYDHFZ1kqEHqOf2FgJ2Z2BlJgp4fU,8455
 stouputils/installer/__init__.py,sha256=Ff_al_z6GSaazLHqfsSxsxmooXcIRmE--ffb1gZt0Q0,484
@@ -128,44 +128,13 @@ stouputils/installer/windows.pyi,sha256=tHogIFhPVDQS0I10liLkAxnpaFFAvmFtEVMpPIae
 stouputils/io.py,sha256=yQ4jGWoI81cP-ZWxgYwqXmuD6s_IbpkKkZf5jjqqIAE,16841
 stouputils/io.pyi,sha256=TCBTVEWUkI3dO_jWI9oPMF9SbnT1yLzFChE551JPbSY,9076
 stouputils/parallel.py,sha256=_o96klxFYgDPyxCeqFp5qNOtJhhXHQYmFIfqbJYnxko,19061
-stouputils/parallel.pyi,sha256=cvNMT0FyjOmehaVghurwVKABqvTO3BUbPF8f8ISp8Bw,10855
+stouputils/parallel.pyi,sha256=ug9I-Ni2q9cwwByXERQuxW-UM3rqw3dCiurnJjOWUpI,11576
 stouputils/print.py,sha256=BGPGu8SfIWhIjFRoUI2VaSCVGFhbBumYq9U2g1K-5uQ,16627
-stouputils/print.pyi,sha256=-uYWZ-hlPhkeu8E0gSoQqY0u-4UhkJAtPUioQb3Xujo,6674
+stouputils/print.pyi,sha256=TtP-OuK22uwsP0Wcruy0FxG_zD3fFwHUpxNp34HgCUU,6745
 stouputils/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-stouputils/stouputils/__init__.pyi,sha256=J8LeijIkWrTdGlevNR8dlGlgYg-Dh_MvGjp2EsPZ8UM,351
-stouputils/stouputils/_deprecated.pyi,sha256=6-8YsftJd2fRAdBLsysc6jf-uA8V2wiqkiFAbdfWfJQ,664
-stouputils/stouputils/all_doctests.pyi,sha256=8JD8qn7neYuR0PolabWxX6id1dNEvQDrvOhMS2aYhTM,1907
-stouputils/stouputils/applications/__init__.pyi,sha256=DTYq2Uqq1uLzCMkFByjRqdtREA-9SaQnp4QpgmCEPFg,56
-stouputils/stouputils/applications/automatic_docs.pyi,sha256=sfFXpVE5y5Z907HEjKzpZ_9zM34d-jKNDQCdMx7E-9s,6189
-stouputils/stouputils/applications/upscaler/__init__.pyi,sha256=VSp6Tq09ATCTdfnjhbDnu7lblaLLGbCNi-E22jYxa88,67
-stouputils/stouputils/applications/upscaler/config.pyi,sha256=lsRHAW3mvvM2inKSJ66VXb511ovmIScLABrUzckmUfk,608
-stouputils/stouputils/applications/upscaler/image.pyi,sha256=AB92XoKt8Q2c_J72ZdDdyVDuCGOEiM7E6v8L-uFmAxI,4786
-stouputils/stouputils/applications/upscaler/video.pyi,sha256=AyRlb7iHqCwdW7lHiW8Dy_czin8CbN-GiK2_xoVJvNU,2918
-stouputils/stouputils/archive.pyi,sha256=Z2BbQAiErRYntv53QC9uf_XPw3tx3Oy73wB0Bbil11c,3246
-stouputils/stouputils/backup.pyi,sha256=-SLVykkR5U8479T84zjNPVBNnV193s0zyWjathY2DDA,4923
-stouputils/stouputils/collections.pyi,sha256=mKIBV4K7mm-PTvtoYi_cVOAGjW7bo3iIASqosSXFUzE,3519
-stouputils/stouputils/continuous_delivery/__init__.pyi,sha256=_Sz2D10n1CDEyY8qDFwXNKdr01HVxanY4qdq9aN19cc,117
-stouputils/stouputils/continuous_delivery/cd_utils.pyi,sha256=nxTLQydVOSVIix88dRtBXjMrUPpI5ftiQYbLI_nMByQ,4848
-stouputils/stouputils/continuous_delivery/github.pyi,sha256=RHRsSroEsT0I1qeuq-Wg0JLdEEDttLrzgHZPVRtLZ0Q,6641
-stouputils/stouputils/continuous_delivery/pypi.pyi,sha256=fRAu8ocLNpEN6dhUTMuFxlmRgt3-LRjKPOJjFlUPrJ4,2463
-stouputils/stouputils/continuous_delivery/pyproject.pyi,sha256=bMWwqyG0Auo46dt-dWGePQ9yJ8rSrgb7mnJTfbiS3TQ,2053
-stouputils/stouputils/continuous_delivery/stubs.pyi,sha256=sLZypdz1oGoymQIRPez50rnH8TQhvEIx6A7xUdGtnys,2390
-stouputils/stouputils/ctx.pyi,sha256=-7AJwD9bKzKBFsYlgyULPznstq3LvXRXe2r_2at72FI,9799
-stouputils/stouputils/decorators.pyi,sha256=_ZPqr84G316gkj_cq_LZGuCMhSyGBWunvlxM5Cq9Hvo,10944
-stouputils/stouputils/image.pyi,sha256=Dkf64KmXJTAEcbtYDHFZ1kqEHqOf2FgJ2Z2BlJgp4fU,8455
-stouputils/stouputils/installer/__init__.pyi,sha256=ZB-8frAUOW-0pCEJL-e2AdbFodivv46v3EBYwEXCxRo,117
-stouputils/stouputils/installer/common.pyi,sha256=5aG0-58omFkkNYeVHnQ0uHUBsaI7xoMD-WqWVdOgOms,1403
-stouputils/stouputils/installer/downloader.pyi,sha256=8Xp0sXyba4flHAZ0nNqNlFU4VUmfPvllmPUkWalkvRA,1273
-stouputils/stouputils/installer/linux.pyi,sha256=V-EbY7seOFnC6LL844bqWRNvQ7rHmMhDkcFj5r1V7Tk,1943
-stouputils/stouputils/installer/main.pyi,sha256=r3j4GoMBpU06MpOqjSwoDTiSMOmbA3WWUA87970b6KE,3134
-stouputils/stouputils/installer/windows.pyi,sha256=tHogIFhPVDQS0I10liLkAxnpaFFAvmFtEVMpPIae5LU,1616
-stouputils/stouputils/io.pyi,sha256=TCBTVEWUkI3dO_jWI9oPMF9SbnT1yLzFChE551JPbSY,9076
-stouputils/stouputils/parallel.pyi,sha256=ug9I-Ni2q9cwwByXERQuxW-UM3rqw3dCiurnJjOWUpI,11576
-stouputils/stouputils/print.pyi,sha256=TtP-OuK22uwsP0Wcruy0FxG_zD3fFwHUpxNp34HgCUU,6745
-stouputils/stouputils/version_pkg.pyi,sha256=QPvqp1U3QA-9C_CC1dT9Vahv1hXEhstbM7x5uzMZSsQ,755
 stouputils/version_pkg.py,sha256=Jsp-s03L14DkiZ94vQgrlQmaxApfn9DC8M_nzT1SJLk,7014
 stouputils/version_pkg.pyi,sha256=QPvqp1U3QA-9C_CC1dT9Vahv1hXEhstbM7x5uzMZSsQ,755
-stouputils-1.14.2.dist-info/WHEEL,sha256=RRVLqVugUmFOqBedBFAmA4bsgFcROUBiSUKlERi0Hcg,79
-stouputils-1.14.2.dist-info/entry_points.txt,sha256=tx0z9VOnE-sfkmbFbA93zaBMzV3XSsKEJa_BWIqUzxw,57
-stouputils-1.14.2.dist-info/METADATA,sha256=-FSEGFl-6SdbXmpDRu6g9EwzqysGeWmG-FaOxSSUWoQ,13615
-stouputils-1.14.2.dist-info/RECORD,,
+stouputils-1.14.3.dist-info/WHEEL,sha256=eycQt0QpYmJMLKpE3X9iDk8R04v2ZF0x82ogq-zP6bQ,79
+stouputils-1.14.3.dist-info/entry_points.txt,sha256=tx0z9VOnE-sfkmbFbA93zaBMzV3XSsKEJa_BWIqUzxw,57
+stouputils-1.14.3.dist-info/METADATA,sha256=ZVcCoefkLLJlZz6C20QotomXv78x7Bdt3D1CVqqkB4Y,13615
+stouputils-1.14.3.dist-info/RECORD,,

{stouputils-1.14.2.dist-info → stouputils-1.14.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.9.21
+Generator: uv 0.9.24
 Root-Is-Purelib: true
 Tag: py3-none-any

stouputils/stouputils/__init__.pyi

@@ -1,15 +0,0 @@
-from ._deprecated import *
-from .all_doctests import *
-from .archive import *
-from .backup import *
-from .collections import *
-from .continuous_delivery import *
-from .ctx import *
-from .decorators import *
-from .image import *
-from .io import *
-from .parallel import *
-from .print import *
-from .version_pkg import *
-
-__version__: str

stouputils/stouputils/_deprecated.pyi

@@ -1,12 +0,0 @@
-from .decorators import LogLevels as LogLevels, deprecated as deprecated
-from .io import csv_dump as csv_dump, csv_load as csv_load, json_dump as json_dump, json_load as json_load
-from typing import Any
-
-def super_csv_dump(*args: Any, **kwargs: Any) -> Any:
-    ''' Deprecated function, use "csv_dump" instead. '''
-def super_csv_load(*args: Any, **kwargs: Any) -> Any:
-    ''' Deprecated function, use "csv_load" instead. '''
-def super_json_dump(*args: Any, **kwargs: Any) -> Any:
-    ''' Deprecated function, use "json_dump" instead. '''
-def super_json_load(*args: Any, **kwargs: Any) -> Any:
-    ''' Deprecated function, use "json_load" instead. '''

stouputils/stouputils/all_doctests.pyi

@@ -1,46 +0,0 @@
-from . import decorators as decorators
-from .decorators import measure_time as measure_time
-from .io import clean_path as clean_path, relative_path as relative_path
-from .print import error as error, info as info, progress as progress, warning as warning
-from doctest import TestResults as TestResults
-from types import ModuleType
-
-def launch_tests(root_dir: str, strict: bool = True) -> int:
-    ''' Main function to launch tests for all modules in the given directory.
-
-\tArgs:
-\t\troot_dir\t\t\t\t(str):\t\t\tRoot directory to search for modules
-\t\tstrict\t\t\t\t\t(bool):\t\t\tModify the force_raise_exception variable to True in the decorators module
-
-\tReturns:
-\t\tint: The number of failed tests
-
-\tExamples:
-\t\t>>> launch_tests("unknown_dir")
-\t\tTraceback (most recent call last):
-\t\t\t...
-\t\tValueError: No modules found in \'unknown_dir\'
-
-\t.. code-block:: python
-
-\t\t> if launch_tests("/path/to/source") > 0:
-\t\t\tsys.exit(1)
-\t\t[PROGRESS HH:MM:SS] Importing module \'module1\'\ttook 0.001s
-\t\t[PROGRESS HH:MM:SS] Importing module \'module2\'\ttook 0.002s
-\t\t[PROGRESS HH:MM:SS] Importing module \'module3\'\ttook 0.003s
-\t\t[PROGRESS HH:MM:SS] Importing module \'module4\'\ttook 0.004s
-\t\t[INFO HH:MM:SS] Testing 4 modules...
-\t\t[PROGRESS HH:MM:SS] Testing module \'module1\'\ttook 0.005s
-\t\t[PROGRESS HH:MM:SS] Testing module \'module2\'\ttook 0.006s
-\t\t[PROGRESS HH:MM:SS] Testing module \'module3\'\ttook 0.007s
-\t\t[PROGRESS HH:MM:SS] Testing module \'module4\'\ttook 0.008s
-\t'''
-def test_module_with_progress(module: ModuleType, separator: str) -> TestResults:
-    """ Test a module with testmod and measure the time taken with progress printing.
-
-\tArgs:
-\t\tmodule\t\t(ModuleType):\tModule to test
-\t\tseparator\t(str):\t\t\tSeparator string for alignment in output
-\tReturns:
-\t\tTestResults: The results of the tests
-\t"""

stouputils/stouputils/applications/__init__.pyi

@@ -1,2 +0,0 @@
-from .automatic_docs import *
-from .upscaler import *

stouputils/stouputils/applications/automatic_docs.pyi

@@ -1,106 +0,0 @@
-from ..continuous_delivery import version_to_float as version_to_float
-from ..decorators import LogLevels as LogLevels, handle_error as handle_error, simple_cache as simple_cache
-from ..io import clean_path as clean_path, json_dump as json_dump, super_open as super_open
-from ..print import info as info
-from collections.abc import Callable as Callable
-
-REQUIREMENTS: list[str]
-
-def check_dependencies(html_theme: str) -> None:
-    ''' Check for each requirement if it is installed.
-
-\tArgs:
-\t\thtml_theme (str): HTML theme to use for the documentation, to check if it is installed (e.g. "breeze", "pydata_sphinx_theme", "furo", etc.)
-\t'''
-def get_sphinx_conf_content(project: str, project_dir: str, author: str, current_version: str, copyright: str, html_logo: str, html_favicon: str, html_theme: str = 'breeze', github_user: str = '', github_repo: str = '', version_list: list[str] | None = None, skip_undocumented: bool = True) -> str:
-    """ Get the content of the Sphinx configuration file.
-
-\tArgs:
-\t\tproject           (str):              Name of the project
-\t\tproject_dir       (str):              Path to the project directory
-\t\tauthor            (str):              Author of the project
-\t\tcurrent_version   (str):              Current version
-\t\tcopyright         (str):              Copyright information
-\t\thtml_logo         (str):              URL to the logo
-\t\thtml_favicon      (str):              URL to the favicon
-\t\tgithub_user       (str):              GitHub username
-\t\tgithub_repo       (str):              GitHub repository name
-\t\tversion_list      (list[str] | None): List of versions. Defaults to None
-\t\tskip_undocumented (bool):             Whether to skip undocumented members. Defaults to True
-
-\tReturns:
-\t\tstr: Content of the Sphinx configuration file
-\t"""
-def get_versions_from_github(github_user: str, github_repo: str, recent_minor_versions: int = 2) -> list[str]:
-    """ Get list of versions from GitHub gh-pages branch.
-\tOnly shows detailed versions for the last N minor versions, and keeps only
-\tthe latest patch version for older minor versions.
-
-\tArgs:
-\t\tgithub_user             (str): GitHub username
-\t\tgithub_repo             (str): GitHub repository name
-\t\trecent_minor_versions   (int): Number of recent minor versions to show all patches for (-1 for all).
-
-\tReturns:
-\t\tlist[str]: List of versions, with 'latest' as first element
-\t"""
-def markdown_to_rst(markdown_content: str) -> str:
-    """ Convert markdown content to RST format.
-
-\tArgs:
-\t\tmarkdown_content (str): Markdown content
-
-\tReturns:
-\t\tstr: RST content
-\t"""
-def generate_index_rst(readme_path: str, index_path: str, project: str, github_user: str, github_repo: str, get_versions_function: Callable[[str, str, int], list[str]] = ..., recent_minor_versions: int = 2) -> None:
-    """ Generate index.rst from README.md content.
-
-\tArgs:
-\t\treadme_path            (str): Path to the README.md file
-\t\tindex_path             (str): Path where index.rst should be created
-\t\tproject                (str): Name of the project
-\t\tgithub_user            (str): GitHub username
-\t\tgithub_repo            (str): GitHub repository name
-\t\tget_versions_function  (Callable[[str, str, int], list[str]]): Function to get versions from GitHub
-\t\trecent_minor_versions  (int): Number of recent minor versions to show all patches for. Defaults to 2
-\t"""
-def generate_documentation(source_dir: str, modules_dir: str, project_dir: str, build_dir: str) -> None:
-    """ Generate documentation using Sphinx.
-
-\tArgs:
-\t\tsource_dir        (str): Source directory
-\t\tmodules_dir       (str): Modules directory
-\t\tproject_dir       (str): Project directory
-\t\tbuild_dir         (str): Build directory
-\t"""
-def generate_redirect_html(filepath: str) -> None:
-    """ Generate HTML content for redirect page.
-
-\tArgs:
-\t\tfilepath (str): Path to the file where the HTML content should be written
-\t"""
-def update_documentation(root_path: str, project: str, project_dir: str = '', author: str = 'Author', copyright: str = '2025, Author', html_logo: str = '', html_favicon: str = '', html_theme: str = 'breeze', github_user: str = '', github_repo: str = '', version: str | None = None, skip_undocumented: bool = True, recent_minor_versions: int = 2, get_versions_function: Callable[[str, str, int], list[str]] = ..., generate_index_function: Callable[..., None] = ..., generate_docs_function: Callable[..., None] = ..., generate_redirect_function: Callable[[str], None] = ..., get_conf_content_function: Callable[..., str] = ...) -> None:
-    ''' Update the Sphinx documentation.
-
-\tArgs:
-\t\troot_path                  (str): Root path of the project
-\t\tproject                    (str): Name of the project
-\t\tproject_dir                (str): Path to the project directory (to be used with generate_docs_function)
-\t\tauthor                     (str): Author of the project
-\t\tcopyright                  (str): Copyright information
-\t\thtml_logo                  (str): URL to the logo
-\t\thtml_favicon               (str): URL to the favicon
-\t\thtml_theme                 (str): Theme to use for the documentation. Defaults to "breeze"
-\t\tgithub_user                (str): GitHub username
-\t\tgithub_repo                (str): GitHub repository name
-\t\tversion                    (str | None): Version to build documentation for (e.g. "1.0.0", defaults to "latest")
-\t\tskip_undocumented          (bool): Whether to skip undocumented members. Defaults to True
-\t\trecent_minor_versions      (int): Number of recent minor versions to show all patches for. Defaults to 2
-
-\t\tget_versions_function      (Callable[[str, str, int], list[str]]): Function to get versions from GitHub
-\t\tgenerate_index_function    (Callable[..., None]): Function to generate index.rst
-\t\tgenerate_docs_function     (Callable[..., None]): Function to generate documentation
-\t\tgenerate_redirect_function (Callable[[str], None]): Function to create redirect file
-\t\tget_conf_content_function  (Callable[..., str]): Function to get Sphinx conf.py content
-\t'''

stouputils/stouputils/applications/upscaler/__init__.pyi

@@ -1,3 +0,0 @@
-from .config import *
-from .image import *
-from .video import *

stouputils/stouputils/applications/upscaler/config.pyi

@@ -1,18 +0,0 @@
-WAIFU2X_NCNN_VULKAN_RELEASES: dict[str, str]
-FFMPEG_RELEASES: dict[str, str]
-YOUTUBE_BITRATE_RECOMMENDATIONS: dict[str, dict[str, dict[int, int]]]
-
-class Config:
-    """ Configuration class for the upscaler. """
-    JPG_QUALITY: int
-    VIDEO_FINAL_BITRATE: int
-    FFMPEG_EXECUTABLE: str
-    FFMPEG_ARGS: tuple[str, ...]
-    FFPROBE_EXECUTABLE: str
-    FFMPEG_CHECK_HELP_TEXT: str
-    UPSCALER_EXECUTABLE: str
-    UPSCALER_ARGS: tuple[str, ...]
-    UPSCALER_EXECUTABLE_HELP_TEXT: str
-    SLIGHTLY_FASTER_MODE: bool
-    upscaler_executable_checked: bool
-    ffmpeg_executable_checked: bool

stouputils/stouputils/applications/upscaler/image.pyi

@@ -1,109 +0,0 @@
-from ...installer import check_executable as check_executable
-from ...io import clean_path as clean_path
-from ...parallel import multithreading as multithreading
-from ...print import colored_for_loop as colored_for_loop, debug as debug, info as info
-from .config import Config as Config, WAIFU2X_NCNN_VULKAN_RELEASES as WAIFU2X_NCNN_VULKAN_RELEASES
-from tempfile import TemporaryDirectory
-
-def convert_frame(frame_path: str, delete_png: bool = True) -> None:
-    ''' Convert a PNG frame to JPG format to take less space.
-
-\tArgs:
-\t\tframe_path  (str):   Path to the PNG frame to convert.
-\t\tdelete_png  (bool):  Whether to delete the original PNG file after conversion.
-
-\tReturns:
-\t\tNone: This function doesn\'t return anything.
-
-\tExample:
-\t\t.. code-block:: python
-
-\t\t\t> convert_frame("input.png", delete_png=True)
-\t\t\t> # input.png will be converted to input.jpg and the original file will be deleted
-
-\t\t\t> convert_frame("input.png", delete_png=False)
-\t\t\t> # input.png will be converted to input.jpg and the original file will be kept
-\t'''
-def get_all_files(folder: str, suffix: str | tuple[str, ...] = '') -> list[str]:
-    ''' Get all files paths in a folder, with a specific suffix if provided.
-
-\tArgs:
-\t\tfolder     (str):                    Path to the folder containing the files.
-\t\tsuffix     (str | tuple[str, ...]):  Suffix of the files to get (e.g. ".png", ".jpg", etc.).
-
-\tReturns:
-\t\tlist[str]: List of all files paths in the folder.
-
-\tExample:
-\t\t>>> files: list[str] = get_all_files("some_folder", ".png")
-\t\t>>> len(files)
-\t\t0
-\t'''
-def create_temp_dir_for_not_upscaled(input_path: str, output_path: str) -> TemporaryDirectory[str] | None:
-    """ Creates a temporary directory containing only images that haven't been upscaled yet.
-
-    Args:
-        input_path  (str):  Path to the folder containing input images.
-        output_path (str):  Path to the folder where upscaled images are saved.
-
-    Returns:
-        TemporaryDirectory[str] | None: A temporary directory object if there are images to process,
-                                        None if all images are already upscaled.
-    """
-def check_upscaler_executable() -> None: ...
-def upscale(input_path: str, output_path: str, upscale_ratio: int) -> None:
-    ''' Upscale an input image (or a directory of images) with the upscaler executable.
-
-\tArgs:
-\t\tinput_path     (str):  Path to the image to upscale (or a directory).
-\t\toutput_path    (str):  Path to the output image (or a directory).
-\t\tupscale_ratio  (int):  Upscaling ratio.
-
-\tExample:
-\t\t.. code-block:: python
-
-\t\t\t> upscale("folder", "folder", 2)
-\t\t\tTraceback (most recent call last):
-\t\t\t\t...
-\t\t\tAssertionError: Input and output paths cannot be the same, got \'folder\'
-
-\t\t\t> upscale("stouputils", "stouputils/output.jpg", 2)
-\t\t\tTraceback (most recent call last):
-\t\t\t\t...
-\t\t\tAssertionError: If input is a directory, output must be a directory too, got \'stouputils/output.jpg\'
-
-
-\t\t\t> upscale("input.jpg", "output.jpg", 2)
-\t\t\t> # The input.jpg will be upscaled to output.jpg with a ratio of 2
-
-\t\t\t> upscale("input_folder", "output_folder", 2)
-\t\t\t> # The input_folder will be upscaled to output_folder with a ratio of 2
-\t'''
-def upscale_images(images: list[str], output_folder: str, upscale_ratio: int, desc: str = 'Upscaling images') -> None:
-    """ Upscale multiple images from a list.
-
-\tArgs:
-\t\timages        (list[str]): List of paths to the images to upscale.
-\t\toutput_folder (str):       Path to the output folder where the upscaled images will be saved.
-\t\tupscale_ratio (int):       Upscaling ratio.
-\t\tdesc          (str):       Description of the function execution displayed in the progress bar.
-\t\t\tNo progress bar will be displayed if desc is empty.
-
-\tReturns:
-\t\tNone: This function doesn't return anything.
-\t"""
-def upscale_folder(input_folder: str, output_folder: str, upscale_ratio: int, slightly_faster_mode: bool = True, desc: str = 'Upscaling folder') -> None:
-    """ Upscale all images in a folder.
-
-\tArgs:
-\t\tinput_folder          (str):   Path to the input folder containing the images to upscale.
-\t\toutput_folder         (str):   Path to the output folder where the upscaled images will be saved.
-\t\tupscale_ratio         (int):   Upscaling ratio.
-\t\tslightly_faster_mode  (bool):  Whether to use the slightly faster mode (no progress bar),
-\t\t\tone call to the upscaler executable.
-\t\tdesc                  (str):   Description of the function execution displayed in the progress bar.
-\t\t\tNo progress bar will be displayed if desc is empty.
-
-\tReturns:
-\t\tNone: This function doesn't return anything.
-\t"""

stouputils/stouputils/applications/upscaler/video.pyi

@@ -1,60 +0,0 @@
-from ...installer import check_executable as check_executable
-from ...io import clean_path as clean_path
-from ...parallel import multithreading as multithreading
-from ...print import colored_for_loop as colored_for_loop, debug as debug, error as error, info as info, warning as warning
-from .config import Config as Config, FFMPEG_RELEASES as FFMPEG_RELEASES, YOUTUBE_BITRATE_RECOMMENDATIONS as YOUTUBE_BITRATE_RECOMMENDATIONS
-from .image import convert_frame as convert_frame, get_all_files as get_all_files, upscale_folder as upscale_folder
-from typing import Literal
-
-def get_recommended_bitrate(resolution: tuple[int, int], frame_rate: int = 60, upload_type: Literal['SDR', 'HDR'] = 'SDR') -> int:
-    ''' Get the recommended bitrate (in kbps) for the output video based on the video resolution.
-
-\tArgs:
-\t\tresolution  (tuple[int, int]):       Video resolution (width, height).
-\t\tframe_rate  (int):                   Frame rate of the video, default is 60.
-\t\tupload_type (Literal["SDR","HDR"]):  Upload type from which the recommendation is made, default is "SDR".
-
-\tReturns:
-\t\tint:     The recommended bitrate for the output video (in kbps)
-
-\tSource: https://support.google.com/youtube/answer/1722171?hl=en#zippy=%2Cbitrate
-
-\tExamples:
-\t\t>>> # Valid examples
-\t\t>>> get_recommended_bitrate((3840, 2160), 60, "SDR")
-\t\t68000
-\t\t>>> get_recommended_bitrate((1920, 1080), 60, "HDR")
-\t\t15000
-\t\t>>> get_recommended_bitrate((1920, 1080), 60, "SDR")
-\t\t12000
-\t\t>>> get_recommended_bitrate((1920, 1080), 30, "SDR")
-\t\t8000
-
-\t\t>>> # Invalid examples
-\t\t>>> get_recommended_bitrate((1920, 1080), 60, "Ratio")
-\t\tTraceback (most recent call last):
-\t\t\t...
-\t\tAssertionError: Invalid upload type: \'Ratio\'
-\t\t>>> get_recommended_bitrate("1920x1080", 60, "SDR")
-\t\tTraceback (most recent call last):
-\t\t\t...
-\t\tAssertionError: Invalid resolution: 1920x1080, must be a tuple of two integers
-\t\t>>> get_recommended_bitrate((1920, 1080), -10, "SDR")
-\t\tTraceback (most recent call last):
-\t\t\t...
-\t\tAssertionError: Invalid frame rate: -10, must be a positive integer
-\t'''
-def check_ffmpeg_executable() -> None: ...
-def upscale_video(video_file: str, input_folder: str, progress_folder: str, output_folder: str) -> None:
-    """ Handles a video file. """
-def video_upscaler_cli(input_folder: str, progress_folder: str, output_folder: str) -> None:
-    """ Upscales videos from an input folder and saves them to an output folder.
-
-\tUses intermediate folders for extracted and upscaled frames within the progress folder.
-\t**Handles resuming partially processed videos.**
-
-\tArgs:
-\t\tinput_folder    (str): Path to the folder containing input videos.
-\t\tprogress_folder (str): Path to the folder for storing intermediate files (frames).
-\t\toutput_folder   (str): Path to the folder where upscaled videos will be saved.
-\t"""