Integrating PEP8 compliance

setup.cfg

@@ -43,6 +43,7 @@ dev =
     pre-commit
     pipenv
     typed-ast
+    pep8-naming
     mock
 
 [options.packages.find]

src/diffcalc_API/__init__.py

@@ -1,11 +1,10 @@
-from . import config, errorDefinitions, server
+from . import config, server
 from ._version_git import __version__
 
 # __all__ defines the public API for the package.
 # Each module also defines its own __all__.
 __all__ = [
     "__version__",
     "server",
-    "errorDefinitions",
     "config",
 ]

src/diffcalc_API/config.py

@@ -1,11 +1,10 @@
 # this file is for defining constants
 
-savePicklesFolder = "/dls/tmp/ton99817/diffcalc_pickles"
-VectorProperties = ["n_hkl", "n_phi", "surf_nhkl", "surf_nphi"]
-pickledNames = {"ub", "constraints", "hkl"}
-constraintsWithNoValue = {"a_eq_b", "bin_eq_bout", "mu_is_gam", "bisect"}
+SAVE_PICKLES_FOLDER = "/dls/tmp/ton99817/diffcalc_pickles"
+VECTOR_PROPERTIES = ["n_hkl", "n_phi", "surf_nhkl", "surf_nphi"]
+CONSTRAINTS_WITH_NO_VALUE = {"a_eq_b", "bin_eq_bout", "mu_is_gam", "bisect"}
 
-allConstraints = {
+ALL_CONSTRAINTS = {
     "delta",
     "gam" "qaz",
     "naz",

src/diffcalc_API/errors/__init__.py

@@ -1,3 +1,3 @@
-from diffcalc_API.errors import Constraints, HklCalculation, UBCalculation
+from diffcalc_API.errors import constraints, hkl, ub
 
-__all__ = ["HklCalculation", "UBCalculation", "Constraints"]
+__all__ = ["hkl", "ub", "constraints"]

src/diffcalc_API/errors/constraints.py

@@ -0,0 +1,26 @@
+import numpy as np
+
+from diffcalc_API.config import ALL_CONSTRAINTS
+from diffcalc_API.errors.definitions import (
+    ALL_RESPONSES,
+    DiffcalcAPIException,
+    ErrorCodes,
+)
+
+
+class Codes(ErrorCodes):
+    CHECK_CONSTRAINT_EXISTS = 400
+
+
+responses = {code: ALL_RESPONSES[code] for code in np.unique(Codes().all_codes())}
+
+
+def check_constraint_exists(constraint: str) -> None:
+    if constraint not in ALL_CONSTRAINTS:
+        raise DiffcalcAPIException(
+            status_code=Codes.CHECK_CONSTRAINT_EXISTS,
+            detail=(
+                f"property {constraint} does not exist as a valid constraint."
+                f" Choose one of {ALL_CONSTRAINTS}"
+            ),
+        )