amati 0.3.1__tar.gz → 0.3.3__tar.gz

{amati-0.3.1 → amati-0.3.3}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: amati
-Version: 0.3.1
+Version: 0.3.3
 Summary: Validates that a .yaml or .json file conforms to the OpenAPI Specifications 3.x.
 Project-URL: Homepage, https://github.com/gwyli/amati
 Project-URL: Issues, https://github.com/gwyli/amati/issues
 Author-email: Ben <2551337+ben-alexander@users.noreply.github.com>
 License-File: LICENSE
+Keywords: json,openapi,openapi3,openapi3.0,openapi3.1,swagger,validation,validator,yaml
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License

{amati-0.3.1 → amati-0.3.3}/amati/_data/files/spdx-licences.json

@@ -2817,6 +2817,17 @@
     ],
     "isOsiApproved": false
   },
+  {
+    "reference": "https://spdx.org/licenses/ESA-PL-strong-copyleft-2.4.html",
+    "isDeprecatedLicenseId": false,
+    "detailsUrl": "https://spdx.org/licenses/ESA-PL-strong-copyleft-2.4.json",
+    "name": "European Space Agency Public License (ESA-PL) - V2.4 - Strong Copyleft (Type 1)",
+    "licenseId": "ESA-PL-strong-copyleft-2.4",
+    "seeAlso": [
+      "https://essr.esa.int/license/european-space-agency-public-license-v2-4-strong-copyleft-type-1"
+    ],
+    "isOsiApproved": false
+  },
   {
     "reference": "https://spdx.org/licenses/ESA-PL-weak-copyleft-2.4.html",
     "isDeprecatedLicenseId": false,
@@ -6416,6 +6427,17 @@
     "isOsiApproved": true,
     "isFsfLibre": true
   },
+  {
+    "reference": "https://spdx.org/licenses/OSSP.html",
+    "isDeprecatedLicenseId": false,
+    "detailsUrl": "https://spdx.org/licenses/OSSP.json",
+    "name": "OSSP License",
+    "licenseId": "OSSP",
+    "seeAlso": [
+      "https://git.sr.ht/~nabijaczleweli/ossp-var"
+    ],
+    "isOsiApproved": false
+  },
   {
     "reference": "https://spdx.org/licenses/PADL.html",
     "isDeprecatedLicenseId": false,
@@ -6934,6 +6956,17 @@
     ],
     "isOsiApproved": false
   },
+  {
+    "reference": "https://spdx.org/licenses/SGMLUG-PM.html",
+    "isDeprecatedLicenseId": false,
+    "detailsUrl": "https://spdx.org/licenses/SGMLUG-PM.json",
+    "name": "SGMLUG Parser Materials License",
+    "licenseId": "SGMLUG-PM",
+    "seeAlso": [
+      "https://gitweb.gentoo.org/repo/gentoo.git/tree/licenses/SGMLUG?id=7d999af4a47bf55e53e54713d98d145f935935c1"
+    ],
+    "isOsiApproved": false
+  },
   {
     "reference": "https://spdx.org/licenses/SGP4.html",
     "isDeprecatedLicenseId": false,

{amati-0.3.1 → amati-0.3.3}/amati/_data/media_types.py

@@ -8,7 +8,7 @@ DATA_FILE = Path("media-types.json")
 DATA_SOURCE: dict[str, str] = {
     "application": "https://www.iana.org/assignments/media-types/application.csv",
     "audio": "https://www.iana.org/assignments/media-types/audio.csv",
-    # "example": "currently no valid values",
+    # "example": "currently no valid values", # noqa ERA001
     "font": "https://www.iana.org/assignments/media-types/font.csv",
     "haptics": "https://www.iana.org/assignments/media-types/haptics.csv",
     "image": "https://www.iana.org/assignments/media-types/image.csv",

{amati-0.3.1 → amati-0.3.3}/amati/_data/refresh.py

@@ -157,7 +157,9 @@ def get(data_type: data_types) -> dict[str, JSONValue] | list[JSONValue] | None:
     for module_ in to_get:
         module = importlib.import_module(f"amati._data.{module_}")
 
-        with open(current_path / module.DATA_FILE, encoding="utf-8") as f:
+        data_file: Path = current_path / module.DATA_FILE
+
+        with data_file.open(encoding="utf-8") as f:
             data = json.loads(f.read())
 
         if not data:

{amati-0.3.1 → amati-0.3.3}/amati/amati.py

@@ -132,11 +132,11 @@ def run(
             if not error_path.exists():
                 error_path.mkdir()
 
-        with open(
-            error_path / error_file.with_suffix(error_file.suffix + ".json"),
-            "w",
-            encoding="utf-8",
-        ) as f:
+        json_error_file: Path = error_path / error_file.with_suffix(
+            error_file.suffix + ".json"
+        )
+
+        with json_error_file.open("w", encoding="utf-8") as f:
             f.write(json.dumps(handled_errors))
 
         if html_report:
@@ -150,11 +150,11 @@ def run(
             html_output = template.render(errors=handled_errors)
 
             # Save the output to a file
-            with open(
-                error_path / error_file.with_suffix(error_file.suffix + ".html"),
-                "w",
-                encoding="utf-8",
-            ) as f:
+
+            html_error_file: Path = error_path / error_file.with_suffix(
+                error_file.suffix + ".html"
+            )
+            with html_error_file.open("w", encoding="utf-8") as f:
                 f.write(html_output)
 
     if result and consistency_check:
@@ -247,7 +247,7 @@ if __name__ == "__main__":
             logger.info("Data refreshed successfully.")
             sys.exit(0)
         except Exception as e:
-            logger.error(f"Error refreshing data: {str(e)}")
+            logger.error(f"Error refreshing data: {e}")
             sys.exit(1)
 
     specification: Path = Path(args.spec)
@@ -262,7 +262,7 @@ if __name__ == "__main__":
         )
         logger.info(f"Specification {specification} processed successfully.")
     except Exception as e:
-        logger.error(f"Error processing {specification}, {str(e)}")
+        logger.error(f"Error processing {specification}, {e}")
         sys.exit(1)
 
     if args.consistency_check and successful_check:

{amati-0.3.1 → amati-0.3.3}/amati/fields/uri.py

@@ -3,7 +3,7 @@ Validates a URI according to the RFC3986 ABNF grammar
 """
 
 from enum import Enum
-from typing import Self, cast
+from typing import ClassVar, Self, cast
 
 import idna
 from abnf import Node, ParseError, Rule
@@ -61,7 +61,7 @@ class Scheme(_Str):
 
         # Look up the scheme in the IANA registry to get status info
         # Returns None if the scheme is not in the registry
-        self.status = SCHEMES.get(value, None)
+        self.status = SCHEMES.get(value)
 
 
 class URIType(str, Enum):
@@ -123,7 +123,7 @@ class URI(_Str):
     # RFC 3987 Internationalized Resource Identifier (IRI) flag
     is_iri: bool = False
 
-    _attribute_map: dict[str, str] = {
+    _attribute_map: ClassVar[dict[str, str]] = {
         "authority": "authority",
         "iauthority": "authority",
         "host": "host",
@@ -176,7 +176,7 @@ class URI(_Str):
         # an additional return there is a code path in type() that doesn't return a
         # value. It's better to deal with the potential error case than ignore the
         # lack of a return value.
-        raise TypeError(f"{str(self)} does not have a URI type.")  # pragma: no cover
+        raise TypeError(f"{self!s} does not have a URI type.")  # pragma: no cover
 
     def __init__(self, value: str):
         """

{amati-0.3.1 → amati-0.3.3}/amati/file_handler.py

@@ -151,7 +151,7 @@ class FileProcessor:
             True if the file is gzip-compressed, False otherwise.
         """
         try:
-            with open(file_path, "rb") as f:
+            with file_path.open("rb") as f:
                 magic = f.read(2)
                 return magic == b"\x1f\x8b"
         except OSError:
@@ -189,7 +189,7 @@ class FileProcessor:
             with gzip.open(file_path, "rt", encoding="utf-8") as f:
                 return f.read()
         else:
-            with open(file_path, encoding="utf-8") as f:
+            with file_path.open(encoding="utf-8") as f:
                 return f.read()
 
     def _get_appropriate_loader(self, file_path: Path) -> FileLoader:

{amati-0.3.1 → amati-0.3.3}/amati/grammars/oas.py

@@ -36,10 +36,10 @@ class Rule(_Rule):
         # reference-token = *( unescaped / escaped )
         # unescaped       = %x00-2E / %x30-7D / %x7F-10FFFF
         #               ; %x2F ('/') and %x7E ('~') are excluded from 'unescaped'
-        # escaped         = "~" ( "0" / "1" )
+        # escaped         = "~" ( "0" / "1" ) # noqa: ERA001
         #               ; representing '~' and '/', respectively
         "name = *( CHAR )",
-        # token = 1*tchar,
-        # tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "."
+        # token = 1*tchar, # noqa: ERA001
+        # tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." # noqa: ERA001 E501
         #     / "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA
     ]

{amati-0.3.1 → amati-0.3.3}/amati/model_validators.py

@@ -154,7 +154,7 @@ def at_least_one_of(
             if is_truthy_with_numeric_zero(value):
                 return self
 
-        public_fields = ", ".join(f"{name}" for name in candidates.keys())
+        public_fields = ", ".join(f"{name}" for name in candidates)
 
         msg = f"{public_fields} do not have values, expected at least one."
         Logger.log(
@@ -245,10 +245,8 @@ def only_one_of(
                 truthy.append(name)
 
         if len(truthy) != 1:
-            if truthy:
-                field_string = ", ".join(truthy)
-            else:
-                field_string = "none"
+            field_string = ", ".join(truthy) if truthy else "none"
+
             msg = f"Expected at most one field to have a value, {field_string} did"
 
             Logger.log(

{amati-0.3.1 → amati-0.3.3}/amati/validators/generic.py

@@ -52,10 +52,7 @@ class GenericObject(BaseModel):
         # If extra fields aren't allowed log those that aren't going to be added
         # to the model.
         for field in data:
-            if (
-                field not in self.model_dump().keys()
-                and field not in self.get_field_aliases()
-            ):
+            if field not in self.model_dump() and field not in self.get_field_aliases():
                 message = f"{field} is not a valid field for {self.__repr_name__()}."
                 Logger.log(
                     {
@@ -92,9 +89,7 @@ class GenericObject(BaseModel):
         excess_fields: set[str] = set()
 
         pattern: re.Pattern[str] = re.compile(self._extra_field_pattern)
-        excess_fields.update(
-            key for key in self.model_extra.keys() if not pattern.match(key)
-        )
+        excess_fields.update(key for key in self.model_extra if not pattern.match(key))
 
         for field in excess_fields:
             message = f"{field} is not a valid field for {self.__repr_name__()}."

{amati-0.3.1 → amati-0.3.3}/amati/validators/oas304.py

@@ -239,7 +239,7 @@ class PathsObject(GenericObject):
         Special-case specification extensions, which are also allowed.
         """
 
-        for field in data.keys():
+        for field in data:
             # Specification extensions
             if field.startswith("x-"):
                 continue
@@ -700,7 +700,7 @@ class SchemaObject(GenericObject):
             if isinstance(type_val, str) and type_val != "null":
                 schema_dict["type"] = [type_val, "null"]
             elif isinstance(type_val, list) and "null" not in type_val:
-                schema_dict["type"] = type_val + ["null"]
+                schema_dict["type"] = [*type_val, ["null"]]
 
         # 2. Validate the schema structure using jsonschema's meta-schema
         # Get the right validator based on the declared $schema or default
@@ -748,7 +748,7 @@ class OAuthFlowObject(GenericObject):
     authorizationUrl: URI | None = None
     tokenUrl: URI | None = None
     refreshUrl: URI | None = None
-    scopes: dict[str, str] = {}
+    scopes: dict[str, str] = Field(default={})
     _reference_uri: ClassVar[str] = (
         "https://spec.openapis.org/oas/v3.0.4.html#oauth-flow-object"
     )
@@ -956,7 +956,7 @@ class ComponentsObject(GenericObject):
                     f"Invalid type for '{field_name}': expected dict, got {type(value)}"
                 )
 
-            for key in value.keys():
+            for key in value:
                 if not re.match(pattern, key):
                     raise ValueError(
                         f"Invalid key '{key}' in '{field_name}': must match pattern {pattern}"  # noqa: E501

{amati-0.3.1 → amati-0.3.3}/amati/validators/oas311.py

@@ -104,7 +104,7 @@ class LicenceObject(GenericObject):
             except AmatiValueError:
                 Logger.log(
                     {
-                        "msg": f"{str(self.url)} is not a valid SPDX URL",
+                        "msg": f"{self.url} is not a valid SPDX URL",
                         "type": "warning",
                         "loc": (self.__class__.__name__,),
                         "input": self.url,
@@ -376,7 +376,7 @@ class SchemaObject(GenericObject):
             if isinstance(type_val, str) and type_val != "null":
                 schema_dict["type"] = [type_val, "null"]
             elif isinstance(type_val, list) and "null" not in type_val:
-                schema_dict["type"] = type_val + ["null"]
+                schema_dict["type"] = [*type_val, ["null"]]
 
         # 2. Validate the schema structure using jsonschema's meta-schema
         # Get the right validator based on the declared $schema or default
@@ -484,7 +484,7 @@ class ComponentsObject(GenericObject):
                     f"Invalid type for '{field_name}': expected dict, got {type(value)}"
                 )
 
-            for key in value.keys():
+            for key in value:
                 if not re.match(pattern, key):
                     raise ValueError(
                         f"Invalid key '{key}' in '{field_name}': must match pattern {pattern}"  # noqa: E501

{amati-0.3.1 → amati-0.3.3}/pyproject.toml

@@ -1,12 +1,13 @@
 [project]
 name = "amati"
-version = "0.3.1"
+version = "0.3.3"
 description = "Validates that a .yaml or .json file conforms to the OpenAPI Specifications 3.x."
 readme = "README.md"
 authors = [
     { name = "Ben", email = "2551337+ben-alexander@users.noreply.github.com" }
 ]
 requires-python = ">=3.14"
+keywords = ["openapi", "openapi3", "openapi3.0", "openapi3.1", "swagger", "validator", "validation", "yaml", "json"]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
@@ -92,13 +93,30 @@ line-length = 88
 
 [tool.ruff.lint]
 select = [
+    "A",   # flake8-builtins
+    "ARG", # flake8-arguments
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "C90", # McCabe complexity
+    "DTZ", # flake8-datetimez
     "E",   # pycodestyle errors
-    "W",   # pycodestyle warnings  
+    "ERA", # eradicate (commented out code)
     "F",   # pyflakes
     "I",   # isort
-    "B",   # flake8-bugbear
-    "C4",  # flake8-comprehensions
+    "ISC", # flake8-implicit-str-concat
+    "PL",  # Pylint
+    "PLC", # Pylint - Convention
+    "PLE", # Pylint - Error
+    "PTH", # flake8-pathlib
+    "PLR", # Pylint - Refactor
+    "PLW", # Pylint - warnings
+    "RUF", # ruff-specific rules
+    "S",   # flake8-bandit
+    "SIM", # flake8-simplify
+    "T20", # flake8-print
     "UP",  # pyupgrade
+    "W",   # pycodestyle warnings  
+    "YTT", # flake8-2020
 ]
 extend-fixable = ["UP015"]
 
@@ -106,3 +124,20 @@ extend-fixable = ["UP015"]
 known-first-party=["amati"]
 known-third-party=["pytest","pydantic","yaml","abnf", "rfc3987"]
 extra-standard-library=["typing_extensions", "annotationlib", "compression"]
+
+[tool.ruff.lint.per-file-ignores]
+# Disable certain checks in tests
+"tests/**/*.py" = [
+    "S101", # Allow assert
+    "S311", # Allow random choice
+    "S603", # Allow subprocess calls
+    "S607", # Allow partially executable paths
+    "RUF001", # Allow ambiguous unicode characters
+]
+
+# Disable certain checks in internal script
+"scripts/setup_test_specs.py" = [
+    "S108", # Allow use of temp files
+    "S603", # Allow subprocess calls
+    "S607", # Allow partially executable paths
+]

{amati-0.3.1 → amati-0.3.3}/scripts/setup_test_specs.py

@@ -19,7 +19,7 @@ def guard():
     of the top-level directory for amati
     """
 
-    if Path("pyproject.toml") not in Path(".").iterdir():
+    if Path("pyproject.toml") not in Path().iterdir():
         raise ValueError("setup_test_specs.py must be run in the top-level directory")
 
 
@@ -30,7 +30,8 @@ def get_repos() -> dict[str, Any]:
 
     guard()
 
-    with open("tests/data/.amati.tests.yaml", encoding="utf-8") as f:
+    config: Path = Path("tests/data/.amati.tests.yaml")
+    with config.open(encoding="utf-8") as f:
         content = yaml.safe_load(f)
 
     return content

{amati-0.3.1 → amati-0.3.3}/tests/model_validators/test_all_of.py

@@ -49,7 +49,7 @@ def test_empty_object():
     st.integers(min_value=MIN),
     st.lists(st.integers(min_value=MIN), min_size=1),
 )
-def test_all_of_no_restrictions(name: str, age: int, music: list[int]):
+def test_all_of_no_restrictions(name: str, age: int, music: list[int]):  # noqa: PLR0915
     """Test when at least one field is not empty. Uses both None and falsy values."""
 
     # Tests with None

{amati-0.3.1 → amati-0.3.3}/tests/model_validators/test_if_then.py

@@ -290,7 +290,7 @@ def test_multiple_iterable_consequences_valid():
         )
         assert not Logger.logs
         assert model.status == "active"
-        assert model.level == 2
+        assert model.level == 2  # noqa: PLR2004
 
 
 def test_multiple_iterable_consequences_partial_invalid():

{amati-0.3.1 → amati-0.3.3}/tests/test_external_specs.py

@@ -16,8 +16,8 @@ def get_test_data() -> dict[str, Any]:
     """
     Gathers the set of test data.
     """
-
-    with open("tests/data/.amati.tests.yaml", encoding="utf-8") as f:
+    config: Path = Path("tests/data/.amati.tests.yaml")
+    with config.open(encoding="utf-8") as f:
         content = yaml.safe_load(f)
 
     return content
@@ -29,7 +29,7 @@ def get_errors(error_file: Path) -> list[dict[str, Any]]:
     with a given test specification.
     """
 
-    with open(error_file, encoding="utf-8") as f:
+    with error_file.open(encoding="utf-8") as f:
         expected_errors = json.loads(f.read())
 
     return expected_errors
@@ -66,8 +66,6 @@ def test_specs():
         file: Path = Path(directory) / name / repo["spec"]
         files = determine_file_names(file)
 
-        print(f"Testing {file}")
-
         consistency_check = run(
             file_path=file, consistency_check=True, local=True, html_report=True
         )
@@ -75,7 +73,7 @@ def test_specs():
         if errors := repo.get("error_file"):
             error_file = get_errors(Path(errors))
 
-            with open(files["error_json"], encoding="utf-8") as f:
+            with Path(files["error_json"]).open(encoding="utf-8") as f:
                 json_encoded = json.loads(f.read())
 
             assert json.dumps(json_encoded, sort_keys=True) == json.dumps(

{amati-0.3.1 → amati-0.3.3}/tests/validators/test_generic.py

@@ -33,7 +33,7 @@ class ModelExtraPattern(GenericObject):
     st.data(),
 )
 def test_invalid_generic_object(data: dict[str, str], data_strategy: st.DataObject):
-    if "value" not in data.keys():
+    if "value" not in data:
         data["value"] = data_strategy.draw(st.text())
 
     with Logger.context():
@@ -55,7 +55,7 @@ def test_valid_generic_object(data: dict[str, str]):
     st.data(),
 )
 def test_allow_extra_fields(data: dict[str, str], data_strategy: st.DataObject):
-    if "value" not in data.keys():
+    if "value" not in data:
         data["value"] = data_strategy.draw(st.text())
 
     with Logger.context():
@@ -78,7 +78,7 @@ def text_matching_pattern(draw: st.DrawFn) -> dict[str, str]:
 def test_allow_extra_fields_with_pattern(
     data: dict[str, str], data_strategy: st.DataObject
 ):
-    if "value" not in data.keys():
+    if "value" not in data:
         data["value"] = data_strategy.draw(st.text())
 
     with Logger.context():
@@ -90,7 +90,7 @@ def test_allow_extra_fields_with_pattern(
 def test_allow_extra_fields_with_pattern_and_extra(
     data: dict[str, str], data_strategy: st.DataObject
 ):
-    if "value" not in data.keys():
+    if "value" not in data:
         data["value"] = data_strategy.draw(st.text())
 
     # Add another field not begining with 'x-'

{amati-0.3.1 → amati-0.3.3}/tests/validators/test_licence_object.py

@@ -145,13 +145,12 @@ def test_case_4_id_url_match(name: str, identifier: str):
 @given(text_excluding_empty_string(), st.sampled_from(VALID_IDENTIFIERS_WITH_URLS))
 def test_case_4_id_url_match_no(name: str, identifier: str):
     url = unassociated_url(identifier)
-    print(url)
+
     with Logger.context():
         LicenceObject(name=name, identifier=identifier, url=url)  # type: ignore
         assert Logger.logs[0]["msg"]
         assert Logger.logs[0]["type"] == "value_error"
-        for i in Logger.logs:
-            print(i)
+
         assert (
             Logger.logs[1]["msg"]
             == f"{url} is not associated with the identifier {identifier}"

{amati-0.3.1 → amati-0.3.3}/uv.lock

@@ -13,7 +13,7 @@ wheels = [
 
 [[package]]
 name = "amati"
-version = "0.3.1"
+version = "0.3.3"
 source = { editable = "." }
 dependencies = [
     { name = "abnf" },