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

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

@@ -5,6 +5,14 @@ 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.4 - 2020-08-29
+### Additions
+- Support for octet-stream content type (#116)
+- Support for [nullable](https://swagger.io/docs/specification/data-models/data-types/#null) (#99)
+- Union properties can be defined using oneOf (#98)
+- Support for lists of strings, integers, floats and booleans as responses (#165). Thanks @Maistho!
+
+
 ## 0.5.3 - 2020-08-13
 ### Security
 - All values that become file/directory names are sanitized to address path traversal vulnerabilities (CVE-2020-15141)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openapi-python-client
-Version: 0.5.3
+Version: 0.5.4
 Summary: Generate modern Python clients from OpenAPI
 Home-page: https://github.com/triaxtec/openapi-python-client
 License: MIT

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

@@ -273,6 +273,7 @@ class Schemas:
                     required=True,
                     default=data.default,
                     values=EnumProperty.values_from_list(data.enum),
+                    nullable=data.nullable,
                 )
                 continue
             s = Model.from_data(data=data, name=name)

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

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from dataclasses import InitVar, dataclass, field
 from datetime import date, datetime
+from itertools import chain
 from typing import Any, ClassVar, Dict, Generic, List, Optional, Set, TypeVar, Union
 
 from .. import schema as oai
@@ -27,6 +28,7 @@ class Property:
 
     name: str
     required: bool
+    nullable: bool
     default: Optional[Any]
 
     template: ClassVar[Optional[str]] = None
@@ -44,8 +46,13 @@ class Property:
         raise ValidationError
 
     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 or no_optional:
+        """
+        Get a string representation of type that should be used when declaring this property
+
+        Args:
+            no_optional: Do not include Optional even if the value is optional (needed for isinstance checks)
+        """
+        if no_optional or (self.required and not self.nullable):
             return self._type_string
         return f"Optional[{self._type_string}]"
 
@@ -212,7 +219,7 @@ class ListProperty(Property, Generic[InnerProp]):
 
     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 or no_optional:
+        if no_optional or (self.required and not self.nullable):
             return f"List[{self.inner_property.get_type_string()}]"
         return f"Optional[List[{self.inner_property.get_type_string()}]]"
 
@@ -253,7 +260,7 @@ class UnionProperty(Property):
         """ 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 or no_optional:
+        if no_optional or (self.required and not self.nullable):
             return f"Union[{inner_prop_string}]"
         return f"Optional[Union[{inner_prop_string}]]"
 
@@ -320,7 +327,7 @@ class EnumProperty(Property):
     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 or no_optional:
+        if no_optional or (self.required and not self.nullable):
             return self.reference.class_name
         return f"Optional[{self.reference.class_name}]"
 
@@ -375,7 +382,7 @@ class RefProperty(Property):
 
     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 or no_optional:
+        if no_optional or (self.required and not self.nullable):
             return self.reference.class_name
         return f"Optional[{self.reference.class_name}]"
 
@@ -437,13 +444,15 @@ def _string_based_property(
     """ Construct a Property from the type "string" """
     string_format = data.schema_format
     if string_format == "date-time":
-        return DateTimeProperty(name=name, required=required, default=data.default)
+        return DateTimeProperty(name=name, required=required, default=data.default, nullable=data.nullable,)
     elif string_format == "date":
-        return DateProperty(name=name, required=required, default=data.default)
+        return DateProperty(name=name, required=required, default=data.default, nullable=data.nullable,)
     elif string_format == "binary":
-        return FileProperty(name=name, required=required, default=data.default)
+        return FileProperty(name=name, required=required, default=data.default, nullable=data.nullable,)
     else:
-        return StringProperty(name=name, default=data.default, required=required, pattern=data.pattern)
+        return StringProperty(
+            name=name, default=data.default, required=required, pattern=data.pattern, nullable=data.nullable,
+        )
 
 
 def _property_from_data(
@@ -452,7 +461,9 @@ def _property_from_data(
     """ 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)
+        return RefProperty(
+            name=name, required=required, reference=Reference.from_ref(data.ref), default=None, nullable=False,
+        )
     if data.enum:
         return EnumProperty(
             name=name,
@@ -460,34 +471,39 @@ def _property_from_data(
             values=EnumProperty.values_from_list(data.enum),
             title=data.title or name,
             default=data.default,
+            nullable=data.nullable,
         )
-    if data.anyOf:
+    if data.anyOf or data.oneOf:
         sub_properties: List[Property] = []
-        for sub_prop_data in data.anyOf:
+        for sub_prop_data in chain(data.anyOf, data.oneOf):
             sub_prop = property_from_data(name=name, required=required, data=sub_prop_data)
             if isinstance(sub_prop, PropertyError):
                 return PropertyError(detail=f"Invalid property in union {name}", data=sub_prop_data)
             sub_properties.append(sub_prop)
-        return UnionProperty(name=name, required=required, default=data.default, inner_properties=sub_properties)
+        return UnionProperty(
+            name=name, required=required, default=data.default, inner_properties=sub_properties, nullable=data.nullable,
+        )
     if not data.type:
         return PropertyError(data=data, detail="Schemas must either have one of enum, anyOf, or type defined.")
     if data.type == "string":
         return _string_based_property(name=name, required=required, data=data)
     elif data.type == "number":
-        return FloatProperty(name=name, default=data.default, required=required)
+        return FloatProperty(name=name, default=data.default, required=required, nullable=data.nullable,)
     elif data.type == "integer":
-        return IntProperty(name=name, default=data.default, required=required)
+        return IntProperty(name=name, default=data.default, required=required, nullable=data.nullable,)
     elif data.type == "boolean":
-        return BooleanProperty(name=name, required=required, default=data.default)
+        return BooleanProperty(name=name, required=required, default=data.default, nullable=data.nullable,)
     elif data.type == "array":
         if data.items is None:
             return PropertyError(data=data, detail="type array must have items defined")
         inner_prop = property_from_data(name=f"{name}_item", required=True, data=data.items)
         if isinstance(inner_prop, PropertyError):
             return PropertyError(data=inner_prop.data, detail=f"invalid data in items of array {name}")
-        return ListProperty(name=name, required=required, default=data.default, inner_property=inner_prop,)
+        return ListProperty(
+            name=name, required=required, default=data.default, inner_property=inner_prop, nullable=data.nullable,
+        )
     elif data.type == "object":
-        return DictProperty(name=name, required=required, default=data.default)
+        return DictProperty(name=name, required=required, default=data.default, nullable=data.nullable,)
     return PropertyError(data=data, detail=f"unknown type {data.type}")
 
 

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

@@ -51,6 +51,25 @@ class RefResponse(Response):
         return f"{self.reference.class_name}.from_dict(cast(Dict[str, Any], response.json()))"
 
 
+@dataclass
+class ListBasicResponse(Response):
+    """ Response is a list of some basic type """
+
+    openapi_type: InitVar[str]
+    python_type: str = field(init=False)
+
+    def __post_init__(self, openapi_type: str) -> None:
+        self.python_type = openapi_types_to_python_type_strings[openapi_type]
+
+    def return_string(self) -> str:
+        """ How this Response should be represented as a return type """
+        return f"List[{self.python_type}]"
+
+    def constructor(self) -> str:
+        """ How the return value of this response should be constructed """
+        return f"[{self.python_type}(item) for item in cast(List[{self.python_type}], response.json())]"
+
+
 @dataclass
 class BasicResponse(Response):
     """ Response is a basic type """
@@ -70,6 +89,21 @@ class BasicResponse(Response):
         return f"{self.python_type}(response.text)"
 
 
+@dataclass
+class BytesResponse(Response):
+    """ Response is a basic type """
+
+    python_type: str = "bytes"
+
+    def return_string(self) -> str:
+        """ How this Response should be represented as a return type """
+        return self.python_type
+
+    def constructor(self) -> str:
+        """ How the return value of this response should be constructed """
+        return f"{self.python_type}(response.content)"
+
+
 openapi_types_to_python_type_strings = {
     "string": "str",
     "number": "float",
@@ -88,6 +122,8 @@ def response_from_data(*, status_code: int, data: Union[oai.Response, oai.Refere
     schema_data = None
     if "application/json" in content:
         schema_data = data.content["application/json"].media_type_schema
+    elif "application/octet-stream" in content:
+        return BytesResponse(status_code=status_code)
     elif "text/html" in content:
         schema_data = data.content["text/html"].media_type_schema
 
@@ -101,6 +137,12 @@ def response_from_data(*, status_code: int, data: Union[oai.Response, oai.Refere
         return Response(status_code=status_code)
     if response_type == "array" and isinstance(schema_data.items, oai.Reference):
         return ListRefResponse(status_code=status_code, reference=Reference.from_ref(schema_data.items.ref),)
+    if (
+        response_type == "array"
+        and isinstance(schema_data.items, oai.Schema)
+        and schema_data.items.type in openapi_types_to_python_type_strings
+    ):
+        return ListBasicResponse(status_code=status_code, openapi_type=schema_data.items.type)
     if response_type in openapi_types_to_python_type_strings:
         return BasicResponse(status_code=status_code, openapi_type=response_type)
     return ParseError(data=data, detail=f"Unrecognized type {schema_data.type}")

{openapi-python-client-0.5.3 → openapi-python-client-0.5.4}/openapi_python_client/schema/schema.py

@@ -241,7 +241,7 @@ class Schema(BaseModel):
     value.
     """
 
-    oneOf: Optional[List[Union[Reference, "Schema"]]] = None
+    oneOf: List[Union[Reference, "Schema"]] = []
     """
     **From OpenAPI spec:
     Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema.**
@@ -258,7 +258,7 @@ class Schema(BaseModel):
     keyword's value.
     """
 
-    anyOf: Optional[List[Union[Reference, "Schema"]]] = None
+    anyOf: List[Union[Reference, "Schema"]] = []
     """
     **From OpenAPI spec:
     Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema.**
@@ -406,7 +406,7 @@ class Schema(BaseModel):
     Other than the JSON Schema subset fields, the following fields MAY be used for further schema documentation:
     """
 
-    nullable: Optional[bool] = None
+    nullable: bool = False
     """
     A `true` value adds `"null"` to the allowed type specified by the `type` keyword,
     only if `type` is explicitly defined within the same Schema Object.

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openapi-python-client"
-version = "0.5.3"
+version = "0.5.4"
 description = "Generate modern Python clients from OpenAPI"
 repository = "https://github.com/triaxtec/openapi-python-client"
 license = "MIT"

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

@@ -30,7 +30,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'openapi-python-client',
-    'version': '0.5.3',
+    'version': '0.5.4',
     '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',