openapi-python-client 0.5.2__tar.gz → 0.5.3__tar.gz

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/CHANGELOG.md

@@ -5,6 +5,22 @@ 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).
 
 
+## 0.5.3 - 2020-08-13
+### Security
+- All values that become file/directory names are sanitized to address path traversal vulnerabilities (CVE-2020-15141)
+- All values that get placed into python files (everything from enum names, to endpoint descriptions, to default values) are validated and/or saniziatied to address arbitrary code execution vulnerabilities (CVE-2020-15142)
+
+### Changes
+- Due to security concerns/implementation complexities, default values are temporarily unsupported for any `RefProperty` that doesn't refer to an enum.
+- Defaults for properties must now be valid values for their respective type (e.g. "example string" is an invalid default for an `integer` type property, and the function for an endpoint using it would fail to generate and be skipped). 
+
+### Additions
+- Added support for header parameters (#117)
+
+### Fixes
+- JSON bodies will now be assigned correctly in generated clients(#139 & #147). Thanks @pawamoy!
+
+
 ## 0.5.2 - 2020-08-06
 ### Additions
 - Added `project_name_override` and `package_name_override` config options to override the name of the generated project/package (#123)

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openapi-python-client
-Version: 0.5.2
+Version: 0.5.3
 Summary: Generate modern Python clients from OpenAPI
 Home-page: https://github.com/triaxtec/openapi-python-client
 License: MIT
@@ -18,7 +18,7 @@ Classifier: Topic :: Software Development :: Code Generators
 Classifier: Typing :: Typed
 Requires-Dist: black (>=19.10b0,<20.0)
 Requires-Dist: colorama (>=0.4.3,<0.5.0); sys_platform == "win32"
-Requires-Dist: httpx (>=0.13.0,<0.14.0)
+Requires-Dist: httpx (>=0.13,<0.15)
 Requires-Dist: importlib_metadata (>=1.6.0,<2.0.0); python_version == "3.7"
 Requires-Dist: isort (>=5.0.5,<6.0.0)
 Requires-Dist: jinja2 (>=2.11.1,<3.0.0)

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/openapi_python_client/__init__.py

@@ -83,7 +83,7 @@ def _get_document(*, url: Optional[str], path: Optional[Path]) -> Union[Dict[str
 
 
 class Project:
-    TEMPLATE_FILTERS = {"snakecase": utils.snake_case}
+    TEMPLATE_FILTERS = {"snakecase": utils.snake_case, "kebabcase": utils.kebab_case}
     project_name_override: Optional[str] = None
     package_name_override: Optional[str] = None
 
@@ -91,12 +91,14 @@ class Project:
         self.openapi: GeneratorData = openapi
         self.env: Environment = Environment(loader=PackageLoader(__package__), trim_blocks=True, lstrip_blocks=True)
 
-        self.project_name: str = self.project_name_override or f"{openapi.title.replace(' ', '-').lower()}-client"
+        self.project_name: str = self.project_name_override or f"{utils.kebab_case(openapi.title).lower()}-client"
         self.project_dir: Path = Path.cwd() / self.project_name
 
         self.package_name: str = self.package_name_override or self.project_name.replace("-", "_")
         self.package_dir: Path = self.project_dir / self.package_name
-        self.package_description: str = f"A client library for accessing {self.openapi.title}"
+        self.package_description: str = utils.remove_string_escapes(
+            f"A client library for accessing {self.openapi.title}"
+        )
         self.version: str = openapi.version
 
         self.env.filters.update(self.TEMPLATE_FILTERS)
@@ -231,6 +233,7 @@ class Project:
         endpoint_template = self.env.get_template("endpoint_module.pyi")
         async_endpoint_template = self.env.get_template("async_endpoint_module.pyi")
         for tag, collection in self.openapi.endpoint_collections_by_tag.items():
+            tag = utils.snake_case(tag)
             module_path = api_dir / f"{tag}.py"
             module_path.write_text(endpoint_template.render(collection=collection))
             async_module_path = async_api_dir / f"{tag}.py"

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/openapi_python_client/parser/errors.py

@@ -2,7 +2,7 @@ from dataclasses import dataclass
 from enum import Enum
 from typing import Optional
 
-__all__ = ["GeneratorError", "ParseError", "PropertyError"]
+__all__ = ["GeneratorError", "ParseError", "PropertyError", "ValidationError"]
 
 from pydantic import BaseModel
 
@@ -37,3 +37,7 @@ class PropertyError(ParseError):
     """ Error raised when there's a problem creating a Property """
 
     header = "Problem creating a Property: "
+
+
+class ValidationError(Exception):
+    pass

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/openapi_python_client/parser/openapi.py

@@ -8,6 +8,7 @@ from typing import Any, Dict, List, Optional, Set, Union
 from pydantic import ValidationError
 
 from .. import schema as oai
+from .. import utils
 from .errors import GeneratorError, ParseError, PropertyError
 from .properties import EnumProperty, Property, property_from_data
 from .reference import Reference
@@ -19,6 +20,7 @@ class ParameterLocation(str, Enum):
 
     QUERY = "query"
     PATH = "path"
+    HEADER = "header"
 
 
 def import_string_from_reference(reference: Reference, prefix: str = "") -> str:
@@ -78,6 +80,7 @@ class Endpoint:
     relative_imports: Set[str] = field(default_factory=set)
     query_parameters: List[Property] = field(default_factory=list)
     path_parameters: List[Property] = field(default_factory=list)
+    header_parameters: List[Property] = field(default_factory=list)
     responses: List[Response] = field(default_factory=list)
     form_body_reference: Optional[Reference] = None
     json_body: Optional[Property] = None
@@ -164,6 +167,8 @@ class Endpoint:
                 endpoint.query_parameters.append(prop)
             elif param.param_in == ParameterLocation.PATH:
                 endpoint.path_parameters.append(prop)
+            elif param.param_in == ParameterLocation.HEADER:
+                endpoint.header_parameters.append(prop)
             else:
                 return ParseError(data=param, detail="Parameter must be declared in path or query")
         return endpoint
@@ -178,7 +183,7 @@ class Endpoint:
         endpoint = Endpoint(
             path=path,
             method=method,
-            description=data.description,
+            description=utils.remove_string_escapes(data.description) if data.description else "",
             name=data.operationId,
             requires_security=bool(data.security),
             tag=tag,

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/openapi_python_client/parser/properties.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
 
 from dataclasses import InitVar, dataclass, field
+from datetime import date, datetime
 from typing import Any, ClassVar, Dict, Generic, List, Optional, Set, TypeVar, Union
 
 from .. import schema as oai
 from .. import utils
-from .errors import PropertyError
+from .errors import PropertyError, ValidationError
 from .reference import Reference
 
 
@@ -19,6 +20,9 @@ class Property:
             templates/property_templates and must contain two macros: construct and transform. Construct will be used to
             build this property from JSON data (a response from an API). Transform will be used to convert this property
             to JSON data (when sending a request to the API).
+
+    Raises:
+        ValidationError: Raised when the default value fails to be converted to the expected type
     """
 
     name: str
@@ -32,10 +36,16 @@ class Property:
 
     def __post_init__(self) -> None:
         self.python_name = utils.snake_case(self.name)
+        if self.default is not None:
+            self.default = self._validate_default(default=self.default)
+
+    def _validate_default(self, default: Any) -> Any:
+        """ Check that the default value is valid for the property's type + perform any necessary sanitization """
+        raise ValidationError
 
-    def get_type_string(self) -> str:
+    def get_type_string(self, no_optional: bool = False) -> str:
         """ Get a string representation of type that should be used when declaring this property """
-        if self.required:
+        if self.required or no_optional:
             return self._type_string
         return f"Optional[{self._type_string}]"
 
@@ -74,10 +84,8 @@ class StringProperty(Property):
 
     _type_string: ClassVar[str] = "str"
 
-    def __post_init__(self) -> None:
-        super().__post_init__()
-        if self.default is not None:
-            self.default = f'"{self.default}"'
+    def _validate_default(self, default: Any) -> str:
+        return f'"{utils.remove_string_escapes(default)}"'
 
 
 @dataclass
@@ -86,7 +94,7 @@ class DateTimeProperty(Property):
     A property of type datetime.datetime
     """
 
-    _type_string: ClassVar[str] = "datetime"
+    _type_string: ClassVar[str] = "datetime.datetime"
     template: ClassVar[str] = "datetime_property.pyi"
 
     def get_imports(self, *, prefix: str) -> Set[str]:
@@ -97,15 +105,23 @@ class DateTimeProperty(Property):
             prefix: A prefix to put before any relative (local) module names.
         """
         imports = super().get_imports(prefix=prefix)
-        imports.update({"from datetime import datetime", "from typing import cast"})
+        imports.update({"import datetime", "from typing import cast"})
         return imports
 
+    def _validate_default(self, default: Any) -> str:
+        for format_string in ("%Y-%m-%dT%H:%M:%S", "%Y-%m-%dT%H:%M:%S%z"):
+            try:
+                return repr(datetime.strptime(default, format_string))
+            except (TypeError, ValueError):
+                continue
+        raise ValidationError
+
 
 @dataclass
 class DateProperty(Property):
     """ A property of type datetime.date """
 
-    _type_string: ClassVar[str] = "date"
+    _type_string: ClassVar[str] = "datetime.date"
     template: ClassVar[str] = "date_property.pyi"
 
     def get_imports(self, *, prefix: str) -> Set[str]:
@@ -116,9 +132,15 @@ class DateProperty(Property):
             prefix: A prefix to put before any relative (local) module names.
         """
         imports = super().get_imports(prefix=prefix)
-        imports.update({"from datetime import date", "from typing import cast"})
+        imports.update({"import datetime", "from typing import cast"})
         return imports
 
+    def _validate_default(self, default: Any) -> str:
+        try:
+            return repr(date.fromisoformat(default))
+        except (TypeError, ValueError) as e:
+            raise ValidationError() from e
+
 
 @dataclass
 class FileProperty(Property):
@@ -146,6 +168,12 @@ class FloatProperty(Property):
     default: Optional[float] = None
     _type_string: ClassVar[str] = "float"
 
+    def _validate_default(self, default: Any) -> float:
+        try:
+            return float(default)
+        except (TypeError, ValueError) as e:
+            raise ValidationError() from e
+
 
 @dataclass
 class IntProperty(Property):
@@ -154,6 +182,12 @@ class IntProperty(Property):
     default: Optional[int] = None
     _type_string: ClassVar[str] = "int"
 
+    def _validate_default(self, default: Any) -> int:
+        try:
+            return int(default)
+        except (TypeError, ValueError) as e:
+            raise ValidationError() from e
+
 
 @dataclass
 class BooleanProperty(Property):
@@ -161,6 +195,10 @@ class BooleanProperty(Property):
 
     _type_string: ClassVar[str] = "bool"
 
+    def _validate_default(self, default: Any) -> bool:
+        # no try/except needed as anything that comes from the initial load from json/yaml will be boolable
+        return bool(default)
+
 
 InnerProp = TypeVar("InnerProp", bound=Property)
 
@@ -172,14 +210,9 @@ class ListProperty(Property, Generic[InnerProp]):
     inner_property: InnerProp
     template: ClassVar[str] = "list_property.pyi"
 
-    def __post_init__(self) -> None:
-        super().__post_init__()
-        if self.default is not None:
-            self.default = f"field(default_factory=lambda: cast({self.get_type_string()}, {self.default}))"
-
-    def get_type_string(self) -> str:
+    def get_type_string(self, no_optional: bool = False) -> str:
         """ Get a string representation of type that should be used when declaring this property """
-        if self.required:
+        if self.required or no_optional:
             return f"List[{self.inner_property.get_type_string()}]"
         return f"Optional[List[{self.inner_property.get_type_string()}]]"
 
@@ -198,6 +231,16 @@ class ListProperty(Property, Generic[InnerProp]):
             imports.add("from typing import cast")
         return imports
 
+    def _validate_default(self, default: Any) -> str:
+        if not isinstance(default, list):
+            raise ValidationError()
+
+        default = list(map(self.inner_property._validate_default, default))
+        if isinstance(self.inner_property, RefProperty):  # Fix enums to use the actual value
+            default = str(default).replace("'", "")
+
+        return f"field(default_factory=lambda: cast({self.get_type_string()}, {default}))"
+
 
 @dataclass
 class UnionProperty(Property):
@@ -206,11 +249,11 @@ class UnionProperty(Property):
     inner_properties: List[Property]
     template: ClassVar[str] = "union_property.pyi"
 
-    def get_type_string(self) -> str:
+    def get_type_string(self, no_optional: bool = False) -> str:
         """ Get a string representation of type that should be used when declaring this property """
         inner_types = [p.get_type_string() for p in self.inner_properties]
         inner_prop_string = ", ".join(inner_types)
-        if self.required:
+        if self.required or no_optional:
             return f"Union[{inner_prop_string}]"
         return f"Optional[Union[{inner_prop_string}]]"
 
@@ -227,6 +270,15 @@ class UnionProperty(Property):
         imports.add("from typing import Union")
         return imports
 
+    def _validate_default(self, default: Any) -> Any:
+        for property in self.inner_properties:
+            try:
+                val = property._validate_default(default)
+                return val
+            except ValidationError:
+                continue
+        raise ValidationError()
+
 
 _existing_enums: Dict[str, EnumProperty] = {}
 
@@ -242,7 +294,6 @@ class EnumProperty(Property):
     template: ClassVar[str] = "enum_property.pyi"
 
     def __post_init__(self, title: str) -> None:  # type: ignore
-        super().__post_init__()
         reference = Reference.from_ref(title)
         dedup_counter = 0
         while reference.class_name in _existing_enums:
@@ -253,9 +304,7 @@ class EnumProperty(Property):
             reference = Reference.from_ref(f"{reference.class_name}{dedup_counter}")
 
         self.reference = reference
-        inverse_values = {v: k for k, v in self.values.items()}
-        if self.default is not None:
-            self.default = f"{self.reference.class_name}.{inverse_values[self.default]}"
+        super().__post_init__()
         _existing_enums[self.reference.class_name] = self
 
     @staticmethod
@@ -268,10 +317,10 @@ class EnumProperty(Property):
         """ Get all the EnumProperties that have been registered keyed by class name """
         return _existing_enums.get(name)
 
-    def get_type_string(self) -> str:
+    def get_type_string(self, no_optional: bool = False) -> str:
         """ Get a string representation of type that should be used when declaring this property """
 
-        if self.required:
+        if self.required or no_optional:
             return self.reference.class_name
         return f"Optional[{self.reference.class_name}]"
 
@@ -298,10 +347,18 @@ class EnumProperty(Property):
                 key = f"VALUE_{i}"
             if key in output:
                 raise ValueError(f"Duplicate key {key} in Enum")
-            output[key] = value
+            sanitized_key = utils.fix_keywords(utils.sanitize(key))
+            output[sanitized_key] = utils.remove_string_escapes(value)
 
         return output
 
+    def _validate_default(self, default: Any) -> str:
+        inverse_values = {v: k for k, v in self.values.items()}
+        try:
+            return f"{self.reference.class_name}.{inverse_values[default]}"
+        except KeyError as e:
+            raise ValidationError() from e
+
 
 @dataclass
 class RefProperty(Property):
@@ -316,9 +373,9 @@ class RefProperty(Property):
             return "enum_property.pyi"
         return "ref_property.pyi"
 
-    def get_type_string(self) -> str:
+    def get_type_string(self, no_optional: bool = False) -> str:
         """ Get a string representation of type that should be used when declaring this property """
-        if self.required:
+        if self.required or no_optional:
             return self.reference.class_name
         return f"Optional[{self.reference.class_name}]"
 
@@ -339,17 +396,20 @@ class RefProperty(Property):
         )
         return imports
 
+    def _validate_default(self, default: Any) -> Any:
+        enum = EnumProperty.get_enum(self.reference.class_name)
+        if enum:
+            return enum._validate_default(default)
+        else:
+            raise ValidationError
+
 
 @dataclass
 class DictProperty(Property):
     """ Property that is a general Dict """
 
     _type_string: ClassVar[str] = "Dict[Any, Any]"
-
-    def __post_init__(self) -> None:
-        super().__post_init__()
-        if self.default is not None:
-            self.default = f"field(default_factory=lambda: cast({self.get_type_string()}, {self.default}))"
+    template: ClassVar[str] = "dict_property.pyi"
 
     def get_imports(self, *, prefix: str) -> Set[str]:
         """
@@ -365,6 +425,11 @@ class DictProperty(Property):
             imports.add("from typing import cast")
         return imports
 
+    def _validate_default(self, default: Any) -> str:
+        if isinstance(default, dict):
+            return repr(default)
+        raise ValidationError
+
 
 def _string_based_property(
     name: str, required: bool, data: oai.Schema
@@ -381,10 +446,11 @@ def _string_based_property(
         return StringProperty(name=name, default=data.default, required=required, pattern=data.pattern)
 
 
-def property_from_data(
+def _property_from_data(
     name: str, required: bool, data: Union[oai.Reference, oai.Schema]
 ) -> Union[Property, PropertyError]:
     """ Generate a Property from the OpenAPI dictionary representation of it """
+    name = utils.remove_string_escapes(name)
     if isinstance(data, oai.Reference):
         return RefProperty(name=name, required=required, reference=Reference.from_ref(data.ref), default=None)
     if data.enum:
@@ -423,3 +489,12 @@ def property_from_data(
     elif data.type == "object":
         return DictProperty(name=name, required=required, default=data.default)
     return PropertyError(data=data, detail=f"unknown type {data.type}")
+
+
+def property_from_data(
+    name: str, required: bool, data: Union[oai.Reference, oai.Schema]
+) -> Union[Property, PropertyError]:
+    try:
+        return _property_from_data(name=name, required=required, data=data)
+    except ValidationError:
+        return PropertyError(detail="Failed to validate default value", data=data)

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/openapi_python_client/templates/async_endpoint_module.pyi

@@ -11,7 +11,7 @@ from ..errors import ApiResponseError
 {% endfor %}
 {% for endpoint in collection.endpoints %}
 
-{% from "endpoint_macros.pyi" import query_params, json_body, return_type %}
+{% from "endpoint_macros.pyi" import header_params, query_params, json_body, return_type %}
 
 async def {{ endpoint.name | snakecase }}(
     *,
@@ -41,6 +41,9 @@ async def {{ endpoint.name | snakecase }}(
     {% for parameter in endpoint.query_parameters %}
     {{ parameter.to_string() }},
     {% endfor %}
+    {% for parameter in endpoint.header_parameters %}
+    {{ parameter.to_string() }},
+    {% endfor %}
 {{ return_type(endpoint) }}
     """ {{ endpoint.description }} """
     url = "{}{{ endpoint.path }}".format(
@@ -50,13 +53,16 @@ async def {{ endpoint.name | snakecase }}(
         {% endfor %}
     )
 
+    headers: Dict[str, Any] = client.get_headers()
+    {{ header_params(endpoint) | indent(4) }}
+
     {{ query_params(endpoint) | indent(4) }}
     {{ json_body(endpoint) | indent(4) }}
 
     async with httpx.AsyncClient() as _client:
         response = await _client.{{ endpoint.method }}(
             url=url,
-            headers=client.get_headers(),
+            headers=headers,
             {% if endpoint.form_body_reference %}
             data=asdict(form_data),
             {% endif %}
@@ -64,7 +70,7 @@ async def {{ endpoint.name | snakecase }}(
             files=multipart_data.to_dict(),
             {% endif %}
             {% if endpoint.json_body %}
-            json={{ endpoint.json_body.python_name }},
+            json={{ "json_" + endpoint.json_body.python_name }},
             {% endif %}
             {% if endpoint.query_parameters %}
             params=params,

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/openapi_python_client/templates/endpoint_macros.pyi

@@ -1,3 +1,16 @@
+{% macro header_params(endpoint) %}
+{% if endpoint.header_parameters %}
+    {% for parameter in endpoint.header_parameters %}
+        {% if parameter.required %}
+headers["{{ parameter.python_name | kebabcase}}"] = {{ parameter.python_name }}
+        {% else %}
+if {{ parameter.python_name }} is not None:
+    headers["{{ parameter.python_name | kebabcase}}"] = {{ parameter.python_name }}
+        {% endif %}
+    {% endfor %}
+{% endif %}
+{% endmacro %}
+
 {% macro query_params(endpoint) %}
 {% if endpoint.query_parameters %}
     {% for property in endpoint.query_parameters %}

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/openapi_python_client/templates/endpoint_module.pyi

@@ -11,7 +11,7 @@ from ..errors import ApiResponseError
 {% endfor %}
 {% for endpoint in collection.endpoints %}
 
-{% from "endpoint_macros.pyi" import query_params, json_body, return_type %}
+{% from "endpoint_macros.pyi" import header_params, query_params, json_body, return_type %}
 
 def {{ endpoint.name | snakecase }}(
     *,
@@ -41,6 +41,9 @@ def {{ endpoint.name | snakecase }}(
     {% for parameter in endpoint.query_parameters %}
     {{ parameter.to_string() }},
     {% endfor %}
+    {% for parameter in endpoint.header_parameters %}
+    {{ parameter.to_string() }},
+    {% endfor %}
 {{ return_type(endpoint) }}
     """ {{ endpoint.description }} """
     url = "{}{{ endpoint.path }}".format(
@@ -50,6 +53,9 @@ def {{ endpoint.name | snakecase }}(
         {%- endfor -%}
     )
 
+    headers: Dict[str, Any] = client.get_headers()
+    {{ header_params(endpoint) | indent(4) }}
+
     {{ query_params(endpoint) | indent(4) }}
 
     {{ json_body(endpoint) | indent(4) }}
@@ -57,7 +63,7 @@ def {{ endpoint.name | snakecase }}(
 
     response = httpx.{{ endpoint.method }}(
         url=url,
-        headers=client.get_headers(),
+        headers=headers,
         {% if endpoint.form_body_reference %}
         data=asdict(form_data),
         {% endif %}
@@ -65,7 +71,7 @@ def {{ endpoint.name | snakecase }}(
         files=multipart_data.to_dict(),
         {% endif %}
         {% if endpoint.json_body %}
-        json={{ endpoint.json_body.python_name }},
+        json={{ "json_" + endpoint.json_body.python_name }},
         {% endif %}
         {% if endpoint.query_parameters %}
         params=params,

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/openapi_python_client/templates/property_templates/date_property.pyi

@@ -1,10 +1,10 @@
 {% macro construct(property, source) %}
 {% if property.required %}
-{{ property.python_name }} = date.fromisoformat({{ source }})
+{{ property.python_name }} = datetime.date.fromisoformat({{ source }})
 {% else %}
 {{ property.python_name }} = None
 if {{ source }} is not None:
-    {{ property.python_name }} = date.fromisoformat(cast(str, {{ source }}))
+    {{ property.python_name }} = datetime.date.fromisoformat(cast(str, {{ source }}))
 {% endif %}
 {% endmacro %}
 

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/openapi_python_client/templates/property_templates/datetime_property.pyi

@@ -1,10 +1,10 @@
 {% macro construct(property, source) %}
 {% if property.required %}
-{{ property.python_name }} = datetime.fromisoformat({{ source }})
+{{ property.python_name }} = datetime.datetime.fromisoformat({{ source }})
 {% else %}
 {{ property.python_name }} = None
 if {{ source }} is not None:
-    {{ property.python_name }} = datetime.fromisoformat(cast(str, {{ source }}))
+    {{ property.python_name }} = datetime.datetime.fromisoformat(cast(str, {{ source }}))
 {% endif %}
 {% endmacro %}
 

openapi-python-client-0.5.3/openapi_python_client/templates/property_templates/dict_property.pyi

@@ -0,0 +1,17 @@
+{% macro construct(property, source) %}
+{% if property.required %}
+{{ property.python_name }} = {{ source }}
+{% else %}
+{{ property.python_name }} = None
+if {{ source }} is not None:
+    {{ property.python_name }} = {{ source }}
+{% endif %}
+{% endmacro %}
+
+{% macro transform(property, source, destination) %}
+{% if property.required %}
+{{ destination }} = {{ source }}
+{% else %}
+{{ destination }} = {{ source }} if {{ source }} else None
+{% endif %}
+{% endmacro %}

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/openapi_python_client/templates/property_templates/union_property.pyi

@@ -24,13 +24,13 @@ def _parse_{{ property.python_name }}(data: Dict[str, Any]) -> {{ property.get_t
 {% macro transform(property, source, destination) %}
 {% if not property.required %}
 if {{ source }} is None:
-    {{ destination }} = None
+    {{ destination }}: {{ property.get_type_string() }} = None
 {% endif %}
 {% for inner_property in property.inner_properties %}
     {% if loop.first and property.required %}{# No if None statement before this #}
-if isinstance({{ source }}, {{ inner_property.get_type_string() }}):
+if isinstance({{ source }}, {{ inner_property.get_type_string(no_optional=True) }}):
     {% elif not loop.last %}
-elif isinstance({{ source }}, {{ inner_property.get_type_string() }}):
+elif isinstance({{ source }}, {{ inner_property.get_type_string(no_optional=True) }}):
     {% else %}
 else:
     {% endif %}

openapi-python-client-0.5.3/openapi_python_client/utils.py

@@ -0,0 +1,36 @@
+import re
+from keyword import iskeyword
+
+import stringcase
+
+
+def sanitize(value: str) -> str:
+    return re.sub(r"[^\w _\-]+", "", value)
+
+
+def fix_keywords(value: str) -> str:
+    if iskeyword(value):
+        return f"{value}_"
+    return value
+
+
+def group_title(value: str) -> str:
+    value = re.sub(r"([A-Z]{2,})([A-Z][a-z]|[ \-_]|$)", lambda m: m.group(1).title() + m.group(2), value.strip())
+    value = re.sub(r"(^|[ _-])([A-Z])", lambda m: m.group(1) + m.group(2).lower(), value)
+    return value
+
+
+def snake_case(value: str) -> str:
+    return fix_keywords(stringcase.snakecase(group_title(sanitize(value))))
+
+
+def pascal_case(value: str) -> str:
+    return fix_keywords(stringcase.pascalcase(sanitize(value)))
+
+
+def kebab_case(value: str) -> str:
+    return fix_keywords(stringcase.spinalcase(group_title(sanitize(value))))
+
+
+def remove_string_escapes(value: str) -> str:
+    return value.replace('"', r"\"")

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openapi-python-client"
-version = "0.5.2"
+version = "0.5.3"
 description = "Generate modern Python clients from OpenAPI"
 repository = "https://github.com/triaxtec/openapi-python-client"
 license = "MIT"
@@ -25,7 +25,7 @@ stringcase = "^1.2.0"
 typer = ">=0.1,<0.4"
 colorama = {version = "^0.4.3", markers = "sys_platform == 'win32'"}
 shellingham = "^1.3.2"
-httpx = "^0.13.0"
+httpx = ">=0.13,<0.15"
 black = "^19.10b0"
 isort = "^5.0.5"
 pyyaml = "^5.3.1"
@@ -58,6 +58,11 @@ isort .\
 openapi = "python -m end_to_end_tests.fastapi_app"
 gm = "python -m end_to_end_tests.regen_golden_master"
 e2e = "pytest openapi_python_client end_to_end_tests"
+oge = """
+task openapi\
+&& task gm\
+&& task e2e\
+"""
 
 [tool.black]
 line-length = 120

{openapi-python-client-0.5.2 → openapi-python-client-0.5.3}/setup.py

@@ -12,7 +12,7 @@ package_data = \
 
 install_requires = \
 ['black>=19.10b0,<20.0',
- 'httpx>=0.13.0,<0.14.0',
+ 'httpx>=0.13,<0.15',
  'isort>=5.0.5,<6.0.0',
  'jinja2>=2.11.1,<3.0.0',
  'pydantic>=1.6.1,<2.0.0',
@@ -30,7 +30,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'openapi-python-client',
-    'version': '0.5.2',
+    'version': '0.5.3',
     'description': 'Generate modern Python clients from OpenAPI',
     'long_description': '[![triaxtec](https://circleci.com/gh/triaxtec/openapi-python-client.svg?style=svg)](https://circleci.com/gh/triaxtec/openapi-python-client)\n[![codecov](https://codecov.io/gh/triaxtec/openapi-python-client/branch/master/graph/badge.svg)](https://codecov.io/gh/triaxtec/openapi-python-client)\n[![PyPI version shields.io](https://img.shields.io/pypi/v/openapi-python-client.svg)](https://pypi.python.org/pypi/openapi-python-client/)\n[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)\n[![Generic badge](https://img.shields.io/badge/type_checked-mypy-informational.svg)](https://mypy.readthedocs.io/en/stable/introduction.html)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n\n# openapi-python-client\nGenerate modern Python clients from OpenAPI\n\n**This project is still in development and does not support all OpenAPI features**\n\n## Why This?\nThe Python clients generated by openapi-generator support Python 2 and therefore come with a lot of baggage. This tool \naims to generate clients which:\n1. Use all the latest and greatest Python features like type annotations and dataclasses\n1. Don\'t carry around a bunch of compatibility code for older version of Python (e.g. the `six` package)\n1. Have better documentation and more obvious usage instructions\n\nAdditionally, because this generator is written in Python, it should be more accessible to contribution by the people \nusing it (Python developers).\n\n## Installation\nI recommend you install with [pipx](https://pipxproject.github.io/pipx/)  so you don\'t conflict with any other packages \nyou might have: `pipx install openapi-python-client`.\n\nBetter yet, use `pipx run openapi-python-client <normal params / options>` to always use the latest version of the generator.\n\nYou can install with normal pip if you want to though: `pip install openapi-python-client`\n\nThen, if you want tab completion: `openapi-python-client --install-completion`\n\n## Usage\n### Create a new client\n`openapi-python-client generate --url https://my.api.com/openapi.json`\n\nThis will generate a new client library named based on the title in your OpenAPI spec.  For example, if the title \nof your API is "My API", the expected output will be "my-api-client".  If a folder already exists by that name, you\'ll \nget an error.\n\n### Update an existing client\n`openapi-python-client update --url https://my.api.com/openapi.json`\n\n> For more usage details run `openapi-python-client --help` or read [usage](usage.md)\n\n## What You Get\n1. A `pyproject.toml` file with some basic metadata intended to be used with [Poetry].\n1. A `README.md` you\'ll most definitely need to update with your project\'s details\n1. A Python module named just like the auto-generated project name (e.g. "my_api_client") which contains:\n    1. A `client` module which will have both a `Client` class and an `AuthenticatedClient` class.  You\'ll need these \n    for calling the functions in the `api` module.\n    1. An `api` module which will contain one module for each tag in your OpenAPI spec, as well as a `default` module \n    for endpoints without a tag.  Each of these modules in turn contains one function for calling each endpoint.\n    1. A `models` module which has all the classes defined by the various schemas in your OpenAPI spec\n    \nFor a full example you can look at the `test_end_to_end` directory which has a declared [FastAPI](https://fastapi.tiangolo.com/) \nserver and the resulting openapi.json file in the "fastapi" directory.  "golden-master" is the generated client from that \nOpenAPI document.\n    \n## OpenAPI features supported\n1. All HTTP Methods\n1. JSON and form bodies, path and query parameters\n1. File uploads with multipart/form-data bodies\n1. float, string, int, date, datetime, string enums, and custom schemas or lists containing any of those\n1. html/text or application/json responses containing any of the previous types\n1. Bearer token security\n\n## Configuration\nYou can pass a YAML (or JSON) file to openapi-python-client with the `--config` option in order to change some behavior.\nThe following parameters are supported:\n\n### class_overrides\nUsed to change the name of generated model classes.  This param should be a mapping of existing class name \n(usually a key in the "schemas" section of your OpenAPI document) to class_name and module_name. As an example, if the \nname of the a model in OpenAPI (and therefore the generated class name) was something like "_PrivateInternalLongName" \nand you want the generated client\'s model to be called "ShortName" in a module called "short_name" you could do this:\n\nExample:\n```yaml\nclass_overrides:\n    _PrivateInternalLongName:\n      class_name: ShortName\n      module_name: short_name\n```\n\nThe easiest way to find what needs to be overridden is probably to generate your client and go look at everything in the\n models folder.\n \n ### project_name_override and package_name_override\nUsed to change the name of generated client library project/package. If the project name is changed but an override for the package name\nisn\'t provided, the package name will be converted from the project name using the standard convention (replacing `-`\'s with `_`\'s).\n\nExample:\n```yaml\nproject_name_override: my-special-project-name\npackage_name_override: my_extra_special_package_name\n```\n\n\n[CHANGELOG.md]: CHANGELOG.md\n[Poetry]: https://python-poetry.org/\n',
     'author': 'Dylan Anthony',

openapi-python-client-0.5.2/openapi_python_client/utils.py

@@ -1,13 +0,0 @@
-import re
-
-import stringcase
-
-
-def snake_case(value: str) -> str:
-    value = re.sub(r"([A-Z]{2,})([A-Z][a-z]|[ -_]|$)", lambda m: m.group(1).title() + m.group(2), value.strip())
-    value = re.sub(r"(^|[ _-])([A-Z])", lambda m: m.group(1) + m.group(2).lower(), value)
-    return stringcase.snakecase(value)
-
-
-def pascal_case(value: str) -> str:
-    return stringcase.pascalcase(value)