hunterMakesPy 0.2.1__py3-none-any.whl → 0.2.2__py3-none-any.whl

hunterMakesPy/dataStructures.py

@@ -11,7 +11,7 @@ import sys
 if sys.version_info < (3, 14):
 	import python_minifier
 
-	def autoDecodingRLE(arrayTarget: NDArray[integer[Any]], *, assumeAddSpaces: bool = False) -> str:  # noqa: C901, PLR0915
+	def autoDecodingRLE(arrayTarget: NDArray[integer[Any]], *, assumeAddSpaces: bool = False) -> str:
 		"""Transform a NumPy array into a compact, self-decoding run-length encoded string representation.
 
 		This function converts a NumPy array into a string that, when evaluated as Python code,
@@ -159,7 +159,7 @@ if sys.version_info < (3, 14):
 		# Add unpack operator `*` for automatic decoding when evaluated.
 		return arrayAsStr.replace('range(0,', 'range(').replace('range', '*range')
 
-def stringItUp(*scrapPile: Any) -> list[str]:  # noqa: C901
+def stringItUp(*scrapPile: Any) -> list[str]:
 	"""Convert, if possible, every element in the input data structure to a string.
 
 	Order is not preserved or readily predictable.
@@ -178,7 +178,7 @@ def stringItUp(*scrapPile: Any) -> list[str]:  # noqa: C901
 	scrap = None
 	listStrungUp: list[str] = []
 
-	def drill(KitKat: Any) -> None:  # noqa: C901, PLR0912
+	def drill(KitKat: Any) -> None:
 		match KitKat:
 			case str():
 				listStrungUp.append(KitKat)
@@ -204,7 +204,7 @@ def stringItUp(*scrapPile: Any) -> list[str]:  # noqa: C901
 					except TypeError:  # "The error traceback provided indicates that there is an issue when calling the __str__ method on an object that does not have this method properly defined, leading to a TypeError."
 						pass
 					except:
-						print(f"\nWoah! I received '{repr(KitKat)}'.\nTheir report card says, 'Plays well with others: Needs improvement.'\n")  # noqa: RUF010, T201
+						print(f"\nWoah! I received '{repr(KitKat)}'.\nTheir report card says, 'Plays well with others: Needs improvement.'\n")  # noqa: T201
 						raise
 	try:
 		for scrap in scrapPile:

hunterMakesPy/parseParameters.py

@@ -75,7 +75,7 @@ def _constructErrorMessage(context: ErrorMessageContext, parameterName: str, par
 
 	return "".join(messageParts)
 
-def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int = multiprocessing.cpu_count()) -> int:  # noqa: C901, PYI041
+def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int = multiprocessing.cpu_count()) -> int:
 	"""Determine the concurrency limit based on the provided parameter.
 
 	Tests for this function can be run with:
@@ -84,8 +84,7 @@ def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int =
 	Parameters
 	----------
 	limit : bool | float | int | None
-		Whether and how to limit CPU usage. Accepts `True`/`False`, an integer count, or a fraction of total CPUs. Positive and
-		negative values have different behaviors, see code for details.
+		Whether and how to limit CPU usage. See notes and examples for details how to describe the options to your users.
 	cpuTotal : int = multiprocessing.cpu_count()
 		The total number of CPUs available in the system. Default is `multiprocessing.cpu_count()`.
 
@@ -96,35 +95,40 @@ def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int =
 
 	Notes
 	-----
-	If you want to be extra nice to your users, consider using `hunterMakesPy.oopsieKwargsie()` to handle malformed inputs. For
-	example:
+	Consider using `hunterMakesPy.oopsieKwargsie()` to handle malformed inputs. For example:
 
 	```
 	if not (CPUlimit is None or isinstance(CPUlimit, (bool, int, float))):
 		CPUlimit = oopsieKwargsie(CPUlimit)
 	```
 
-	Examples
-	--------
-	Example parameters:
-		CPUlimit: bool | float | int | None
-		CPUlimit: bool | float | int | None = None
+	Example parameters
+	------------------
+	```python
+	CPUlimit: bool | float | int | None
+	CPUlimit: bool | float | int | None = None
+	```
 
-	Example docstring:
-		```python
+	Example docstring
+	-----------------
+	```python
 
-		Arguments:
-			CPUlimit: bool | float | int | None
-				whether and how to limit the CPU usage. See notes for details.
+	Arguments
+	---------
+	CPUlimit: bool | float | int | None
+		Whether and how to limit the the number of available processors used by the function. See notes for details.
 
-		Limits on CPU usage `CPUlimit`:
-			- `False`, `None`, or `0`: No limits on CPU usage; uses all available CPUs. All other values will potentially limit CPU usage.
-			- `True`: Yes, limit the CPU usage; limits to 1 CPU.
-			- Integer `>= 1`: Limits usage to the specified number of CPUs.
-			- Decimal value (`float`) between 0 and 1: Fraction of total CPUs to use.
-			- Decimal value (`float`) between -1 and 0: Fraction of CPUs to *not* use.
-			- Integer `<= -1`: Subtract the absolute value from total CPUs.
-		```
+	Notes
+	-----
+	Limits on CPU usage, `CPUlimit`:
+		- `False`, `None`, or `0`: No limits on processor usage; uses all available processors. All other values will potentially limit processor usage.
+		- `True`: Yes, limit the processor usage; limits to 1 processor.
+		- `int >= 1`: The maximum number of available processors to use.
+		- `0 < float < 1`: The maximum number of processors to use expressed as a fraction of available processors.
+		- `-1 < float < 0`: The number of processors to *not* use expressed as a fraction of available processors.
+		- `int <= -1`: The number of available processors to *not* use.
+		- If the value of `CPUlimit` is a `float` greater than 1 or less than -1, the function truncates the value to an `int` with the same sign as the `float`.
+	```
 
 	"""
 	concurrencyLimit = cpuTotal
@@ -160,7 +164,7 @@ def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int =
 	return max(int(concurrencyLimit), 1)
 
 # ruff: noqa: TRY301
-def intInnit(listInt_Allegedly: Iterable[Any], parameterName: str | None = None, parameterType: type[Any] | None = None) -> list[int]:  # noqa: C901, PLR0912, PLR0915
+def intInnit(listInt_Allegedly: Iterable[Any], parameterName: str | None = None, parameterType: type[Any] | None = None) -> list[int]:
 	"""Validate and convert input values to a `list` of integers.
 
 	Accepts various numeric types and attempts to convert them into integers while providing descriptive error messages. This

{huntermakespy-0.2.1.dist-info → huntermakespy-0.2.2.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: hunterMakesPy
-Version: 0.2.1
+Version: 0.2.2
 Summary: Easy Python functions making making functional Python functions easier.
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 License: CC-BY-NC-4.0
 Project-URL: Donate, https://www.patreon.com/integrated
-Project-URL: Homepage, https://github.com/hunterhogan/
-Project-URL: Issues, https://github.com/hunterhogan/
-Project-URL: Repository, https://github.com/hunterhogan/
+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: Environment :: Console
@@ -174,4 +174,4 @@ Coding One Step at a Time:
 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.svg)](https://creativecommons.org/licenses/by-nc/4.0/)
+[![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.1.dist-info → huntermakespy-0.2.2.dist-info}/RECORD

@@ -1,9 +1,9 @@
 hunterMakesPy/__init__.py,sha256=bVF1F2Mdo5AOiioEfxKvNrnsa3vCFI16eMK7Oy5O5TU,1450
 hunterMakesPy/_theSSOT.py,sha256=lkLOG3oTIWNKD_ULX55chlUGNqCHgqVIrBvolvK1vbQ,153
 hunterMakesPy/coping.py,sha256=covqNFAwkF9gjafrlAvMdtCO8haFsESQBhO-7s68qSg,5581
-hunterMakesPy/dataStructures.py,sha256=CFyGjmAOoN2MoEPwWwWdwKNXmOXX8kCS3ttMOa2Rsx0,11379
+hunterMakesPy/dataStructures.py,sha256=Ur2Z4Pytb1Lc5ov8Ag_xm3eii16nJR_yMZzBhbS8vpI,11311
 hunterMakesPy/filesystemToolkit.py,sha256=jd7H5UtrIrPiCYWcvNBNa6DAy-2Ewcf21-jbGXg_IVI,4702
-hunterMakesPy/parseParameters.py,sha256=DXpyATx7trGBg_8jlO5dXGfLcG8vg_lU3R1sq1rRFOQ,11644
+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
@@ -13,8 +13,8 @@ hunterMakesPy/tests/test_coping.py,sha256=mH89TUAL6fJanBLlhdVlCNNQqm5OpdcQMP_p5W
 hunterMakesPy/tests/test_dataStructures.py,sha256=O4aqzSKg7KfWWVhIewOH0Y8Zj28PbFCb4XX3xhwuFQA,16605
 hunterMakesPy/tests/test_filesystemToolkit.py,sha256=q2voXjCbQPIT8l8VF9iuWX1Bs2ZieABItWoVkITj_fo,8841
 hunterMakesPy/tests/test_parseParameters.py,sha256=80npsoWcCackjxvoW2dMXMpHeale7fuRXyXp78MibLs,14037
-huntermakespy-0.2.1.dist-info/licenses/LICENSE,sha256=NxH5Y8BdC-gNU-WSMwim3uMbID2iNDXJz7fHtuTdXhk,19346
-huntermakespy-0.2.1.dist-info/METADATA,sha256=U7mdPv2TiV-JgdBigReM9zxA1N9uZ0Nb93fmASS1-bk,6501
-huntermakespy-0.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-huntermakespy-0.2.1.dist-info/top_level.txt,sha256=Uh4bj8EDTdsRpqY1VlK_his_B4HDfZ6Tqrwhoj75P_w,14
-huntermakespy-0.2.1.dist-info/RECORD,,
+huntermakespy-0.2.2.dist-info/licenses/LICENSE,sha256=NxH5Y8BdC-gNU-WSMwim3uMbID2iNDXJz7fHtuTdXhk,19346
+huntermakespy-0.2.2.dist-info/METADATA,sha256=s4xUkaMaL_EEx5S0V5YZdV4qyl_ql6dx1Ozgvhf6kRA,6547
+huntermakespy-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+huntermakespy-0.2.2.dist-info/top_level.txt,sha256=Uh4bj8EDTdsRpqY1VlK_his_B4HDfZ6Tqrwhoj75P_w,14
+huntermakespy-0.2.2.dist-info/RECORD,,