stouputils 1.2.6__tar.gz → 1.2.8__tar.gz

{stouputils-1.2.6 → stouputils-1.2.8}/PKG-INFO

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

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.6"
+version = "1.2.8"
 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.6 → stouputils-1.2.8}/stouputils/applications/automatic_docs.py

@@ -28,10 +28,6 @@ Example of usage:
 .. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/applications/automatic_docs.gif
   :alt: stouputils automatic_docs examples
 
-Note:
-    This module requires Sphinx and its dependencies to be installed.
-    It also requires the 'm2r2' package for Markdown to RST conversion.
-
 Example of GitHub Actions workflow:
 
 .. code-block:: yaml
@@ -40,11 +36,8 @@ Example of GitHub Actions workflow:
 
   on: 
     push:
-      branches:
-        - main
       tags:
         - 'v*'
-    pull_request:
     workflow_dispatch:
 
   permissions:
@@ -58,19 +51,13 @@ Example of GitHub Actions workflow:
         - uses: actions/setup-python@v5
         - name: Install dependencies
           run: |
-            pip install hatch stouputils sphinx sphinx_rtd_theme myst_parser furo m2r2
+            pip install hatch stouputils
             hatch build
-        - name: Build latest docs
-          if: github.ref == 'refs/heads/main'
-          run: |
-            python scripts/create_docs.py
         - name: Build version docs
-          if: startsWith(github.ref, 'refs/tags/v')
           run: |
             python scripts/create_docs.py ${GITHUB_REF#refs/tags/v}
         - name: Deploy to GitHub Pages
           uses: peaceiris/actions-gh-pages@v3
-          if: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') || startsWith(github.ref, 'refs/tags/v') }}
           with:
             publish_branch: gh-pages
             github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -206,7 +193,7 @@ autodoc_default_options: dict[str, bool | str] = {{
 	"member-order": "bysource",
 	"special-members": False,
 	"undoc-members": False,
-	"private-members": False,
+	"private-members": True,
 	"show-inheritance": True,
 	"ignore-module-all": True,
 	"exclude-members": "__weakref__",
@@ -506,8 +493,9 @@ def update_documentation(
 	# If version is specified, copy the build directory to latest too
 	# This is useful for GitHub Actions to prevent re-building the documentation from scratch without the version
 	if version:
-		shutil.rmtree(latest_dir)
-		shutil.copytree(build_dir, latest_dir)
+		if os.path.exists(latest_dir):
+			shutil.rmtree(latest_dir)
+		shutil.copytree(build_dir, latest_dir, dirs_exist_ok=True)
 
 	info(f"Documentation updated successfully!")
 	info(f"You can view the documentation by opening {build_dir}/index.html")

{stouputils-1.2.6 → stouputils-1.2.8}/stouputils/ctx.py

@@ -27,17 +27,28 @@ class Muffle:
 	"""
 	def __init__(self, mute_stderr: bool = False) -> None:
 		self.mute_stderr: bool = mute_stderr
+		""" Attribute remembering if stderr should be muted """
+		self.original_stdout: TextIO = sys.stdout
+		""" Attribute remembering original stdout """
+		self.original_stderr: TextIO = sys.stderr
+		""" Attribute remembering original stderr """
 
 	def __enter__(self) -> None:
-		self.original_stdout: TextIO = sys.stdout
-		sys.stdout = open(os.devnull, 'w')
+		""" Enter context manager which redirects stdout and stderr to devnull """
+		# Redirect stdout to devnull
+		sys.stdout = open(os.devnull, "w")
+
+		# Redirect stderr to devnull if needed
 		if self.mute_stderr:
-			self.original_stderr: TextIO = sys.stderr
-			sys.stderr = open(os.devnull, 'w')
+			sys.stderr = open(os.devnull, "w")
 
 	def __exit__(self, exc_type: type[BaseException]|None, exc_val: BaseException|None, exc_tb: Any|None) -> None:
+		""" Exit context manager which restores original stdout and stderr """
+		# Restore original stdout
 		sys.stdout.close()
 		sys.stdout = self.original_stdout
+
+		# Restore original stderr if needed
 		if self.mute_stderr:
 			sys.stderr.close()
 			sys.stderr = self.original_stderr
@@ -64,15 +75,25 @@ class LogToFile:
 	"""
 	def __init__(self, path: str, mode: str = "w", encoding: str = "utf-8") -> None:
 		self.path: str = path
+		""" Attribute remembering path to the log file """
 		self.mode: str = mode
+		""" Attribute remembering mode to open the file in """
 		self.encoding: str = encoding
+		""" Attribute remembering encoding to use for the file """
+		self.file: IO[Any] = super_open(self.path, mode=self.mode, encoding=self.encoding)
+		""" Attribute remembering opened file """
 
 	def __enter__(self) -> None:
-		self.file: IO[Any] = super_open(self.path, mode=self.mode, encoding=self.encoding)
+		""" Enter context manager which opens the log file and adds it to the logging_to list """
+		# Add file to logging_to list
 		logging_to.add(self.file)
 
 	def __exit__(self, exc_type: type[BaseException]|None, exc_val: BaseException|None, exc_tb: Any|None) -> None:
+		""" Exit context manager which closes the log file and removes it from the logging_to list """
+		# Close file
 		self.file.close()
+
+		# Remove file from logging_to list
 		logging_to.discard(self.file)
 	
 	@staticmethod

{stouputils-1.2.6 → stouputils-1.2.8}/stouputils/dont_look/zip_file_override.py

@@ -11,7 +11,10 @@ from zipfile import ZipFile, ZipInfo, ZipExtFile, _SharedFile, sizeFileHeader, s
 
 # Class overrides
 class ZipExtFileOverride(ZipExtFile):
+	""" Override of the ZipExtFile class """
+
 	def _update_crc(self, newdata) -> None:	# type: ignore
+		""" Override of the _update_crc method """
 		# Update the CRC using the given data.
 		if self._expected_crc is None:	# type: ignore
 			# No need to compute the CRC if we don't have a reference value
@@ -19,6 +22,7 @@ class ZipExtFileOverride(ZipExtFile):
 		self._running_crc = crc32(newdata, self._running_crc)	# type: ignore
 
 class ZipFileOverride(ZipFile):
+	""" Override of the ZipFile class """
 
 	def open(self, name, mode="r", pwd=None, *, force_zip64=False):	# type: ignore
 		"""Return file-like object for 'name'.