Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make it possible to mark Argument Clinic args as unused #104389

Closed
erlend-aasland opened this issue May 11, 2023 · 2 comments · Fixed by #104390
Closed

Make it possible to mark Argument Clinic args as unused #104389

erlend-aasland opened this issue May 11, 2023 · 2 comments · Fixed by #104390
Assignees
@erlend-aasland
Labels
topic-argument-clinic type-feature A feature request or enhancement

Comments

@erlend-aasland
Copy link
Contributor

erlend-aasland commented May 11, 2023 •
edited by bedevere-bot
Loading

For base classes, it is not unusual to create stubs for interface methods, and let those stubs simply raise an exception. It would be nice to be able to mark the arguments with Py_UNUSED in those cases.

Implementing this is straight-forward in clinic.py. CConverter get's a new keyword argument unused which defaults to False, and we can write code like this:

/*[clinic input]
_io._TextIOBase.read
    cls: defining_class
    size: int(unused=True) = -1
[clinic start generated code]*/

Linked PRs
@erlend-aasland erlend-aasland added type-feature A feature request or enhancement topic-argument-clinic labels May 11, 2023
@erlend-aasland erlend-aasland self-assigned this May 11, 2023
@erlend-aasland
Copy link
Contributor Author

cc. @vstinner

@bedevere-bot bedevere-bot mentioned this issue May 11, 2023
Merged
erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue May 11, 2023
@erlend-aasland
pythongh-104389: Argument Clinic now wraps unused args with Py_UNUSED
2def279 
Use the unused keyword param in the converter to explicitly
mark an argument as unused:

    /*[clinic input]
    BaseClass.interface
        flag: bool(unused=True)
@erlend-aasland erlend-aasland linked a pull request May 12, 2023 that will close this issue
gh-104389: Add 'unused' keyword to Argument Clinic C converters #104390
Merged
erlend-aasland added a commit that referenced this issue May 12, 2023
@erlend-aasland
gh-104389: Add 'unused' keyword to Argument Clinic C converters (#104390
b2c1b4d 
)

Use the unused keyword param in the converter to explicitly
mark an argument as unused:

    /*[clinic input]
    SomeBaseClass.stubmethod
        flag: bool(unused=True)
    [clinic start generated code]*/
@erlend-aasland
Copy link
Contributor Author

Implemented with:

carljm added a commit to carljm/cpython that referenced this issue May 12, 2023
@carljm
Merge branch 'main' into supermon
8efd7c6 
* main:
  pythongh-91896: Fixup some docs issues following ByteString deprecation (python#104422)
  pythonGH-104371: check return value of calling `mv.release` (python#104417)
  pythongh-104415: Fix refleak tests for `typing.ByteString` deprecation (python#104416)
  pythonGH-86275: Implementation of hypothesis stubs for property-based tests, with zoneinfo tests (python#22863)
  pythonGH-103082: Filter LINE events in VM, to simplify tool implementation. (pythonGH-104387)
  pythongh-93649: Split gc- and allocation tests from _testcapimodule.c (pythonGH-104403)
  pythongh-104389: Add 'unused' keyword to Argument Clinic C converters (python#104390)
  pythongh-101819: Prepare _io._IOBase for module state (python#104386)
  pythongh-104413: Fix refleak when super attribute throws AttributeError (python#104414)
  Fix refleak in `super_descr_get` (python#104408)
  pythongh-87526: Remove dead initialization from _zoneinfo parse_abbr() (python#24700)
  pythongh-91896: Improve visibility of `ByteString` deprecation warnings (python#104294)
  pythongh-104371: Fix calls to `__release_buffer__` while an exception is active (python#104378)
  pythongh-104377: fix cell in comprehension that is free in outer scope (python#104394)
  pythongh-104392: Remove _paramspec_tvars from typing (python#104393)
  pythongh-104396: uuid.py to skip platform check for emscripten and wasi (pythongh-104397)
  pythongh-99108: Refresh HACL* from upstream (python#104401)
  pythongh-104301: Allow leading whitespace in disambiguated pdb statements (python#104342)
@JelleZijlstra JelleZijlstra mentioned this issue May 22, 2023
Closed
erlend-aasland added a commit to erlend-aasland/devguide that referenced this issue Sep 8, 2023
@erlend-aasland
python/cpython#104389: Add 'unused' keyword to Argument Clinic C conv…
816a8be 
…erters (python/cpython#104390)

Use the unused keyword param in the converter to explicitly
mark an argument as unused:

    /*[clinic input]
    SomeBaseClass.stubmethod
        flag: bool(unused=True)
    [clinic start generated code]*/
AA-Turner pushed a commit to AA-Turner/devguide that referenced this issue Sep 13, 2023
@erlend-aasland
python/cpython#104389: Add 'unused' keyword to Argument Clinic C conv…
d8a7663 
…erters (python/cpython#104390)

Use the unused keyword param in the converter to explicitly
mark an argument as unused:

    /*[clinic input]
    SomeBaseClass.stubmethod
        flag: bool(unused=True)
    [clinic start generated code]*/
erlend-aasland added a commit to python/devguide that referenced this issue Sep 26, 2023
@erlend-aasland
python/cpython#104389: Add 'unused' keyword to Argument Clinic C conv…
9e49475 
…erters (python/cpython#104390)

Use the unused keyword param in the converter to explicitly
mark an argument as unused:

    /*[clinic input]
    SomeBaseClass.stubmethod
        flag: bool(unused=True)
    [clinic start generated code]*/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@erlend-aasland erlend-aasland

Labels
topic-argument-clinic type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-104389: Add 'unused' keyword to Argument Clinic C converters erlend-aasland/cpython
1 participant
@erlend-aasland