Merge pull request #17 from Isaak-Malers/10-naming-sweep

10 naming sweep

CliFunction.py

@@ -4,7 +4,7 @@
 import re
 
 
-class FunctionCliException(Exception):
+class CliFunctionException(Exception):
     """
     Common exception type for CliFunction.
     This ensures it is obvious when a problem occurs with the CLI wrapper vs the code being called into.
@@ -75,7 +75,7 @@ def type_coercer(self, *, arg: str, desired_type: type):
     def generate_method_kwargs(self, *, args: [str], function) -> dict:
         """
             should be passed the args string list from the terminal which will look something like this:
-            ['FunctionCLI.py', 'two', '--arg1=5']
+            ['CliFunction.py', 'two', '--arg1=5']
             and a function which may or may not be invoke-able given the information in the args string list.
 
             if the function cannot be invoked from the given arguments, return None
@@ -193,21 +193,21 @@ def add_target(self, to_add):
         """
         for func in self.targets:
             if func.__name__ == to_add.__name__:
-                raise FunctionCliException(f"duplicate target names: {func.__name__}")
+                raise CliFunctionException(f"duplicate function names: {func.__name__}")
 
         if to_add.__doc__ is None:
-            raise FunctionCliException(
-                "Bake requires doc-strings for target functions (denoted by a triple quoted comment as the first thing in the function body)")
+            raise CliFunctionException(
+                "CliFunction requires doc-strings for exposed functions (denoted by a triple quoted comment as the first thing in the function body)")
 
         # pylint: disable=unused-variable
         names, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations = inspect.getfullargspec(to_add)
         if len(names) != 0 or defaults is not None:
-            raise FunctionCliException(
-                "Bake requires functions with arguments to use exclusively keyword arguments (denoted by a [*] as the first argument to the function)")
+            raise CliFunctionException(
+                "CliFunction requires functions with arguments to use exclusively keyword arguments (denoted by a [*] as the first argument to the function)")
         if varargs is not None:
-            raise FunctionCliException("Bake does not support varargs")
+            raise CliFunctionException("CliFunction does not support varargs")
         if varkw is not None:
-            raise FunctionCliException("Bake does not support varargs")
+            raise CliFunctionException("CliFunction does not support varargs")
         self.targets.append(to_add)
 
     def function_help(self, func, pad: str = "") -> str:

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "clifunction"
-version = "0.2.3"
+version = "0.2.4"
 authors = [
   { name="Isaak Malers", email="isaak.malers+clifunction@gmail.com" },
 ]

test/test_invalidTargets.py

@@ -1,6 +1,6 @@
 import pytest
 
-from ..CliFunction import Targets, FunctionCliException
+from ..CliFunction import Targets, CliFunctionException
 
 
 def one():
@@ -33,10 +33,10 @@ def test_no_docstring(self):
         t = Targets()
         with pytest.raises(Exception) as e:
             t.add_target(noDocstring)
-        assert e.type == FunctionCliException
+        assert e.type == CliFunctionException
 
     def test_no_kwargs_only(self):
         t = Targets()
         with pytest.raises(Exception) as e:
             t.add_target(noKwargs)
-        assert e.type == FunctionCliException
+        assert e.type == CliFunctionException