Title: Argument Clinic: add support for deprecating positional use of parameters · Issue #95065 · python/cpython · GitHub
Open Graph Title: Argument Clinic: add support for deprecating positional use of parameters · Issue #95065 · python/cpython
X Title: Argument Clinic: add support for deprecating positional use of parameters · Issue #95065 · python/cpython
Description: Feature or enhancement Suggesting to add syntax for producing deprecation warnings for positional use of optional parameters. I made a proof-of-concept patch for this where I introduced a new special symbol x. Example use: /*[clinic inpu...
Open Graph Description: Feature or enhancement Suggesting to add syntax for producing deprecation warnings for positional use of optional parameters. I made a proof-of-concept patch for this where I introduced a new speci...
X Description: Feature or enhancement Suggesting to add syntax for producing deprecation warnings for positional use of optional parameters. I made a proof-of-concept patch for this where I introduced a new speci...
Opengraph URL: https://github.com/python/cpython/issues/95065
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Argument Clinic: add support for deprecating positional use of parameters","articleBody":"**Feature or enhancement**\r\n\r\nSuggesting to add syntax for producing deprecation warnings for positional use of optional parameters.\r\n\r\nI made a [proof-of-concept patch](https://github.com/erlend-aasland/cpython/pull/37) for this where I introduced a new special symbol `x`. Example use:\r\n\r\n```c\r\n/*[clinic input]\r\nmod.func\r\n stuff: object\r\n /\r\n x\r\n optarg: int = 128\r\n```\r\n\r\nThis will then generate code that emits a DeprecationWarning if `optarg` is passed as a positional argument, but not if it is passed as a keyword.\r\n\r\nWe can use this feature to introduce deprecation warnings for parameters that will become keyword-only in future releases. When the deprecation period is done, we can simply replace the `x` with `*`, to really make the optional params keyword-only.\r\n\r\n**Pitch**\r\n\r\nQuoting @serhiy-storchaka, in issue #93057:\r\n\r\n\u003e It is recommended to make optional rarely used arguments keyword-only. I do not think it will break much code, but we need a deprecation period for this.\r\n\u003e\r\n\u003e The problem is that sqlite3.connect() was converted to Argument Clinic, and it was much easier to add deprecation warning in the old code.\r\n\r\n**Previous discussion**\r\n\r\n- #93057\n\n\u003c!-- gh-linked-prs --\u003e\n### Linked PRs\n* gh-95151\n* gh-107712\n* gh-107742\n* gh-107745\n* gh-107766\n* gh-107768\n* gh-107808\n* gh-108132\n\u003c!-- /gh-linked-prs --\u003e\n","author":{"url":"https://github.com/erlend-aasland","@type":"Person","name":"erlend-aasland"},"datePublished":"2022-07-20T19:53:46.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":24},"url":"https://github.com/95065/cpython/issues/95065"}
| 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:414e22ed-c1e5-e502-5035-e2e94532e262 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B6FE:327857:17E1CD4:20D1C84:696A9F24 |
| html-safe-nonce | 3aed3ec0b25997e7d2d1b52bce50f5422f8a4071b7d646754db50a4dca54ad64 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCNkZFOjMyNzg1NzoxN0UxQ0Q0OjIwRDFDODQ6Njk2QTlGMjQiLCJ2aXNpdG9yX2lkIjoiNDQwMDk0NzEzNDk1MzMwNTk2IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | f4089d12dd54b0633cd0eeb94fd1472d29a23fab9127a60628c990f2b790864e |
| hovercard-subject-tag | issue:1311803166 |
| 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/python/cpython/95065/issue_layout |
| twitter:image | https://opengraph.githubassets.com/d61eadad2345c0dea0fb62a235f2105b56308a330a8ca77578af62cb1ce378b8/python/cpython/issues/95065 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/d61eadad2345c0dea0fb62a235f2105b56308a330a8ca77578af62cb1ce378b8/python/cpython/issues/95065 |
| og:image:alt | Feature or enhancement Suggesting to add syntax for producing deprecation warnings for positional use of optional parameters. I made a proof-of-concept patch for this where I introduced a new speci... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | erlend-aasland |
| hostname | github.com |
| expected-hostname | github.com |
| None | a51f97dbb9326f71c08ecb61577457d543c602124d1a2672871258ef37ac5261 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| 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 | 4bd0eac606c70914085176ef312ebdcd97a8cdf1 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width