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

hunterMakesPy/__init__.py

@@ -17,13 +17,10 @@ from hunterMakesPy.parseParameters import (defineConcurrencyLimit as defineConcu
 
 from hunterMakesPy.filesystemToolkit import (importLogicalPath2Identifier as importLogicalPath2Identifier,
 	importPathFilename2Identifier as importPathFilename2Identifier, makeDirsSafely as makeDirsSafely,
-	writeStringToHere as writeStringToHere)
+	writePython as writePython, writeStringToHere as writeStringToHere)
 
 from hunterMakesPy.dataStructures import stringItUp as stringItUp, updateExtendPolishDictionaryLists as updateExtendPolishDictionaryLists
 
-import sys
-
-if sys.version_info < (3, 14):
-    from hunterMakesPy.dataStructures import autoDecodingRLE as autoDecodingRLE
+from hunterMakesPy.dataStructures import autoDecodingRLE as autoDecodingRLE
 
 from hunterMakesPy._theSSOT import settingsPackage

hunterMakesPy/dataStructures.py

@@ -8,12 +8,7 @@ import more_itertools
 import re as regex
 
 def removeExtraWhitespace(text: str) -> str:
-	"""Remove extra whitespace from string representation of Python data structures.
-
-	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.
-	"""
+	"""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

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
@@ -97,6 +98,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, 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/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-0.2.4.dist-info → huntermakespy-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hunterMakesPy
-Version: 0.2.4
+Version: 0.3.0
 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/)

{huntermakespy-0.2.4.dist-info → huntermakespy-0.3.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
-hunterMakesPy/__init__.py,sha256=bVF1F2Mdo5AOiioEfxKvNrnsa3vCFI16eMK7Oy5O5TU,1450
+hunterMakesPy/__init__.py,sha256=5UWFiB9YCTei76LfMCYipSFSIMVspw2jhcca_NmynGI,1431
 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/dataStructures.py,sha256=WC6MO0LjrhCEv0prd5hlC9efG4DuL9lEm-fWlhHUVUw,11509
+hunterMakesPy/filesystemToolkit.py,sha256=loBn6GcScIucrMpjopGdZu6ja3nTkyBfcSiH9_P4cxY,6773
 hunterMakesPy/parseParameters.py,sha256=1mwGNVIZ1x23k_di3lhOhQb8QMXMUCHgt7xw3NRzDXs,11814
 hunterMakesPy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hunterMakesPy/pytestForYourUse.py,sha256=GiN1C1gTTM0ZunRPEMnrKlLQLMdH0wF_ZGr_RPgRjjA,500
@@ -11,10 +11,10 @@ hunterMakesPy/tests/__init__.py,sha256=C_FzfKDi_VrGVxlenWHyOYtKShAKlt3KW14jeRx1m
 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_filesystemToolkit.py,sha256=_CoSMzstJwWZ_tkNyIqclOIIqTaY2tYfUIgxGFfC0Jk,15335
 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,,
+huntermakespy-0.3.0.dist-info/licenses/LICENSE,sha256=NxH5Y8BdC-gNU-WSMwim3uMbID2iNDXJz7fHtuTdXhk,19346
+huntermakespy-0.3.0.dist-info/METADATA,sha256=SNJ2cKtyLw97-NGIsvCQsqllBJ82DW9Ipxntx2Qvmzk,6290
+huntermakespy-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+huntermakespy-0.3.0.dist-info/top_level.txt,sha256=Uh4bj8EDTdsRpqY1VlK_his_B4HDfZ6Tqrwhoj75P_w,14
+huntermakespy-0.3.0.dist-info/RECORD,,