stouputils 1.0.21__tar.gz → 1.0.22__tar.gz

{stouputils-1.0.21 → stouputils-1.0.22}/.github/workflows/documentation.yml

@@ -20,7 +20,7 @@ jobs:
       - uses: actions/setup-python@v5
       - name: Install dependencies
         run: |
-          pip install hatch stouputils sphinx sphinx_rtd_theme myst_parser
+          pip install hatch stouputils sphinx sphinx_rtd_theme myst_parser furo
           hatch build
       - name: Build latest docs
         if: github.ref == 'refs/heads/main'
@@ -37,5 +37,6 @@ jobs:
           publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: docs/build/html
+          keep_files: true
           force_orphan: false
 

{stouputils-1.0.21 → stouputils-1.0.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.0.21
+Version: 1.0.22
 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.
 Project-URL: Homepage, https://github.com/Stoupy51/stouputils
 Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues

stouputils-1.0.22/examples/all_doctests.py

@@ -0,0 +1,17 @@
+
+# Imports
+import os
+import stouputils as stp
+
+# Constants
+ROOT: str = os.path.dirname(os.path.abspath(__file__))
+FOLDER_TO_TEST: str = f"{ROOT}/../src"
+
+# Main
+@stp.measure_time(stp.info, message="All doctests finished")
+def main() -> None:
+	stp.launch_tests(FOLDER_TO_TEST)
+
+if __name__ == "__main__":
+	main()
+

stouputils-1.0.22/examples/archive.py

@@ -0,0 +1,24 @@
+
+# Imports
+import stouputils as stp
+from zipfile import ZipFile, BadZipFile
+
+# Main
+if __name__ == "__main__":
+	PREFIX: str = "examples/archive"
+
+	## Repair a corrupted zip file
+	# Try to read the first file
+	@stp.handle_error(BadZipFile)
+	def read_file() -> None:
+		with ZipFile(f"{PREFIX}/corrupted.zip", "r") as zip_file:
+			stp.info(zip_file.read("pack.mcmeta"))
+	read_file()
+
+	# Repair it
+	stp.repair_zip_file(f"{PREFIX}/corrupted.zip", f"{PREFIX}/repaired.zip")
+
+	# Read the first file
+	with ZipFile(f"{PREFIX}/repaired.zip", "r") as zip_file:
+		stp.info(zip_file.read("pack.mcmeta"))
+

stouputils-1.0.22/examples/collections.py

@@ -0,0 +1,28 @@
+
+# Imports
+import stouputils as stp
+
+# Main
+if __name__ == "__main__":
+	
+	# Example with numbers
+	numbers: list[int] = [1, 2, 3, 2, 1, 4, 3]
+	unique_numbers: list[int] = stp.unique_list(numbers)
+	stp.info(f"Original numbers: {numbers}")
+	stp.info(f"Unique numbers: {unique_numbers}")
+	
+	# Example with sets using different methods
+	s1: set[int] = {1, 2, 3}
+	s2: set[int] = {2, 3, 4}
+	s3: set[int] = {1, 2, 3}
+	sets: list[set[int]] = [s1, s2, s1, s1, s3, s2, s3]
+	
+	# Using id method (keeps s1 and s3 as separate objects)
+	unique_sets_id: list[set[int]] = stp.unique_list(sets, method="id")
+	stp.info(f"Unique sets (id method): {unique_sets_id}")
+	
+	# Using str method (combines s1 and s3 as they have same string representation)
+	unique_sets_str: list[set[int]] = stp.unique_list(sets, method="str")
+	stp.info(f"Unique sets (str method): {unique_sets_str}")
+
+

stouputils-1.0.22/examples/ctx.py

@@ -0,0 +1,25 @@
+
+# Imports
+import stouputils as stp
+import sys
+import os
+
+# Main
+if __name__ == "__main__":
+	
+	with stp.Muffle(mute_stderr=True):
+		print("Nothing")
+		print("here", file=sys.stderr)
+		stp.info("will be")
+		stp.info("printed", file=sys.stderr)
+
+	OUTPUT_PATH: str = "_super_idol_de_xiao_rong.log"
+	with stp.LogToFile(OUTPUT_PATH):
+		stp.info("""
+Why did the programmer always bring a ladder to work?
+Because they spent so much time debugging and climbing through their log files!
+""")
+		
+	stp.breakpoint("Press Enter to continue...")
+	os.remove(OUTPUT_PATH)
+

stouputils-1.0.22/examples/decorators_1.py

@@ -0,0 +1,29 @@
+
+# Imports
+import stouputils as stp
+import time
+
+# Main
+if __name__ == "__main__":
+	
+	# Cache the result of the function and measure the time it takes to execute
+	@stp.measure_time(stp.progress, "Time taken to execute long_function")
+	@stp.simple_cache()
+	def long_function() -> dict[str, int]:
+		stp.info("Starting long function...")
+		time.sleep(1)
+		stp.info("Long function finished!")
+		return {"a": 1, "b": 2}
+	
+	a = long_function()		# Takes 1 second
+	b = long_function()		# Takes 0 second
+	stp.info(f"a: {a}, b: {b}, a is b: {a is b}")
+	b["c"] = 3
+	stp.info(f"a has been modified because a is b: {a}")
+
+	# Silent decorator
+	@stp.silent
+	def silent_function():
+		print("ON THE CONSOLE")
+	silent_function()
+

stouputils-1.0.22/examples/decorators_2.py

@@ -0,0 +1,21 @@
+
+# Imports
+import stouputils as stp
+
+# Main
+if __name__ == "__main__":
+
+	# Handle exceptions
+	@stp.handle_error(ZeroDivisionError,
+		"Debugging: The process of removing software bugs, and putting in new ones",
+		error_log=stp.LogLevels.WARNING_TRACEBACK
+	)
+	def raise_value_error():
+		return 1 / 0
+
+	@stp.handle_error()
+	def raise_value_error_2():
+		return 1 / 0
+
+	raise_value_error()			# This will show the error using stp.warning
+	raise_value_error_2()		# This will show the error using stp.error

stouputils-1.0.22/examples/delta_backup.py

@@ -0,0 +1,7 @@
+
+# Example of use:
+# py examples/delta_backup.py delta "src" "backup" -x "*pycache*"
+
+import stouputils as stp
+stp.backup_cli()
+

stouputils-1.0.22/examples/io.py

@@ -0,0 +1,33 @@
+
+# Imports
+import stouputils as stp
+from typing import Any
+
+# Main
+if __name__ == "__main__":
+	
+	path: str = "C:\\\\Users\\\\Stoupy\\\\Documents\\\\test.txt"
+	path = stp.clean_path(path)
+	stp.info(path)
+
+	tilde_path: str = "~/Desktop/OnlyFansIncome.txt"
+	tilde_path = stp.replace_tilde(tilde_path)
+	stp.info(tilde_path)
+
+	this_folder_dont_exist: str = "./this_folder_dont_exist/a/c/feff/efefe/a"
+	with stp.super_open(this_folder_dont_exist, "w") as file:	# Automatically create the folder
+		file.write("Hello, world!")
+	
+	# Copy a file to a folder, or rename the copied file
+	stp.super_copy("LICENSE", "this_folder_dont_exist/a/")           # .../a/LICENSE
+	stp.super_copy("LICENSE", "this_folder_dont_exist/a/LICENSE_2")  # .../a/LICENSE_2
+	stp.breakpoint("Waiting for input to continue code execution...")
+
+	# Dump a JSON file with a specified indentation depth
+	data: dict[str, Any] = {"name": "John", "array": [[[1, 2, 3], [4, 5, 6]], [[7, 8, 9], [10, 11, 12]]]}
+	stp.info("\n", stp.super_json_dump(data, max_level=2))
+
+	# Remove the folder
+	import shutil
+	shutil.rmtree("this_folder_dont_exist")
+

stouputils-1.0.22/examples/parallel.py

@@ -0,0 +1,28 @@
+
+# Imports
+import stouputils as stp
+import time
+
+# Functions
+def is_even(n: int) -> bool:
+	return n % 2 == 0
+
+def multiple_args(a: int, b: int) -> int:
+	return a * b
+
+# Main
+if __name__ == "__main__":
+	
+	# Multi-threading (blazingly fast for IO-bound tasks)
+	args_1: list[int] = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+	results_1: list[bool] = stp.multithreading(is_even, args_1)
+	stp.info(f"Results: {results_1}")
+
+	# Multi-processing (better for CPU-bound tasks)
+	time.sleep(1)
+	args_2: list[tuple[int, int]] = [(1, 2), (3, 4), (5, 6), (7, 8), (9, 10)]
+	results_2: list[int] = stp.multiprocessing(
+		multiple_args, args_2, use_starmap=True, desc="Multiple args", max_workers=2, verbose=1
+	)
+	stp.info(f"Results: {results_2}")
+

stouputils-1.0.22/examples/print.py

@@ -0,0 +1,27 @@
+
+# Imports
+import time
+import stouputils as stp
+
+# Main
+if __name__ == "__main__":
+	stp.info("Hello", "World")
+	time.sleep(0.5)
+	stp.info("Hello", "World")
+	time.sleep(0.5)
+	stp.info("Hello", "World")
+	time.sleep(0.5)
+	stp.info("Not Hello World !")
+	time.sleep(0.5)
+	stp.info("Hello", "World")
+	time.sleep(0.5)
+	stp.info("Hello", "World")
+
+	# All remaining print functions
+	stp.debug("Hello", "World")
+	stp.suggestion("Hello", "World")
+	stp.progress("Hello", "World")
+	stp.warning("Hello", "World")
+	stp.error("Hello", "World", exit=False)
+	stp.whatisit("Hello", "World")
+

{stouputils-1.0.21 → stouputils-1.0.22}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.0.21"
+version = "1.0.22"
 authors = [
 	{ name="Stoupy51", email="stoupy51@gmail.com" },
 ]

{stouputils-1.0.21 → stouputils-1.0.22}/scripts/create_docs.py

@@ -4,7 +4,8 @@ import os
 import shutil
 import subprocess
 import sys
-from stouputils import clean_path, handle_error
+from stouputils import clean_path, handle_error, warning, simple_cache
+from stouputils.continuous_delivery.github import version_to_float
 clean_exec: str = clean_path(sys.executable)
 
 conf_content: str = """
@@ -26,21 +27,45 @@ release: str = current_version
 extensions: list[str] = [
 	'sphinx.ext.autodoc',
 	'sphinx.ext.napoleon',
-	'sphinx.ext.viewcode',
+	'sphinx.ext.viewcode', 
 	'sphinx.ext.githubpages',
 	'sphinx.ext.intersphinx',
+	'furo.sphinxext',
 ]
 
 templates_path: list[str] = ['_templates']
 exclude_patterns: list[str] = []
 
 # HTML output options
-html_theme: str = 'sphinx_rtd_theme'
+html_theme: str = 'furo'
 html_static_path: list[str] = ['_static']
+html_logo: str = 'https://avatars.githubusercontent.com/u/35665974'
+html_title: str = 'stouputils'
+html_favicon: str = 'https://avatars.githubusercontent.com/u/35665974'
 
 # Theme options
 html_theme_options: dict[str, Any] = {
-	'style_external_links': True,
+	'light_css_variables': {
+		'color-brand-primary': '#2980B9',
+		'color-brand-content': '#2980B9',
+		'color-admonition-background': '#E8F0F8',
+	},
+	'dark_css_variables': {
+		'color-brand-primary': '#56B4E9',
+		'color-brand-content': '#56B4E9',
+		'color-admonition-background': '#1F262B',
+	},
+	'sidebar_hide_name': False,
+	'navigation_with_keys': True,
+	'announcement': 'This is the latest documentation of stouputils',
+	'footer_icons': [
+		{
+			'name': 'GitHub',
+			'url': 'https://github.com/Stoupy51/stouputils',
+			'html': '<i class="fab fa-github-square"></i>',
+			'class': '',
+		},
+	],
 }
 
 # Add any paths that contain custom static files
@@ -71,6 +96,7 @@ html_context = {
 	'github_version': 'main',
 	'conf_py_path': '/docs/source/',
 	'source_suffix': '.rst',
+	'default_mode': 'dark',
 }
 
 # Only document items with docstrings
@@ -83,6 +109,30 @@ def setup(app: Any) -> None:
 	app.connect('autodoc-skip-member', skip_undocumented)
 """
 
+@simple_cache()
+def get_versions_from_github() -> list[str]:
+	""" Get list of versions from GitHub gh-pages branch.
+
+	Returns:
+		list[str]: List of versions, with 'latest' as first element
+	"""
+	import requests
+	version_list: list[str] = []
+	try:
+		response = requests.get("https://api.github.com/repos/Stoupy51/stouputils/contents?ref=gh-pages")
+		if response.status_code == 200:
+			contents = response.json()
+			version_list = ["latest"] + sorted(
+				[d["name"].replace("v", "") for d in contents 
+				if d["type"] == "dir" and d["name"].startswith("v")],
+				key=version_to_float,
+				reverse=True
+			)
+	except Exception as e:
+		warning(f"Failed to get versions from GitHub: {e}")
+		version_list = ["latest"]
+	return version_list
+
 def generate_index_rst(readme_path: str, index_path: str) -> None:
 	""" Generate index.rst from README.md content.
 	
@@ -107,14 +157,8 @@ def generate_index_rst(readme_path: str, index_path: str) -> None:
 
 **Versions**: """
 	
-	# Add versions from html_context
-	version_list: list[str] = []
-	html_dir = "docs/build/html"
-	if os.path.exists(html_dir):
-		version_list = [d[1:] for d in os.listdir(html_dir) if d.startswith('v')]
-	from stouputils.continuous_delivery.github import version_to_float
-	version_list.sort(key=version_to_float, reverse=True)
-	version_list.insert(0, 'latest')
+	# Get versions from GitHub
+	version_list: list[str] = get_versions_from_github()
 	
 	# Create version links
 	version_links: list[str] = []
@@ -218,10 +262,7 @@ def update_documentation(version: str | None = None) -> None:
 		os.makedirs(modules_dir)
 
 	# Update conf.py to include version selector
-	version_list: list[str] = []
-	if os.path.exists(clean_path(f"{docs_dir}/build/html")):
-		version_list = [d.replace("v", "") for d in os.listdir(clean_path(f"{docs_dir}/build/html")) 
-					   if d.startswith("v")] + ["latest"]
+	version_list: list[str] = get_versions_from_github()
 	
 	# Update html_context in conf.py
 	global conf_content

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/all_doctests.py

@@ -1,12 +1,16 @@
 """
 This module is used to run all the doctests for all the modules in a given directory.
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/all_doctests_module.gif
+  :alt: stouputils all_doctests examples
 """
 
 # Imports
 import os
 import sys
-from .print import *
-from .decorators import measure_time, handle_error, LogLevels, force_raise_exception
+from .print import info, error, progress
+from .decorators import measure_time, handle_error, LogLevels
+from . import decorators
 from doctest import TestResults, testmod
 from types import ModuleType
 import importlib
@@ -46,10 +50,9 @@ def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_
 		[PROGRESS HH:MM:SS] Testing module 'module3'	took 0.007s
 		[PROGRESS HH:MM:SS] Testing module 'module4'	took 0.008s
 	"""
-	global force_raise_exception
 	if strict:
 		old_value: bool = strict
-		force_raise_exception = True
+		decorators.force_raise_exception = True
 		strict = old_value
 
 
@@ -91,5 +94,5 @@ def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_
 			error(f"Errors in module {module.__name__}", exit=False)
 
 	# Reset force_raise_exception back
-	force_raise_exception = strict
+	decorators.force_raise_exception = strict
 

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/archive.py

@@ -3,12 +3,17 @@ This module provides functions for creating and managing archives.
 
 - make_archive: Make an archive with consistency using FILES_TO_WRITE variable
 - repair_zip_file: Try to repair a corrupted zip file (NOT IMPLEMENTED)
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/archive_module.gif
+  :alt: stouputils archive examples
 """
 
 # Imports
-from .io import *
-from .print import *
+import os
 from zipfile import ZipFile, ZipInfo, ZIP_DEFLATED
+from .io import clean_path, super_copy
+from .decorators import handle_error, LogLevels
+from .dont_look.zip_file_override import ZipFileOverride
 
 # Function that makes an archive with consistency (same zip file each time)
 @handle_error()
@@ -18,7 +23,12 @@ def make_archive(
 	override_time: None | tuple[int, int, int, int, int, int] = None,
 	create_dir: bool = False
 ) -> bool:
-	""" Make an archive with consistency using FILES_TO_WRITE variable
+	""" Create a zip archive from a source directory with consistent file timestamps.
+	(Meaning deterministic zip file each time)
+
+	Creates a zip archive from the source directory and copies it to one or more destinations.
+	The archive will have consistent file timestamps across runs if override_time is specified.
+	Uses maximum compression level (9) with ZIP_DEFLATED algorithm.
 
 	Args:
 		source				(str):						The source folder to archive
@@ -33,6 +43,7 @@ def make_archive(
 
 		> make_archive("/path/to/source", "/path/to/destination.zip")
 		> make_archive("/path/to/source", ["/path/to/destination.zip", "/path/to/destination2.zip"])
+		> make_archive("src", "hello_from_year_2085.zip", override_time=(2085,1,1,0,0,0))
 	"""
 	# Fix copy_destinations type if needed
 	if destinations and isinstance(destinations, str):
@@ -66,7 +77,6 @@ def make_archive(
 
 
 # Function that repair a corrupted zip file (ignoring some of the errors)
-from .dont_look.zip_file_override import ZipFileOverride
 @handle_error()
 def repair_zip_file(file_path: str, destination: str) -> bool:
 	""" Try to repair a corrupted zip file by ignoring some of the errors

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/backup.py

@@ -5,6 +5,9 @@ This module provides utilities for backup management.
 - create_delta_backup: Creates a ZIP delta backup, saving only modified or new files while tracking deleted files
 - consolidate_backups: Consolidates the files from the given backup and all previous ones into a new ZIP file
 - backup_cli: Main entry point for command line usage
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/backup_module.gif
+  :alt: stouputils backup examples
 """
 
 # Standard library imports

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/collections.py

@@ -2,6 +2,9 @@
 This module provides utilities for collection manipulation:
 
 - unique_list: Remove duplicates from a list while preserving order using object id, hash or str
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/collections_module.gif
+  :alt: stouputils collections examples
 """
 
 # Imports

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/continuous_delivery/cd_utils.py

@@ -3,7 +3,7 @@ It is mainly used by the `stouputils.continuous_delivery.github` module.
 """
 
 # Imports
-from ..print import *
+from ..print import warning
 from ..decorators import handle_error
 from ..io import clean_path, super_json_load
 import requests

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/continuous_delivery/github.py

@@ -1,12 +1,19 @@
 """ This module contains utilities for continuous delivery on GitHub.
 
 - upload_to_github: Upload the project to GitHub using the credentials and the configuration (make a release and upload the assets, handle existing tag, generate changelog, etc.)
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/continuous_delivery/github_module.gif
+  :alt: stouputils upload_to_github examples
 """
 
 # Imports
-from ..print import *
-from ..decorators import measure_time
-from .cd_utils import *
+from ..print import info, warning, progress
+from ..decorators import measure_time, handle_error
+from ..io import clean_path
+from .cd_utils import handle_response
+from typing import Any
+import requests
+import os
 
 # Constants
 GITHUB_API_URL: str = "https://api.github.com"
@@ -131,7 +138,7 @@ def delete_existing_tag(tag_url: str, headers: dict[str, str]) -> None:
 	"""
 	delete_response: requests.Response = requests.delete(tag_url, headers=headers)
 	handle_response(delete_response, "Failed to delete existing tag")
-	info(f"Deleted existing tag")
+	info("Deleted existing tag")
 
 def clean_version(version: str, keep: str = "") -> str:
 	""" Clean a version string

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/ctx.py

@@ -3,12 +3,17 @@ This module provides context managers for temporarily silencing output.
 
 - Muffle: Context manager that temporarily silences output (alternative to stouputils.decorators.silent())
 - LogToFile: Context manager to log to a file every calls to the print functions in stouputils.print
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/ctx_module.gif
+  :alt: stouputils ctx examples
 """
 
 # Imports
 import os
 import sys
 from typing import IO, TextIO, Callable, Any
+from .print import logging_to
+from .io import super_open
 
 # Context manager to temporarily silence output
 class Muffle:
@@ -39,8 +44,6 @@ class Muffle:
 
 
 # Context manager to log to a file
-from .print import logging_to
-from .io import super_open
 class LogToFile:
 	""" Context manager to log to a file.
 
@@ -53,9 +56,11 @@ class LogToFile:
 		encoding (str): Encoding to use for the file (default: "utf-8")
 
 	Examples:
-		>>> with LogToFile("output.log"):
-		...     from stouputils.print import info
-		...     info("This will be logged to output.log and printed normally")
+		.. code-block:: python
+
+			> import stouputils as stp
+			> with stp.LogToFile("output.log"):
+			>     stp.info("This will be logged to output.log and printed normally")
 	"""
 	def __init__(self, path: str, mode: str = "w", encoding: str = "utf-8") -> None:
 		self.path: str = path

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/decorators.py

@@ -6,6 +6,12 @@ This module provides decorators for various purposes:
 - handle_error(): Handle an error with different log levels
 - simple_cache(): Easy cache function with parameter caching method
 - deprecated(): Mark a function as deprecated
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/decorators_module_1.gif
+  :alt: stouputils decorators examples
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/decorators_module_2.gif
+  :alt: stouputils decorators examples
 """
 
 # Imports
@@ -17,7 +23,7 @@ from pickle import dumps as pickle_dumps
 from traceback import format_exc
 from typing import Callable, Literal, Any
 from functools import wraps
-from .print import *
+from .print import debug, warning, error
 
 
 # Decorator that make a function silent (disable stdout)
@@ -82,10 +88,12 @@ def measure_time(
 		Callable:	Decorator to measure the time of the function.
 	
 	Examples:
-		>>> @measure_time(info)
-		... def test():
-		...     pass
-		>>> test()	# [INFO HH:MM:SS] Execution time of test: 0.000ms (0ns)
+		.. code-block:: python
+
+			> @measure_time(info)
+			> def test():
+			>     pass
+			> test()  # [INFO HH:MM:SS] Execution time of test: 0.000ms (400ns)
 	"""
 	ns: Callable[[], int] = time.perf_counter_ns if perf_counter else time.time_ns
 	def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
@@ -165,10 +173,12 @@ def handle_error(
 			LogLevels.RAISE_EXCEPTION:		Raise exception (as if the decorator didn't exist)
 	
 	Examples:
-		>>> @handle_error(error_log=LogLevels.WARNING)
-		... def test():
-		...     raise ValueError("Let's fail")
-		>>> test()	# [WARNING HH:MM:SS] Error during test: (ValueError) Let's fail
+		.. code-block:: python
+
+			> @handle_error(error_log=LogLevels.WARNING)
+			> def test():
+			>     raise ValueError("Let's fail")
+			> test()	# [WARNING HH:MM:SS] Error during test: (ValueError) Let's fail
 	"""	
 	# Update error_log if needed
 	if force_raise_exception:
@@ -271,10 +281,12 @@ def deprecated(
 		Callable[..., Any]: Decorator that marks a function as deprecated
 	
 	Examples:
-		>>> @deprecated(message="Use 'this_function()' instead", error_log=LogLevels.WARNING)
-		... def test():
-		...     pass
-		>>> test()	# [WARNING HH:MM:SS] Function 'test()' is deprecated. Use 'this_function()' instead
+		.. code-block:: python
+
+			> @deprecated(message="Use 'this_function()' instead", error_log=LogLevels.WARNING)
+			> def test():
+			>     pass
+			> test()	# [WARNING HH:MM:SS] Function 'test()' is deprecated. Use 'this_function()' instead
 	"""
 	def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
 		@wraps(func)
@@ -299,42 +311,3 @@ def deprecated(
 		return wrapper
 	return decorator
 
-
-
-
-
-
-def __test_simple_cache():
-	@measure_time(progress)
-	@simple_cache(method="pickle")
-	def test_pickle_cache(*args: tuple[Any, ...], **kwargs: dict[str, Any]) -> str:
-		return "pickle cache"
-
-	@measure_time(progress)
-	@simple_cache(method="str")
-	def test_str_cache(*args: tuple[Any, ...], **kwargs: dict[str, Any]) -> str:
-		return "str cache"
-
-
-	args: list[int] = list(range(1_000_000))
-	kwargs: dict[str, int] = {str(i): i for i in args}
-
-	info("Testing with large arguments")
-	for _ in range(2):
-		test_pickle_cache(*args, **kwargs)
-		test_str_cache(*args, **kwargs)
-
-	info("Testing with small arguments")
-	for _ in range(2):
-		test_pickle_cache()
-		test_str_cache()
-
-
-if __name__ == "__main__":
-	__test_simple_cache()
-
-	@deprecated(message="Use 'this_function()' instead", error_log=LogLevels.WARNING)
-	def test_deprecated():
-		return "test"
-	test_deprecated()
-

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/dont_look/zip_file_override.py

@@ -6,7 +6,7 @@ See the archive.py module for more information.
 """
 
 # Imports
-from zipfile import ZipFile, ZipInfo, ZipExtFile, _SharedFile, sizeFileHeader, struct, structFileHeader, _FH_FILENAME_LENGTH, _FH_EXTRA_FIELD_LENGTH, _FH_GENERAL_PURPOSE_FLAG_BITS, crc32	# type: ignore
+from zipfile import ZipFile, ZipInfo, ZipExtFile, _SharedFile, sizeFileHeader, struct, structFileHeader, _FH_EXTRA_FIELD_LENGTH, crc32	# type: ignore
 
 
 # Class overrides
@@ -73,7 +73,6 @@ class ZipFileOverride(ZipFile):
 			fheader = zef_file.read(sizeFileHeader)	# type: ignore
 			fheader = struct.unpack(structFileHeader, fheader)	# type: ignore
 
-			fname = zef_file.read(fheader[_FH_FILENAME_LENGTH])	# type: ignore
 			if fheader[_FH_EXTRA_FIELD_LENGTH]:
 				zef_file.seek(fheader[_FH_EXTRA_FIELD_LENGTH], whence=1)	# type: ignore
 
@@ -85,12 +84,6 @@ class ZipFileOverride(ZipFile):
 				# strong encryption
 				raise NotImplementedError("strong encryption (flag bit 6)")
 
-			if fheader[_FH_GENERAL_PURPOSE_FLAG_BITS] & 0x800:
-				# UTF-8 filename
-				fname_str = fname.decode("utf-8")	# type: ignore
-			else:
-				fname_str = fname.decode(self.metadata_encoding or "cp437")	# type: ignore
-
 			# if (zinfo._end_offset is not None and
 			# 	zef_file.tell() + zinfo.compress_size > zinfo._end_offset):
 			# 	raise BadZipFile(f"Overlapped entries: {zinfo.orig_filename!r} (possible zip bomb)")

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/io.py

@@ -7,15 +7,17 @@ This module provides utilities for file management.
 - super_copy: Copy a file (or a folder) from the source to the destination (always create the directory)
 - super_json_load: Load a JSON file from the given path
 - super_json_dump: Writes the provided data to a JSON file with a specified indentation depth.
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/io_module.gif
+  :alt: stouputils io examples
 """
 
 # Imports
-from .decorators import *
 import shutil
 import json
 import os
 import io
-from typing import IO
+from typing import IO, Any
 
 # Function that replace the "~" by the user's home directory
 def replace_tilde(path: str) -> str:

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/parallel.py

@@ -5,11 +5,14 @@ This module provides utility functions for parallel processing, such as:
 - multithreading(): Execute a function in parallel using multithreading
 
 I highly encourage you to read the function docstrings to understand when to use each method.
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/parallel_module.gif
+  :alt: stouputils parallel examples
 """
 
 # Imports
-from .print import *
-from .decorators import *
+from .print import MAGENTA, RESET
+from .decorators import handle_error, LogLevels
 from multiprocessing import Pool, cpu_count
 from typing import Callable, TypeVar
 from tqdm import tqdm
@@ -21,7 +24,7 @@ import time
 def doctest_square(x: int) -> int:
 	return x * x
 def doctest_slow(x: int) -> int:
-	time.sleep(0.5)
+	time.sleep(0.1)
 	return x
 
 # Constants
@@ -107,11 +110,11 @@ def multiprocessing(func: Callable[[T], R], args: list[T], use_starmap: bool = F
 		[2, 12, 30]
 
 		>>> # Will process in parallel with progress bar
-		>>> multiprocessing(doctest_slow, list(range(10)), desc="Processing", verbose=1)
+		>>> multiprocessing(doctest_slow, range(10), desc="Processing", verbose=1)
 		[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 
 		>>> # Will process in parallel with progress bar and delay the first threads
-		>>> multiprocessing(doctest_slow, list(range(10)), desc="Processing with delay", max_workers=2, delay_first_calls=1.2, verbose=1)
+		>>> multiprocessing(doctest_slow, range(10), desc="Processing with delay", max_workers=2, delay_first_calls=0.6, verbose=1)
 		[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 	"""
 	# Handle parameters
@@ -159,11 +162,11 @@ def multithreading(func: Callable[[T], R], args: list[T], use_starmap: bool = Fa
 		[2, 12, 30]
 
 		>>> # Will process in parallel with progress bar
-		>>> multithreading(doctest_slow, list(range(10)), desc="Threading", verbose=1)
+		>>> multithreading(doctest_slow, range(10), desc="Threading", verbose=1)
 		[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 
 		>>> # Will process in parallel with progress bar and delay the first threads
-		>>> multithreading(doctest_slow, list(range(10)), desc="Threading with delay", max_workers=2, delay_first_calls=1.2, verbose=1)
+		>>> multithreading(doctest_slow, range(10), desc="Threading with delay", max_workers=2, delay_first_calls=0.6, verbose=1)
 		[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 	"""
 	# Handle parameters

{stouputils-1.0.21 → stouputils-1.0.22}/src/stouputils/print.py

@@ -1,22 +1,9 @@
 """
-This module provides utility functions for printing messages with different levels of importance,
-If a message is printed multiple times, it will be displayed as "(xN) message" where N is the number of times the message has been printed.
-
-The functions are such as:
+This module provides utility functions for printing messages with different levels of importance.
 
-- info()
-- debug()
-- suggestion()
-- progress()
-- warning()
-- error()
-- whatisit(): a function to print the type of each value and the value itself (and few other things)
-- breakpoint(): a breakpoint function to pause the program while calling whatisit()
-- logging_to: a set of file-like objects that will receive log messages without ANSI color codes, see stouputils.ctx.LogToFile for easy logging
-
-Here is a demonstration gif showing examples of uses:
+If a message is printed multiple times, it will be displayed as "(xN) message" where N is the number of times the message has been printed.
 
-.. image:: https://i.imgur.com/EIeiLwa.gif
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/print_module.gif
   :alt: stouputils print examples
 """
 
@@ -67,7 +54,7 @@ def current_time() -> str:
 	else:
 		return time.strftime("%H:%M:%S")
 
-def info(*values: Any, color: str = GREEN, text: str = "INFO ", prefix: str = "", file: TextIO|list[TextIO] = sys.stdout, **print_kwargs: Any) -> None:
+def info(*values: Any, color: str = GREEN, text: str = "INFO ", prefix: str = "", file: TextIO|list[TextIO]|None = None, **print_kwargs: Any) -> None:
 	""" Print an information message looking like "[INFO HH:MM:SS] message" in green by default.
 
 	Args:
@@ -78,6 +65,8 @@ def info(*values: Any, color: str = GREEN, text: str = "INFO ", prefix: str = ""
 		file			(TextIO|list[TextIO]):	File(s) to write the message to (default: sys.stdout)
 		print_kwargs	(dict):					Keyword arguments to pass to the print function
 	"""
+	if file is None:
+		file = sys.stdout
 	if isinstance(file, list):
 		for f in file:
 			info(*values, color=color, text=text, prefix=prefix, file=f, **print_kwargs)
@@ -180,7 +169,9 @@ def whatisit(*values: Any, print_function: Callable[..., None] = debug, max_leng
 		value_str: str = str(value)
 		if len(value_str) > max_length:
 			value_str = value_str[:max_length] + "..."
-		return f"{type(value)}, <id {id(value)}>:\t{length}{value_str}"
+		if "\n" in value_str:
+			length = "\n" + length	# Add a newline before the length if there is a newline in the value.
+		return f"{type(value)}, <id {id(value)}>: {length}{value_str}"
 
 	# Print
 	if len(values) > 1:

stouputils-1.0.21/doctests.py

@@ -1,17 +0,0 @@
-
-# Imports
-import os
-from src.stouputils import launch_tests, measure_time, info
-
-# Constants
-ROOT: str = os.path.dirname(os.path.abspath(__file__))
-FOLDER_TO_TEST: str = f"{ROOT}/src"
-
-# Main
-@measure_time(info, message="All doctests finished")
-def main() -> None:
-	launch_tests(FOLDER_TO_TEST)
-
-if __name__ == "__main__":
-	main()
-

stouputils-1.0.21/examples/delta_backup.py

@@ -1,7 +0,0 @@
-
-# Example of use:
-# py .\delta_backup.py delta "src" "backup" -x "*pycache*"
-
-import stouputils as stp
-stp.backup_cli()
-