Description

assignee = None
closed_at = None
created_at = <Date 2022-04-08.15:14:46.053>
labels = ['expert-C-API', 'docs']
title = 'RFC: Clarify usage of macros for PySequence_Fast within the Limited C API'
updated_at = <Date 2022-04-08.15:19:49.541>
user = 'https://github.com/HaoZeke'

activity = <Date 2022-04-08.15:19:49.541>
actor = 'rgoswami'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'C API']
creation = <Date 2022-04-08.15:14:46.053>
creator = 'rgoswami'
dependencies = []
files = []
hgrepos = []
issue_num = 47261
keywords = []
message_count = 2.0
messages = ['416989', '416990']
nosy_count = 2.0
nosy_names = ['docs@python', 'rgoswami']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue47261'
versions = []

Activity

1. HaoZeke commented on Apr 8, 2022

   

   HaoZekemannequin

   on Apr 8, 2022

   MannequinAuthor

   More actions

   The current documentation_ of the Python-C API mentions that PySequence_Fast is part of the limited API. However, this may be a typo as all the functions interacting with a PySequence_Fast object are macros, e.g. PySequence_Fast_GET_SIZE, PySequence_Fast_GET_ITEM etc.

   If this is indeed a documentation bug I'm happy to open a PR to fix this once consensus is reached.

   .. _current documentation : https://docs.python.org/3/c-api/stable.html#contents-of-limited-api
2. HaoZeke

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   topic-C-API

   on Apr 8, 2022
3. HaoZeke

   assigned

   docspython

   on Apr 8, 2022
4. HaoZeke

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   topic-C-API

   on Apr 8, 2022
5. HaoZeke

   assigned

   docspython

   on Apr 8, 2022
6. HaoZeke commented on Apr 8, 2022

   

   HaoZekemannequin

   on Apr 8, 2022

   MannequinAuthor

   More actions

   Perhaps to be clear, there are two possibilities:

   1. PySequence_Fast should be removed from the Limited API
   2. All macros used with PySequence_Fast are valid for use in the context of the Limited API

   In either case the documentation should need to be clarified.

   The only situation where no changes would result is if:

   • PySequence_Fast is part of the Limited API, but must be treated the same as a regular PySequence object
     • Since only PySequence_Size and other variants can be used in the context of the Limited API

   This is actually also still confusing and should be mentioned clearly.
7. HaoZeke

   changed the title [-]RFC: Clarify Limited API macros for PySequence_Fast[/-] [+]RFC: Clarify usage of macros for PySequence_Fast within the Limited C API[/+] on Apr 8, 2022
8. HaoZeke

   changed the title [-]RFC: Clarify Limited API macros for PySequence_Fast[/-] [+]RFC: Clarify usage of macros for PySequence_Fast within the Limited C API[/+] on Apr 8, 2022
9. ezio-melotti

   transferred this issue fromon Apr 10, 2022
10. vstinner

    added 2 commits that reference this issue on Jan 28, 2025

    pythongh-91417: Remove PySequence_Fast() from the limited C API

    7c85c91

    pythongh-91417: Remove PySequence_Fast() from the limited C API

    6500fe7
11. vstinner commented on Jan 29, 2025

    

    vstinner

    on Jan 29, 2025

    Member

    More actions

    I created PR gh-129398 to remove the function PySequence_Fast() from the limited C API.
12. vstinner

    added a commit that references this issue on Feb 2, 2025

    gh-91417: Remove PySequence_Fast() from the limited C API (#129398)

    2ad069d
13. vstinner commented on Feb 2, 2025

    

    vstinner

    on Feb 2, 2025

    Member

    More actions

    The function was removed from the limited C API by change 2ad069d.
14. vstinner

    closed this as completedon Feb 2, 2025
15. srinivasreddy

    added a commit that references this issue on Feb 7, 2025

    pythongh-91417: Remove PySequence_Fast() from the limited C API (pyth…

    badf111

Issue actions