Resolve circular import for Operation and PathItem

Author: dachucky

openapi_python_client/schema/openapi_schema_pydantic/operation.py

@@ -5,6 +5,9 @@
 from .callback import Callback
 from .external_documentation import ExternalDocumentation
 from .parameter import Parameter
+
+# Required to update forward ref after object creation, as this is not imported yet
+from .path_item import PathItem  # pylint: disable=unused-import
 from .reference import Reference
 from .request_body import RequestBody
 from .responses import Responses
@@ -79,3 +82,7 @@ class Config:  # pylint: disable=missing-class-docstring
                 }
             ]
         }
+
+
+# PathItem in Callback uses Operation, so we need to update forward refs due to circular dependency
+Operation.update_forward_refs()

openapi_python_client/schema/openapi_schema_pydantic/path_item.py

@@ -2,7 +2,6 @@
 
 from pydantic import BaseModel, Extra, Field
 
-from .operation import Operation
 from .parameter import Parameter
 from .reference import Reference
 from .server import Server
@@ -23,14 +22,14 @@ class PathItem(BaseModel):
     ref: Optional[str] = Field(default=None, alias="$ref")
     summary: Optional[str] = None
     description: Optional[str] = None
-    get: Optional[Operation] = None
-    put: Optional[Operation] = None
-    post: Optional[Operation] = None
-    delete: Optional[Operation] = None
-    options: Optional[Operation] = None
-    head: Optional[Operation] = None
-    patch: Optional[Operation] = None
-    trace: Optional[Operation] = None
+    get: Optional["Operation"] = None
+    put: Optional["Operation"] = None
+    post: Optional["Operation"] = None
+    delete: Optional["Operation"] = None
+    options: Optional["Operation"] = None
+    head: Optional["Operation"] = None
+    patch: Optional["Operation"] = None
+    trace: Optional["Operation"] = None
     servers: Optional[List[Server]] = None
     parameters: Optional[List[Union[Parameter, Reference]]] = None
 
@@ -70,3 +69,9 @@ class Config:  # pylint: disable=missing-class-docstring
                 }
             ]
         }
+
+
+# Operation uses PathItem via Callback, so we need late import and to update forward refs due to circular dependency
+from .operation import Operation  # pylint: disable=wrong-import-position unused-import
+
+PathItem.update_forward_refs()

tests/test_schema/test_open_api.py

@@ -14,3 +14,23 @@ def test_validate_version(version, valid):
     else:
         with pytest.raises(ValidationError):
             OpenAPI.parse_obj(data)
+
+
+def test_parse_with_callback():
+    data = {
+        "openapi": "3.0.1",
+        "info": {"title": "API with Callback", "version": ""},
+        "paths": {
+            "/create": {
+                "post": {
+                    "responses": {"200": {"description": "Success"}},
+                    "callbacks": {"event": {"callback": {"post": {"responses": {"200": {"description": "Success"}}}}}},
+                }
+            }
+        },
+    }
+
+    open_api = OpenAPI.parse_obj(data)
+    create_endpoint = open_api.paths["/create"]
+    assert "200" in create_endpoint.post.responses
+    assert "200" in create_endpoint.post.callbacks["event"]["callback"].post.responses