8000 Add "how to" for the getter Argument Clinic directive. by corona10 · Pull Request #1232 · python/devguide · GitHub
[go: up one dir, main page]
Skip to content

Add "how to" for the getter Argument Clinic directive. #1232

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

Merged
merged 16 commits into from
Nov 30, 2023
Merged

Add "how to" for the getter Argument Clinic directive. #1232

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
e9d9ed2
Add "how to" for the getter Argument Clinic directive.
corona10 Nov 27, 2023
97e644e
Apply suggestions from code review
corona10 Nov 27, 2023
4dc72e9
Address code review
corona10 Nov 28, 2023
8cb31a9
Update development-tools/clinic.rst
corona10 Nov 28, 2023
1af671f
Address code review
corona10 Nov 28, 2023
d631e8e
fix
corona10 Nov 28, 2023
7a8bfae
Apply suggestions from code review
corona10 Nov 29, 2023
7248868
Address code review
corona10 Nov 30, 2023
9761c60
Fix REPL
corona10 Nov 30, 2023
45a7250
Fix
corona10 Nov 30, 2023
65145a9
Fix URL
corona10 Nov 30, 2023
7511cbf
Address code review
corona10 Nov 30, 2023
5f48ac0
Apply suggestions from code review
corona10 Nov 30, 2023
2b2d38b
fix
corona10 Nov 30, 2023
a630aec
Apply suggestions from code review
corona10 Nov 30, 2023
8d5ffd1
Update development-tools/clinic.rst
corona10 Nov 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
  • Loading branch information
@corona10 @AlexWaygood
corona10 and AlexWaygood authored Nov 30, 2023
commit a630aecea631c250bceaa2e35ff7d10c86a41731
7 changes: 4 additions & 3 deletions development-tools/clinic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2006,11 +2006,12 @@ The generated glue code looks like this:
How to generate a getter
------------------------

"Getters" are C functions that facilitate property-like access for a type.
"Getters" are C functions that facilitate property-like access for a class.
See :c:type:`getter <PyGetSetDef>` for details.
You can use the ``@getter`` directive to generate an "impl" function for a getter.
You can use the ``@getter`` directive to generate an "impl" function for a
getter using Argument Clinic.

This example --- taken from :cpy-file:`Modules/_io/bufferedio.c` ---
This example -- taken from :cpy-file:`Modules/_io/bufferedio.c` --
shows the use of ``@getter`` in combination with
the :ref:`@critical_section <clinic-howto-critical-sections>` directive
(which achieves thread safety without causing deadlocks between threads)::
Expand Down
0