pass models & enums as lists so custom templates can use them

Author: eli-bl

.changeset/fix-models-enums-lists.md

@@ -0,0 +1,11 @@
+---
+default: patch
+---
+
+# Make lists of models and enums work correctly in custom templates
+
+Lists of model and enum classes should be available to custom templates via the Jinja
+variables `openapi.models` and `openapi.enums`, but these were being passed in a way that made
+them always appear empty. This has been fixed so a custom template can now iterate over them.
+
+Closes #1188.

end_to_end_tests/custom-templates-golden-record/my_test_api_client/models/__init__.py

@@ -0,0 +1,16 @@
+# Testing that we can access model-related information via Jinja variables.
+
+# To avoid having to update this file in the golden record every time the test specs are changed,
+# we won't include all the classes in this output - we'll just look for one of them.
+
+# Using "alls"
+#   AModel
+
+# Using "imports"
+#   from .a_model import AModel
+
+# Using "openapi.models"
+#   AModel (a_model)
+
+# Using "openapi.enums"
+#   AnEnum (an_enum)

end_to_end_tests/test_custom_templates/models_init.py.jinja

@@ -0,0 +1,33 @@
+
+# Testing that we can access model-related information via Jinja variables.
+
+# To avoid having to update this file in the golden record every time the test specs are changed,
+# we won't include all the classes in this output - we'll just look for one of them.
+
+# Using "alls"
+{% for name in alls %}
+{% if name == "AModel" %}
+#   {{ name }}
+{% endif %}
+{% endfor %}
+
+# Using "imports"
+{% for import in imports %}
+{% if import.endswith("import AModel") %}
+#   {{ import }}
+{% endif %}
+{% endfor %}
+
+# Using "openapi.models"
+{% for model in openapi.models %}
+{% if model.class_info.name == "AModel" %}
+#   {{ model.class_info.name }} ({{ model.class_info.module_name }})
+{% endif %}
+{% endfor %}
+
+# Using "openapi.enums"
+{% for enum in openapi.enums %}
+{% if enum.class_info.name == "AnEnum" %}
+#   {{ enum.class_info.name }} ({{ enum.class_info.module_name }})
+{% endif %}
+{% endfor %}

openapi_python_client/parser/openapi.py

@@ -493,10 +493,10 @@ class GeneratorData:
     title: str
     description: Optional[str]
     version: str
-    models: Iterator[ModelProperty]
+    models: list[ModelProperty]
     errors: list[ParseError]
     endpoint_collections_by_tag: dict[utils.PythonIdentifier, EndpointCollection]
-    enums: Iterator[Union[EnumProperty, LiteralEnumProperty]]
+    enums: list[Union[EnumProperty, LiteralEnumProperty]]
 
     @staticmethod
     def from_dict(data: dict[str, Any], *, config: Config) -> Union["GeneratorData", GeneratorError]:
@@ -525,10 +525,10 @@ def from_dict(data: dict[str, Any], *, config: Config) -> Union["GeneratorData",
             data=openapi.paths, schemas=schemas, parameters=parameters, request_bodies=request_bodies, config=config
         )
 
-        enums = (
+        enums = [
             prop for prop in schemas.classes_by_name.values() if isinstance(prop, (EnumProperty, LiteralEnumProperty))
-        )
-        models = (prop for prop in schemas.classes_by_name.values() if isinstance(prop, ModelProperty))
+        ]
+        models = [prop for prop in schemas.classes_by_name.values() if isinstance(prop, ModelProperty)]
 
         return GeneratorData(
             title=openapi.info.title,