Features/add remote reference support rebased

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Additions
 
+- Add support of properties indirect reference ($ref) resolution; Add support of inner properties direct and indirect reference resolution to its owner model/enum (#329). Thanks @p1-ra!
 - New `--meta` command line option for specifying what type of metadata should be generated:
   - `poetry` is the default value, same behavior you're used to in previous versions
   - `setup` will generate a pyproject.toml with no Poetry information, and instead create a `setup.py` with the

end_to_end_tests/golden-record-custom/custom_e2e/models/a_model.py

@@ -27,6 +27,9 @@ class AModel:
     a_nullable_date: Optional[datetime.date]
     required_nullable: Optional[str]
     nullable_model: Optional[AModelNullableModel]
+    an_enum_indirect_ref: Union[Unset, AnEnum] = UNSET
+    direct_ref_to_itself: Union["AModel", Unset] = UNSET
+    indirect_ref_to_itself: Union["AModel", Unset] = UNSET
     nested_list_of_enums: Union[Unset, List[List[DifferentEnum]]] = UNSET
     a_not_required_date: Union[Unset, datetime.date] = UNSET
     attr_1_leading_digit: Union[Unset, str] = UNSET
@@ -48,6 +51,18 @@ def to_dict(self) -> Dict[str, Any]:
         required_not_nullable = self.required_not_nullable
         model = self.model.to_dict()
 
+        an_enum_indirect_ref: Union[Unset, AnEnum] = UNSET
+        if not isinstance(self.an_enum_indirect_ref, Unset):
+            an_enum_indirect_ref = self.an_enum_indirect_ref
+
+        direct_ref_to_itself: Union[Unset, Dict[str, Any]] = UNSET
+        if not isinstance(self.direct_ref_to_itself, Unset):
+            direct_ref_to_itself = self.direct_ref_to_itself.to_dict()
+
+        indirect_ref_to_itself: Union[Unset, Dict[str, Any]] = UNSET
+        if not isinstance(self.indirect_ref_to_itself, Unset):
+            indirect_ref_to_itself = self.indirect_ref_to_itself.to_dict()
+
         nested_list_of_enums: Union[Unset, List[Any]] = UNSET
         if not isinstance(self.nested_list_of_enums, Unset):
             nested_list_of_enums = []
@@ -94,6 +109,12 @@ def to_dict(self) -> Dict[str, Any]:
                 "nullable_model": nullable_model,
             }
         )
+        if an_enum_indirect_ref is not UNSET:
+            field_dict["an_enum_indirect_ref"] = an_enum_indirect_ref
+        if direct_ref_to_itself is not UNSET:
+            field_dict["direct_ref_to_itself"] = direct_ref_to_itself
+        if indirect_ref_to_itself is not UNSET:
+            field_dict["indirect_ref_to_itself"] = indirect_ref_to_itself
         if nested_list_of_enums is not UNSET:
             field_dict["nested_list_of_enums"] = nested_list_of_enums
         if a_not_required_date is not UNSET:
@@ -137,6 +158,21 @@ def _parse_a_camel_date_time(data: Any) -> Union[datetime.datetime, datetime.dat
 
         model = AModelModel.from_dict(d.pop("model"))
 
+        an_enum_indirect_ref: Union[Unset, AnEnum] = UNSET
+        _an_enum_indirect_ref = d.pop("an_enum_indirect_ref", UNSET)
+        if not isinstance(_an_enum_indirect_ref, Unset):
+            an_enum_indirect_ref = AnEnum(_an_enum_indirect_ref)
+
+        direct_ref_to_itself: Union[AModel, Unset] = UNSET
+        _direct_ref_to_itself = d.pop("direct_ref_to_itself", UNSET)
+        if not isinstance(_direct_ref_to_itself, Unset):
+            direct_ref_to_itself = AModel.from_dict(_direct_ref_to_itself)
+
+        indirect_ref_to_itself: Union[AModel, Unset] = UNSET
+        _indirect_ref_to_itself = d.pop("indirect_ref_to_itself", UNSET)
+        if not isinstance(_indirect_ref_to_itself, Unset):
+            indirect_ref_to_itself = AModel.from_dict(_indirect_ref_to_itself)
+
         nested_list_of_enums = []
         _nested_list_of_enums = d.pop("nested_list_of_enums", UNSET)
         for nested_list_of_enums_item_data in _nested_list_of_enums or []:
@@ -188,6 +224,9 @@ def _parse_a_camel_date_time(data: Any) -> Union[datetime.datetime, datetime.dat
             a_date=a_date,
             required_not_nullable=required_not_nullable,
             model=model,
+            an_enum_indirect_ref=an_enum_indirect_ref,
+            direct_ref_to_itself=direct_ref_to_itself,
+            indirect_ref_to_itself=indirect_ref_to_itself,
             nested_list_of_enums=nested_list_of_enums,
             a_nullable_date=a_nullable_date,
             a_not_required_date=a_not_required_date,

end_to_end_tests/golden-record/my_test_api_client/models/a_model.py

@@ -27,6 +27,9 @@ class AModel:
     a_nullable_date: Optional[datetime.date]
     required_nullable: Optional[str]
     nullable_model: Optional[AModelNullableModel]
+    an_enum_indirect_ref: Union[Unset, AnEnum] = UNSET
+    direct_ref_to_itself: Union["AModel", Unset] = UNSET
+    indirect_ref_to_itself: Union["AModel", Unset] = UNSET
     nested_list_of_enums: Union[Unset, List[List[DifferentEnum]]] = UNSET
     a_not_required_date: Union[Unset, datetime.date] = UNSET
     attr_1_leading_digit: Union[Unset, str] = UNSET
@@ -48,6 +51,18 @@ def to_dict(self) -> Dict[str, Any]:
         required_not_nullable = self.required_not_nullable
         model = self.model.to_dict()
 
+        an_enum_indirect_ref: Union[Unset, AnEnum] = UNSET
+        if not isinstance(self.an_enum_indirect_ref, Unset):
+            an_enum_indirect_ref = self.an_enum_indirect_ref
+
+        direct_ref_to_itself: Union[Unset, Dict[str, Any]] = UNSET
+        if not isinstance(self.direct_ref_to_itself, Unset):
+            direct_ref_to_itself = self.direct_ref_to_itself.to_dict()
+
+        indirect_ref_to_itself: Union[Unset, Dict[str, Any]] = UNSET
+        if not isinstance(self.indirect_ref_to_itself, Unset):
+            indirect_ref_to_itself = self.indirect_ref_to_itself.to_dict()
+
         nested_list_of_enums: Union[Unset, List[Any]] = UNSET
         if not isinstance(self.nested_list_of_enums, Unset):
             nested_list_of_enums = []
@@ -94,6 +109,12 @@ def to_dict(self) -> Dict[str, Any]:
                 "nullable_model": nullable_model,
             }
         )
+        if an_enum_indirect_ref is not UNSET:
+            field_dict["an_enum_indirect_ref"] = an_enum_indirect_ref
+        if direct_ref_to_itself is not UNSET:
+            field_dict["direct_ref_to_itself"] = direct_ref_to_itself
+        if indirect_ref_to_itself is not UNSET:
+            field_dict["indirect_ref_to_itself"] = indirect_ref_to_itself
         if nested_list_of_enums is not UNSET:
             field_dict["nested_list_of_enums"] = nested_list_of_enums
         if a_not_required_date is not UNSET:
@@ -137,6 +158,21 @@ def _parse_a_camel_date_time(data: Any) -> Union[datetime.datetime, datetime.dat
 
         model = AModelModel.from_dict(d.pop("model"))
 
+        an_enum_indirect_ref: Union[Unset, AnEnum] = UNSET
+        _an_enum_indirect_ref = d.pop("an_enum_indirect_ref", UNSET)
+        if not isinstance(_an_enum_indirect_ref, Unset):
+            an_enum_indirect_ref = AnEnum(_an_enum_indirect_ref)
+
+        direct_ref_to_itself: Union[AModel, Unset] = UNSET
+        _direct_ref_to_itself = d.pop("direct_ref_to_itself", UNSET)
+        if not isinstance(_direct_ref_to_itself, Unset):
+            direct_ref_to_itself = AModel.from_dict(_direct_ref_to_itself)
+
+        indirect_ref_to_itself: Union[AModel, Unset] = UNSET
+        _indirect_ref_to_itself = d.pop("indirect_ref_to_itself", UNSET)
+        if not isinstance(_indirect_ref_to_itself, Unset):
+            indirect_ref_to_itself = AModel.from_dict(_indirect_ref_to_itself)
+
         nested_list_of_enums = []
         _nested_list_of_enums = d.pop("nested_list_of_enums", UNSET)
         for nested_list_of_enums_item_data in _nested_list_of_enums or []:
@@ -188,6 +224,9 @@ def _parse_a_camel_date_time(data: Any) -> Union[datetime.datetime, datetime.dat
             a_date=a_date,
             required_not_nullable=required_not_nullable,
             model=model,
+            an_enum_indirect_ref=an_enum_indirect_ref,
+            direct_ref_to_itself=direct_ref_to_itself,
+            indirect_ref_to_itself=indirect_ref_to_itself,
             nested_list_of_enums=nested_list_of_enums,
             a_nullable_date=a_nullable_date,
             a_not_required_date=a_not_required_date,

end_to_end_tests/openapi.json

@@ -675,6 +675,15 @@
         "required": ["an_enum_value", "aCamelDateTime", "a_date", "a_nullable_date", "required_nullable", "required_not_nullable", "model", "nullable_model"],
         "type": "object",
         "properties": {
+          "an_enum_indirect_ref": {
+            "$ref": "#/components/schemas/AnEnumDeeperIndirectReference"
+          },
+          "direct_ref_to_itself": {
+            "$ref": "#/components/schemas/AModel"
+          },
+          "indirect_ref_to_itself": {
+            "$ref": "#/components/schemas/AModelDeeperIndirectReference"
+          },
           "an_enum_value": {
             "$ref": "#/components/schemas/AnEnum"
           },
@@ -716,7 +725,7 @@
           "a_not_required_date": {
             "title": "A Nullable Date",
             "type": "string",
-            "format": "date",
+            "format": "date"
           },
           "1_leading_digit": {
             "title": "Leading Digit",
@@ -782,11 +791,23 @@
         "description": "A Model for testing all the ways custom objects can be used ",
         "additionalProperties": false
       },
+      "AModelIndirectReference": {
+        "$ref": "#/components/schemas/AModel"
+      },
+      "AModelDeeperIndirectReference": {
+        "$ref": "#/components/schemas/AModelIndirectReference"
+      },
+      "AnEnumIndirectReference": {
+       "$ref": "#/components/schemas/AnEnum" 
+      },
       "AnEnum": {
         "title": "AnEnum",
         "enum": ["FIRST_VALUE", "SECOND_VALUE"],
         "description": "For testing Enums in all the ways they can be used "
       },
+      "AnEnumDeeperIndirectReference": {
+        "$ref": "#/components/schemas/AnEnumIndirectReference" 
+      },
       "AnIntEnum": {
         "title": "AnIntEnum",
         "enum": [-1, 1, 2],

openapi_python_client/__init__.py

@@ -3,19 +3,20 @@
 import shutil
 import subprocess
 import sys
+import urllib
 from enum import Enum
 from pathlib import Path
-from typing import Any, Dict, Optional, Sequence, Union
+from typing import Any, Dict, Optional, Sequence, Union, cast
 
 import httpcore
 import httpx
-import yaml
 from jinja2 import BaseLoader, ChoiceLoader, Environment, FileSystemLoader, PackageLoader
 
 from openapi_python_client import utils
 
 from .parser import GeneratorData, import_string_from_reference
 from .parser.errors import GeneratorError
+from .resolver.schema_resolver import SchemaResolver
 from .utils import snake_case
 
 if sys.version_info.minor < 8:  # version did not exist before 3.8, need to use a backport
@@ -318,20 +319,21 @@ def update_existing_client(
 
 
 def _get_document(*, url: Optional[str], path: Optional[Path]) -> Union[Dict[str, Any], GeneratorError]:
-    yaml_bytes: bytes
     if url is not None and path is not None:
         return GeneratorError(header="Provide URL or Path, not both.")
-    if url is not None:
-        try:
-            response = httpx.get(url)
-            yaml_bytes = response.content
-        except (httpx.HTTPError, httpcore.NetworkError):
-            return GeneratorError(header="Could not get OpenAPI document from provided URL")
-    elif path is not None:
-        yaml_bytes = path.read_bytes()
-    else:
+
+    if url is None and path is None:
         return GeneratorError(header="No URL or Path provided")
+
+    source = cast(Union[str, Path], (url if url is not None else path))
     try:
-        return yaml.safe_load(yaml_bytes)
-    except yaml.YAMLError:
+        resolver = SchemaResolver(source)
+        result = resolver.resolve()
+        if len(result.errors) > 0:
+            return GeneratorError(header="; ".join(result.errors))
+    except (httpx.HTTPError, httpcore.NetworkError, urllib.error.URLError):
+        return GeneratorError(header="Could not get OpenAPI document from provided URL")
+    except Exception:
         return GeneratorError(header="Invalid YAML from provided source")
+
+    return result.schema