amati 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

amati/__init__.py

@@ -3,7 +3,9 @@ Amati is a specification validator, built to put a specification into
 a single datatype and validate on instantiation.
 """
 
-__version__ = "0.1.0"
+import importlib.metadata
+
+__version__ = importlib.metadata.version("amati")
 
 # Imports are here for convenience, they're not going to be used here
 # pylint: disable=unused-import

amati/amati.py

@@ -37,10 +37,10 @@ def dispatch(data: JSONObject) -> tuple[BaseModel | None, list[ErrorDetails] | N
     version: JSONValue = data.get("openapi")
 
     if not isinstance(version, str):
-        raise ValueError("A OpenAPI specification version must be a string.")
+        raise TypeError("A OpenAPI specification version must be a string.")
 
     if not version:
-        raise ValueError("An OpenAPI Specfication must contain a version.")
+        raise TypeError("An OpenAPI Specfication must contain a version.")
 
     version_map: dict[str, str] = {
         "3.1.1": "311",
@@ -86,9 +86,19 @@ def check(original: JSONObject, validated: BaseModel) -> bool:
     return original_ == new_
 
 
-def run(file_path: str, consistency_check: bool = False, store_errors: bool = False):
+def run(file_path: str | Path, consistency_check: bool = False):
     """
-    Runs the full amati process
+    Runs the full amati process on a specific specification file.
+
+     * Parses the YAML or JSON specification, gunzipping if necessary.
+     * Validates the specification.
+     * Runs a consistency check on the ouput of the validation to verify
+       that the output is identical to the input.
+     * Stores any errors found during validation.
+
+    Args:
+        file_path: The specification to be validated
+        consistency_check: Whether or not to verify the output against the input
     """
 
     data = load_file(file_path)
@@ -101,25 +111,73 @@ def run(file_path: str, consistency_check: bool = False, store_errors: bool = Fa
         else:
             print("Consistency check failed")
 
-    if errors and store_errors:
+    if errors:
         if not Path(".amati").exists():
             Path(".amati").mkdir()
 
-        with open(".amati/pydantic.json", "w", encoding="utf-8") as f:
+        error_file = Path(file_path).parts[-1]
+
+        with open(f".amati/{error_file}.json", "w", encoding="utf-8") as f:
             f.write(jsonpickle.encode(errors, unpicklable=False))  # type: ignore
 
 
+def discover(discover_dir: str = ".") -> list[Path]:
+    """
+    Finds OpenAPI Specification files to validate
+
+    Args:
+        discover_dir: The directory to search through.
+    Returns:
+        A list of paths to validate.
+    """
+
+    specs: list[Path] = []
+
+    if Path("openapi.json").exists():
+        specs.append(Path("openapi.json"))
+
+    if Path("openapi.yaml").exists():
+        specs.append(Path("openapi.yaml"))
+
+    if specs:
+        return specs
+
+    if discover_dir == ".":
+        raise FileNotFoundError(
+            "openapi.json or openapi.yaml can't be found, use --discover or --spec."
+        )
+
+    specs = specs + list(Path(discover_dir).glob("**/openapi.json"))
+    specs = specs + list(Path(discover_dir).glob("**/openapi.yaml"))
+
+    if not specs:
+        raise FileNotFoundError(
+            "openapi.json or openapi.yaml can't be found, use --spec."
+        )
+
+    return specs
+
+
 if __name__ == "__main__":
 
     import argparse
 
     parser = argparse.ArgumentParser(
         prog="amati",
-        description="Test whether a OpenAPI specification is valid.",
+        description="""
+        Tests whether a OpenAPI specification is valid. Will look an openapi.json
+        or openapi.yaml file in the directory that amati is called from. If 
+        --discover is set will search the directory tree. If the specification
+        does not follow the naming recommendation the --spec switch should be
+        used.
+        """,
     )
 
     parser.add_argument(
-        "-s", "--spec", required=True, help="The specification to be parsed"
+        "-s",
+        "--spec",
+        required=False,
+        help="The specification to be parsed",
     )
 
     parser.add_argument(
@@ -131,13 +189,19 @@ if __name__ == "__main__":
     )
 
     parser.add_argument(
-        "-se",
-        "--store-errors",
+        "-d",
+        "--discover",
         required=False,
-        action="store_true",
-        help="Stores and errors in a file for visibility.",
+        default=".",
+        help="Searches the specified directory tree for openapi.yaml or openapi.json.",
     )
 
     args = parser.parse_args()
 
-    run(args.spec, args.consistency_check, args.store_errors)
+    if args.spec:
+        specifications: list[Path] = [Path(args.spec)]
+    else:
+        specifications = discover(args.discover)
+
+    for specification in specifications:
+        run(specification, args.consistency_check)

{amati-0.1.0.dist-info → amati-0.1.1.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: amati
-Version: 0.1.0
-Summary: Validates that a .yaml or .json file conforms to the OpenAPI Specifications 3.x. This is an ALPHA build.
+Version: 0.1.1
+Summary: Validates that a .yaml or .json file conforms to the OpenAPI Specifications 3.x.
 Project-URL: Homepage, https://github.com/ben-alexander/amati
 Project-URL: Issues, https://github.com/ben-alexander/amati/issues
 Author-email: Ben <2551337+ben-alexander@users.noreply.github.com>

{amati-0.1.0.dist-info → amati-0.1.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
-amati/__init__.py,sha256=C-4SGpCtZFCxS_PEPaGNFiKJu-gW5YxMSauYA-LxmzQ,449
+amati/__init__.py,sha256=suTY0Rf540LRPtdkOJi9OolXlUlv-uPNDvem_2o5eVs,504
 amati/_resolve_forward_references.py,sha256=iOibCv_XuIUpe7qbRBtPzd7H5rvL-aldUzlXV_9FJaw,6511
-amati/amati.py,sha256=fl6RL5_RWtoSpxTkEcDsgeejSh8HynxPuKvU4F5EwXY,3775
+amati/amati.py,sha256=L-kdIrXR_RTkShAKl4E2C4brHeDadbEBeNzRBGWaJjo,5661
 amati/exceptions.py,sha256=Rm0njRFjyYTa6KcrbfwDXOz8IqZraCoXo82sDKseQMY,645
 amati/file_handler.py,sha256=h95t7TDxDA_qr4rIe2bddCjh2Xw5Ht27yLK7zCQzT68,5085
 amati/logging.py,sha256=AZXQv4jXKy6NAxths7DbpUlOWAhkh3XZ6imBtYjkHxc,1323
@@ -30,8 +30,8 @@ amati/validators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 amati/validators/generic.py,sha256=NehHehVimlsVHDgStRWYgn0MZyR-i78yIPP_lw6L1bU,3736
 amati/validators/oas304.py,sha256=5QrfvBRKNZnqGZZgG7VbdIkbvklW_1M9qHeBh55D-d4,33885
 amati/validators/oas311.py,sha256=F6ejYYtSrSPFQm2MneuzbtTtlw7hv7AkfrYHDOlpWDs,20776
-amati-0.1.0.dist-info/METADATA,sha256=5Up6rsMw3Vev44sHuGovORpjYrpKKZ0-fn3Fx0WTRbE,3695
-amati-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-amati-0.1.0.dist-info/entry_points.txt,sha256=sacBb6g0f0ZJtNjNYx93_Xe4y5xzawvklCFVXup9ru0,37
-amati-0.1.0.dist-info/licenses/LICENSE,sha256=WAA01ZXeNs1bwpNWKR6aVucjtYjYm_iQIUYkCAENjqM,1070
-amati-0.1.0.dist-info/RECORD,,
+amati-0.1.1.dist-info/METADATA,sha256=5vYhn9HWXqKAuVMrWW7MitP5tQaBxEQqdQCc6KGyeQk,3671
+amati-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+amati-0.1.1.dist-info/entry_points.txt,sha256=sacBb6g0f0ZJtNjNYx93_Xe4y5xzawvklCFVXup9ru0,37
+amati-0.1.1.dist-info/licenses/LICENSE,sha256=WAA01ZXeNs1bwpNWKR6aVucjtYjYm_iQIUYkCAENjqM,1070
+amati-0.1.1.dist-info/RECORD,,