feat(parser): Detect OpenAPI documents of incorrect versions (closes #281)

Author: dbanty

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## 0.8.0 - Unreleased
 
 ### Additions
 
@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `setup` will generate a pyproject.toml with no Poetry information, and instead create a `setup.py` with the
     project info.
   - `none` will not create a project folder at all, only the inner package folder (which won't be inner anymore)
+- Attempt to detect and alert users if they are using an unsupported version of OpenAPI (#281).
 
 ### Changes
 

openapi_python_client/parser/openapi.py

@@ -260,12 +260,22 @@ class GeneratorData:
     enums: Dict[str, EnumProperty]
 
     @staticmethod
-    def from_dict(d: Dict[str, Dict[str, Any]]) -> Union["GeneratorData", GeneratorError]:
+    def from_dict(d: Dict[str, Any]) -> Union["GeneratorData", GeneratorError]:
         """ Create an OpenAPI from dict """
         try:
             openapi = oai.OpenAPI.parse_obj(d)
         except ValidationError as e:
-            return GeneratorError(header="Failed to parse OpenAPI document", detail=str(e))
+            detail = str(e)
+            if "swagger" in d:
+                detail = (
+                    "You may be trying to use a Swagger document; this is not supported by this project.\n\n" + detail
+                )
+            return GeneratorError(header="Failed to parse OpenAPI document", detail=detail)
+        if openapi.openapi.major != 3:
+            return GeneratorError(
+                header="openapi-python-client only supports OpenAPI 3.x",
+                detail=f"The version of the provided document was {openapi.openapi}",
+            )
         if openapi.components is None or openapi.components.schemas is None:
             schemas = Schemas()
         else:

openapi_python_client/schema/__init__.py

@@ -1,69 +1,50 @@
-"""
-OpenAPI v3.0.3 schema types, created according to the specification:
-https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md
-
-The type orders are according to the contents of the specification:
-https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#table-of-contents
-"""
-
 __all__ = [
-    "Components",
-    "Contact",
-    "Discriminator",
-    "Encoding",
-    "Example",
-    "ExternalDocumentation",
-    "Header",
-    "Info",
-    "License",
-    "Link",
     "MediaType",
-    "OAuthFlow",
-    "OAuthFlows",
     "OpenAPI",
     "Operation",
     "Parameter",
     "PathItem",
-    "Paths",
     "Reference",
     "RequestBody",
     "Response",
     "Responses",
     "Schema",
-    "SecurityRequirement",
-    "SecurityScheme",
-    "Server",
-    "ServerVariable",
-    "Tag",
-    "XML",
 ]
 
-from .components import Components
-from .contact import Contact
-from .discriminator import Discriminator
-from .encoding import Encoding
-from .example import Example
-from .external_documentation import ExternalDocumentation
-from .header import Header
-from .info import Info
-from .license import License
-from .link import Link
-from .media_type import MediaType
-from .oauth_flow import OAuthFlow
-from .oauth_flows import OAuthFlows
-from .open_api import OpenAPI
-from .operation import Operation
-from .parameter import Parameter
-from .path_item import PathItem
-from .paths import Paths
-from .reference import Reference
-from .request_body import RequestBody
-from .response import Response
-from .responses import Responses
-from .schema import Schema
-from .security_requirement import SecurityRequirement
-from .security_scheme import SecurityScheme
-from .server import Server
-from .server_variable import ServerVariable
-from .tag import Tag
-from .xml import XML
+
+import re
+from typing import Callable, Iterator
+
+from .openapi_schema_pydantic import MediaType
+from .openapi_schema_pydantic import OpenAPI as _OpenAPI
+from .openapi_schema_pydantic import Operation, Parameter, PathItem, Reference, RequestBody, Response, Responses, Schema
+
+regex = re.compile(r"(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)")
+
+
+class SemVer:
+    def __init__(self, str_value: str) -> None:
+        self.str_value = str_value
+        if not isinstance(str_value, str):
+            raise TypeError("string required")
+        m = regex.fullmatch(str_value)
+        if not m:
+            raise ValueError("invalid semantic versioning format")
+        self.major = int(m.group(1))
+        self.minor = int(m.group(2))
+        self.patch = int(m.group(3))
+
+    @classmethod
+    def __get_validators__(cls) -> Iterator[Callable[[str], "SemVer"]]:
+        yield cls.validate
+
+    @classmethod
+    def validate(cls, v: str) -> "SemVer":
+        return cls(v)
+
+    def __str__(self) -> str:
+        return self.str_value
+
+
+class OpenAPI(_OpenAPI):
+    openapi: SemVer

openapi_python_client/schema/LICENSE renamed to openapi_python_client/schema/openapi_schema_pydantic/LICENSE

@@ -1,4 +1,4 @@
-# OpenAPI v3.0.3 schema classes
+Everything in this directory (including the rest of this file after this paragraph) is a vendored copy of [openapi-schem-pydantic](https://github.com/kuimono/openapi-schema-pydantic) and is licensed under the LICENSE file in this directory.
 
 ## Alias
 

openapi_python_client/schema/README.md renamed to openapi_python_client/schema/openapi_schema_pydantic/README.md

@@ -0,0 +1,69 @@
+"""
+OpenAPI v3.0.3 schema types, created according to the specification:
+https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md
+
+The type orders are according to the contents of the specification:
+https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#table-of-contents
+"""
+
+__all__ = [
+    "Components",
+    "Contact",
+    "Discriminator",
+    "Encoding",
+    "Example",
+    "ExternalDocumentation",
+    "Header",
+    "Info",
+    "License",
+    "Link",
+    "MediaType",
+    "OAuthFlow",
+    "OAuthFlows",
+    "OpenAPI",
+    "Operation",
+    "Parameter",
+    "PathItem",
+    "Paths",
+    "Reference",
+    "RequestBody",
+    "Response",
+    "Responses",
+    "Schema",
+    "SecurityRequirement",
+    "SecurityScheme",
+    "Server",
+    "ServerVariable",
+    "Tag",
+    "XML",
+]
+
+from .components import Components
+from .contact import Contact
+from .discriminator import Discriminator
+from .encoding import Encoding
+from .example import Example
+from .external_documentation import ExternalDocumentation
+from .header import Header
+from .info import Info
+from .license import License
+from .link import Link
+from .media_type import MediaType
+from .oauth_flow import OAuthFlow
+from .oauth_flows import OAuthFlows
+from .open_api import OpenAPI
+from .operation import Operation
+from .parameter import Parameter
+from .path_item import PathItem
+from .paths import Paths
+from .reference import Reference
+from .request_body import RequestBody
+from .response import Response
+from .responses import Responses
+from .schema import Schema
+from .security_requirement import SecurityRequirement
+from .security_scheme import SecurityScheme
+from .server import Server
+from .server_variable import ServerVariable
+from .tag import Tag
+from .xml import XML