kisspy-python 1.1.0__tar.gz → 1.2.0__tar.gz

{kisspy_python-1.1.0 → kisspy_python-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kisspy-python
-Version: 1.1.0
+Version: 1.2.0
 Summary: Simple Python Scripting Helpers
 Home-page: https://github.com/joemarchionna/kisspy
 Author: Joe Marchionna

{kisspy_python-1.1.0 → kisspy_python-1.2.0}/changes.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 none
 
+## [1.2.0] - 2026 05 07
+### Added
+- methodParameter decorators
+
 ## [1.1.0] - 2026 04 07
 ### Changed
 - Doc Strings 

{kisspy_python-1.1.0 → kisspy_python-1.2.0}/kisspy/_metadata.json

@@ -1,7 +1,7 @@
 
 {
     "name": "kisspy-python",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "author": "Joe Marchionna",
     "author_email": "joemarchionna@gmail.com",
     "description": "Simple Python Scripting Helpers",

kisspy_python-1.2.0/kisspy/decorators/methodParameters.py

@@ -0,0 +1,97 @@
+import functools
+import inspect
+
+
+def _raiseValueErrorIfErrors(errors: list[str], frmt: str):
+    if not errors:
+        return
+    raise ValueError(frmt.format(", ".join(errors)))
+
+
+def parametersNotNone(paramNames: list[str]):
+    """
+    validates that the parameters that are listed are not literally 'None'
+
+    Args:
+        paramNames (list[str]): the decorated function parameter names to validate
+
+    Raises:
+        ValueError
+    """
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            sig = inspect.signature(func)
+            bound = sig.bind(*args, **kwargs)
+            bound.apply_defaults()
+            errors = []
+            for pn in paramNames:
+                if pn in bound.arguments:
+                    val = bound.arguments[pn]
+                    if val is None:
+                        errors.append(pn)
+            _raiseValueErrorIfErrors(errors, "Parameter(s) '{}' Cannot Be 'None'")
+            return func(*bound.args, **bound.kwargs)
+
+        return wrapper
+
+    return decorator
+
+
+def parametersHaveTruthyValue(paramNames: list[str]):
+    """
+    validates that the parameters that are listed all have 'truthy' values
+
+    Args:
+        paramNames (list[str]): the decorated function parameter names to validate
+
+    Raises:
+        ValueError
+    """
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            sig = inspect.signature(func)
+            bound = sig.bind(*args, **kwargs)
+            bound.apply_defaults()
+            errors = []
+            for pn in paramNames:
+                if pn in bound.arguments:
+                    val = bound.arguments[pn]
+                    if not val:
+                        errors.append(pn)
+            _raiseValueErrorIfErrors(errors, "Parameter(s) '{}' Are Not A Truthy Value")
+            return func(*bound.args, **bound.kwargs)
+
+        return wrapper
+
+    return decorator
+
+
+def parameterLimit(paramName: str, lo: float | int, hi: float | int):
+    """
+    validates that the listed parameter's value is within the hi and lo value specified
+    and corrects the value keeping it within the range specified
+
+    Args:
+        paramName (str): the decorated function parameter name to validate
+        lo (float | int): lower value limit
+        hi (float | int): upper value limit
+    """
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            sig = inspect.signature(func)
+            bound = sig.bind(*args, **kwargs)
+            bound.apply_defaults()
+            if paramName in bound.arguments:
+                val = bound.arguments[paramName]
+                bound.arguments[paramName] = max(lo, min(hi, val))
+            return func(*bound.args, **bound.kwargs)
+
+        return wrapper
+
+    return decorator

{kisspy_python-1.1.0 → kisspy_python-1.2.0}/kisspy_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kisspy-python
-Version: 1.1.0
+Version: 1.2.0
 Summary: Simple Python Scripting Helpers
 Home-page: https://github.com/joemarchionna/kisspy
 Author: Joe Marchionna

{kisspy_python-1.1.0 → kisspy_python-1.2.0}/kisspy_python.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ kisspy/converters/__init__.py
 kisspy/converters/excelHelpers.py
 kisspy/converters/numericConverter.py
 kisspy/decorators/__init__.py
+kisspy/decorators/methodParameters.py
 kisspy/decorators/pidFile.py
 kisspy/decorators/singleton.py
 kisspy/decorators/thrdSafeSync.py