hunterMakesPy 0.2.4__py3-none-any.whl → 0.3.1__py3-none-any.whl

hunterMakesPy/__init__.py

@@ -7,23 +7,29 @@ This package provides:
 - Utilities for string extraction from nested data structures and merging dictionaries of lists.
 
 """
-# pyright: reportUnusedImport=false
+
+# isort: split
 from hunterMakesPy.theTypes import identifierDotAttribute as identifierDotAttribute
 
+# isort: split
 from hunterMakesPy.coping import PackageSettings as PackageSettings, raiseIfNone as raiseIfNone
 
-from hunterMakesPy.parseParameters import (defineConcurrencyLimit as defineConcurrencyLimit, intInnit as intInnit,
-	oopsieKwargsie as oopsieKwargsie)
+# isort: split
+from hunterMakesPy.parseParameters import (
+	defineConcurrencyLimit as defineConcurrencyLimit, intInnit as intInnit, oopsieKwargsie as oopsieKwargsie)
 
-from hunterMakesPy.filesystemToolkit import (importLogicalPath2Identifier as importLogicalPath2Identifier,
+# isort: split
+from hunterMakesPy.filesystemToolkit import (
+	importLogicalPath2Identifier as importLogicalPath2Identifier,
 	importPathFilename2Identifier as importPathFilename2Identifier, makeDirsSafely as makeDirsSafely,
-	writeStringToHere as writeStringToHere)
-
-from hunterMakesPy.dataStructures import stringItUp as stringItUp, updateExtendPolishDictionaryLists as updateExtendPolishDictionaryLists
+	writePython as writePython, writeStringToHere as writeStringToHere)
 
-import sys
+# isort: split
+from hunterMakesPy.dataStructures import (
+	stringItUp as stringItUp, updateExtendPolishDictionaryLists as updateExtendPolishDictionaryLists)
 
-if sys.version_info < (3, 14):
-    from hunterMakesPy.dataStructures import autoDecodingRLE as autoDecodingRLE
+# isort: split
+from hunterMakesPy.dataStructures import autoDecodingRLE as autoDecodingRLE
 
-from hunterMakesPy._theSSOT import settingsPackage
+# isort: split
+from hunterMakesPy._theSSOT import settingsPackage  # pyright: ignore[reportUnusedImport]

hunterMakesPy/_theSSOT.py

@@ -1,4 +1,4 @@
 """Settings for this package."""
 from hunterMakesPy import PackageSettings
 
-settingsPackage = PackageSettings(identifierPackageFALLBACK="hunterMakesPy")
+settingsPackage: PackageSettings = PackageSettings(identifierPackageFALLBACK='hunterMakesPy')

hunterMakesPy/coping.py

@@ -22,7 +22,7 @@ def getPathPackageINSTALLING(identifierPackage: str) -> Path:
 	try:
 		moduleSpecification: ModuleSpec | None = find_spec(identifierPackage)
 		if moduleSpecification and moduleSpecification.origin:
-			pathFilename = Path(moduleSpecification.origin)
+			pathFilename: Path = Path(moduleSpecification.origin)
 			return pathFilename.parent if pathFilename.is_file() else pathFilename
 	except ModuleNotFoundError:
 		pass
@@ -148,6 +148,6 @@ def raiseIfNone(expression: TypeSansNone | None, errorMessage: str | None = None
 
 	"""
 	if expression is None:
-		message = errorMessage or 'A function unexpectedly returned `None`. Hint: look at the traceback immediately before `raiseIfNone`.'
+		message: str = errorMessage or 'A function unexpectedly returned `None`. Hint: look at the traceback immediately before `raiseIfNone`.'
 		raise ValueError(message)
 	return expression

hunterMakesPy/dataStructures.py

@@ -1,19 +1,17 @@
 """Provides utilities for string extraction from nested data structures and merges multiple dictionaries containing lists into one dictionary."""
 
-from collections.abc import Iterator, Mapping
+from collections.abc import Mapping
 from numpy import integer
 from numpy.typing import NDArray
-from typing import Any
+from typing import Any, Protocol, TYPE_CHECKING, TypeVar
 import more_itertools
 import re as regex
 
-def removeExtraWhitespace(text: str) -> str:
-	"""Remove extra whitespace from string representation of Python data structures.
+if TYPE_CHECKING:
+	from collections.abc import Iterator
 
-	This function replaces python_minifier.minify() for the specific use case of
-	minimizing string representations of lists, tuples, ranges, etc. It removes
-	spaces after commas, around brackets and parentheses.
-	"""
+def removeExtraWhitespace(text: str) -> str:
+	"""Remove extra whitespace from string representation of Python data structures."""
 	# Remove spaces after commas
 	text = regex.sub(r',\s+', ',', text)
 	# Remove spaces after opening brackets/parens
@@ -193,13 +191,13 @@ def stringItUp(*scrapPile: Any) -> list[str]:
 			case str():
 				listStrungUp.append(KitKat)
 			case bool() | bytearray() | bytes() | complex() | float() | int() | memoryview() | None:
-				listStrungUp.append(str(KitKat)) # pyright: ignore [reportUnknownArgumentType]
+				listStrungUp.append(str(KitKat))
 			case dict():
-				for broken, piece in KitKat.items(): # pyright: ignore [reportUnknownVariableType]
+				for broken, piece in KitKat.items():
 					drill(broken)
 					drill(piece)
 			case list() | tuple() | set() | frozenset() | range():
-				for kit in KitKat: # pyright: ignore [reportUnknownVariableType]
+				for kit in KitKat:
 					drill(kit)
 			case _:
 				if hasattr(KitKat, '__iter__'):  # Unpack other iterables
@@ -223,38 +221,50 @@ def stringItUp(*scrapPile: Any) -> list[str]:
 		listStrungUp.append(repr(scrap))
 	return listStrungUp
 
-def updateExtendPolishDictionaryLists(*dictionaryLists: Mapping[str, list[Any] | set[Any] | tuple[Any, ...]], destroyDuplicates: bool = False, reorderLists: bool = False, killErroneousDataTypes: bool = False) -> dict[str, list[Any]]:
-	"""Merge multiple dictionaries containing `list` into a single dictionary.
+class Ordinals(Protocol):
+	"""Protocol for types that support ordering comparisons."""
+
+	def __le__(self, other: "Ordinals", /) -> bool:
+		"""Less than or equal to comparison."""
+		...
+	def __ge__(self, other: "Ordinals", /) -> bool:
+		"""Greater than or equal to comparison."""
+		...
 
-	With options to handle duplicates, `list` ordering, and erroneous data types.
+小于 = TypeVar('小于', bound=Ordinals)
+
+def updateExtendPolishDictionaryLists(*dictionaryLists: Mapping[str, list[小于] | set[小于] | tuple[小于, ...]], destroyDuplicates: bool = False, reorderLists: bool = False, killErroneousDataTypes: bool = False) -> dict[str, list[小于]]:
+	"""Merge multiple dictionaries with `list` values into a single dictionary with the `list` values merged.
+
+	Plus options to destroy duplicates, sort `list` values, and handle erroneous data types.
 
 	Parameters
 	----------
 	*dictionaryLists : Mapping[str, list[Any] | set[Any] | tuple[Any, ...]]
-		(dictionary2lists) Variable number of dictionaries to be merged. If only one dictionary is passed, it will be processed based on the provided options.
+		Variable number of dictionaries to be merged. If only one dictionary is passed, it will be "polished".
 	destroyDuplicates : bool = False
-		(destroy2duplicates) If `True`, removes duplicate elements from the `list`. Defaults to `False`.
+		If `True`, removes duplicate elements from the `list`. Defaults to `False`.
 	reorderLists : bool = False
-		(reorder2lists) If `True`, sorts the `list`. Defaults to `False`.
+		If `True`, sorts each `list` value. Defaults to `False`. The elements must be comparable; otherwise, a `TypeError` will be raised.
 	killErroneousDataTypes : bool = False
-		(kill2erroneous2data2types) If `True`, skips dictionary keys or dictionary values that cause a `TypeError` during merging. Defaults to `False`.
+		If `True`, suppresses any `TypeError` `Exception` and omits the dictionary key or value that caused the `Exception`.
+		Defaults to `False`.
 
 	Returns
 	-------
 	ePluribusUnum : dict[str, list[Any]]
-		(e2pluribus2unum) A single dictionary with merged `list` based on the provided options. If only one dictionary is passed,
-		it will be cleaned up based on the options.
+		A single dictionary with merged and optionally "polished" `list` values.
 
 	Notes
 	-----
 	The returned value, `ePluribusUnum`, is a so-called primitive dictionary (`dict`). Furthermore, every dictionary key is a
-	so-called primitive string (cf. `str()`) and every dictionary value is a so-called primitive `list` (`list`). If
+	so-called primitive string (*cf.* `str()`) and every dictionary value is a so-called primitive `list` (`list`). If
 	`dictionaryLists` has other data types, the data types will not be preserved. That could have unexpected consequences.
 	Conversion from the original data type to a `list`, for example, may not preserve the order even if you want the order to be
 	preserved.
 
 	"""
-	ePluribusUnum: dict[str, list[Any]] = {}
+	ePluribusUnum: dict[str, list[小于]] = {}
 
 	for dictionaryListTarget in dictionaryLists:
 		for keyName, keyValue in dictionaryListTarget.items():
@@ -272,7 +282,7 @@ def updateExtendPolishDictionaryLists(*dictionaryLists: Mapping[str, list[Any] |
 		for ImaStr, ImaList in ePluribusUnum.items():
 			ePluribusUnum[ImaStr] = list(dict.fromkeys(ImaList))
 	if reorderLists:
-		for ImaStr, ImaList in ePluribusUnum.items():
-			ePluribusUnum[ImaStr] = sorted(ImaList)
+		for ImaStr, ImaRichComparisonSupporter in ePluribusUnum.items():
+			ePluribusUnum[ImaStr] = sorted(ImaRichComparisonSupporter)
 
 	return ePluribusUnum

hunterMakesPy/filesystemToolkit.py

@@ -3,8 +3,9 @@
 This module provides basic file I/O utilities such as importing callables from modules, safely creating directories, and writing to files or streams (pipes).
 
 """
-
+from autoflake import fix_code as autoflake_fix_code
 from hunterMakesPy import identifierDotAttribute
+from isort import code as isort_code
 from os import PathLike
 from pathlib import Path, PurePath
 from typing import Any, TYPE_CHECKING, TypeVar
@@ -14,6 +15,7 @@ import importlib.util
 import io
 
 if TYPE_CHECKING:
+	from importlib.machinery import ModuleSpec
 	from types import ModuleType
 
 归个 = TypeVar('归个')
@@ -71,9 +73,9 @@ def importPathFilename2Identifier(pathFilename: PathLike[Any] | PurePath, identi
 	"""
 	pathFilename = Path(pathFilename)
 
-	importlibSpecification = importlib.util.spec_from_file_location(moduleIdentifier or pathFilename.stem, pathFilename)
+	importlibSpecification: ModuleSpec | None = importlib.util.spec_from_file_location(moduleIdentifier or pathFilename.stem, pathFilename)
 	if importlibSpecification is None or importlibSpecification.loader is None:
-		message = f"I received\n\t`{pathFilename = }`,\n\t`{identifier = }`, and\n\t`{moduleIdentifier = }`.\n\tAfter loading, \n\t`importlibSpecification` {'is `None`' if importlibSpecification is None else 'has a value'} and\n\t`importlibSpecification.loader` is unknown."
+		message: str = f"I received\n\t`{pathFilename = }`,\n\t`{identifier = }`, and\n\t`{moduleIdentifier = }`.\n\tAfter loading, \n\t`importlibSpecification` {'is `None`' if importlibSpecification is None else 'has a value'} and\n\t`importlibSpecification.loader` is unknown."
 		raise ImportError(message)
 
 	moduleImported_jk_hahaha: ModuleType = importlib.util.module_from_spec(importlibSpecification)
@@ -97,6 +99,59 @@ def makeDirsSafely(pathFilename: Any) -> None:
 		with contextlib.suppress(OSError):
 			Path(pathFilename).parent.mkdir(parents=True, exist_ok=True)
 
+settings_autoflakeDEFAULT: dict[str, list[str] | bool] = {
+	'additional_imports': [],
+	'expand_star_imports': True,
+	'remove_all_unused_imports': True,
+	'remove_duplicate_keys': False,
+	'remove_unused_variables': False,
+}
+
+settings_isortDEFAULT: dict[str, bool | int | str | list[str]] = {
+	"combine_as_imports": True,
+	"force_alphabetical_sort_within_sections": True,
+	"from_first": True,
+	"honor_noqa": True,
+	"indent": "\t",
+	"line_length": 120,
+	"lines_after_imports": 1,
+	"lines_between_types": 0,
+	"multi_line_output": 4,
+	"no_sections": True,
+	"skip": ["__init__.py"], # TODO think
+	"use_parentheses": True,
+}
+
+def writePython(pythonSource: str, pathFilename: PathLike[Any] | PurePath | io.TextIOBase, settings: dict[str, dict[str, Any]] | None = None) -> None:
+	"""Format and write Python source code to a file or text stream.
+
+	(AI generated docstring)
+
+	This function processes Python source code through autoflake and isort formatters before writing to the specified destination.
+	The formatters remove unused imports, sort imports, and apply consistent code style according to the provided or default
+	settings.
+
+	Parameters
+	----------
+	pythonSource : str
+		The Python source code to format and write.
+	pathFilename : PathLike[Any] | PurePath | io.TextIOBase
+		The target destination: either a file path or an open text stream.
+	settings : dict[str, dict[str, Any]] | None = None
+		Configuration for the formatters. Keys are `'autoflake'` and `'isort'`, each mapping to a dictionary of formatter-specific
+		settings. If `None`, default settings are used for both formatters.
+
+	"""
+	if settings is None:
+		settings = {}
+
+	settings_autoflake: dict[str, Any] = settings.get('autoflake', settings_autoflakeDEFAULT)
+	pythonSource = autoflake_fix_code(pythonSource, **settings_autoflake)
+
+	settings_isort: dict[str, Any] = settings.get('isort', settings_isortDEFAULT)
+	pythonSource = isort_code(pythonSource, **settings_isort)
+	writeStringToHere(pythonSource + '\n', pathFilename)
+
 def writeStringToHere(this: str, pathFilename: PathLike[Any] | PurePath | io.TextIOBase) -> None:
 	"""Write a string to a file or text stream.
 

hunterMakesPy/parseParameters.py

@@ -1,10 +1,13 @@
 """Provides parameter and input validation, integer parsing, and concurrency handling utilities."""
 from collections.abc import Iterable, Sized
 from dataclasses import dataclass
-from typing import Any
+from typing import Any, TYPE_CHECKING
 import charset_normalizer
 import multiprocessing
 
+if TYPE_CHECKING:
+	from charset_normalizer.models import CharsetMatch
+
 @dataclass
 class ErrorMessageContext:
 	"""Context information for constructing error messages.
@@ -52,7 +55,7 @@ def _constructErrorMessage(context: ErrorMessageContext, parameterName: str, par
 		The constructed error message string.
 
 	"""
-	messageParts = ["I received "]
+	messageParts: list[str] = ["I received "]
 
 	if context.parameterValue is not None and not isinstance(context.parameterValue, (bytes, bytearray, memoryview)):
 		messageParts.append(f'"{context.parameterValue}"')
@@ -131,15 +134,15 @@ def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int =
 	```
 
 	"""
-	concurrencyLimit = cpuTotal
+	concurrencyLimit: int = cpuTotal
 
 	if isinstance(limit, str):
-		limitFromString = oopsieKwargsie(limit)
+		limitFromString: bool | None | str = oopsieKwargsie(limit)
 		if isinstance(limitFromString, str):
 			try:
 				limit = float(limitFromString)
 			except ValueError as ERRORmessage:
-				message = f"I received '{limitFromString}', but it must be a number, `True`, `False`, or `None`."
+				message: str = f"I received '{limitFromString}', but it must be a number, `True`, `False`, or `None`."
 				raise ValueError(message) from ERRORmessage
 		else:
 			limit = limitFromString
@@ -208,19 +211,19 @@ def intInnit(listInt_Allegedly: Iterable[Any], parameterName: str | None = None,
 		message = f"I did not receive a value for {parameterName}, but it is required."
 		raise ValueError(message)
 
-	# Be nice: assume the input container is valid and every element is valid.  # noqa: ERA001
+	# Be nice, and assume the input container is valid and every element is valid.
 	# Nevertheless, this is a "fail-early" step, so reject ambiguity and try to induce errors now that could be catastrophic later.
 	try:
 		iter(listInt_Allegedly)
-		lengthInitial = None
+		lengthInitial: int | None = None
 		if isinstance(listInt_Allegedly, Sized):
 			lengthInitial = len(listInt_Allegedly)
 
 		listValidated: list[int] = []
 
 		for allegedInt in listInt_Allegedly:
-# ruff: noqa: PLW2901
-			errorMessageContext = ErrorMessageContext(
+
+			errorMessageContext: ErrorMessageContext = ErrorMessageContext(
 				parameterValue = allegedInt,
 				parameterValueType = type(allegedInt).__name__,
 				isElement = True
@@ -237,7 +240,7 @@ def intInnit(listInt_Allegedly: Iterable[Any], parameterName: str | None = None,
 				errorMessageContext.parameterValue = None  # Don't expose potentially garbled binary data in error messages
 				if isinstance(allegedInt, memoryview):
 					allegedInt = allegedInt.tobytes()
-				decodedString = charset_normalizer.from_bytes(allegedInt).best()
+				decodedString: CharsetMatch | None = charset_normalizer.from_bytes(allegedInt).best()
 				if not decodedString:
 					raise ValueError(errorMessageContext)
 				allegedInt = errorMessageContext.parameterValue = str(decodedString)
@@ -308,7 +311,7 @@ def oopsieKwargsie(huh: Any) -> bool | None | str:
 			huh = str(huh)
 		except BaseException:  # noqa: BLE001
 			return huh
-	formatted = huh.strip().title()
+	formatted: str = huh.strip().title()
 	if formatted == str(True):
 		return True
 	if formatted == str(False):

hunterMakesPy/tests/test_filesystemToolkit.py

@@ -1,5 +1,6 @@
 # pyright: standard
-from hunterMakesPy import importLogicalPath2Identifier, importPathFilename2Identifier, makeDirsSafely, writeStringToHere
+from hunterMakesPy import (
+	importLogicalPath2Identifier, importPathFilename2Identifier, makeDirsSafely, writePython, writeStringToHere)
 from hunterMakesPy.tests.conftest import standardizedEqualTo
 import io
 import math
@@ -261,3 +262,188 @@ def testImportPathFilename2IdentifierWithValidFileInvalidIdentifier(
 		identifierTarget
 	)
 
+
+@pytest.mark.parametrize(
+	"pythonSourceTarget, expectedFormattedContent",
+	[
+		(
+			"import sys\nimport os\nimport math\n\ndef fibonacciFunction():\n    return 13\n",
+			"\ndef fibonacciFunction():\n    return 13\n\n"
+		),
+		(
+			"from pathlib import Path\nimport sys\nimport os\n\ndef primeFunction():\n    return 17\n",
+			"\ndef primeFunction():\n    return 17\n\n"
+		),
+		(
+			"import unused\nimport sys\n\nvalueCardinal = sys.version\n",
+			"import sys\n\nvalueCardinal = sys.version\n\n"
+		),
+		(
+			"import math\n\nvalueFibonacci = math.sqrt(21)\n",
+			"import math\n\nvalueFibonacci = math.sqrt(21)\n\n"
+		),
+	]
+)
+def testWritePythonFormatsAndWritesToFile(
+	pathTmpTesting: pathlib.Path,
+	pythonSourceTarget: str,
+	expectedFormattedContent: str
+) -> None:
+	"""Test that writePython formats Python source code and writes it to files."""
+	pathFilenameTarget = pathTmpTesting / "formattedModule.py"
+	writePython(pythonSourceTarget, pathFilenameTarget)
+
+	assert pathFilenameTarget.exists(), (
+		f"\nTesting: `writePython(..., {pathFilenameTarget})`\n"
+		f"Expected: File {pathFilenameTarget} to exist\n"
+		f"Got: exists={pathFilenameTarget.exists()}"
+	)
+
+	contentActual = pathFilenameTarget.read_text(encoding="utf-8")
+	assert contentActual == expectedFormattedContent, (
+		f"\nTesting: `writePython(...)`\n"
+		f"Expected content:\n{repr(expectedFormattedContent)}\n"
+		f"Got content:\n{repr(contentActual)}"
+	)
+
+
+@pytest.mark.parametrize(
+	"pythonSourceTarget, expectedFormattedContent",
+	[
+		(
+			"import sys\nimport unused\n\ndef cardinalFunction():\n    return sys.version\n",
+			"import sys\n\ndef cardinalFunction():\n    return sys.version\n\n"
+		),
+		(
+			"from pathlib import Path\nfrom os import getcwd\nimport math\n\nvalueSequence = getcwd()\n",
+			"from os import getcwd\n\nvalueSequence = getcwd()\n\n"
+		),
+	]
+)
+def testWritePythonFormatsAndWritesToStream(
+	pythonSourceTarget: str,
+	expectedFormattedContent: str
+) -> None:
+	"""Test that writePython formats Python source code and writes it to IO streams."""
+	streamMemory = io.StringIO()
+	writePython(pythonSourceTarget, streamMemory)
+
+	contentActual = streamMemory.getvalue()
+	assert contentActual == expectedFormattedContent, (
+		f"\nTesting: `writePython(..., StringIO)`\n"
+		f"Expected content:\n{repr(expectedFormattedContent)}\n"
+		f"Got content:\n{repr(contentActual)}"
+	)
+
+
+@pytest.mark.parametrize(
+	"pythonSourceTarget, settingsCustom, expectedFormattedContent",
+	[
+		(
+			"import math\nimport unused\n\nvalueFibonacci = 34\n\ndef fibonacciFunction():\n    return math.sqrt(13)\n",
+			{'autoflake': {'remove_all_unused_imports': True, 'remove_unused_variables': False}},
+			"import math\n\nvalueFibonacci = 34\n\ndef fibonacciFunction():\n    return math.sqrt(13)\n\n"
+		),
+		(
+			"from pathlib import Path\nimport sys\n\nvaluePrime = Path.cwd()\n",
+			{'isort': {'force_alphabetical_sort_within_sections': False, 'from_first': False}},
+			"from pathlib import Path\n\nvaluePrime = Path.cwd()\n\n"
+		),
+	]
+)
+def testWritePythonWithCustomSettings(
+	pathTmpTesting: pathlib.Path,
+	pythonSourceTarget: str,
+	settingsCustom: dict[str, dict[str, object]],
+	expectedFormattedContent: str
+) -> None:
+	"""Test that writePython respects custom formatter settings."""
+	pathFilenameTarget = pathTmpTesting / "customFormattedModule.py"
+	writePython(pythonSourceTarget, pathFilenameTarget, settingsCustom)
+
+	contentActual = pathFilenameTarget.read_text(encoding="utf-8")
+	assert contentActual == expectedFormattedContent, (
+		f"\nTesting: `writePython(..., custom settings)`\n"
+		f"Expected content:\n{repr(expectedFormattedContent)}\n"
+		f"Got content:\n{repr(contentActual)}"
+	)
+
+
+@pytest.mark.parametrize(
+	"pythonSourceTarget",
+	[
+		"import math\nimport sys\n\nvalueFibonacci = 34\n",
+		"from pathlib import Path\n\nvalueCardinal = 'SW'\n",
+		"def primeFunction():\n    return 37\n",
+	]
+)
+def testWritePythonCreatesNestedDirectories(
+	pathTmpTesting: pathlib.Path,
+	pythonSourceTarget: str
+) -> None:
+	"""Test that writePython creates nested directories when writing to files."""
+	pathFilenameTarget = pathTmpTesting / "nested" / "directories" / "module.py"
+	writePython(pythonSourceTarget, pathFilenameTarget)
+
+	assert pathFilenameTarget.exists(), (
+		f"\nTesting: `writePython(..., {pathFilenameTarget})`\n"
+		f"Expected: File {pathFilenameTarget} to exist\n"
+		f"Got: exists={pathFilenameTarget.exists()}"
+	)
+
+	assert pathFilenameTarget.parent.exists(), (
+		f"\nTesting: `writePython(..., {pathFilenameTarget})`\n"
+		f"Expected: Parent directory {pathFilenameTarget.parent} to exist\n"
+		f"Got: exists={pathFilenameTarget.parent.exists()}"
+	)
+
+
+@pytest.mark.parametrize(
+	"pythonSourceTarget, expectedContainsImport",
+	[
+		("import math\n\nvaluePrime = math.sqrt(41)\n", "import math"),
+		("from os import getcwd\n\nvalueSequence = getcwd()\n", "from os import getcwd"),
+		("import sys\n\nvalueFibonacci = sys.version\n", "import sys"),
+	]
+)
+def testWritePythonPreservesUsedImports(
+	pathTmpTesting: pathlib.Path,
+	pythonSourceTarget: str,
+	expectedContainsImport: str
+) -> None:
+	"""Test that writePython preserves imports that are actually used in the code."""
+	pathFilenameTarget = pathTmpTesting / "preservedImports.py"
+	writePython(pythonSourceTarget, pathFilenameTarget)
+
+	contentActual = pathFilenameTarget.read_text(encoding="utf-8")
+	assert expectedContainsImport in contentActual, (
+		f"\nTesting: `writePython(...)` preserves used imports\n"
+		f"Expected content to contain: {expectedContainsImport}\n"
+		f"Got content:\n{contentActual}"
+	)
+
+
+@pytest.mark.parametrize(
+	"pythonSourceTarget, expectedNotContainsImport",
+	[
+		("import math\nimport unused\n\nvaluePrime = 43\n", "import unused"),
+		("from os import getcwd, unused\n\nvalueSequence = getcwd()\n", "unused"),
+		("import sys\nimport collections\n\nvalueFibonacci = sys.version\n", "import collections"),
+	]
+)
+def testWritePythonRemovesUnusedImports(
+	pathTmpTesting: pathlib.Path,
+	pythonSourceTarget: str,
+	expectedNotContainsImport: str
+) -> None:
+	"""Test that writePython removes imports that are not used in the code."""
+	pathFilenameTarget = pathTmpTesting / "removedImports.py"
+	writePython(pythonSourceTarget, pathFilenameTarget)
+
+	contentActual = pathFilenameTarget.read_text(encoding="utf-8")
+	assert expectedNotContainsImport not in contentActual, (
+		f"\nTesting: `writePython(...)` removes unused imports\n"
+		f"Expected content to NOT contain: {expectedNotContainsImport}\n"
+		f"Got content:\n{contentActual}"
+	)
+

hunterMakesPy/tests/test_parseParameters.py

@@ -8,7 +8,7 @@ import pytest
 parameters = ParamSpec('parameters')
 returnType = TypeVar('returnType')
 
-def PytestFor_defineConcurrencyLimit(callableToTest: Callable[..., int] = defineConcurrencyLimit, cpuCount: int = 8) -> list[tuple[str, Callable[[], None]]]:  # noqa: C901
+def PytestFor_defineConcurrencyLimit(callableToTest: Callable[..., int] = defineConcurrencyLimit, cpuCount: int = 8) -> list[tuple[str, Callable[[], None]]]:
 	"""Return a list of test functions to validate concurrency limit behavior.
 
 	This function provides a comprehensive test suite for validating concurrency limit parsing
@@ -80,15 +80,17 @@ def PytestFor_defineConcurrencyLimit(callableToTest: Callable[..., int] = define
 	@patch('multiprocessing.cpu_count', return_value=cpuCount)
 	def testBooleanTrue(_mockCpu: Mock) -> None:
 		assert callableToTest(limit=True, cpuTotal=cpuCount) == 1
-		assert callableToTest(limit='True', cpuTotal=cpuCount) == 1  # pyright: ignore[reportArgumentType]
-		assert callableToTest(limit='TRUE', cpuTotal=cpuCount) == 1 # pyright: ignore[reportArgumentType]
-		assert callableToTest(limit=' true ', cpuTotal=cpuCount) == 1 # pyright: ignore[reportArgumentType]
+# pyright: reportArgumentType=false
+		assert callableToTest(limit='True', cpuTotal=cpuCount) == 1
+		assert callableToTest(limit='TRUE', cpuTotal=cpuCount) == 1
+		assert callableToTest(limit=' true ', cpuTotal=cpuCount) == 1
+# pyright: reportArgumentType=true
 
 	@patch('multiprocessing.cpu_count', return_value=cpuCount)
 	def testInvalidStrings(_mockCpu: Mock) -> None:
 		for stringInput in ["invalid", "True but not quite", "None of the above"]:
 			with pytest.raises(ValueError, match="must be a number, `True`, `False`, or `None`"):
-				callableToTest(limit=stringInput, cpuTotal=cpuCount) # pyright: ignore[reportArgumentType]
+				callableToTest(limit=stringInput, cpuTotal=cpuCount)
 
 	@patch('multiprocessing.cpu_count', return_value=cpuCount)
 	def testStringNumbers(_mockCpu: Mock) -> None:
@@ -100,7 +102,7 @@ def PytestFor_defineConcurrencyLimit(callableToTest: Callable[..., int] = define
 			("-0.25", 6),
 		]
 		for stringNumber, expectedLimit in testCases:
-			assert callableToTest(limit=stringNumber, cpuTotal=cpuCount) == expectedLimit # pyright: ignore[reportArgumentType]
+			assert callableToTest(limit=stringNumber, cpuTotal=cpuCount) == expectedLimit
 
 	return [
 		('testDefaults', testDefaults),
@@ -112,7 +114,7 @@ def PytestFor_defineConcurrencyLimit(callableToTest: Callable[..., int] = define
 		('testStringNumbers', testStringNumbers)
 	]
 
-def PytestFor_intInnit(callableToTest: Callable[[Iterable[int], str | None, type[Any] | None], list[int]] = intInnit) -> list[tuple[str, Callable[[], None]]]:  # noqa: C901
+def PytestFor_intInnit(callableToTest: Callable[[Iterable[int], str | None, type[Any] | None], list[int]] = intInnit) -> list[tuple[str, Callable[[], None]]]:
 	"""Return a list of test functions to validate integer initialization behavior.
 
 	This function provides a comprehensive test suite for validating integer parsing
@@ -156,64 +158,64 @@ def PytestFor_intInnit(callableToTest: Callable[[Iterable[int], str | None, type
 	"""
 	def testHandlesValidIntegers() -> None:
 		assert callableToTest([2, 3, 5, 8], 'test', None) == [2, 3, 5, 8]
-		assert callableToTest([13.0, 21.0, 34.0], 'test', None) == [13, 21, 34] # pyright: ignore[reportArgumentType]
-		assert callableToTest(['55', '89', '144'], 'test', None) == [55, 89, 144] # pyright: ignore[reportArgumentType]
-		assert callableToTest([' 233 ', '377', '-610'], 'test', None) == [233, 377, -610] # pyright: ignore[reportArgumentType]
+		assert callableToTest([13.0, 21.0, 34.0], 'test', None) == [13, 21, 34]
+		assert callableToTest(['55', '89', '144'], 'test', None) == [55, 89, 144]
+		assert callableToTest([' 233 ', '377', '-610'], 'test', None) == [233, 377, -610]
 
 	def testRejectsNonWholeNumbers() -> None:
 		listInvalidNumbers: list[float] = [13.7, 21.5, 34.8, -55.9]
 		for invalidNumber in listInvalidNumbers:
 			with pytest.raises(ValueError):
-				callableToTest([invalidNumber], 'test', None) # pyright: ignore[reportArgumentType]
-
-	def testRejectsBooleans() -> None:
-		with pytest.raises(TypeError):
-			callableToTest([True, False], 'test', None)
+				callableToTest([invalidNumber], 'test', None)
 
 	def testRejectsInvalidStrings() -> None:
 		for invalidString in ['NW', '', ' ', 'SE.SW']:
 			with pytest.raises(ValueError):
-				callableToTest([invalidString], 'test', None) # pyright: ignore[reportArgumentType]
+				callableToTest([invalidString], 'test', None)
+
+	def testHandlesMixedValidTypes() -> None:
+		assert callableToTest([13, '21', 34.0], 'test', None) == [13, 21, 34]
+
+	def testRejectsBooleans() -> None:
+		with pytest.raises(TypeError):
+			callableToTest([True, False], 'test', None)
 
 	def testRejectsEmptyList() -> None:
 		with pytest.raises(ValueError):
 			callableToTest([], 'test', None)
 
-	def testHandlesMixedValidTypes() -> None:
-		assert callableToTest([13, '21', 34.0], 'test', None) == [13, 21, 34] # pyright: ignore[reportArgumentType]
-
 	def testHandlesBytes() -> None:
 		validCases: list[tuple[list[bytes], str, list[int]]] = [
 			([b'123'], '123', [123]),
 		]
 		for inputData, testName, expected in validCases:
-			assert callableToTest(inputData, testName, None) == expected # pyright: ignore[reportArgumentType]
+			assert callableToTest(inputData, testName, None) == expected
 
 		extendedCases: list[tuple[list[bytes], str, list[int]]] = [
 			([b'123456789'], '123456789', [123456789]),
 		]
 		for inputData, testName, expected in extendedCases:
-			assert callableToTest(inputData, testName, None) == expected # pyright: ignore[reportArgumentType]
+			assert callableToTest(inputData, testName, None) == expected
 
 		invalidCases: list[list[bytes]] = [[b'\x00']]
 		for inputData in invalidCases:
 			with pytest.raises(ValueError):
-				callableToTest(inputData, 'test', None) # pyright: ignore[reportArgumentType]
+				callableToTest(inputData, 'test', None)
 
 	def testHandlesMemoryview() -> None:
 		validCases: list[tuple[list[memoryview], str, list[int]]] = [
 			([memoryview(b'123')], '123', [123]),
 		]
 		for inputData, testName, expected in validCases:
-			assert callableToTest(inputData, testName, None) == expected # pyright: ignore[reportArgumentType]
+			assert callableToTest(inputData, testName, None) == expected
 
 		largeMemoryviewCase: list[memoryview] = [memoryview(b'9999999999')]
-		assert callableToTest(largeMemoryviewCase, 'test', None) == [9999999999] # pyright: ignore[reportArgumentType]
+		assert callableToTest(largeMemoryviewCase, 'test', None) == [9999999999]
 
 		invalidMemoryviewCases: list[list[memoryview]] = [[memoryview(b'\x00')]]
 		for inputData in invalidMemoryviewCases:
 			with pytest.raises(ValueError):
-				callableToTest(inputData, 'test', None) # pyright: ignore[reportArgumentType]
+				callableToTest(inputData, 'test', None)
 
 	def testRejectsMutableSequence() -> None:
 		class MutableList(list[int]):
@@ -229,12 +231,12 @@ def PytestFor_intInnit(callableToTest: Callable[[Iterable[int], str | None, type
 			([21+0j, 34+0j], [21, 34])
 		]
 		for inputData, expected in testCases:
-			assert callableToTest(inputData, 'test', None) == expected # pyright: ignore[reportArgumentType]
+			assert callableToTest(inputData, 'test', None) == expected
 
 	def testRejectsInvalidComplex() -> None:
 		for invalidComplex in [13+1j, 21+0.5j, 34.5+0j]:
 			with pytest.raises(ValueError):
-				callableToTest([invalidComplex], 'test', None) # pyright: ignore[reportArgumentType]
+				callableToTest([invalidComplex], 'test', None)
 
 	return [
 		('testHandlesValidIntegers', testHandlesValidIntegers),
@@ -250,7 +252,7 @@ def PytestFor_intInnit(callableToTest: Callable[[Iterable[int], str | None, type
 		('testRejectsInvalidComplex', testRejectsInvalidComplex)
 	]
 
-def PytestFor_oopsieKwargsie(callableToTest: Callable[[str], bool | None | str] = oopsieKwargsie) -> list[tuple[str, Callable[[], None]]]:  # noqa: C901
+def PytestFor_oopsieKwargsie(callableToTest: Callable[[str], bool | None | str] = oopsieKwargsie) -> list[tuple[str, Callable[[], None]]]:
 	"""Return a list of test functions to validate string-to-boolean/None conversion behavior.
 
 	This function provides a comprehensive test suite for validating string parsing and conversion
@@ -312,10 +314,10 @@ def PytestFor_oopsieKwargsie(callableToTest: Callable[[str], bool | None | str]
 				message = "Cannot be stringified"
 				raise TypeError(message)
 
-		assert callableToTest(123) == "123" # pyright: ignore[reportArgumentType]
+		assert callableToTest(123) == "123"
 
 		neverGonnaStringIt = NeverGonnaStringIt()
-		result = callableToTest(neverGonnaStringIt) # pyright: ignore[reportArgumentType]
+		result = callableToTest(neverGonnaStringIt)
 		assert result is neverGonnaStringIt
 
 	return [

{huntermakespy-0.2.4.dist-info → huntermakespy-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hunterMakesPy
-Version: 0.2.4
+Version: 0.3.1
 Summary: Easy Python functions making making functional Python functions easier.
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 License: CC-BY-NC-4.0
@@ -9,7 +9,7 @@ Project-URL: Homepage, https://github.com/hunterhogan/hunterMakesPy
 Project-URL: Issues, https://github.com/hunterhogan/hunterMakesPy/issues
 Project-URL: Repository, https://github.com/hunterhogan/hunterMakesPy
 Keywords: attribute loading,concurrency limit,configuration,defensive programming,dictionary merging,directory creation,dynamic import,error propagation,file system utilities,input validation,integer parsing,module loading,nested data structures,package settings,parameter validation,pytest,string extraction,test utilities
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
@@ -30,12 +30,12 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: autoflake
 Requires-Dist: charset_normalizer
+Requires-Dist: isort
 Requires-Dist: more_itertools
 Requires-Dist: numpy
 Provides-Extra: development
-Requires-Dist: mypy; extra == "development"
-Requires-Dist: pyupgrade; extra == "development"
 Requires-Dist: setuptools-scm; extra == "development"
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"
@@ -164,13 +164,4 @@ def test_myFunction(nameOfTest, callablePytest):
 [![Static Badge](https://img.shields.io/badge/2011_August-Homeless_since-blue?style=flat)](https://HunterThinks.com/support)
 [![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UC3Gx7kz61009NbhpRtPP7tw)](https://www.youtube.com/@HunterHogan)
 
-## How to code
-
-Coding One Step at a Time:
-
-0. WRITE CODE.
-1. Don't write stupid code that's hard to revise.
-2. Write good code.
-3. When revising, write better code.
-
-[![CC-BY-NC-4.0](https://github.com/hunterhogan/hunterMakesPy/blob/main/CC-BY-NC-4.0.png)](https://creativecommons.org/licenses/by-nc/4.0/)
+[![CC-BY-NC-4.0](https://raw.githubusercontent.com/hunterhogan/hunterMakesPy/refs/heads/main/.github/CC-BY-NC-4.0.png)](https://creativecommons.org/licenses/by-nc/4.0/)

huntermakespy-0.3.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+hunterMakesPy/__init__.py,sha256=N2Bvmacvs9z8ITWWjQr6-5LQHZ1FG5KL6v-pR1m6fCY,1547
+hunterMakesPy/_theSSOT.py,sha256=x9Rdmw0qeAqgmlMFyFYRTRV5kEDYXcN4aBZ4KjlnKEU,170
+hunterMakesPy/coping.py,sha256=42a_1kB6zHeRpfbpPnjmhrgWTPvUtqE5W9z3tqu-K8w,6068
+hunterMakesPy/dataStructures.py,sha256=0-BRFriADFKX9pvjYj03ukj021ZII61wet2Wq2yAEdM,11776
+hunterMakesPy/filesystemToolkit.py,sha256=8Yx8SH56w7g9wxpLjsdCaC1RvsW8Ur_cDrxhHaY9cLM,6848
+hunterMakesPy/parseParameters.py,sha256=uQXoD89BfWAmRVT2yabyHtW7qITwAuCC9eh0sQFIV5Q,11966
+hunterMakesPy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hunterMakesPy/pytestForYourUse.py,sha256=GiN1C1gTTM0ZunRPEMnrKlLQLMdH0wF_ZGr_RPgRjjA,500
+hunterMakesPy/theTypes.py,sha256=C2d0uLn1VIx6_2CK41it3IP7iplSQqe51tzWc-RT320,306
+hunterMakesPy/tests/__init__.py,sha256=C_FzfKDi_VrGVxlenWHyOYtKShAKlt3KW14jeRx1mQI,224
+hunterMakesPy/tests/conftest.py,sha256=NZQPRiwvGhP16hJ6WGGm9eKLxfQArYV8E9X12YzSpP0,2827
+hunterMakesPy/tests/test_coping.py,sha256=mH89TUAL6fJanBLlhdVlCNNQqm5OpdcQMP_p5W2JJwo,9860
+hunterMakesPy/tests/test_dataStructures.py,sha256=OouddHjN-Km26U92jYwnjYeP6_Y2DrJLgq3qD_8GvGw,16393
+hunterMakesPy/tests/test_filesystemToolkit.py,sha256=_CoSMzstJwWZ_tkNyIqclOIIqTaY2tYfUIgxGFfC0Jk,15335
+hunterMakesPy/tests/test_parseParameters.py,sha256=UKf1hwhLtXYL96VVJNf8NpJOyzRLO204pd-9PdDjufA,13267
+huntermakespy-0.3.1.dist-info/licenses/LICENSE,sha256=NxH5Y8BdC-gNU-WSMwim3uMbID2iNDXJz7fHtuTdXhk,19346
+huntermakespy-0.3.1.dist-info/METADATA,sha256=_rbA9J-buuKyZvp8vkiYMhSipTCPdLFGdjRsRNtK5oU,6319
+huntermakespy-0.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+huntermakespy-0.3.1.dist-info/top_level.txt,sha256=Uh4bj8EDTdsRpqY1VlK_his_B4HDfZ6Tqrwhoj75P_w,14
+huntermakespy-0.3.1.dist-info/RECORD,,

huntermakespy-0.2.4.dist-info/RECORD

@@ -1,20 +0,0 @@
-hunterMakesPy/__init__.py,sha256=bVF1F2Mdo5AOiioEfxKvNrnsa3vCFI16eMK7Oy5O5TU,1450
-hunterMakesPy/_theSSOT.py,sha256=lkLOG3oTIWNKD_ULX55chlUGNqCHgqVIrBvolvK1vbQ,153
-hunterMakesPy/coping.py,sha256=7NBwaGutEr6Q-2mIz65M69NkrbpG24u1I5HXx6VaAWI,6057
-hunterMakesPy/dataStructures.py,sha256=7CxCBpQmHJzGxTq_AfkAeh2QdJDkzBr5lfSpPaA1GkE,11722
-hunterMakesPy/filesystemToolkit.py,sha256=jd7H5UtrIrPiCYWcvNBNa6DAy-2Ewcf21-jbGXg_IVI,4702
-hunterMakesPy/parseParameters.py,sha256=1mwGNVIZ1x23k_di3lhOhQb8QMXMUCHgt7xw3NRzDXs,11814
-hunterMakesPy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hunterMakesPy/pytestForYourUse.py,sha256=GiN1C1gTTM0ZunRPEMnrKlLQLMdH0wF_ZGr_RPgRjjA,500
-hunterMakesPy/theTypes.py,sha256=C2d0uLn1VIx6_2CK41it3IP7iplSQqe51tzWc-RT320,306
-hunterMakesPy/tests/__init__.py,sha256=C_FzfKDi_VrGVxlenWHyOYtKShAKlt3KW14jeRx1mQI,224
-hunterMakesPy/tests/conftest.py,sha256=NZQPRiwvGhP16hJ6WGGm9eKLxfQArYV8E9X12YzSpP0,2827
-hunterMakesPy/tests/test_coping.py,sha256=mH89TUAL6fJanBLlhdVlCNNQqm5OpdcQMP_p5W2JJwo,9860
-hunterMakesPy/tests/test_dataStructures.py,sha256=OouddHjN-Km26U92jYwnjYeP6_Y2DrJLgq3qD_8GvGw,16393
-hunterMakesPy/tests/test_filesystemToolkit.py,sha256=q2voXjCbQPIT8l8VF9iuWX1Bs2ZieABItWoVkITj_fo,8841
-hunterMakesPy/tests/test_parseParameters.py,sha256=80npsoWcCackjxvoW2dMXMpHeale7fuRXyXp78MibLs,14037
-huntermakespy-0.2.4.dist-info/licenses/LICENSE,sha256=NxH5Y8BdC-gNU-WSMwim3uMbID2iNDXJz7fHtuTdXhk,19346
-huntermakespy-0.2.4.dist-info/METADATA,sha256=UeGvfHoO_DMo_K5yy8daea6K7Ska8X6hHbC7MuCh7p8,6491
-huntermakespy-0.2.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-huntermakespy-0.2.4.dist-info/top_level.txt,sha256=Uh4bj8EDTdsRpqY1VlK_his_B4HDfZ6Tqrwhoj75P_w,14
-huntermakespy-0.2.4.dist-info/RECORD,,