hunterMakesPy 0.7.0__tar.gz → 0.7.1__tar.gz

{huntermakespy-0.7.0 → huntermakespy-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hunterMakesPy
-Version: 0.7.0
+Version: 0.7.1
 Summary: Easy Python functions making making functional Python functions easier.
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 License-Expression: CC-BY-NC-4.0

{huntermakespy-0.7.0 → huntermakespy-0.7.1}/hunterMakesPy/dataStructures.py

@@ -1,38 +1,24 @@
 """Manipulate data structures with encoding, extraction, and merging utilities.
 
-(AI generated docstring)
-
-You can use this module to transform NumPy arrays [1] into compact run-length encoded
-strings, extract strings from arbitrarily nested data structures, and merge multiple
-dictionaries with list values. The module provides specialized utilities for working with
-Cartesian mappings, heterogeneous nested data, and dictionary consolidation operations.
-
-The run-length encoding function produces self-decoding string representations optimized for
-large arrays with repetitive patterns. The string extraction function recursively traverses
-nested structures to collect all convertible string values. The dictionary merging function
-consolidates multiple dictionaries while offering optional deduplication and sorting.
+You can use this module to transform arrays (in the general sense) into compact run-length encoded
+strings, extract strings from arbitrarily nested data structures, or merge dictionaries of lists.
 
 Contents
 --------
 Functions
 	autoDecodingRLE
-		Transform a NumPy array into a compact, self-decoding run-length encoded string representation.
+		Transform a NumPy array into a compact, self-decoding run-length encoded string
+		representation.
 	stringItUp
 		Convert every element in input data structures to strings.
 	updateExtendPolishDictionaryLists
 		Merge multiple dictionaries with list values into a single dictionary.
-
-References
-----------
-[1] NumPy - Context7
-	https://numpy.org/doc/stable/reference/index.html
-
 """
 from __future__ import annotations
 
 from charset_normalizer import CharsetMatch
 from types import FunctionType
-from typing import Any, cast, TYPE_CHECKING
+from typing import cast, TYPE_CHECKING
 import charset_normalizer
 import more_itertools
 import re as regex
@@ -43,24 +29,23 @@ if TYPE_CHECKING:
 	from hunterMakesPy import 小于
 	from numpy import integer
 	from numpy.typing import NDArray
+	from typing import Any
 
 def removeExtraWhitespace(string: str) -> str:
 	"""Remove extra whitespace from string representation of Python data structures."""  # noqa: DOC201
 	commas: str = regex.sub(r',\s+', ',', string)
 	bracketsOpening: str = regex.sub(r'([\[\(])\s+', r'\1', commas)
-	# Remove spaces before closing brackets/parentheses.
 	return regex.sub(r'\s+([\]\)])', r'\1', bracketsOpening)
 
 def autoDecodingRLE(arrayTarget: NDArray[integer[Any]], *, assumeAddSpaces: bool = False) -> str:
 	"""Transform a NumPy array into a compact, self-decoding run-length encoded string representation.
 
 	Use this function to convert a NumPy array into a string that, when evaluated as Python code,
-	creates a list or nested lists representing the original array structure, and if used as an
-	argument to `numpy.array()`, will recreate the original array structure. The RLE (Run-Length
-	Encoding) string does _not_ need a special decoder function: it is already native Python syntax.
-	The function employs two encoding strategies:
-	1. Python `range` syntax for consecutive integer sequences.
-	2. Multiplication syntax for repeated elements.
+	creates a list or nested lists representing the original array structure. You can create a NumPy
+	array, torch Tensor, or other array-like object with the auto-decoded list of lists. The RLE
+	(Run-Length Encoding) string does _not_ need a decoder function: it is native Python syntax. The
+	function employs two encoding strategies: 1. Python `range` syntax for consecutive integer
+	sequences. 2. Multiplication syntax for repeated elements.
 
 	The resulting string representation is merely minified Python code, so it is space-efficient and,
 	hypothetically, human-readable.
@@ -71,9 +56,8 @@ def autoDecodingRLE(arrayTarget: NDArray[integer[Any]], *, assumeAddSpaces: bool
 		The NumPy array to be encoded.
 	assumeAddSpaces : bool = False
 		Affects internal length comparison during compression decisions. This parameter doesn't
-		directly change output format but influences whether `range` or multiplication syntax is
-		preferred in certain cases. The parameter exists because `ast.unparse()` (Abstract Syntax
-		Tree) inserts spaces in the RLE string.
+		directly change the output: instead, use it to assume that something else will add spaces,
+		such as `ast.unparse()` (Abstract Syntax Tree) or a Python formatter.
 
 	Returns
 	-------
@@ -207,7 +191,6 @@ def stringItUp(*scrapPile: Any) -> list[str]:
 	-------
 	listStrungUp : list[str]
 		(list2strung2up) A `list` of string versions of all convertible elements.
-
 	"""
 	scrap: Any = None
 	listStrungUp: list[str] = []
@@ -283,7 +266,7 @@ def updateExtendPolishDictionaryLists(*dictionaryLists: Mapping[str, list[小于
 	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
+	every dictionary key is a 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

{huntermakespy-0.7.0 → huntermakespy-0.7.1}/hunterMakesPy/filesystemToolkit.py

@@ -2,64 +2,65 @@
 
 (AI generated docstring)
 
-You can use this module to import `identifier` values from logical module paths or Python
-files, create parent directories for output paths, and write text or formatted Python
-source to files and text streams. The writing functions can normalize Python imports with
-`autoflake` [1] and `isort` [2] before the destination receives the final text.
+You can use this module to import `identifier` values from logical module paths or Python files,
+create parent directories for output paths, and write text or formatted Python source to files and
+text streams. The writing functions can normalize Python imports with `autoflake` [1] and `isort` [2]
+before the destination receives the final text.
 
 Contents
 --------
 Functions
-	importLogicalPath2Identifier
-		Import `identifier` from the module named by `logicalPathModule`.
-	importPathFilename2Identifier
-		Import `identifier` from the Python file at `pathFilename`.
-	makeDirectorySafely
-		Create parent directories for `pathFilename` when `pathFilename` is a filesystem path.
-	makeDirsSafely
-		Temporary alias for `makeDirectorySafely`.
-	writePython
-		Format `pythonSource` and write `pythonSource` to `pathFilename`.
-	writeStringToHere
-		Write `this` to `pathFilename`.
+    importLogicalPath2Identifier
+        Import `identifier` from the module named by `logicalPathModule`.
+    importPathFilename2Identifier
+        Import `identifier` from the Python file at `pathFilename`.
+    makeDirectorySafely
+        Create parent directories for `pathFilename` when `pathFilename` is a filesystem path.
+    makeDirsSafely
+        Temporary alias for `makeDirectorySafely`.
+    writePython
+        Format `pythonSource` and write `pythonSource` to `pathFilename`.
+    writeStringToHere
+        Write `this` to `pathFilename`.
 
 Variables
 ---------
-	settings_autoflakeDEFAULT
-		Default settings dictionary for Python source cleanup.
-	settings_isortDEFAULT
-		Default settings dictionary for Python import sorting.
+    settings_autoflakeDEFAULT
+        Default settings dictionary for Python source cleanup.
+    settings_isortDEFAULT
+        Default settings dictionary for Python import sorting.
 
 References
 ----------
 [1] autoflake
-	https://github.com/PyCQA/autoflake
+    https://github.com/PyCQA/autoflake
 [2] isort
-	https://pycqa.github.io/isort/
+    https://pycqa.github.io/isort/
 """
 from __future__ import annotations
 
 from autoflake import fix_code as autoflake_fix_code
+from io import IOBase, TextIOBase
 from isort import code as isort_code
 from pathlib import Path, PurePath
-from typing import Any, overload, TYPE_CHECKING
+from typing import overload, TYPE_CHECKING
 import contextlib
 import importlib
 import importlib.util
-import io
 
 if TYPE_CHECKING:
 	from hunterMakesPy import identifierDotAttribute
 	from importlib.machinery import ModuleSpec
 	from os import PathLike
 	from types import ModuleType
+	from typing import Any
 
 def importLogicalPath2Identifier(logicalPathModule: identifierDotAttribute, identifier: str, packageIdentifierIfRelative: str | None = None) -> Any:
 	"""Import `identifier` from the module named by `logicalPathModule`.
 
-	You can use this function to resolve a function, class, or other attribute from a module
-	path string. This function imports `logicalPathModule` with `importlib.import_module` [1]
-	and returns the attribute selected by `identifier`.
+	You can use this function to resolve a function, class, or other attribute from a module path
+	string. This function imports `logicalPathModule` with `importlib.import_module` [1] and returns
+	the attribute selected by `identifier`.
 
 	Parameters
 	----------
@@ -83,8 +84,8 @@ def importLogicalPath2Identifier(logicalPathModule: identifierDotAttribute, iden
 def importPathFilename2Identifier(pathFilename: PathLike[Any] | PurePath, identifier: str, moduleIdentifier: str | None = None) -> Any:
 	"""Import `identifier` from the Python file at `pathFilename`.
 
-	You can use this function to load a Python source file as a module and retrieve a named
-	attribute from that module. This function builds a module specification with
+	You can use this function to load a Python source file as a module and retrieve a named attribute
+	from that module. This function builds a module specification with
 	`importlib.util.spec_from_file_location` [1], executes the loaded module with
 	`importlib.util.module_from_spec` [2], and returns the attribute selected by `identifier`.
 
@@ -134,79 +135,78 @@ def makeDirectorySafely(pathFilename: Any) -> None:
 
 	You can use this function to prepare an output location before a later write operation. This
 	function ignores `OSError` from `Path.mkdir` [1] and does nothing when `pathFilename` is an
-	`io.IOBase` [2] stream.
+	`IOBase` [2] stream.
 
 	Parameters
 	----------
 	pathFilename : Any
-		The target path or open stream. When `pathFilename` is not an `io.IOBase` instance, the
+		The target path or open stream. When `pathFilename` is not an `IOBase` instance, the
 		function creates the parent directory of `pathFilename`.
 
 	References
 	----------
 	[1] `pathlib.Path.mkdir`
 		https://docs.python.org/3/library/pathlib.html#pathlib.Path.mkdir
-	[2] `io.IOBase`
+	[2] `IOBase`
 		https://docs.python.org/3/library/io.html#io.IOBase
 	"""
-	if not isinstance(pathFilename, io.IOBase):
+	if not isinstance(pathFilename, IOBase):
 		with contextlib.suppress(OSError):
 			Path(pathFilename).parent.mkdir(parents=True, exist_ok=True)
 makeDirsSafely = makeDirectorySafely
 """Alias for `makeDirectorySafely`."""
 
 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,
+	'additional_imports': []
+	, 'expand_star_imports': True
+	, 'remove_all_unused_imports': True
+	, 'remove_duplicate_keys': False
+	, 'remove_unused_variables': False
 }
 """Default settings dictionary for Python source cleanup."""
 
 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": 140,
-	"lines_after_imports": 1,
-	"lines_between_types": 0,
-	"multi_line_output": 4,
-	"no_sections": True,
-	"use_parentheses": True,
+	"combine_as_imports": True
+	, "force_alphabetical_sort_within_sections": True
+	, "from_first": True
+	, "honor_noqa": True
+	, "indent": "\t"
+	, "line_length": 140
+	, "lines_after_imports": 1
+	, "lines_between_types": 0
+	, "multi_line_output": 4
+	, "no_sections": True
+	, "use_parentheses": True
 }
 """Default settings dictionary for Python import sorting."""
 
 @overload
 def writePython(pythonSource: str, pathFilename: PathLike[Any] | PurePath, settings: dict[str, dict[str, Any]] | None = None) -> Path: ...
 @overload
-def writePython(pythonSource: str, pathFilename: io.TextIOBase, settings: dict[str, dict[str, Any]] | None = None) ->  io.TextIOBase: ...
-def writePython(pythonSource: str, pathFilename: PathLike[Any] | PurePath | io.TextIOBase, settings: dict[str, dict[str, Any]] | None = None) -> Path | io.TextIOBase:
+def writePython(pythonSource: str, pathFilename: TextIOBase, settings: dict[str, dict[str, Any]] | None = None) ->  TextIOBase: ...
+def writePython(pythonSource: str, pathFilename: PathLike[Any] | PurePath | TextIOBase, settings: dict[str, dict[str, Any]] | None = None) -> Path | TextIOBase:
 	"""Format and write Python source code to a file or text stream.
 
 	(AI generated docstring)
 
-	You can use this function to normalize Python imports and then send the resulting source
-	code to a file path or open text stream. This function applies `autoflake` [1] first,
-	applies `isort` [2] second, appends a trailing newline, and writes the final text to
-	`pathFilename`.
+	You can use this function to normalize Python imports and then send the resulting source code to a
+	file path or open text stream. This function applies `autoflake` [1] first, applies `isort` [2]
+	second, appends a trailing newline, and writes the final text to `pathFilename`.
 
 	Parameters
 	----------
 	pythonSource : str
 		The Python source code to format and write.
-	pathFilename : PathLike[Any] | PurePath | io.TextIOBase
+	pathFilename : PathLike[Any] | PurePath | TextIOBase
 		The target destination. `pathFilename` can be a filesystem path or an open text stream.
 	settings : dict[str, dict[str, Any]] | None = None
-		Formatter configuration. The `'autoflake'` key overrides `settings_autoflakeDEFAULT`.
-		The `'isort'` key overrides `settings_isortDEFAULT`. `None` uses the default settings for
-		each formatter.
+		Formatter configuration. The `'autoflake'` key overrides `settings_autoflakeDEFAULT`. The
+		`'isort'` key overrides `settings_isortDEFAULT`. `None` uses the default settings for each
+		formatter.
 
 	Returns
 	-------
-	destinationWritten : Path | io.TextIOBase
+	destinationWritten : Path | TextIOBase
 		The file path or text stream that received the formatted source code.
 
 	See Also
@@ -235,26 +235,24 @@ def writePython(pythonSource: str, pathFilename: PathLike[Any] | PurePath | io.T
 @overload
 def writeStringToHere(this: str, pathFilename: PathLike[Any] | PurePath) -> Path: ...
 @overload
-def writeStringToHere(this: str, pathFilename: io.TextIOBase) -> io.TextIOBase: ...
-def writeStringToHere(this: str, pathFilename: PathLike[Any] | PurePath | io.TextIOBase) -> Path | io.TextIOBase:
+def writeStringToHere(this: str, pathFilename: TextIOBase) -> TextIOBase: ...
+def writeStringToHere(this: str, pathFilename: PathLike[Any] | PurePath | TextIOBase) -> Path | TextIOBase:
 	"""Write `this` to `pathFilename`.
 
-	You can use this function to send text to a filesystem path or an open text stream. This
-	function creates the parent directory when `pathFilename` is path-like, writes UTF-8 text
-	with `Path.write_text` [1], or writes and flushes an `io.TextIOBase` [2] stream. The
-	package-assimilation code in `hunterMakesPy.assimilate.chopShop.transformPackages` [3] uses
-	this function to persist transformed source files.
+	You can use this function to send text to a filesystem path or an open text stream. This function
+	creates the parent directory when `pathFilename` is path-like, writes UTF-8 text with
+	`Path.write_text` [1], or writes and flushes a `TextIOBase` [2] stream.
 
 	Parameters
 	----------
 	this : str
 		The string content to write.
-	pathFilename : PathLike[Any] | PurePath | io.TextIOBase
+	pathFilename : PathLike[Any] | PurePath | TextIOBase
 		The target destination. `pathFilename` can be a filesystem path or an open text stream.
 
 	Returns
 	-------
-	destinationWritten : Path | io.TextIOBase
+	destinationWritten : Path | TextIOBase
 		The file path or text stream that received `this`.
 
 	See Also
@@ -266,12 +264,11 @@ def writeStringToHere(this: str, pathFilename: PathLike[Any] | PurePath | io.Tex
 	--------
 	The package-assimilation code writes transformed source text to a destination package path.
 
-	```python
-	from hunterMakesPy.filesystemToolkit import writeStringToHere
+	```python from hunterMakesPy.filesystemToolkit import writeStringToHere
 
 	writeStringToHere(
-		regexChangeImports(pathFilename.read_text()),
-		settingsFor[humpyPackage].pathPackage / pathFilename.relative_to(pathTransformee),
+		regexChangeImports(pathFilename.read_text()), settingsFor[humpyPackage].pathPackage /
+		pathFilename.relative_to(pathTransformee)
 	)
 	```
 
@@ -279,11 +276,10 @@ def writeStringToHere(this: str, pathFilename: PathLike[Any] | PurePath | io.Tex
 	----------
 	[1] `pathlib.Path.write_text`
 		https://docs.python.org/3/library/pathlib.html#pathlib.Path.write_text
-	[2] `io.TextIOBase`
+	[2] `TextIOBase`
 		https://docs.python.org/3/library/io.html#io.TextIOBase
-	[3] `hunterMakesPy.assimilate.chopShop.transformPackages`
 	"""
-	if isinstance(pathFilename, io.TextIOBase):
+	if isinstance(pathFilename, TextIOBase):
 		pathFilename.write(str(this))
 		pathFilename.flush()
 	else:

{huntermakespy-0.7.0 → huntermakespy-0.7.1}/hunterMakesPy/parseParameters.py

@@ -37,12 +37,14 @@ from __future__ import annotations
 
 from collections.abc import Iterable, Sized
 from dataclasses import dataclass
-from typing import Any, TYPE_CHECKING
+from typing import TYPE_CHECKING
 import charset_normalizer
 import multiprocessing
+import sys
 
 if TYPE_CHECKING:
 	from charset_normalizer.models import CharsetMatch
+	from typing import Any
 
 @dataclass
 class ErrorMessageContext:
@@ -114,13 +116,6 @@ def _constructErrorMessage(context: ErrorMessageContext, parameterName: str, par
 
 	return "".join(messageParts)
 
-# TODO Should I change the function because "On Windows, max_workers must be less than or equal to 61."?
-# https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.ProcessPoolExecutor
-# autoflake
-#         if sys.platform == "win32":
-#			 # Work around https://bugs.python.org/issue26903
-#			 worker_count = min(worker_count, 60)  # noqa: ERA001
-
 def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int = multiprocessing.cpu_count()) -> int:
 	"""Determine the concurrency limit based on the provided parameter.
 
@@ -177,8 +172,6 @@ def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int =
 	```
 
 	"""  # noqa: DOC501
-	concurrencyLimit: int = cpuTotal
-
 	if isinstance(limit, str):
 		limitFromString: bool | str | None = oopsieKwargsie(limit)
 		if isinstance(limitFromString, str):
@@ -191,7 +184,9 @@ def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int =
 			limit = limitFromString
 	if isinstance(limit, float) and 1 <= abs(limit):
 		limit = round(limit)
-	if limit is None or limit is False or limit == 0:
+
+	concurrencyLimit: int = cpuTotal
+	if (limit is None) or (limit is False) or (limit == 0):
 		pass
 	elif limit is True:
 		concurrencyLimit = 1
@@ -204,6 +199,9 @@ def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int =
 	elif limit <= -1:
 		concurrencyLimit = cpuTotal - abs(int(limit))
 
+	# https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.ProcessPoolExecutor
+	if sys.platform == "win32":
+		concurrencyLimit = min(concurrencyLimit, 61)
 	return max(int(concurrencyLimit), 1)
 
 # ruff: noqa: TRY301

{huntermakespy-0.7.0 → huntermakespy-0.7.1}/hunterMakesPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hunterMakesPy
-Version: 0.7.0
+Version: 0.7.1
 Summary: Easy Python functions making making functional Python functions easier.
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 License-Expression: CC-BY-NC-4.0

{huntermakespy-0.7.0 → huntermakespy-0.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hunterMakesPy"
-version = "0.7.0"
+version = "0.7.1"
 description = "Easy Python functions making making functional Python functions easier."
 readme = "README.md"
 requires-python = ">=3.10"