Merge branch 'main' of https://github.com/triaxtec/openapi-python-client into feature/add-unset-value-and-model-to-dict-params

Author: emann

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

.gitignore

@@ -19,9 +19,11 @@ dmypy.json
 # JetBrains
 .idea/
 
+test-reports/
+
 /coverage.xml
 /.coverage
 htmlcov/
 
 # Generated end to end test data
-my-test-api-client
+my-test-api-client

CHANGELOG.md

@@ -5,17 +5,25 @@ 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).
 
-## Unreleased
+## 0.7.0 - Unreleased
 
-### Changes
+### Additions
+
+- Added a `--custom-template-path` option for providing custom jinja2 templates (#231 - Thanks @erichulburd!).
+
+## 0.6.2 - 2020-11-03
 
 ### Fixes
 
 - Prefix generated identifiers to allow leading digits in field names (#206 - @kalzoo).
+- Prevent autoflake from removing `__init__.py` imports during generation. (#223 - Thanks @fyhertz!)
+- Update minimum Pydantic version to support Python 3.9
 
 ### Additions
 - Better compatibility for "required" (whether or not the field must be included) and "nullable" (whether or not the field can be null) (#205 & #208). Thanks @bowenwr & @emannguitar!
 
+- Allow specifying the generated client's version using `package_version_override` in a config file. (#225 - Thanks @fyhertz!)
+
 ## 0.6.1 - 2020-09-26
 
 ### Changes

CODE_OF_CONDUCT.md

@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities
 

README.md

@@ -1,9 +1,10 @@
 [![triaxtec](https://circleci.com/gh/triaxtec/openapi-python-client.svg?style=svg)](https://circleci.com/gh/triaxtec/openapi-python-client)
 [![codecov](https://codecov.io/gh/triaxtec/openapi-python-client/branch/main/graph/badge.svg)](https://codecov.io/gh/triaxtec/openapi-python-client)
-[![PyPI version shields.io](https://img.shields.io/pypi/v/openapi-python-client.svg)](https://pypi.python.org/pypi/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)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+[![PyPI version shields.io](https://img.shields.io/pypi/v/openapi-python-client.svg)](https://pypi.python.org/pypi/openapi-python-client/)
+[![Downloads](https://static.pepy.tech/personalized-badge/openapi-python-client?period=total&units=international_system&left_color=blue&right_color=green&left_text=Downloads)](https://pepy.tech/project/openapi-python-client)
 
 # openapi-python-client
 
@@ -53,6 +54,18 @@ get an error.
 
 > For more usage details run `openapi-python-client --help` or read [usage](usage.md)
 
+### Using custom templates
+
+This feature leverages Jinja2's [ChoiceLoader](https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.ChoiceLoader) and [FileSystemLoader](https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.FileSystemLoader). This means you do _not_ need to customize every template. Simply copy the template(s) you want to customize from [the default template directory](openapi_python_client/templates) to your own custom template directory (file names _must_ match exactly) and pass the template directory through the `custom-template-path` flag to the `generate` and `update` commands. For instance,
+
+```
+openapi-python-client update \
+  --url https://my.api.com/openapi.json \
+  --custom-template-path=relative/path/to/mytemplates
+```
+
+_Be forewarned, this is a beta-level feature in the sense that the API exposed in the templates is undocumented and unstable._
+
 ## What You Get
 
 1. A `pyproject.toml` file with some basic metadata intended to be used with [Poetry].
@@ -114,14 +127,24 @@ package_name_override: my_extra_special_package_name
 
 ### field_prefix
 
-When generating properties, the `name` attribute of the OpenAPI schema will be used. When the `name` is not a valid 
-Python identifier (e.g. begins with a number) this string will be prepended. Defaults to "field_".
+When generating properties, the `name` attribute of the OpenAPI schema will be used. When the `name` is not a valid
+Python identifier (e.g. begins with a number) this string will be prepended. Defaults to "field\_".
 
 Example:
 
 ```yaml
 field_prefix: attr_
 ```
 
+### package_version_override
+
+Specify the package version of the generated client. If unset, the client will use the version of the OpenAPI spec.
+
+Example:
+
+```yaml
+package_version_override: 1.2.3
+```
+
 [changelog.md]: CHANGELOG.md
 [poetry]: https://python-poetry.org/

SECURITY.md

@@ -6,7 +6,7 @@ Only the latest release is currently supported, we will not be backporting fixes
 
 ## Reporting a Vulnerability
 
-If you've discovered a vulnerability in this project, please report it to Dylan Anthony at danthony@triaxtec.com. I will create an advisory and add you 
+If you've discovered a vulnerability in this project, please report it to Dylan Anthony at danthony@triaxtec.com. I will create an advisory and add you
 to the discussion / credit you with discovery.
 
 It's better not to create an issue in the repository unless it's already actively being exploited.

end_to_end_tests/golden-record-custom/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage

end_to_end_tests/golden-record-custom/README.md

@@ -0,0 +1,61 @@
+# my-test-api-client
+A client library for accessing My Test API
+
+## Usage
+First, create a client:
+
+```python
+from my_test_api_client import Client
+
+client = Client(base_url="https://api.example.com")
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from my_test_api_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from my_test_api_client.models import MyDataModel
+from my_test_api_client.api.my_tag import get_my_data_model
+
+my_data: MyDataModel = get_my_data_model(client=client)
+```
+
+Or do the same thing with an async version:
+
+```python
+from my_test_api_client.models import MyDataModel
+from my_test_api_client.async_api.my_tag import get_my_data_model
+
+my_data: MyDataModel = await get_my_data_model(client=client)
+```
+
+Things to know:
+1. Every path/method combo becomes a Python function with type annotations. 
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `my_test_api_client.api.default`
+1. If the API returns a response code that was not declared in the OpenAPI document, a 
+    `my_test_api_client.api.errors.ApiResponseError` wil be raised 
+    with the `response` attribute set to the `httpx.Response` that was received.
+    
+
+## Building / publishing this Client
+This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
+1. Update the metadata in pyproject.toml (e.g. authors, version)
+1. If you're using a private repository, configure it with Poetry
+    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
+    1. `poetry config http-basic.<your-repository-name> <username> <password>`
+1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
+
+If you want to install this client into another project without publishing it (e.g. for development) then:
+1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
+1. If that project is not using Poetry:
+    1. Build a wheel with `poetry build -f wheel`
+    1. Install that wheel from the other project `pip install <path-to-wheel>`

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

@@ -0,0 +1,2 @@
+""" A client library for accessing My Test API """
+from .client import AuthenticatedClient, Client

end_to_end_tests/golden-record-custom/my_test_api_client/api/__init__.py

@@ -0,0 +1 @@
+""" Contains methods for accessing the API """

end_to_end_tests/golden-record-custom/my_test_api_client/api/default/__init__.py

@@ -0,0 +1,33 @@
+from typing import Optional
+
+import httpx
+
+Client = httpx.Client
+
+
+def _parse_response(*, response: httpx.Response) -> Optional[bool]:
+    if response.status_code == 200:
+        return bool(response.text)
+    return None
+
+
+def _build_response(*, response: httpx.Response) -> httpx.Response[bool]:
+    return httpx.Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(response=response),
+    )
+
+
+def httpx_request(
+    *,
+    client: Client,
+) -> httpx.Response[bool]:
+
+    response = client.request(
+        "get",
+        "/ping",
+    )
+
+    return _build_response(response=response)

end_to_end_tests/golden-record-custom/my_test_api_client/api/default/ping_ping_get.py

@@ -0,0 +1,99 @@
+from typing import Optional
+
+import httpx
+
+Client = httpx.Client
+
+import datetime
+from typing import Dict, List, Optional, Union, cast
+
+from dateutil.parser import isoparse
+
+from ...models.an_enum import AnEnum
+from ...models.http_validation_error import HTTPValidationError
+
+
+def _parse_response(*, response: httpx.Response) -> Optional[Union[None, HTTPValidationError]]:
+    if response.status_code == 200:
+        return None
+    if response.status_code == 422:
+        return HTTPValidationError.from_dict(cast(Dict[str, Any], response.json()))
+    return None
+
+
+def _build_response(*, response: httpx.Response) -> httpx.Response[Union[None, HTTPValidationError]]:
+    return httpx.Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(response=response),
+    )
+
+
+def httpx_request(
+    *,
+    client: Client,
+    json_body: Dict[Any, Any],
+    string_prop: Optional[str] = "the default string",
+    datetime_prop: Optional[datetime.datetime] = isoparse("1010-10-10T00:00:00"),
+    date_prop: Optional[datetime.date] = isoparse("1010-10-10").date(),
+    float_prop: Optional[float] = 3.14,
+    int_prop: Optional[int] = 7,
+    boolean_prop: Optional[bool] = False,
+    list_prop: Optional[List[AnEnum]] = None,
+    union_prop: Optional[Union[Optional[float], Optional[str]]] = "not a float",
+    enum_prop: Optional[AnEnum] = None,
+) -> httpx.Response[Union[None, HTTPValidationError]]:
+
+    json_datetime_prop = datetime_prop.isoformat() if datetime_prop else None
+
+    json_date_prop = date_prop.isoformat() if date_prop else None
+
+    if list_prop is None:
+        json_list_prop = None
+    else:
+        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)
+
+    if union_prop is None:
+        json_union_prop: Optional[Union[Optional[float], Optional[str]]] = None
+    elif isinstance(union_prop, float):
+        json_union_prop = union_prop
+    else:
+        json_union_prop = union_prop
+
+    json_enum_prop = enum_prop.value if enum_prop else None
+
+    params: Dict[str, Any] = {}
+    if string_prop is not None:
+        params["string_prop"] = string_prop
+    if datetime_prop is not None:
+        params["datetime_prop"] = json_datetime_prop
+    if date_prop is not None:
+        params["date_prop"] = json_date_prop
+    if float_prop is not None:
+        params["float_prop"] = float_prop
+    if int_prop is not None:
+        params["int_prop"] = int_prop
+    if boolean_prop is not None:
+        params["boolean_prop"] = boolean_prop
+    if list_prop is not None:
+        params["list_prop"] = json_list_prop
+    if union_prop is not None:
+        params["union_prop"] = json_union_prop
+    if enum_prop is not None:
+        params["enum_prop"] = json_enum_prop
+
+    json_json_body = json_body
+
+    response = client.request(
+        "post",
+        "/tests/defaults",
+        json=json_json_body,
+        params=params,
+    )
+
+    return _build_response(response=response)