Title: Typing error in generated client when response attribute use reserved keywords · Issue #359 · openapi-generators/openapi-python-client · GitHub
Open Graph Title: Typing error in generated client when response attribute use reserved keywords · Issue #359 · openapi-generators/openapi-python-client
X Title: Typing error in generated client when response attribute use reserved keywords · Issue #359 · openapi-generators/openapi-python-client
Description: Describe the bug I am using this library to generate a Python client for Jira using their OpenAPI spec. I get a strange bug at import time: File "D:\Repos\jira_generated\the-jira-cloud-platform-rest-api-client\the_jira_cloud_platform_res...
Open Graph Description: Describe the bug I am using this library to generate a Python client for Jira using their OpenAPI spec. I get a strange bug at import time: File "D:\Repos\jira_generated\the-jira-cloud-platform-res...
X Description: Describe the bug I am using this library to generate a Python client for Jira using their OpenAPI spec. I get a strange bug at import time: File "D:\Repos\jira_generated\the-jira-cloud-platfor...
Opengraph URL: https://github.com/openapi-generators/openapi-python-client/issues/359
X: @github
Domain: github.com
IPv4 address: 140.82.112.4
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Typing error in generated client when response attribute use reserved keywords","articleBody":"**Describe the bug**\r\nI am using this library to generate a Python client for Jira using [their OpenAPI spec](https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json).\r\n\r\nI get a strange bug at import time:\r\n```\r\n File \"D:\\Repos\\jira_generated\\the-jira-cloud-platform-rest-api-client\\the_jira_cloud_platform_rest_api_client\\models\\json_node.py\", line 38, in JsonNode\r\n int_value: Union[Unset, int] = UNSET\r\n File \"C:\\Apps\\Python38\\lib\\typing.py\", line 261, in inner\r\n return func(*args, **kwds)\r\n File \"C:\\Apps\\Python38\\lib\\typing.py\", line 358, in __getitem__\r\n parameters = tuple(_type_check(p, msg) for p in parameters)\r\n File \"C:\\Apps\\Python38\\lib\\typing.py\", line 358, in \u003cgenexpr>\r\n parameters = tuple(_type_check(p, msg) for p in parameters)\r\n File \"C:\\Apps\\Python38\\lib\\typing.py\", line 149, in _type_check\r\n raise TypeError(f\"{msg} Got {arg!r:.100}.\")\r\nTypeError: Union[arg, ...]: each arg must be a type. Got \u003cthe_jira_cloud_platform_rest_api_client.types.Unset object at 0x0000018CF4EEA070>.\r\n```\r\n\r\nAfter investigating for a while, I came to the conclusion that it's because the `JsonNode` object has an attribute named \"int\". The attribute shadows the built-in name `int` and causes type hinting to fail:\r\n\r\n```python\r\n@attr.s(auto_attribs=True)\r\nclass JsonNode:\r\n \"\"\" \"\"\"\r\n\r\n ... # Other attributes\r\n int: Union[Unset, bool] = UNSET\r\n ... # Other attributes\r\n int_value: Union[Unset, int] = UNSET # Breaks here!\r\n ... # Other attributes\r\n```\r\n\r\n**To Reproduce**\r\nSteps to reproduce the behavior:\r\n1. Generate the client for Jira: openapi-python-client generate --url https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json\r\n2. cd to the generated directory and open a Python shell\r\n3. Import `get_changelogs`: `from the_jira_cloud_platform_rest_api_client.api.issues import get_change_logs` or anything else indirectly using `JsonNode`\r\n\r\n**Expected behavior**\r\nA different name may need to be used here like `int_` or similar.\r\n\r\n**OpenAPI Spec File**\r\nhttps://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json\r\n\r\n**Desktop (please complete the following information):**\r\n - OS: Windows 10\r\n - Python Version: 3.8.8\r\n - openapi-python-client version: 0.8.0\r\n\r\n**Additional context**\r\nThanks for the great tool!\r\n","author":{"url":"https://github.com/dblanchette","@type":"Person","name":"dblanchette"},"datePublished":"2021-03-23T14:54:38Z","url":"https://github.com/openapi-generators/openapi-python-client/issues/359"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:d0c93f5c-c8f7-99af-c652-88fbccf043d9 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | D7B0:D5B7F:30EA489:40B3A61:6B03592D |
| html-safe-nonce | b03f7ee75d5779071e1c006ff1d7bee48551c2be854fc4fbadc3130212e04f4c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEN0IwOkQ1QjdGOjMwRUE0ODk6NDBCM0E2MTo2QjAzNTkyRCIsInZpc2l0b3JfaWQiOiI0NDIzODAxMTY4MzI1NzI4NTU3IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | e2cb257b5653dadd856584878f09cf588aaf3c230581ca6942ba15aa6c85532e |
| hovercard-subject-tag | issue:838813884 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/openapi-generators/openapi-python-client/359/issue_layout |
| twitter:image | https://opengraph.githubassets.com/ed03e4004167294d7e1d14b598ad484a060806c9a433db9f4e6ff9009d310881/openapi-generators/openapi-python-client/issues/359 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/ed03e4004167294d7e1d14b598ad484a060806c9a433db9f4e6ff9009d310881/openapi-generators/openapi-python-client/issues/359 |
| og:image:alt | Describe the bug I am using this library to generate a Python client for Jira using their OpenAPI spec. I get a strange bug at import time: File "D:\Repos\jira_generated\the-jira-cloud-platform-res... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | dblanchette |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| go-import | github.com/openapi-generators/openapi-python-client git https://github.com/openapi-generators/openapi-python-client.git |
| octolytics-dimension-user_id | 84925606 |
| octolytics-dimension-user_login | openapi-generators |
| octolytics-dimension-repository_id | 240776275 |
| octolytics-dimension-repository_nwo | openapi-generators/openapi-python-client |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 240776275 |
| octolytics-dimension-repository_network_root_nwo | openapi-generators/openapi-python-client |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
| Server | github.com |
| Content-Type | text/html; charset=utf-8 |
| Cache-Control | max-age=0, private, must-revalidate |
Viewport: width=device-width