rebased aiopenapi3

.github/workflows/codecov.yml

@@ -0,0 +1,36 @@
+name: Codecov
+on: [push, pull_request]
+jobs:
+  run:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.7","3.8","3.9","3.10"]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python }}
+      PYTHONPATH: "."
+    steps:
+    - uses: actions/checkout@master
+    - name: Setup Python
+      uses: actions/setup-python@master
+      with:
+        python-version: ${{ matrix.python }}
+    - name: Generate coverage report
+      run: |
+        pip install '.[tests]'
+        pip install '.[compat]'
+        pytest --cov=./ --cov-report=xml
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        directory: ./coverage/reports/
+        env_vars: OS,PYTHON
+        fail_ci_if_error: false
+        files: ./coverage.xml
+        flags: unittests
+        name: codecov-aiopenapi3
+        path_to_write_report: ./coverage/codecov_report.txt
+        verbose: true

.pre-commit-config.yaml

@@ -1,16 +1,16 @@
 repos:
   - repo: https://github.com/hadialqattan/pycln
-    rev: v0.0.4 # Possible releases: https://github.com/hadialqattan/pycln/releases
+    rev: v1.1.0 # Possible releases: https://github.com/hadialqattan/pycln/releases
     hooks:
       - id: pycln
   - repo: 'https://github.com/psf/black'
-    rev: 21.6b0
+    rev: 21.12b0
     hooks:
       - id: black
         args:
         - "--line-length=120"
   - repo: 'https://github.com/pre-commit/pre-commit-hooks'
-    rev: v4.0.1
+    rev: v4.1.0
     hooks:
       - id: end-of-file-fixer
         exclude: '^docs/[^/]*\.svg$'
@@ -20,20 +20,12 @@ repos:
         files: |
           .gitignore
       - id: check-case-conflict
-      - id: check-json
       - id: check-xml
       - id: check-executables-have-shebangs
-      - id: check-toml
-      - id: check-xml
-      - id: check-yaml
       - id: debug-statements
       - id: check-added-large-files
       - id: check-symlinks
       - id: debug-statements
-      - id: detect-aws-credentials
-        args:
-          - '--allow-missing-credentials'
-      - id: detect-private-key
   - repo: 'https://gitlab.com/pycqa/flake8'
     rev: 3.9.2
     hooks:
@@ -42,3 +34,13 @@ repos:
         - "--max-line-length=120"
         - "--ignore=E203,W503"
         - "--select=W504"
+
+ci:
+    autofix_commit_msg: |
+        [pre-commit.ci] auto fixes from pre-commit.ci hooks
+    autofix_prs: true
+    autoupdate_branch: ''
+    autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
+    autoupdate_schedule: weekly
+    skip: []
+    submodules: false

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.7-slim-buster
+
+WORKDIR /app
+COPY setup.cfg pyproject.toml requirements.txt /app/
+COPY aiopenapi3/ /app/aiopenapi3
+COPY tests /app/tests
+RUN ls -al /app
+RUN pip install --upgrade pip
+RUN pip install ".[compat]"
+RUN pip install ".[tests]"

LICENSE

@@ -1,4 +1,5 @@
 Copyright (c) 2019, William Smith
+Copyright (c) 2022, Markus Kötter
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -0,0 +1,220 @@
+# aiopenapi3
+
+A Python [OpenAPI 3 Specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) client and validator for Python 3.
+
+[![Test](https://github.com/commonism/aiopenapi3/workflows/Codecov/badge.svg?event=push&branch=master)](https://github.com/commonism/aiopenapi3/actions?query=workflow%3ACodecov+event%3Apush+branch%3Amaster)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/commonism/aiopenapi3/master.svg)](https://results.pre-commit.ci/latest/github/commonism/aiopenapi3/master)
+[![Coverage](https://img.shields.io/codecov/c/github/commonism/aiopenapi3)](https://codecov.io/gh/commonism/aiopenapi3)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/aiopenapi3.svg)](https://pypi.org/project/aiopenapi3)
+
+
+This project is based on [Dorthu/openapi3](github.com/Dorthu/openapi3/).
+
+## Features
+  * implements …
+    * Swagger 2.0
+    * OpenAPI 3.0.3
+    * OpenAPI 3.1.0
+  * object parsing via pydantic
+  * request body model creation via [pydantic](https://github.com/samuelcolvin/pydantic)
+  * blocking and nonblocking (asyncio) interface via [httpx](https://www.python-httpx.org/)
+  * tests with pytest
+  * providing access to methods and arguments via the sad smiley ._. interface
+
+
+## Usage as a Client
+
+This library also functions as an interactive client for arbitrary OpenAPI 3
+specs. For example, using `Linode's OpenAPI 3 Specification`_ for reference:
+
+*Unfortunately I do not have access to the Linode API to validate object creation*
+
+### asyncio
+```python
+from aiopenapi3 import OpenAPI
+url = "https://www.linode.com/docs/api/openapi.yaml"
+
+api = await OpenAPI.load_async(url)
+
+# call operations and receive result models
+regions = await api._.getRegions()
+```
+
+### blocking io
+```python
+from aiopenapi3 import OpenAPI
+url = "https://www.linode.com/docs/api/openapi.yaml"
+my_token = "Gae6aikaegainoor"
+api = OpenAPI.load_sync(url)
+
+# call operations and receive result models
+regions = api._.getRegions()
+
+
+```
+
+### objects
+pydantic is used for the models.
+https://pydantic-docs.helpmanual.io/usage/exporting_models/
+
+```python
+from aiopenapi3 import OpenAPI
+url = "https://www.linode.com/docs/api/openapi.yaml"
+
+api = await OpenAPI.load_sync(url)
+
+# call operations and receive result models
+regions = await api._.getRegions()
+
+regions.__fields_set__
+{'results', 'page', 'pages', 'data'}
+
+import json
+print(json.dumps((list(filter(lambda x: 'eu-west' in x.id, regions.data))[0]).dict(), indent=2))
+{
+  "id": "eu-west",
+  "country": "uk",
+  "capabilities": [
+    "Linodes",
+    "NodeBalancers",
+    "Block Storage",
+    "Kubernetes",
+    "Cloud Firewall"
+  ],
+  "status": "ok",
+  "resolvers": {
+    "ipv4": "178.79.182.5,176.58.107.5,176.58.116.5,176.58.121.5,151.236.220.5,212.71.252.5,212.71.253.5,109.74.192.20,109.74.193.20,109.74.194.20",
+    "ipv6": "2a01:7e00::9,2a01:7e00::3,2a01:7e00::c,2a01:7e00::5,2a01:7e00::6,2a01:7e00::8,2a01:7e00::b,2a01:7e00::4,2a01:7e00::7,2a01:7e00::2"
+  }
+}
+```
+
+#### discriminators
+discriminators are supported as well, but the linode api can't be used to show how to use them.
+look at [aiopenapi3/tests/model_test.py](aiopenapi3/tests/model_test.py) test_model.
+
+### authentication
+```python
+my_token = "Gae6aikaegainoor"
+api.authenticate(personalAccessToken=my_token)
+
+# call an operation that requires authentication
+linodes  = api._.getLinodeInstances()
+```
+
+HTTP basic authentication and HTTP digest authentication works like this:
+```python
+# authenticate using a securityScheme defined in the spec's components.securitySchemes
+# Tuple with (username, password) as second argument
+api.authenticate(basicAuth=('username', 'password'))
+```
+
+Resetting authentication tokens:
+```python
+api.authenticate(None)
+```
+
+### parameters
+
+```python
+# call an opertaion with parameters
+linode = api._.getLinodeInstance(parameters={"linodeId": 123})
+```
+
+### body
+```python
+body = api._.createLinodeInstance.args()["data"].model({"region":"us-east", "type":"g6-standard-2"})
+print(json.dumps(body.dict(), indent=2))
+{
+  "image": null,
+  "root_pass": null,
+  "authorized_keys": null,
+  "authorized_users": null,
+  "stackscript_id": null,
+  "stackscript_data": null,
+  "booted": null,
+  "backup_id": null,
+  "backups_enabled": null,
+  "swap_size": null,
+  "type": "g6-standard-2",
+  "region": "us-east",
+  "label": null,
+  "tags": null,
+  "group": null,
+  "private_ip": null,
+  "interfaces": null
+}
+
+print(json.dumps(body.dict(exclude_unset=True), indent=2))
+{
+  "type": "g6-standard-2",
+  "region": "us-east"
+}
+
+
+>>>
+new_linode = api._.createLinodeInstance(data=body)
+```
+
+## Validation Mode
+
+
+This module can be run against a spec file to validate it like so::
+
+```
+python3 -m aiopenapi3 tests/fixtures/with-broken-links.yaml
+
+6 validation errors for OpenAPISpec
+paths -> /with-links -> get -> responses -> 200 -> links -> exampleWithBoth -> __root__
+ operationId and operationRef are mutually exclusive, only one of them is allowed (type=value_error.spec; message=operationId and operationRef are mutually exclusive, only one of them is allowed; element=None)
+paths -> /with-links -> get -> responses -> 200 -> links -> exampleWithBoth -> $ref
+ field required (type=value_error.missing)
+paths -> /with-links -> get -> responses -> 200 -> $ref
+ field required (type=value_error.missing)
+paths -> /with-links-two -> get -> responses -> 200 -> links -> exampleWithNeither -> __root__
+ operationId and operationRef are mutually exclusive, one of them must be specified (type=value_error.spec; message=operationId and operationRef are mutually exclusive, one of them must be specified; element=None)
+paths -> /with-links-two -> get -> responses -> 200 -> links -> exampleWithNeither -> $ref
+ field required (type=value_error.missing)
+paths -> /with-links-two -> get -> responses -> 200 -> $ref
+ field required (type=value_error.missing)
+```
+
+## Real World issues
+### YAML
+The description document may no be valid yaml.
+YAML type coercion can cause this.
+```python
+>>> yaml.safe_load(str(datetime.datetime.now().date()))
+datetime.date(2022, 1, 12)
+
+>>> yaml.safe_load("name: on")
+{'name': True}
+
+>>> yaml.safe_load('12_24: "test"')
+{1224: 'test'}
+```
+Those can be turned of using the yload yaml.Loader argument to the Loader.
+
+```python
+import aiopenapi3.loader
+
+OpenAPI.load…(…, loader=FileSystemLoader(pathlib.Path(dir), yload = aiopenapi3.loader.YAMLCompatibilityLoader))
+
+```
+
+### description document mismatch
+In case the description document does not match the protocol, it may be required to alter the description, objects or data sent/received.
+The [Plugin interface](tests/plugin_test.py) can be used to alter any of those.
+It can even be used to alter an invalid description document to be usable.
+
+
+
+## Running Tests
+
+This project includes a test suite, run via ``pytest``.  To run the test suite,
+ensure that you've installed the dependencies and then run ``pytest`` in the root
+of this project.
+
+```shell
+PYTHONPATH=. pytest --cov=./ --cov-report=xml .
+```