feat!: Change the Response.status_code type to the HTTPStatus enum

[asfaltboy]

In the OpenAPI/Swagger 3.0 spec docs, in the section on responses, it's mentioned that the property name will be HTTP Response codes as per the IANA spec:

The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are defined by RFC7231 and registered status codes are listed in the IANA Status Code Registry.

It continues to add two special cases, which are currently out of scope of this PR (see below for future work).

This PR includes two main changes:

• store int code in a HTTPResponse type, catching a ValueError as before - for both int and HTTPResponse
• update the error message

Note: my initial aim was to add default responses (as mentioned in #124), but I thought I'd start with a smaller PR, to help me find my way around the project and help build confidence this is the right approach.
The following steps would be to:

1. Support the special error response form: 1XX, 2XX, 3XX, 4XX, and 5XX
2. Support default response (no error code given).
   I would probably implement this using a new wrapper type (we can call it OpenAPIResponseParameter) that is a Union of HTTPResponse with a new set of Literal types.

(p.s: I'm not sure when I will have a stretch of a few hours again, but hopefully the info above is sufficiently detailed for anyone else to continue the work)

[codecov]

Codecov Report

Merging #665 (7f542d1) into main (e2cb382) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main      #665   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           49        49           
  Lines         1795      1797    +2     
=========================================
+ Hits          1795      1797    +2     

Impacted Files	Coverage Δ
openapi_python_client/parser/openapi.py	100.00% <100.00%> (ø)
openapi_python_client/parser/responses.py	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[dbanty]

Thanks for the PR! I did some digging to find out why httpx isn't already using the builtin enum and it looks like they have their own internal enum with a bunch of helper methods on it for determining the type of code.

It's a shame they don't expose their own, since I believe that's the actual type that we're capturing, not int. 🤷

[dbanty]

Looks great, thanks! Even though this is really fixing our compatibility with the spec—it will disallow OpenAPI documents that previously generated code fine (if they have unsupported HTTP codes), so I'll mark this is a breaking change.

[asfaltboy]

I'm going to out for the day, later when back, I can do this:

1. rebase over main (remove the redundant commit)
2. use the feat! type and indicate BREAKING CHANGE in the commit, I think it should help it appear automatically as a breaking change in the release notes
3. update the changelog , and test if knope supports the above

[dbanty]

Don’t worry about doing all that, I squash on merge so I can make sure the commits look right.

Thanks for the attention to detail, though!!

[asfaltboy]

I squash on merge so I can make sure the commits look right

Nice, so I won't need to update the changelog manually in the PR, and you'd only need to add the BREAKING CHANGE: note when squashing; cool 👍

Regarding the failing tests in CI, I tried reproducing the same issue by installing a fresh 3.7 env in poetry, installing dependencies and running:

TASKIPY=true poetry run pytest --cov=openapi_python_client --cov-report=term-missing tests end_to_end_tests/test_end_to_end.py --basetemp=tests/tmp
...
======================================================================================= test session starts ==========================================================================================
platform darwin -- Python 3.7.8, pytest-6.2.5, py-1.10.0, pluggy-0.13.1
rootdir: /Users/pavelsavchenko/github/openapi-python-client, configfile: pyproject.toml
plugins: cov-2.12.1, anyio-3.3.0, mock-3.6.1
collected 372 items

tests/test___init__.py .....................................                                                                                                                                     [  9%]
...
end_to_end_tests/test_end_to_end.py ..                                                                                                                                                           [100%]

---------- coverage: platform darwin, python 3.7.8-final-0 -----------
...
TOTAL                                                                             1788      2    99%


========================================================================================= 372 passed in 17.27s ===========================================================================================

Would you know how to resolve this? Could this be coming from the cache step, where do?:

/usr/bin/tar --use-compress-program unzstd -xf /home/runner/work/_temp/e43cafd0-1f39-4c5d-9b22-95fc04289cd4/cache.tzst -P -C /home/runner/work/openapi-python-client/openapi-python-client