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

amati/validators/oas311.py

@@ -23,23 +23,21 @@ from pydantic import (
     ConfigDict,
     Field,
     RootModel,
-    ValidationError,
     model_validator,
 )
 
-from amati import AmatiValueError, Reference
+from amati import AmatiValueError
 from amati import model_validators as mv
 from amati.fields import (
     SPDXURL,
     URI,
-    HTTPStatusCode,
     SPDXIdentifier,
 )
 from amati.fields.commonmark import CommonMark
 from amati.fields.json import JSON
 from amati.fields.oas import OpenAPI
 from amati.fields.spdx_licences import VALID_LICENCES
-from amati.logging import Log, LogMixin
+from amati.logging import LogMixin
 from amati.validators.generic import GenericObject, allow_extra_fields
 from amati.validators.oas304 import (
     CallbackObject,
@@ -53,6 +51,7 @@ from amati.validators.oas304 import (
     PathsObject,
     RequestBodyObject,
     ResponseObject,
+    ResponsesObject,
 )
 from amati.validators.oas304 import SecuritySchemeObject as OAS30SecuritySchemeObject
 from amati.validators.oas304 import (
@@ -84,10 +83,8 @@ class LicenceObject(GenericObject):
     # What difference does Optional make here?
     identifier: Optional[SPDXIdentifier] = None
     url: Optional[URI] = None
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/v3.1.1.html#license-object",
-        section="License Object",
+    _reference_uri: ClassVar[str] = URI(
+        "https://spec.openapis.org/oas/v3.1.1.html#license-object"
     )
 
     _not_url_and_identifier = mv.only_one_of(["url", "identifier"])
@@ -109,11 +106,13 @@ class LicenceObject(GenericObject):
                 SPDXURL(self.url)
             except AmatiValueError:
                 LogMixin.log(
-                    Log(
-                        message=f"{self.url} is not a valid SPDX URL",
-                        type=Warning,
-                        reference=self._reference,
-                    )
+                    {
+                        "msg": f"{str(self.url)} is not a valid SPDX URL",
+                        "type": "warning",
+                        "loc": (self.__class__.__name__,),
+                        "input": self.url,
+                        "url": self._reference_uri,
+                    }
                 )
 
         # Both Identifier and URI, technically invalid, but should check if
@@ -124,11 +123,13 @@ class LicenceObject(GenericObject):
             and str(self.url) not in VALID_LICENCES[self.identifier]
         ):
             LogMixin.log(
-                Log(
-                    message=f"{self.url} is not associated with the identifier {self.identifier}",  # pylint: disable=line-too-long
-                    type=Warning,
-                    reference=self._reference,
-                )
+                {
+                    "msg": f"{self.url} is not associated with the identifier {self.identifier}",  # pylint: disable=line-too-long
+                    "type": "warning",
+                    "loc": (self.__class__.__name__,),
+                    "input": self.model_dump_json(),
+                    "url": self._reference_uri,
+                }
             )
 
         return self
@@ -149,10 +150,8 @@ class ReferenceObject(GenericObject):
     ref: URI = Field(alias="$ref")
     summary: Optional[str]
     description: Optional[CommonMark]
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/v3.1.1.html#reference-object",
-        section="Reference Object",
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/v3.1.1.html#reference-object"
     )
 
 
@@ -169,10 +168,8 @@ class InfoObject(GenericObject):
     contact: Optional[ContactObject] = None
     license: Optional[LicenceObject] = None
     version: str
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/3.1.1.html#info-object",
-        section="Info Object",
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/3.1.1.html#info-object"
     )
 
 
@@ -187,10 +184,8 @@ class DiscriminatorObject(GenericObject):
     # properly.
     propertyName: str
     mapping: Optional[dict[str, str | URI]] = None
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/v3.1.1.html#discriminator-object",
-        section="Discriminator Object",
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/v3.1.1.html#discriminator-object"
     )
 
 
@@ -203,10 +198,8 @@ class ServerVariableObject(GenericObject):
     enum: Optional[list[str]] = Field(None, min_length=1)
     default: str = Field(min_length=1)
     description: Optional[str | CommonMark] = None
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/v3.1.1.html#server-variable-object",
-        section="Server Variable Object",
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/v3.1.1.html#server-variable-object"
     )
 
     @model_validator(mode="after")
@@ -222,11 +215,13 @@ class ServerVariableObject(GenericObject):
 
         if self.default not in self.enum:
             LogMixin.log(
-                Log(
-                    message=f"The default value {self.default} is not in the enum list {self.enum}",  # pylint: disable=line-too-long
-                    type=ValueError,
-                    reference=self._reference,
-                )
+                {
+                    "msg": f"The default value {self.default} is not in the enum list {self.enum}",  # pylint: disable=line-too-long
+                    "type": "value_error",
+                    "loc": (self.__class__.__name__,),
+                    "input": {"default": self.default, "enum": self.enum},
+                    "url": self._reference_uri,
+                }
             )
 
         return self
@@ -249,10 +244,8 @@ class OperationObject(GenericObject):
     security: Optional[list["SecurityRequirementObject"]] = None
     servers: Optional[list[ServerObject]] = None
 
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/v3.1.1.html#operation-object",
-        section="Operation Object",
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/v3.1.1.html#operation-object"
     )
 
 
@@ -267,6 +260,7 @@ PARAMETER_STYLES: set[str] = {
 }
 
 
+@specification_extensions("x-")
 class ParameterObject(GenericObject):
     """Validates the OpenAPI Specification parameter object - §4.8.11"""
 
@@ -283,6 +277,9 @@ class ParameterObject(GenericObject):
     example: Optional[Any] = None
     examples: Optional[dict[str, "ExampleObject | ReferenceObject"]] = None
     content: Optional[dict[str, "MediaTypeObject"]] = None
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/v3.1.1.html#parameter-object"
+    )
 
     _in_valid = mv.if_then(
         conditions={"in_": mv.UNKNOWN},
@@ -328,99 +325,10 @@ class MediaTypeObject(GenericObject):
     example: Optional[Any] = None
     examples: Optional[dict[str, ExampleObject | ReferenceObject]] = None
     encoding: Optional["EncodingObject"] = None
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/v3.1.1.html#media-type-object",
-        section="Tag Object",
-    )
-
-
-type _ResponsesObjectReturnType = dict[str, "ReferenceObject | ResponseObject"]
-
-
-@specification_extensions("x-")
-class ResponsesObject(GenericObject):
-    """
-    Validates the OpenAPI Specification responses object - §4.8.16
-    """
-
-    model_config = ConfigDict(
-        extra="allow",
-    )
-
-    default: Optional["ResponseObject | ReferenceObject"] = None
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/v3.1.1.html#responses-object",
-        section="Responses Object",
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/v3.1.1.html#media-type-object"
     )
 
-    @classmethod
-    def _choose_model(
-        cls, value: Any, field_name: str
-    ) -> "ReferenceObject | ResponseObject":
-        """
-        Choose the model to use for validation based on the type of value.
-
-        Args:
-            value: The value to validate.
-
-        Returns:
-            The model class to use for validation.
-        """
-
-        message = f"{field_name} must be a ResponseObject or ReferenceObject, got {type(value)}"  # pylint: disable=line-too-long
-
-        try:
-            return ResponseObject.model_validate(value)
-        except ValidationError:
-            try:
-                return ReferenceObject.model_validate(value)
-            except ValidationError as e:
-                raise ValueError(message, ResponsesObject._reference) from e
-
-    @model_validator(mode="before")
-    @classmethod
-    def validate_all_fields(cls, data: dict[str, Any]) -> _ResponsesObjectReturnType:
-        """
-        Validates the responses object.
-        """
-
-        validated_data: _ResponsesObjectReturnType = {}
-
-        for field_name, value in data.items():
-
-            # If the value is a specification extension, allow it
-            if field_name.startswith("x-"):
-                validated_data[field_name] = value
-                continue
-
-            # If the value is the fixed field, "default", allow it
-            if field_name == "default":
-                if isinstance(value, dict):
-                    validated_data[field_name] = ResponsesObject._choose_model(
-                        value, field_name
-                    )
-                continue
-
-            # Otherwise, if the field appears like a valid HTTP status code or a range
-            if re.match(r"^[1-5]([0-9]{2}|XX)+$", str(field_name)):
-
-                # Double check and raise a value error if not
-                HTTPStatusCode(field_name)
-
-                # and validate as a ResponseObject or ReferenceObject
-                validated_data[field_name] = ResponsesObject._choose_model(
-                    value, field_name
-                )
-
-                continue
-
-            # If the field is not a valid HTTP status code or "default"
-            raise ValueError(f"Invalid type for numeric field '{field_name}'")
-
-        return validated_data
-
 
 class SchemaObject(GenericObject):
     """
@@ -452,10 +360,8 @@ class SchemaObject(GenericObject):
         default=None, alias="$ref"
     )  # Reference to another schema
 
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/v3.1.1.html#schema-object",
-        section="Link Object",
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/v3.1.1.html#schema-object"
     )
 
     @model_validator(mode="after")
@@ -491,11 +397,13 @@ class SchemaObject(GenericObject):
             validator_cls(meta_schema).validate(schema_dict)  # type: ignore
         except JSONVSchemeValidationError as e:
             LogMixin.log(
-                Log(
-                    message=f"Invalid JSON Schema: {e.message}",
-                    type=ValueError,
-                    reference=self._reference,
-                )
+                {
+                    "msg": f"Invalid JSON Schema: {e.message}",
+                    "type": "value_error",
+                    "loc": (self.__class__.__name__,),
+                    "input": schema_dict,
+                    "url": self._reference_uri,
+                }
             )
 
         return self
@@ -527,10 +435,8 @@ class SecurityRequirementObject(RootModel[list[_Requirement] | _Requirement]):
     # FIXME: The name must be a valid Security Scheme - need to use post-processing
     # FIXME If the security scheme is of type "oauth2" or "openIdConnect", then the
     # value must be a list
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/3.1.1.html#security-requirement-object",
-        section="Security Requirement Object",
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/3.1.1.html#security-requirement-object"
     )
 
 
@@ -542,7 +448,7 @@ class ComponentsObject(GenericObject):
 
     schemas: Optional[dict[str, SchemaObject | ReferenceObject]] = None
     responses: Optional[dict[str, ResponseObject | ReferenceObject]] = None
-    paremeters: Optional[dict[str, ParameterObject | ReferenceObject]] = None
+    parameters: Optional[dict[str, ParameterObject | ReferenceObject]] = None
     examples: Optional[dict[str, ExampleObject | ReferenceObject]] = None
     requestBodies: Optional[dict[str, RequestBodyObject | ReferenceObject]] = None
     headers: Optional[dict[str, HeaderObject | ReferenceObject]] = None
@@ -550,10 +456,8 @@ class ComponentsObject(GenericObject):
     links: Optional[dict[str, LinkObject | ReferenceObject]] = None
     callbacks: Optional[dict[str, CallbackObject | ReferenceObject]] = None
     pathItems: Optional[dict[str, PathItemObject]] = None
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/v3.1.1.html#components-object",
-        section="Components Object",
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/v3.1.1.html#components-object"
     )
 
     @model_validator(mode="before")
@@ -608,8 +512,6 @@ class OpenAPIObject(GenericObject):
     security: Optional[list[SecurityRequirementObject]] = None
     tags: Optional[list[TagObject]] = None
     externalDocs: Optional[ExternalDocumentationObject] = None
-    _reference: ClassVar[Reference] = Reference(
-        title=TITLE,
-        url="https://spec.openapis.org/oas/3.1.1.html#openapi-object",
-        section="OpenAPI Object",
+    _reference_uri: ClassVar[str] = (
+        "https://spec.openapis.org/oas/3.1.1.html#openapi-object"
     )

{amati-0.1.0.dist-info → amati-0.2.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.2
+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>
@@ -15,6 +15,7 @@ Classifier: Topic :: Software Development :: Testing :: Acceptance
 Requires-Python: >=3.13
 Requires-Dist: abnf>=2.3.1
 Requires-Dist: idna>=3.10
+Requires-Dist: jinja2>=3.1.6
 Requires-Dist: jsonpickle>=4.1.1
 Requires-Dist: jsonschema>=4.24.0
 Requires-Dist: pydantic>=2.11.5
@@ -23,26 +24,64 @@ Description-Content-Type: text/markdown
 
 # amati
 
-A programme designed to validate that a file conforms to [OpenAPI Specification](https://spec.openapis.org/oas/v3.1.1.html) (OAS).
-
-Currently a proof of concept.
+amati is designed to validate that a file conforms to the [OpenAPI Specification v3.x](https://spec.openapis.org/) (OAS).
 
 ## Name
 
 amati means to observe in Malay, especially with attention to detail. It's also one of the plurals of beloved or favourite in Italian.
 
+## Usage
+
+```sh
+python amati/amati.py --help
+usage: amati [-h] [-s SPEC] [-cc] [-d DISCOVER] [-l] [-hr]
+
+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. Creates a file <filename>.errors.json alongside the original
+specification containing a JSON representation of all the errors.
+
+options:
+  -h, --help            show this help message and exit
+  -s, --spec SPEC       The specification to be parsed
+  -cc, --consistency-check
+                        Runs a consistency check between the input specification and the parsed specification
+  -d, --discover DISCOVER
+                        Searches the specified directory tree for openapi.yaml or openapi.json.
+  -l, --local           Store errors local to the caller in a file called <file-name>.errors.json; a .amati/ directory
+                        will be created.
+  -hr, --html-report    Creates an HTML report of the errors, called <file-name>.errors.html, alongside the original
+                        file or in a .amati/ directory if the --local switch is used
+```
+
+A Dockerfile is available on [DockerHub](https://hub.docker.com/r/benale/amati/tags)
+
+To run against a specific specification the location of the specification needs to be mounted in the container.
+
+```sh
+docker run -v "<path-to-mount>:/<mount-name> amati <options>
+```
+
+e.g. 
+
+```sh
+docker run -v /Users/myuser/myrepo:/data amati --spec data/myspec.yaml --hr
+```
+
 ## Architecture
 
 This uses Pydantic, especially the validation, and Typing to construct the entire OAS as a single data type. Passing a dictionary to the top-level data type runs all the validation in the Pydantic models constructing a single set of inherited classes and datatypes that validate that the API specification is accurate.
 
 Where the specification conforms, but relies on implementation-defined behavior (e.g. [data type formats](https://spec.openapis.org/oas/v3.1.1.html#data-type-format)), a warning will be raised.
 
-## Requirements
+## Contributing
+
+### Requirements
 
 * The latest version of [uv](https://docs.astral.sh/uv/)
 * [git 2.49+](https://git-scm.com/downloads/linux)
 
-## Testing and formatting
+### Testing and formatting
 
 This project uses:
 
@@ -54,7 +93,7 @@ This project uses:
 * [Black](https://black.readthedocs.io/en/stable/index.html) for automated formatting
 * [isort](https://pycqa.github.io/isort/) for import sorting
 
-It's expected that there are no errors, no surviving mutants and 100% of the code is reached and executed.
+It's expected that there are no errors and 100% of the code is reached and executed. The strategy for test coverage is based on parsing test specifications and not unit tests.
 
 amati runs tests on external specifications, detailed in `tests/data/.amati.tests.yaml`. To be able to run these tests the appropriate GitHub repos need to be local. Specific revisions of the repos can be downloaded by running
 
@@ -62,13 +101,15 @@ amati runs tests on external specifications, detailed in `tests/data/.amati.test
 python scripts/tests/setup_test_specs.py
 ```
 
-To run everything, from linting, type checking to downloading test specs run:
+To run everything, from linting, type checking to downloading test specs and building and testing the Docker image run:
 
 ```sh
 sh bin/checks.sh
 ```
 
-## Building
+You will need to have Docker installed.
+
+### Building
 
 The project uses a [`pyproject.toml` file](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#writing-pyproject-toml) to determine what to build.
 
@@ -80,6 +121,27 @@ uv venv
 uv sync
 ```
 
+### Docker
+
+A development Docker image is provided, `Dockerfile.dev`, to build:
+
+```sh
+docker build -t amati -f Dockerfile .
+```
+
+and to run against a specific specification the location of the specification needs to be mounted in the container.
+
+```sh
+docker run -v "<path-to-mount>:/<mount-name> amati <options>
+```
+
+This can be tested against a provided specification, from the root directory
+
+```sh
+docker run --detach -v "$(pwd):/data" amati
+```
+
+
 ### Data
 
 There are some scripts to create the data needed by the project, for example, all the possible licences. If the data needs to be refreshed this can be done by running the contents of `/scripts/data`.

amati-0.2.dist-info/RECORD

@@ -0,0 +1,37 @@
+amati/__init__.py,sha256=bsPoaYcFmejsqQN6eDxcuGKXg8ZXgk1NoD6Hujwhkkw,428
+amati/_error_handler.py,sha256=s_Nhnq8hz7xQP_yeCCJ8Hwzs5xyrxlisd1XFYYECtSY,1244
+amati/_resolve_forward_references.py,sha256=iOibCv_XuIUpe7qbRBtPzd7H5rvL-aldUzlXV_9FJaw,6511
+amati/amati.py,sha256=sgWQrlvvusK8EgdcsYkCZWUNiv0TAHV8jRivUCBByQA,7698
+amati/exceptions.py,sha256=X_RDBVjcFn_gXPFkhKuREmm5nDCdGs4rBy6sZsXBJDo,609
+amati/file_handler.py,sha256=h95t7TDxDA_qr4rIe2bddCjh2Xw5Ht27yLK7zCQzT68,5085
+amati/logging.py,sha256=X37gLui5Y94X1mlJIzkt3fQDwPcHlZiP3QBnM5Ipric,1339
+amati/model_validators.py,sha256=zKK9G-xaERc-e9AmWBLzCIGKkmpi0nMMx94N_nd8fs8,14979
+amati/data/http-status-codes.json,sha256=xEGBlE7eCXaQFG2gNSeK1aCs7A8XxOe6JcXwAKxwWBU,10903
+amati/data/iso9110.json,sha256=YLv6V8dPrgagjAnHUWKMmade5xboV_eJB9smnUfwgDY,1692
+amati/data/media-types.json,sha256=tSRZTUqIQeiW5cmw5aDAWNqXLGcvX4gwwEkDL5H6lDg,47108
+amati/data/schemes.json,sha256=47a16eEatxahMMAgSQXRiFF7FotiETKTkQcleqF5m6w,10252
+amati/data/spdx-licences.json,sha256=s9DHaYn4PSLVAEKE6wHEu_Rs-VI73WmsvcEgXSU6TTk,255373
+amati/data/tlds.json,sha256=wDio6l8toi54-cano3EUuH3zGEoBvivagKjgbpsCdYo,19235
+amati/fields/__init__.py,sha256=YPFOs0RZu7JlVuMEAkp6w9mNa1zgIZ6-0Mh-2v2tm6g,565
+amati/fields/_custom_types.py,sha256=zHQdzyntVEGbLSblOOdKNzpZTCkmpUZ4Ji6WS6TkcPc,2513
+amati/fields/commonmark.py,sha256=ssRc_338xd76y0MXR9U5OMkFE1ARCy-CWVOMY7AB8SU,220
+amati/fields/email.py,sha256=1jkRVT_uUrDS9Y_AilvWMm776rMYDPiqXM3nq8VZqGY,559
+amati/fields/http_status_codes.py,sha256=PaoebUSul9ZPwmyM0XIrrQ_4dxV4U0NURzXtbQlQVMg,3370
+amati/fields/iso9110.py,sha256=MCfPOC0vmRI0VhM2WmzQyFurHA9kpKR4_fBL2rzYqvw,1855
+amati/fields/json.py,sha256=TsNMW5gcCc3tpjDd0Sew_8okzDQu6S_FLKjGGvoRVos,304
+amati/fields/media.py,sha256=ZFgNHDr-kGzGToOH0RkV4xhuMW-KrVdYlU6_8-G1EHk,3132
+amati/fields/oas.py,sha256=oRvruhRmY9VQtlqiPaRvGKeeOgjYE-JG5aUZYZay6Kg,1733
+amati/fields/spdx_licences.py,sha256=0iXZYzdzElvYmnTrtJM07IODENMP7qd21knZ5eH-7ws,2794
+amati/fields/uri.py,sha256=iLAStugKYt1md4vP9oYrrsmME2d7XF9vSnLb6q_D5EA,11967
+amati/grammars/oas.py,sha256=vTMnJIxeiTC3gJATOo0RRZDlRsQOWkY6jG1VRzazLjM,1666
+amati/grammars/rfc6901.py,sha256=ChpKnoPDTsaNMvJT_UCpY8xwbl9zWZcD36MjRsD8IpQ,656
+amati/grammars/rfc7159.py,sha256=eksX1m7WRzQ9iGeANG1BgmsXbAhV6gQVRkPpLqPjq6U,2218
+amati/validators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+amati/validators/generic.py,sha256=AYIHIuEHpf1p-lCynBp-YGaayIZOylzNgGi533ykVbc,3983
+amati/validators/oas304.py,sha256=84sAc37azkgrOt29scjRtYtJGypnFZd5UkV9VGLsX8c,32472
+amati/validators/oas311.py,sha256=FVMOjNXWlZhq6fgah0NGGPlgdcSZFgVxVbEwWnk4Sn4,17712
+amati-0.2.dist-info/METADATA,sha256=pDJg9ueeR6-_otHva88kNPxiEy3e-AAMIRvxsc4RFhg,5916
+amati-0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+amati-0.2.dist-info/entry_points.txt,sha256=sacBb6g0f0ZJtNjNYx93_Xe4y5xzawvklCFVXup9ru0,37
+amati-0.2.dist-info/licenses/LICENSE,sha256=WAA01ZXeNs1bwpNWKR6aVucjtYjYm_iQIUYkCAENjqM,1070
+amati-0.2.dist-info/RECORD,,

amati/references.py

@@ -1,33 +0,0 @@
-"""
-Represents a reference, declared here to not put in __init__.
-"""
-
-from dataclasses import dataclass
-from typing import Optional, Sequence
-
-
-class AmatiReferenceException(Exception):
-    message: str = "Cannot construct empty references"
-
-
-@dataclass
-class Reference:
-    """
-    Attributes:
-        title : Title of the referenced content
-        section : Section of the referenced content
-        url : URL where the referenced content can be found
-    """
-
-    title: Optional[str] = None
-    section: Optional[str] = None
-    url: Optional[str] = None
-
-    def __post_init__(self):
-
-        if not self.title and not self.section and not self.url:
-            raise AmatiReferenceException
-
-
-type ReferenceArray = Sequence[Reference]
-type References = Reference | ReferenceArray

amati-0.1.0.dist-info/RECORD

@@ -1,37 +0,0 @@
-amati/__init__.py,sha256=C-4SGpCtZFCxS_PEPaGNFiKJu-gW5YxMSauYA-LxmzQ,449
-amati/_resolve_forward_references.py,sha256=iOibCv_XuIUpe7qbRBtPzd7H5rvL-aldUzlXV_9FJaw,6511
-amati/amati.py,sha256=fl6RL5_RWtoSpxTkEcDsgeejSh8HynxPuKvU4F5EwXY,3775
-amati/exceptions.py,sha256=Rm0njRFjyYTa6KcrbfwDXOz8IqZraCoXo82sDKseQMY,645
-amati/file_handler.py,sha256=h95t7TDxDA_qr4rIe2bddCjh2Xw5Ht27yLK7zCQzT68,5085
-amati/logging.py,sha256=AZXQv4jXKy6NAxths7DbpUlOWAhkh3XZ6imBtYjkHxc,1323
-amati/model_validators.py,sha256=omKagnWKQkhMc7AF5JWYZaLGNwYe38jVlCGgTO71zsY,14645
-amati/references.py,sha256=nGMUKIMGqZMpZcdQ7r_gxkcGARh9RULNhVBMej-ZiJE,788
-amati/data/http-status-codes.json,sha256=xEGBlE7eCXaQFG2gNSeK1aCs7A8XxOe6JcXwAKxwWBU,10903
-amati/data/iso9110.json,sha256=YLv6V8dPrgagjAnHUWKMmade5xboV_eJB9smnUfwgDY,1692
-amati/data/media-types.json,sha256=tSRZTUqIQeiW5cmw5aDAWNqXLGcvX4gwwEkDL5H6lDg,47108
-amati/data/schemes.json,sha256=47a16eEatxahMMAgSQXRiFF7FotiETKTkQcleqF5m6w,10252
-amati/data/spdx-licences.json,sha256=s9DHaYn4PSLVAEKE6wHEu_Rs-VI73WmsvcEgXSU6TTk,255373
-amati/data/tlds.json,sha256=wDio6l8toi54-cano3EUuH3zGEoBvivagKjgbpsCdYo,19235
-amati/fields/__init__.py,sha256=YPFOs0RZu7JlVuMEAkp6w9mNa1zgIZ6-0Mh-2v2tm6g,565
-amati/fields/_custom_types.py,sha256=zHQdzyntVEGbLSblOOdKNzpZTCkmpUZ4Ji6WS6TkcPc,2513
-amati/fields/commonmark.py,sha256=ssRc_338xd76y0MXR9U5OMkFE1ARCy-CWVOMY7AB8SU,220
-amati/fields/email.py,sha256=335vaJJmpASmScYCliCyxGElPvLt3bflNuAL6p-KGCg,661
-amati/fields/http_status_codes.py,sha256=bxhZIAlHyf7gYHIhxub-u2xb8VbXsqk96Oe3SnZ8RPM,3466
-amati/fields/iso9110.py,sha256=0nCJqJ3KXRnyUvJGyiMZfLd5ngixZlZpcYqsORAPhjc,1971
-amati/fields/json.py,sha256=TsNMW5gcCc3tpjDd0Sew_8okzDQu6S_FLKjGGvoRVos,304
-amati/fields/media.py,sha256=rst8okknJCQiQlDYYR_DIckd65VYHAK4A98Fl8C26z0,3268
-amati/fields/oas.py,sha256=J8QegOIiGcqGziJEaYxalsGZAMjWOt85R30k4oQ7h6w,1980
-amati/fields/spdx_licences.py,sha256=vPBkQsxC2z4uyeS2iGrgMTXJKHSn3VLBo9LR1uIyyh0,2866
-amati/fields/uri.py,sha256=FryHcn3D74-wA0GK9qATMju1KtWmfFb6K-Cy6jfXDL4,12390
-amati/grammars/oas.py,sha256=vTMnJIxeiTC3gJATOo0RRZDlRsQOWkY6jG1VRzazLjM,1666
-amati/grammars/rfc6901.py,sha256=ChpKnoPDTsaNMvJT_UCpY8xwbl9zWZcD36MjRsD8IpQ,656
-amati/grammars/rfc7159.py,sha256=eksX1m7WRzQ9iGeANG1BgmsXbAhV6gQVRkPpLqPjq6U,2218
-amati/validators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-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,,