René's URL Explorer Experiment


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

direct link

Domain: github.com

IPv4 address: 140.82.112.4


Hey, it has json ld scripts:
{"@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-profiling0
react-import-mapreact,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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:d0c93f5c-c8f7-99af-c652-88fbccf043d9
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idD7B0:D5B7F:30EA489:40B3A61:6B03592D
html-safe-nonceb03f7ee75d5779071e1c006ff1d7bee48551c2be854fc4fbadc3130212e04f4c
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEN0IwOkQ1QjdGOjMwRUE0ODk6NDBCM0E2MTo2QjAzNTkyRCIsInZpc2l0b3JfaWQiOiI0NDIzODAxMTY4MzI1NzI4NTU3IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmace2cb257b5653dadd856584878f09cf588aaf3c230581ca6942ba15aa6c85532e
hovercard-subject-tagissue:838813884
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/openapi-generators/openapi-python-client/359/issue_layout
twitter:imagehttps://opengraph.githubassets.com/ed03e4004167294d7e1d14b598ad484a060806c9a433db9f4e6ff9009d310881/openapi-generators/openapi-python-client/issues/359
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/ed03e4004167294d7e1d14b598ad484a060806c9a433db9f4e6ff9009d310881/openapi-generators/openapi-python-client/issues/359
og:image:altDescribe 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:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamedblanchette
hostnamegithub.com
expected-hostnamegithub.com
None87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456
turbo-cache-controlno-preview
go-importgithub.com/openapi-generators/openapi-python-client git https://github.com/openapi-generators/openapi-python-client.git
octolytics-dimension-user_id84925606
octolytics-dimension-user_loginopenapi-generators
octolytics-dimension-repository_id240776275
octolytics-dimension-repository_nwoopenapi-generators/openapi-python-client
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id240776275
octolytics-dimension-repository_network_root_nwoopenapi-generators/openapi-python-client
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release423dbb54c5e7bfecc838eb387c1435eb3d0e760d
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/openapi-generators/openapi-python-client/issues/359#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenapi-generators%2Fopenapi-python-client%2Fissues%2F359
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenapi-generators%2Fopenapi-python-client%2Fissues%2F359
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=openapi-generators%2Fopenapi-python-client
Reloadhttps://github.com/openapi-generators/openapi-python-client/issues/359
Reloadhttps://github.com/openapi-generators/openapi-python-client/issues/359
Reloadhttps://github.com/openapi-generators/openapi-python-client/issues/359
openapi-generatorshttps://github.com/openapi-generators
openapi-python-clienthttps://github.com/openapi-generators/openapi-python-client
Codehttps://github.com/openapi-generators/openapi-python-client
Issues94 (94)https://github.com/openapi-generators/openapi-python-client/issues
Pull requests36 (36)https://github.com/openapi-generators/openapi-python-client/pulls
Discussionshttps://github.com/openapi-generators/openapi-python-client/discussions
Actionshttps://github.com/openapi-generators/openapi-python-client/actions
Security and quality4 (4)https://github.com/openapi-generators/openapi-python-client/security
Insightshttps://github.com/openapi-generators/openapi-python-client/insights
https://github.com/openapi-generators/openapi-python-client
New issuehttps://github.com/login?return_to=https://github.com/openapi-generators/openapi-python-client/issues/359
New issuehttps://github.com/login?return_to=https://github.com/openapi-generators/openapi-python-client/issues/359
#360https://github.com/openapi-generators/openapi-python-client/pull/360
Typing error in generated client when response attribute use reserved keywordshttps://github.com/openapi-generators/openapi-python-client/issues/359#top
#360https://github.com/openapi-generators/openapi-python-client/pull/360
🐞bugSomething isn't workinghttps://github.com/openapi-generators/openapi-python-client/issues?q=state%3Aopen%20label%3A%22%F0%9F%90%9Ebug%22
👋 good first issueGood for newcomershttps://github.com/openapi-generators/openapi-python-client/issues?q=state%3Aopen%20label%3A%22%F0%9F%91%8B%20good%20first%20issue%22
https://github.com/dblanchette
dblanchettehttps://github.com/dblanchette
on Mar 23, 2021https://github.com/openapi-generators/openapi-python-client/issues/359#issue-838813884
their OpenAPI spechttps://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json
https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.jsonhttps://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json
https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.jsonhttps://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json
dblanchettehttps://github.com/dblanchette
🐞bugSomething isn't workinghttps://github.com/openapi-generators/openapi-python-client/issues?q=state%3Aopen%20label%3A%22%F0%9F%90%9Ebug%22
on Mar 23, 2021https://github.com/openapi-generators/openapi-python-client/issues/359#event-4496687540
https://github.com/dbanty
dbantyhttps://github.com/dbanty
on Mar 23, 2021https://github.com/openapi-generators/openapi-python-client/issues/359#issuecomment-804974021
dbantyhttps://github.com/dbanty
👋 good first issueGood for newcomershttps://github.com/openapi-generators/openapi-python-client/issues?q=state%3Aopen%20label%3A%22%F0%9F%91%8B%20good%20first%20issue%22
on Mar 23, 2021https://github.com/openapi-generators/openapi-python-client/issues/359#event-4496717757
dblanchettehttps://github.com/dblanchette
on Mar 23, 2021https://github.com/openapi-generators/openapi-python-client/issues/359#event-4496840141
fix: Support attributes using builtin type nameshttps://github.com/coveord/openapi-python-client/commit/3f5f9a2044e833e8e581439a8a796f8481febd2f
https://docs.github.com/articles/closing-issues-via-commit-messages
3f5f9a2https://github.com/coveord/openapi-python-client/commit/3f5f9a2044e833e8e581439a8a796f8481febd2f
fix: Support attributes using builtin type nameshttps://github.com/coveord/openapi-python-client/commit/c5a7199a8b6f11af98d5e31e5bb3b861c79a38e3
https://docs.github.com/articles/closing-issues-via-commit-messages
c5a7199https://github.com/coveord/openapi-python-client/commit/c5a7199a8b6f11af98d5e31e5bb3b861c79a38e3
fix: Support attributes using builtin type nameshttps://github.com/coveord/openapi-python-client/commit/68c057ed4efd2cca09ef43d0d537cfc3e1d44489
https://docs.github.com/articles/closing-issues-via-commit-messages
68c057ehttps://github.com/coveord/openapi-python-client/commit/68c057ed4efd2cca09ef43d0d537cfc3e1d44489
fix: Support attributes using builtin type nameshttps://github.com/coveord/openapi-python-client/commit/c0078e09483ae836784548409cf306805bead75f
https://docs.github.com/articles/closing-issues-via-commit-messages
c0078e0https://github.com/coveord/openapi-python-client/commit/c0078e09483ae836784548409cf306805bead75f
dbantyhttps://github.com/dbanty
completedhttps://github.com/openapi-generators/openapi-python-client/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#360https://github.com/openapi-generators/openapi-python-client/pull/360
on Mar 23, 2021https://github.com/openapi-generators/openapi-python-client/issues/359#event-4497158146
dbantyhttps://github.com/dbanty
on Mar 23, 2021https://github.com/openapi-generators/openapi-python-client/issues/359#event-4497158250
fix!: Attributes shadowing any builtin will now be renamed in generat…https://github.com/openapi-generators/openapi-python-client/commit/dc051178d6cf2a9d8dae1227d97b951beb71ce61
https://docs.github.com/articles/closing-issues-via-commit-messages
dc05117https://github.com/openapi-generators/openapi-python-client/commit/dc051178d6cf2a9d8dae1227d97b951beb71ce61
Sign up for freehttps://github.com/signup?return_to=https://github.com/openapi-generators/openapi-python-client/issues/359
Sign in to commenthttps://github.com/login?return_to=https://github.com/openapi-generators/openapi-python-client/issues/359
🐞bugSomething isn't workinghttps://github.com/openapi-generators/openapi-python-client/issues?q=state%3Aopen%20label%3A%22%F0%9F%90%9Ebug%22
👋 good first issueGood for newcomershttps://github.com/openapi-generators/openapi-python-client/issues?q=state%3Aopen%20label%3A%22%F0%9F%91%8B%20good%20first%20issue%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Response headers:
Servergithub.com
Content-Typetext/html; charset=utf-8
Cache-Controlmax-age=0, private, must-revalidate

Viewport: width=device-width


URLs of crawlers that visited me.