Merge origin/benchling-issue-285

Author: forest-benchling

.circleci/config.yml

@@ -0,0 +1,46 @@
+name: Run Checks
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  schedule:
+    - cron: '0 23 * * 2'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: [ 3.6, 3.7, 3.8, 3.9 ]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python }}
+    - name: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        path: .venv
+        key: ${{ runner.os }}-${{ matrix.python }}-dependencies-${{ hashFiles('**/poetry.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ matrix.python }}-dependencies-
+    - name: Install dependencies
+      uses: triaxtec/github-actions/python/install-and-configure-poetry@main
+    - name: Run Checks
+      uses: triaxtec/github-actions/python/run-checks@main
+      with:
+        module: openapi_python_client
+
+    - name: End to End Tests
+      run: poetry run pytest --cov=openapi_python_client end_to_end_tests
+
+    - name: Generate E2E Coverage
+      run: poetry run coverage xml -o e2e-coverage.xml
+
+    - uses: codecov/codecov-action@v1
+      with:
+        files: ./coverage.xml,./e2e-coverage.xml

.github/workflows/checks.yml

@@ -5,40 +5,63 @@ All notable changes to this project will be documented in this file.
 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.8.0 - Unreleased
+
+### Additions
+
+- 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
+    project info.
+  - `none` will not create a project folder at all, only the inner package folder (which won't be inner anymore)
+- Attempt to detect and alert users if they are using an unsupported version of OpenAPI (#281).
+
+### Changes
+
+- Lowered the minimum version of `python-dateutil` to 2.8.0 for improved compatibility (#298 & #299). Thanks @bowenwr!
+- The `from_dict` method on generated models is now a `@classmethod` instead of `@staticmethod` (#215 & #292). Thanks @forest-benchling!
+
 ## 0.7.3 - 2020-12-21
+
 ### Fixes
+
 - Spacing and extra returns for Union types of `additionalProperties` (#266 & #268). Thanks @joshzana & @packyg!
 - Title of inline schemas will no longer be missing characters (#271 & #274). Thanks @kalzoo!
-- Handling of nulls (Nones) when parsing or constructing dates (#267). Thanks @fyhertz! 
+- Handling of nulls (Nones) when parsing or constructing dates (#267). Thanks @fyhertz!
 
 ## 0.7.2 - 2020-12-08
+
 ### Fixes
+
 - A bug in handling optional properties that are themselves models (introduced in 0.7.1) (#262). Thanks @packyg!
 
 ## 0.7.1 - 2020-12-08
+
 ### Additions
+
 - Support for additionalProperties attribute in OpenAPI schemas and "free-form" objects by adding an `additional_properties` attribute to generated models. **COMPATIBILITY NOTE**: this will prevent any model property with a name that would be coerced to "additional_properties" in the generated client from generating properly (#218 & #252). Thanks @packyg!
 
 ### Fixes
+
 - Enums will once again work with query parameters (#259). Thanks @packyg!
 - Generated Poetry metadata in pyproject.toml will properly indicate Python 3.6 compatibility (#258). Thanks @bowenwr!
 
 ## 0.7.0 - 2020-11-25
 
 ### Breaking Changes
 
-- Any request/response field that is not `required` and wasn't specified is now set to `UNSET` instead of `None`. 
+- Any request/response field that is not `required` and wasn't specified is now set to `UNSET` instead of `None`.
 - Values that are `UNSET` will not be sent along in API calls
-- Schemas defined with `type=object` will now be converted into classes, just like if they were created as ref components. 
-    The previous behavior was a combination of skipping and using generic Dicts for these schemas.
-- Response schema handling was unified with input schema handling, meaning that responses will behave differently than before. 
-    Specifically, instead of the content-type deciding what the generated Python type is, the schema itself will.
-    - As a result of this, endpoints that used to return `bytes` when content-type was application/octet-stream will now return a `File` object if the type of the data is "binary", just like if you were submitting that type instead of receiving it.
+- Schemas defined with `type=object` will now be converted into classes, just like if they were created as ref components.
+  The previous behavior was a combination of skipping and using generic Dicts for these schemas.
+- Response schema handling was unified with input schema handling, meaning that responses will behave differently than before.
+  Specifically, instead of the content-type deciding what the generated Python type is, the schema itself will.
+  - As a result of this, endpoints that used to return `bytes` when content-type was application/octet-stream will now return a `File` object if the type of the data is "binary", just like if you were submitting that type instead of receiving it.
 - Instead of skipping input properties with no type, enum, anyOf, or oneOf declared, the property will be declared as `None`.
-- Class (models and Enums) names will now contain the name of their parent element (if any). For example, a property 
-    declared in an endpoint will be named like {endpoint_name}_{previous_class_name}. Classes will no longer be
-    deduplicated by appending a number to the end of the generated name, so if two names conflict with this new naming 
-    scheme, there will be an error instead.
+- Class (models and Enums) names will now contain the name of their parent element (if any). For example, a property
+  declared in an endpoint will be named like {endpoint*name}*{previous_class_name}. Classes will no longer be
+  deduplicated by appending a number to the end of the generated name, so if two names conflict with this new naming
+  scheme, there will be an error instead.
 
 ### Additions
 

CHANGELOG.md

@@ -1,4 +1,4 @@
-[![triaxtec](https://circleci.com/gh/triaxtec/openapi-python-client.svg?style=svg)](https://circleci.com/gh/triaxtec/openapi-python-client)
+![Run Checks](https://github.com/triaxtec/openapi-python-client/workflows/Run%20Checks/badge.svg)
 [![codecov](https://codecov.io/gh/triaxtec/openapi-python-client/branch/main/graph/badge.svg)](https://codecov.io/gh/triaxtec/openapi-python-client)
 [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
 [![Generic badge](https://img.shields.io/badge/type_checked-mypy-informational.svg)](https://mypy.readthedocs.io/en/stable/introduction.html)

README.md

@@ -40,42 +40,42 @@ def _build_response(*, response: httpx.Response) -> Response[Union[None, HTTPVal
 def httpx_request(
     *,
     client: Client,
-    string_prop: Union[Unset, str] = "the default string",
-    datetime_prop: Union[Unset, datetime.datetime] = isoparse("1010-10-10T00:00:00"),
-    date_prop: Union[Unset, datetime.date] = isoparse("1010-10-10").date(),
-    float_prop: Union[Unset, float] = 3.14,
-    int_prop: Union[Unset, int] = 7,
-    boolean_prop: Union[Unset, bool] = False,
-    list_prop: Union[Unset, List[AnEnum]] = UNSET,
-    union_prop: Union[Unset, float, str] = "not a float",
-    union_prop_with_ref: Union[Unset, float, AnEnum] = 0.6,
-    enum_prop: Union[Unset, AnEnum] = UNSET,
+    string_prop: Union[Unset, None, str] = "the default string",
+    datetime_prop: Union[Unset, None, datetime.datetime] = isoparse("1010-10-10T00:00:00"),
+    date_prop: Union[Unset, None, datetime.date] = isoparse("1010-10-10").date(),
+    float_prop: Union[Unset, None, float] = 3.14,
+    int_prop: Union[Unset, None, int] = 7,
+    boolean_prop: Union[Unset, None, bool] = False,
+    list_prop: Union[Unset, None, List[AnEnum]] = UNSET,
+    union_prop: Union[Unset, None, float, str] = "not a float",
+    union_prop_with_ref: Union[Unset, None, float, AnEnum] = 0.6,
+    enum_prop: Union[Unset, None, AnEnum] = UNSET,
 ) -> Response[Union[None, HTTPValidationError]]:
 
     json_datetime_prop: Union[Unset, str] = UNSET
-    if not isinstance(datetime_prop, Unset):
+    if not isinstance(datetime_prop, Unset) and datetime_prop is not None:
         json_datetime_prop = datetime_prop.isoformat()
 
     json_date_prop: Union[Unset, str] = UNSET
-    if not isinstance(date_prop, Unset):
+    if not isinstance(date_prop, Unset) and date_prop is not None:
         json_date_prop = date_prop.isoformat()
 
     json_list_prop: Union[Unset, List[Any]] = UNSET
-    if not isinstance(list_prop, Unset):
+    if not isinstance(list_prop, Unset) and list_prop is not None:
         json_list_prop = []
         for list_prop_item_data in list_prop:
             list_prop_item = list_prop_item_data.value
 
             json_list_prop.append(list_prop_item)
 
     json_union_prop: Union[Unset, float, str]
-    if isinstance(union_prop, Unset):
+    if isinstance(union_prop, Unset) or union_prop is None:
         json_union_prop = UNSET
     else:
         json_union_prop = union_prop
 
     json_union_prop_with_ref: Union[Unset, float, AnEnum]
-    if isinstance(union_prop_with_ref, Unset):
+    if isinstance(union_prop_with_ref, Unset) or union_prop_with_ref is None:
         json_union_prop_with_ref = UNSET
     elif isinstance(union_prop_with_ref, AnEnum):
         json_union_prop_with_ref = UNSET
@@ -86,29 +86,29 @@ def httpx_request(
         json_union_prop_with_ref = union_prop_with_ref
 
     json_enum_prop: Union[Unset, AnEnum] = UNSET
-    if not isinstance(enum_prop, Unset):
+    if not isinstance(enum_prop, Unset) and enum_prop is not None:
         json_enum_prop = enum_prop
 
     params: Dict[str, Any] = {}
-    if string_prop is not UNSET:
+    if string_prop is not UNSET and string_prop is not None:
         params["string_prop"] = string_prop
-    if datetime_prop is not UNSET:
+    if datetime_prop is not UNSET and datetime_prop is not None:
         params["datetime_prop"] = json_datetime_prop
-    if date_prop is not UNSET:
+    if date_prop is not UNSET and date_prop is not None:
         params["date_prop"] = json_date_prop
-    if float_prop is not UNSET:
+    if float_prop is not UNSET and float_prop is not None:
         params["float_prop"] = float_prop
-    if int_prop is not UNSET:
+    if int_prop is not UNSET and int_prop is not None:
         params["int_prop"] = int_prop
-    if boolean_prop is not UNSET:
+    if boolean_prop is not UNSET and boolean_prop is not None:
         params["boolean_prop"] = boolean_prop
-    if list_prop is not UNSET:
+    if list_prop is not UNSET and list_prop is not None:
         params["list_prop"] = json_list_prop
-    if union_prop is not UNSET:
+    if union_prop is not UNSET and union_prop is not None:
         params["union_prop"] = json_union_prop
-    if union_prop_with_ref is not UNSET:
+    if union_prop_with_ref is not UNSET and union_prop_with_ref is not None:
         params["union_prop_with_ref"] = json_union_prop_with_ref
-    if enum_prop is not UNSET:
+    if enum_prop is not UNSET and enum_prop is not None:
         params["enum_prop"] = json_enum_prop
 
     response = client.request(

end_to_end_tests/golden-record-custom/custom_e2e/api/tests/defaults_tests_defaults_post.py

@@ -36,15 +36,15 @@ def _build_response(*, response: httpx.Response) -> Response[Union[None, HTTPVal
 def httpx_request(
     *,
     client: Client,
-    query_param: Union[Unset, List[str]] = UNSET,
+    query_param: Union[Unset, None, List[str]] = UNSET,
 ) -> Response[Union[None, HTTPValidationError]]:
 
     json_query_param: Union[Unset, List[Any]] = UNSET
-    if not isinstance(query_param, Unset):
+    if not isinstance(query_param, Unset) and query_param is not None:
         json_query_param = query_param
 
     params: Dict[str, Any] = {}
-    if query_param is not UNSET:
+    if query_param is not UNSET and query_param is not None:
         params["query_param"] = json_query_param
 
     response = client.request(

end_to_end_tests/golden-record-custom/custom_e2e/api/tests/optional_value_tests_optional_query_param.py

@@ -1,5 +1,5 @@
 import datetime
-from typing import Any, Dict, List, Optional, Union, cast
+from typing import Any, Dict, List, Optional, Type, TypeVar, Union, cast
 
 import attr
 from dateutil.parser import isoparse
@@ -8,6 +8,8 @@
 from ..models.different_enum import DifferentEnum
 from ..types import UNSET, Unset
 
+T = TypeVar("T", bound="AModel")
+
 
 @attr.s(auto_attribs=True)
 class AModel:
@@ -21,7 +23,7 @@ class AModel:
     required_nullable: Optional[str]
     nested_list_of_enums: Union[Unset, List[List[DifferentEnum]]] = UNSET
     attr_1_leading_digit: Union[Unset, str] = UNSET
-    not_required_nullable: Union[Unset, Optional[str]] = UNSET
+    not_required_nullable: Union[Unset, None, str] = UNSET
     not_required_not_nullable: Union[Unset, str] = UNSET
 
     def to_dict(self) -> Dict[str, Any]:
@@ -75,8 +77,8 @@ def to_dict(self) -> Dict[str, Any]:
 
         return field_dict
 
-    @staticmethod
-    def from_dict(src_dict: Dict[str, Any]) -> "AModel":
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
         d = src_dict.copy()
         an_enum_value = AnEnum(d.pop("an_enum_value"))
 
@@ -124,7 +126,7 @@ def _parse_a_camel_date_time(data: Any) -> Union[datetime.datetime, datetime.dat
 
         not_required_not_nullable = d.pop("not_required_not_nullable", UNSET)
 
-        a_model = AModel(
+        a_model = cls(
             an_enum_value=an_enum_value,
             a_camel_date_time=a_camel_date_time,
             a_date=a_date,