hunterMakesPy 0.7.2__tar.gz → 0.7.3__tar.gz

{huntermakespy-0.7.2 → huntermakespy-0.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hunterMakesPy
-Version: 0.7.2
+Version: 0.7.3
 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.2 → huntermakespy-0.7.3}/hunterMakesPy/parseParameters.py

@@ -1,3 +1,4 @@
+# ruff: noqa: TRY301, DOC501, PLW0717 BLE001
 """Validate parameters and parse input with defensive error handling.
 
 (AI generated docstring)
@@ -35,7 +36,7 @@ References
 """
 from __future__ import annotations
 
-from collections.abc import Iterable, Sized
+from collections.abc import Sized
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 import charset_normalizer
@@ -44,6 +45,8 @@ import sys
 
 if TYPE_CHECKING:
 	from charset_normalizer.models import CharsetMatch
+	from collections.abc import Iterable
+	from hunterMakesPy.theTypes import Limitation
 	from typing import Any
 
 @dataclass
@@ -68,60 +71,9 @@ class ErrorMessageContext:
 	containerType: str | None = None
 	isElement: bool = False
 
-def _constructErrorMessage(context: ErrorMessageContext, parameterName: str, parameterType: type[Any] | None) -> str:
-	"""Construct error message from available context using template.
-
-	I received ["value" | a value | `None`] [of type `type` | `None`] [as an element in | `None`] [a `containerType` type |
-	`None`] but `parameterName` must have integers [in type(s) `parameterType` | `None`].
-
-	Hypothetically, this is a prototype that can be generalized to other functions. In this package and a few of my other
-	packages, I have developed standardized error messages, but those are quite different from this. I will certainly continue to
-	develop this kind of functionality, and this function will influence things.
-
-	Parameters
-	----------
-	context : ErrorMessageContext
-		The error context containing parameter value, type, and container information.
-	parameterName : str
-		The name of the parameter that caused the error.
-	parameterType : type[Any] | None
-		The expected type of the parameter, used in error messages.
-
-	Returns
-	-------
-	errorMessage : str
-		The constructed error message string.
-
-	"""
-	messageParts: list[str] = ["I received "]
-
-	if context.parameterValue is not None and not isinstance(context.parameterValue, (bytes, bytearray, memoryview)):
-		messageParts.append(f'"{context.parameterValue}"')
-	else:
-		messageParts.append("a value")
-
-	if context.parameterValueType:
-		messageParts.append(f" of type `{context.parameterValueType}`")
-
-	if context.isElement:
-		messageParts.append(" as an element in")
-
-	if context.containerType:
-		messageParts.append(f" a `{context.containerType}` type")
-
-	messageParts.append(f" but {parameterName} must have integers")
-
-	if parameterType:
-		messageParts.append(f" in type(s) `{parameterType}`")
-
-	return "".join(messageParts)
-
-def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int = multiprocessing.cpu_count()) -> int:
+def defineConcurrencyLimit(*, limit: Limitation, cpuTotal: int = multiprocessing.cpu_count()) -> int:
 	"""Determine the concurrency limit based on the provided parameter.
 
-	Tests for this function can be run with:
-	`from hunterMakesPy.tests.test_parseParameters import PytestFor_defineConcurrencyLimit`
-
 	Parameters
 	----------
 	limit : bool | float | int | None
@@ -134,20 +86,11 @@ def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int =
 	concurrencyLimit : int
 		The calculated concurrency limit, ensuring it is at least 1.
 
-	Notes
-	-----
-	Consider using `hunterMakesPy.oopsieKwargsie()` to handle malformed inputs. For example:
-
-	```
-	if not (CPUlimit is None or isinstance(CPUlimit, (bool, int, float))):
-		CPUlimit = oopsieKwargsie(CPUlimit)
-	```
-
 	Example parameters
 	------------------
 	```python
 	CPUlimit: bool | float | int | None
-	CPUlimit: bool | float | int | None = None
+	CPUlimit: Limitation = None
 	```
 
 	Example docstring
@@ -171,7 +114,7 @@ def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int =
 		- 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`.
 	```
 
-	"""  # noqa: DOC501
+	"""
 	if isinstance(limit, str):
 		limitFromString: bool | str | None = oopsieKwargsie(limit)
 		if isinstance(limitFromString, str):
@@ -204,7 +147,53 @@ def defineConcurrencyLimit(*, limit: bool | float | int | None, cpuTotal: int =
 		concurrencyLimit = min(concurrencyLimit, 61)
 	return max(int(concurrencyLimit), 1)
 
-# ruff: noqa: TRY301
+def _constructErrorMessage(context: ErrorMessageContext, parameterName: str, parameterType: type[Any] | None) -> str:
+	"""Construct error message from available context using template.
+
+	I received ["value" | a value | `None`] [of type `type` | `None`] [as an element in | `None`] [a `containerType` type |
+	`None`] but `parameterName` must have integers [in type(s) `parameterType` | `None`].
+
+	Hypothetically, this is a prototype that can be generalized to other functions. In this package and a few of my other
+	packages, I have developed standardized error messages, but those are quite different from this. I will certainly continue to
+	develop this kind of functionality, and this function will influence things.
+
+	Parameters
+	----------
+	context : ErrorMessageContext
+		The error context containing parameter value, type, and container information.
+	parameterName : str
+		The name of the parameter that caused the error.
+	parameterType : type[Any] | None
+		The expected type of the parameter, used in error messages.
+
+	Returns
+	-------
+	errorMessage : str
+		The constructed error message string.
+
+	"""
+	messageParts: list[str] = ["I received "]
+
+	if context.parameterValue is not None and not isinstance(context.parameterValue, (bytes, bytearray, memoryview)):
+		messageParts.append(f'"{context.parameterValue}"')
+	else:
+		messageParts.append("a value")
+
+	if context.parameterValueType:
+		messageParts.append(f" of type `{context.parameterValueType}`")
+
+	if context.isElement:
+		messageParts.append(" as an element in")
+
+	if context.containerType:
+		messageParts.append(f" a `{context.containerType}` type")
+
+	messageParts.append(f" but {parameterName} must have integers")
+
+	if parameterType:
+		messageParts.append(f" in type(s) `{parameterType}`")
+
+	return "".join(messageParts)
 
 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.
@@ -252,7 +241,7 @@ def intInnit(listInt_Allegedly: Iterable[Any], parameterName: str | None = None,
 
 	# 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:  # noqa: PLW0717
+	try:
 		iter(listInt_Allegedly)
 		lengthInitial: int | None = None
 		if isinstance(listInt_Allegedly, Sized):
@@ -349,7 +338,7 @@ def oopsieKwargsie(huh: Any) -> bool | str | None:
 	if not isinstance(huh, str):
 		try:
 			huh = str(huh)
-		except BaseException:  # noqa: BLE001
+		except BaseException:
 			return huh
 	formatted: str = huh.strip().title()
 	if formatted == str(True):

{huntermakespy-0.7.2 → huntermakespy-0.7.3}/hunterMakesPy/theTypes.py

@@ -11,6 +11,8 @@ identifierDotAttribute: TypeAlias = str
 `TypeAlias` for a `str` `object` using dot notation to access an attribute, such as 'scipy.signal.windows'.
 """
 
+Limitation: TypeAlias = bool | float | int | None
+
 class Ordinals(Protocol):
 	"""Any Python `object` `type` that may be ordered before or after a comparable `object` `type` by comparison operators."""
 

{huntermakespy-0.7.2 → huntermakespy-0.7.3}/hunterMakesPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hunterMakesPy
-Version: 0.7.2
+Version: 0.7.3
 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.2 → huntermakespy-0.7.3}/pyproject.toml

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