python / python/cpython

Document that PyErr_SetInterrupt is async-signal-safe

Open
#87,422 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.11 3.12 3.13 docs topic-C-API
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 43256
Nosy @pitrou, @vstinner, @pablogsal

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2021-02-18.14:31:32.964>
labels = ['type-bug', '3.8', '3.9', '3.10', 'expert-C-API', 'docs']
title = 'Document that PyErr_SetInterrupt is async-signal-safe'
updated_at = <Date 2021-02-18.14:31:32.964>
user = 'https://github.com/pitrou'

bugs.python.org fields:

activity = <Date 2021-02-18.14:31:32.964>
actor = 'pitrou'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'C API']
creation = <Date 2021-02-18.14:31:32.964>
creator = 'pitrou'
dependencies = []
files = []
hgrepos = []
issue_num = 43256
keywords = []
message_count = 1.0
messages = ['387234']
nosy_count = 4.0
nosy_names = ['pitrou', 'vstinner', 'docs@python', 'pablogsal']
pr_nums = []
priority = 'low'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue43256'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the C API documentation entry for PyErr_SetInterrupt and review its current description and surrounding guidance. Document that the function is async-signal-safe, then verify that the resulting reference text accurately reflects the requested behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.