Skip to content

Support getters and setters in Argument Clinic #112205

Closed
Closed
Support getters and setters in Argument Clinic#112205
Assignees
corona10
Labels
3.13only security fixestopic-argument-clinictopic-free-threadingtype-featureA feature request or enhancement

Description

@colesbury
colesbury
opened on Nov 17, 2023

Feature or enhancement

In the C API, getters and setters are implemented using PyGetSetDef. Argument Clinic doesn't currently support writing getters and setters, probably because they are pretty straightforward to write manually -- there's not much argument parsing to be done.

Argument Clinic now supports the @critical_section directive, which avoids a bunch of boilerplate code when making things thread-safe with the --disable-gil builds. It would be helpful if Argument Clinic supported getters/setters so that we could avoid the critical section boilerplate in getters and setters as well.

Linked PRs

Activity

  1. colesbury
    added
    type-featureA feature request or enhancement
    topic-argument-clinic
    3.13only security fixes
    topic-free-threading
    on Nov 17, 2023

  2. colesbury commented on Nov 17, 2023

    @colesbury
    colesbury
    on Nov 17, 2023
    ContributorAuthor

    cc @aisk (who brought up this issue in #112116 (comment)) and @erlend-aasland for feedback

  3. corona10 commented on Nov 22, 2023

    @corona10
    corona10
    on Nov 22, 2023
    Member

    Another example that needs this feature: #112298

  4. corona10 commented on Nov 22, 2023

    @corona10
    corona10
    on Nov 22, 2023
    Member

    @colesbury @erlend-aasland @AlexWaygood
    (Just for example)
    What about following DSL for name setter / getter case?
    It looks similar to Java lombok annotation :(

    /*[clinic input] 
@setter
@getter
@critical_section
_io._Buffered.name
[clinic start generated code]*/
  5. corona10
    added a commit that references this issue on Nov 25, 2023

    pythongh-112205: Support @Getter annotation from AC

    72d9018
  6. colesbury
    assigned
    corona10
    on Nov 27, 2023
  7. corona10
    added 3 commits that reference this issue on Nov 30, 2023

    gh-112205: Support @Getter annotation from AC (gh-112396)

    7eeea13

    pythongh-112205: Update stringio module to use AC for the thread-safe

    6288ac0

    gh-112205: Update stringio module to use AC for the thread-safe (gh-1…

    5b06299

  8. corona10 commented on Dec 2, 2023

    @corona10
    corona10
    on Dec 2, 2023
    Member
    /*[clinic input] 
@getter
@critical_section
_io._Buffered.name
[clinic start generated code]*/

/*[clinic input] 
@setter
@critical_section
_io._Buffered.name
[clinic start generated code]*/

    I am working on supporting @setterwith the co-existence case of @getter.
    Separating clinic input is more straightforward and cleaner than declaring with a single input.

  9. AlexWaygood commented on Dec 2, 2023

    @AlexWaygood
    AlexWaygood
    on Dec 2, 2023
    Member

    Separating clinic input is more straightforward and cleaner than declaring with a single input.

    I think it looks nicer as well — having the three stacked decorators kinda looked ugly to me. Moreover, the slightly more verbose syntax of having the two inputs separated is closer to how you'd implement a Python property with a setter. In short: good choice, IMO :-)

  10. corona10
    added a commit that references this issue on Dec 10, 2023

    pythongh-112205: Support `@setter` annotation from AC

    488a127

  11. 13 remaining items

  12. corona10
    closed this as completedon Dec 20, 2023
  13. ryan-duve
    added 2 commits that reference this issue on Dec 26, 2023

    pythongh-112205: Require @Getter and @Setter to be methods (python#11…

    586355d

    pythongh-112205: Support docstring for `@getter` (python#113160)

    fdfe332
  14. aisk
    added 6 commits that reference this issue on Feb 11, 2024

    pythongh-112205: Support @Getter annotation from AC (pythongh-112396)

    fae9ef6

    pythongh-112205: Update stringio module to use AC for the thread-safe (…

    93965ff

    pythongh-112205: Support `@setter` annotation from AC (pythongh-112922)

    6ad31bb

    pythongh-112205: Update textio module to use `@getter` as possible. (p…

    3072202

    pythongh-112205: Require @Getter and @Setter to be methods (python#11…

    a1284ea

    pythongh-112205: Support docstring for `@getter` (python#113160)

    9c75dc2
  15. Glyphack
    added 6 commits that reference this issue on Sep 2, 2024

    pythongh-112205: Support @Getter annotation from AC (pythongh-112396)

    9bbf3ee

    pythongh-112205: Update stringio module to use AC for the thread-safe (…

    088b10f

    pythongh-112205: Support `@setter` annotation from AC (pythongh-112922)

    2475e03

    pythongh-112205: Update textio module to use `@getter` as possible. (p…

    70bfefd

    pythongh-112205: Require @Getter and @Setter to be methods (python#11…

    78f1dc5

    pythongh-112205: Support docstring for `@getter` (python#113160)

    9aad548
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

3.13only security fixestopic-argument-clinictopic-free-threadingtype-featureA feature request or enhancement

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions