Skip to content

Commit

Permalink
Refactor Exception to conform to naming.
Browse files Browse the repository at this point in the history
  • Loading branch information
Isaak-Malers committed Feb 28, 2024
1 parent 37fdf96 commit c2eb626
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions CliFunction.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 target names: {func.__name__}")

if to_add.__doc__ is None:
raise FunctionCliException(
raise CliFunctionException(
"Bake requires doc-strings for target 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(
raise CliFunctionException(
"Bake 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("Bake does not support varargs")
if varkw is not None:
raise FunctionCliException("Bake does not support varargs")
raise CliFunctionException("Bake does not support varargs")
self.targets.append(to_add)

def function_help(self, func, pad: str = "") -> str:
Expand Down
6 changes: 3 additions & 3 deletions test/test_invalidTargets.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import pytest

from ..CliFunction import Targets, FunctionCliException
from ..CliFunction import Targets, CliFunctionException


def one():
Expand Down Expand Up @@ -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

0 comments on commit c2eb626

Please sign in to comment.