stouputils 1.3.19__tar.gz → 1.3.20__tar.gz

{stouputils-1.3.19 → stouputils-1.3.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.3.19
+Version: 1.3.20
 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
@@ -90,8 +90,6 @@ It includes a range of tools for tasks such as execution of doctests, display ut
 │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.mlflow_utils.html">mlflow_utils.py</a>      <span class="comment"># 📊 MLflow integration utilities</span>
 │   └── ...
 │
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.dont_look.html">dont_look/</a>               <span class="comment"># 🙈 Internal utilities (zip_file_override)</span>
-│
 ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.html">installer/</a>
 │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.common.html">common.py</a>            <span class="comment"># 🔧 Common installer utilities</span>
 │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.downloader.html">downloader.py</a>        <span class="comment"># ⬇️ File download utilities</span>

{stouputils-1.3.19 → stouputils-1.3.20}/README.md

@@ -66,8 +66,6 @@ It includes a range of tools for tasks such as execution of doctests, display ut
 │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.mlflow_utils.html">mlflow_utils.py</a>      <span class="comment"># 📊 MLflow integration utilities</span>
 │   └── ...
 │
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.dont_look.html">dont_look/</a>               <span class="comment"># 🙈 Internal utilities (zip_file_override)</span>
-│
 ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.html">installer/</a>
 │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.common.html">common.py</a>            <span class="comment"># 🔧 Common installer utilities</span>
 │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.downloader.html">downloader.py</a>        <span class="comment"># ⬇️ File download utilities</span>

{stouputils-1.3.19 → stouputils-1.3.20}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.3.19"
+version = "1.3.20"
 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.3.19 → stouputils-1.3.20}/stouputils/archive.py

@@ -8,13 +8,13 @@ This module provides functions for creating and managing archives.
   :alt: stouputils archive examples
 """
 
+# pyright: reportUnusedVariable=false
 # Imports
 import fnmatch
 import os
 from zipfile import ZIP_DEFLATED, ZipFile, ZipInfo
 
 from .decorators import LogLevels, handle_error
-from .dont_look.zip_file_override import ZipFileOverride
 from .io import clean_path, super_copy
 
 
@@ -124,6 +124,10 @@ def make_archive(
 def repair_zip_file(file_path: str, destination: str) -> bool:
 	""" Try to repair a corrupted zip file by ignoring some of the errors
 
+	This function manually parses the ZIP file structure to extract files
+	even when the ZIP file is corrupted. It reads the central directory
+	entries and attempts to decompress each file individually.
+
 	Args:
 		file_path		(str):	Path of the zip file to repair
 		destination		(str):	Destination of the new file
@@ -136,6 +140,9 @@ def repair_zip_file(file_path: str, destination: str) -> bool:
 
 		> repair_zip_file("/path/to/source.zip", "/path/to/destination.zip")
 	"""
+	import struct
+	import zlib
+
 	# Check
 	if not os.path.exists(file_path):
 		raise FileNotFoundError(f"File '{file_path}' not found")
@@ -143,20 +150,158 @@ def repair_zip_file(file_path: str, destination: str) -> bool:
 	if dirname and not os.path.exists(dirname):
 		raise FileNotFoundError(f"Directory '{dirname}' not found")
 
-	# Read it
-	with ZipFileOverride(file_path, "r") as zip_file:
-
-		# Get a list of all the files in the ZIP file
-		file_list: list[str] = zip_file.namelist()
+	# Read the entire ZIP file into memory
+	with open(file_path, 'rb') as f:
+		data = f.read()
+
+	# Find central directory entries
+	CENTRAL_SIG = b'PK\x01\x02'
+	entries: list[dict[str, int | str]] = []
+	idx = 0
+
+	while True:
+		idx = data.find(CENTRAL_SIG, idx)
+		if idx == -1:
+			break
+		# Ensure enough length for central directory header
+		if idx + 46 > len(data):
+			break
+
+		header = data[idx:idx+46]
+		try:
+			(
+				sig,
+				ver_made, ver_needed, flags, comp_method, mtime, mdate,
+				crc, csize, usize,
+				name_len, extra_len, comm_len,
+				disk_start, int_attr,
+				ext_attr, local_off
+			) = struct.unpack('<4s6H3L3H2H2L', header)
+
+			name_start = idx + 46
+			if name_start + name_len > len(data):
+				idx += 4
+				continue
+
+			name = data[name_start:name_start+name_len].decode('utf-8', errors='replace')
+			entries.append({
+				'name': name,
+				'comp_method': comp_method,
+				'csize': csize,
+				'usize': usize,
+				'local_offset': local_off,
+				'crc': crc
+			})
+		except (struct.error, UnicodeDecodeError):
+			# Skip corrupted entries
+			pass
+
+		idx += 4
+
+	# Create a new ZIP file with recovered entries
+	with ZipFile(destination, "w", compression=ZIP_DEFLATED) as new_zip_file:
+		for entry in entries:
+			try:
+				# Get the local header to find data start
+				lo: int = int(entry['local_offset'])
+				if lo + 30 > len(data):
+					continue
 
-		# Create a new ZIP file at the destination
-		with ZipFileOverride(destination, "w", compression=ZIP_DEFLATED) as new_zip_file:
-			for file_name in file_list:
+				lh = data[lo:lo+30]
 				try:
-					new_zip_file.writestr(file_name, zip_file.read(file_name))
-				except KeyboardInterrupt:
+					_, _, _, _, _, _, _, _, _, name_len, extra_len = struct.unpack('<4sHHHHHLLLHH', lh)
+				except struct.error:
+					continue
+
+				data_start: int = lo + 30 + name_len + extra_len
+				if data_start + int(entry['csize']) > len(data):
 					continue
 
+				comp_data = data[data_start:data_start+int(entry['csize'])]
+
+				# Decompress the data
+				try:
+					if int(entry['comp_method']) == 0:  # No compression
+						content = comp_data[:int(entry['usize'])]
+					elif int(entry['comp_method']) == 8:  # Deflate compression
+						content = zlib.decompress(comp_data, -zlib.MAX_WBITS)
+					else:
+						# Unsupported compression method, skip
+						continue
+
+					# Write to new ZIP file
+					new_zip_file.writestr(str(entry['name']), content)
+
+				except (zlib.error, Exception):
+					# If decompression fails, try to write raw data as a fallback
+					try:
+						new_zip_file.writestr(f"{entry['name']!s}.corrupted", comp_data)
+					except Exception:
+						# Skip completely corrupted entries
+						continue
+
+			except Exception:
+				# Skip any entries that cause errors
+				continue
+
 	return True
 
 
+# CLI functionality
+if __name__ == "__main__":
+	import argparse
+	import sys
+
+	parser = argparse.ArgumentParser(description="Archive utilities")
+	subparsers = parser.add_subparsers(dest="command", help="Available commands")
+
+	# Repair command
+	repair_parser = subparsers.add_parser("repair", help="Repair a corrupted zip file")
+	repair_parser.add_argument("input_file", help="Path to the corrupted zip file")
+	repair_parser.add_argument("output_file", nargs="?", help="Path to the repaired zip file (optional, defaults to input_file with '_repaired' suffix)")
+
+	# Make archive command
+	archive_parser = subparsers.add_parser("make", help="Create a zip archive")
+	archive_parser.add_argument("source", help="Source directory to archive")
+	archive_parser.add_argument("destination", help="Destination zip file")
+	archive_parser.add_argument("--ignore", help="Glob patterns to ignore (comma-separated)")
+	archive_parser.add_argument("--create-dir", action="store_true", help="Create destination directory if it doesn't exist")
+
+	args = parser.parse_args()
+
+	if args.command == "repair":
+		input_file = args.input_file
+		if args.output_file:
+			output_file = args.output_file
+		else:
+			# Generate default output filename
+			base, ext = os.path.splitext(input_file)
+			output_file = f"{base}_repaired{ext}"
+
+		print(f"Repairing '{input_file}' to '{output_file}'...")
+		try:
+			repair_zip_file(input_file, output_file)
+			print(f"Successfully repaired zip file: {output_file}")
+		except Exception as e:
+			print(f"Error repairing zip file: {e}", file=sys.stderr)
+			sys.exit(1)
+
+	elif args.command == "make":
+		print(f"Creating archive from '{args.source}' to '{args.destination}'...")
+		try:
+			make_archive(
+				source=args.source,
+				destinations=args.destination,
+				create_dir=args.create_dir,
+				ignore_patterns=args.ignore
+			)
+			print(f"Successfully created archive: {args.destination}")
+		except Exception as e:
+			print(f"Error creating archive: {e}", file=sys.stderr)
+			sys.exit(1)
+
+	else:
+		parser.print_help()
+		sys.exit(1)
+
+

{stouputils-1.3.19 → stouputils-1.3.20}/stouputils/io.py

@@ -117,7 +117,7 @@ def get_root_path(relative_path: str, go_up: int = 0) -> str:
 	return clean_path(
 		os.path.dirname(os.path.abspath(relative_path))
 		+ "/.." * go_up
-	)
+	) or "."
 
 
 # Function that returns the relative path of a file
@@ -139,9 +139,9 @@ def relative_path(file_path: str, relative_to: str = os.getcwd()) -> str:
 	file_path = clean_path(file_path)
 	relative_to = clean_path(relative_to)
 	if file_path.startswith(relative_to):
-		return clean_path(os.path.relpath(file_path, relative_to))
+		return clean_path(os.path.relpath(file_path, relative_to)) or "."
 	else:
-		return file_path
+		return file_path or "."
 
 
 # For easy file management

stouputils-1.3.19/stouputils/dont_look/zip_file_override.py

@@ -1,122 +0,0 @@
-"""
-This module provides a zip file override to handle some corrupted zip files.
-
-For instance, some Minecraft servers resource packs are slightly corrupted
-and cannot be opened with the standard zipfile module.
-See the archive.py module for more information.
-"""
-
-# Imports
-from zipfile import (
-	_FH_EXTRA_FIELD_LENGTH,  # type: ignore
-	ZipExtFile,
-	ZipFile,
-	ZipInfo,
-	_SharedFile,  # type: ignore
-	crc32,  # type: ignore
-	sizeFileHeader,  # type: ignore
-	struct,  # type: ignore
-	structFileHeader,  # type: ignore
-)
-
-
-# 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
-			return
-		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'.
-
-		name is a string for the file name within the ZIP file, or a ZipInfo
-		object.
-
-		mode should be 'r' to read a file already in the ZIP file, or 'w' to
-		write to a file newly added to the archive.
-
-		pwd is the password to decrypt files (only used for reading).
-
-		When writing, if the file size is not known in advance but may exceed
-		2 GiB, pass force_zip64 to use the ZIP64 format, which can handle large
-		files.  If the size is known in advance, it is best to pass a ZipInfo
-		instance for name, with zinfo.file_size set.
-		"""
-		if mode not in {"r", "w"}:
-			raise ValueError('open() requires mode "r" or "w"')
-		if pwd and (mode == "w"):
-			raise ValueError("pwd is only supported for reading files")
-		if not self.fp:
-			raise ValueError(
-				"Attempt to use ZIP archive that was already closed")
-
-		# Make sure we have an info object
-		if isinstance(name, ZipInfo):
-			# 'name' is already an info object
-			zinfo = name
-		elif mode == 'w':
-			zinfo = ZipInfo(name)
-			zinfo.compress_type = self.compression
-			zinfo._compresslevel = self.compresslevel	# type: ignore
-		else:
-			# Get info object for name
-			zinfo = self.getinfo(name)
-
-		if mode == 'w':
-			return self._open_to_write(zinfo, force_zip64=force_zip64)	# type: ignore
-
-		if self._writing:	# type: ignore
-			raise ValueError("Can't read from the ZIP file while there "
-					"is an open writing handle on it. "
-					"Close the writing handle before trying to read.")
-
-		# Open for reading:
-		self._fileRefCnt += 1	# type: ignore
-		zef_file = _SharedFile(self.fp, zinfo.header_offset,	# type: ignore
-								self._fpclose, self._lock, lambda: self._writing)	# type: ignore
-		try:
-			# Skip the file header:
-			fheader = zef_file.read(sizeFileHeader)	# type: ignore
-			fheader = struct.unpack(structFileHeader, fheader)	# type: ignore
-
-			if fheader[_FH_EXTRA_FIELD_LENGTH]:
-				zef_file.seek(fheader[_FH_EXTRA_FIELD_LENGTH], whence=1)	# type: ignore
-
-			if zinfo.flag_bits & 0x20:
-				# Zip 2.7: compressed patched data
-				raise NotImplementedError("compressed patched data (flag bit 5)")
-
-			if zinfo.flag_bits & 0x40:
-				# strong encryption
-				raise NotImplementedError("strong encryption (flag bit 6)")
-
-			# 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)")
-
-			# check for encrypted flag & handle password
-			is_encrypted = zinfo.flag_bits & 0x1
-			if is_encrypted:
-				if not pwd:
-					pwd = self.pwd
-				if pwd and not isinstance(pwd, bytes):	# type: ignore
-					raise TypeError(f"pwd: expected bytes, got {type(pwd).__name__}")
-				if not pwd:
-					raise RuntimeError(f"File {name!r} is encrypted, password required for extraction")
-			else:
-				pwd = None
-
-			return ZipExtFileOverride(zef_file, mode, zinfo, pwd, True)	# type: ignore
-		except:
-			zef_file.close()	# type: ignore
-			raise
-