stouputils 1.2.12__tar.gz → 1.2.13__tar.gz

{stouputils-1.2.12 → stouputils-1.2.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.2.12
+Version: 1.2.13
 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.2.12 → stouputils-1.2.13}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.12"
+version = "1.2.13"
 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"
 requires-python = ">=3.10"

{stouputils-1.2.12 → stouputils-1.2.13}/stouputils/all_doctests.py

@@ -23,7 +23,7 @@ def test_module_with_progress(module: ModuleType, separator: str) -> TestResults
 	return internal()
 
 # Main program
-def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_TRACEBACK, strict: bool = True) -> None:
+def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_TRACEBACK, strict: bool = True) -> int:
 	""" Main function to launch tests for all modules in the given directory.
 
 	Args:
@@ -31,6 +31,9 @@ def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_
 		importing_errors		(LogLevels):	Log level for the errors when importing modules
 		strict					(bool):			Modify the force_raise_exception variable to True in the decorators module
 	
+	Returns:
+		int: The number of failed tests
+	
 	Examples:
 		>>> launch_tests("unknown_dir")
 		Traceback (most recent call last):
@@ -39,7 +42,8 @@ def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_
 
 	.. code-block:: python
 
-		> launch_tests("/path/to/source")
+		> if launch_tests("/path/to/source") > 0:
+			sys.exit(1)
 		[PROGRESS HH:MM:SS] Importing module 'module1'	took 0.001s
 		[PROGRESS HH:MM:SS] Importing module 'module2'	took 0.002s
 		[PROGRESS HH:MM:SS] Importing module 'module3'	took 0.003s
@@ -89,10 +93,15 @@ def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_
 	results: list[TestResults] = [test_module_with_progress(module, separator) for module, separator in zip(modules, separators)]
 
 	# Display any error lines for each module at the end of the script
+	nb_failed_tests: int = 0
 	for module, result in zip(modules, results):
 		if result.failed > 0:
 			error(f"Errors in module {module.__name__}", exit=False)
+			nb_failed_tests += result.failed
 
 	# Reset force_raise_exception back
 	decorators.force_raise_exception = strict
 
+	# Return the number of failed tests
+	return nb_failed_tests
+