gh-141004: Document `PyErr_RangedSyntaxLocationObject` #141521

StanFromIreland · 2025-11-13T17:42:46Z

Issue: Document the entire C API #141004

📚 Documentation preview 📚: https://cpython-previews--141521.org.readthedocs.build/

pablogsal

LGTM

miss-islington-app · 2025-11-13T17:59:01Z

Thanks @StanFromIreland for the PR, and @pablogsal for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington-app · 2025-11-13T17:59:02Z

Thanks @StanFromIreland for the PR, and @pablogsal for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

…H-141521) PyErr_RangedSyntaxLocationObject (cherry picked from commit 196f151) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

bedevere-app · 2025-11-13T17:59:16Z

GH-141524 is a backport of this pull request to the 3.13 branch.

…H-141521) PyErr_RangedSyntaxLocationObject (cherry picked from commit 196f151) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

bedevere-app · 2025-11-13T17:59:21Z

GH-141525 is a backport of this pull request to the 3.14 branch.

StanFromIreland · 2025-11-13T18:01:18Z

Thanks ❤️

) (#141525) gh-141004: Document `PyErr_RangedSyntaxLocationObject` (GH-141521) PyErr_RangedSyntaxLocationObject (cherry picked from commit 196f151) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

) (#141524) gh-141004: Document `PyErr_RangedSyntaxLocationObject` (GH-141521) PyErr_RangedSyntaxLocationObject (cherry picked from commit 196f151) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

ZeroIntensity · 2025-11-13T18:37:07Z

Doc/c-api/exceptions.rst

+   Similar to :c:func:`PyErr_SyntaxLocationObject`, but also sets the
+   *end_lineno* and *end_col_offset* information for the current exception.


I'm not entirely sure that this is correct. Unless I'm going crazy, this is exactly the same as PyErr_SyntaxLocationObjectEx:

cpython/Python/errors.c

Lines 1910 to 1914 in 209eaff

void

PyErr_RangedSyntaxLocationObject(PyObject *filename, int lineno, int col_offset,

int end_lineno, int end_col_offset) {

PyErr_SyntaxLocationObjectEx(filename, lineno, col_offset, end_lineno, end_col_offset);

}

Indeed it is, see the PyErr_SyntaxLocationObject invocation of PyErr_SyntaxLocationObjectEx.

void PyErr_SyntaxLocationObject(PyObject *filename, int lineno, int col_offset) { PyErr_SyntaxLocationObjectEx(filename, lineno, col_offset, lineno, -1); }

We are essentially just exposing the full functionality of PyErr_SyntaxLocationObjectEx.

It seems like PyErr_SyntaxLocationObjectEx is undocumented. Let's document that and document PyErr_RangedSyntaxLocationObject as a soft-deprecated alias to it.

We'd have to expose it first:

cpython/Python/errors.c

Line 1801 in a486d45

static void

Ah, so we named something like a public API without exposing it -- yuck! I think we're all good here then.

* main: (463 commits) pythongh-140601: Add ResourceWarning to iterparse when not closed (pythonGH-140603) pythongh-137969: Fix double evaluation of `ForwardRef`s which rely on globals (python#140974) pythongh-139109: A new tracing JIT compiler frontend for CPython (pythonGH-140310) pythongh-141004: Document `PyErr_RangedSyntaxLocationObject` (python#141521) pythongh-140873: Add support of non-descriptor callables in functools.singledispatchmethod() (pythonGH-140884) pythongh-139653: Add PyUnstable_ThreadState_SetStackProtection() (python#139668) pythongh-141004: Document `PyCode_Optimize` (pythonGH-141378) pythongh-141004: Document C APIs for dictionary keys, values, and items (pythonGH-141009) pythongh-137959: Fix `TIER1_TO_TIER2` macro name in JIT InternalDocs (pythonGH-141496) pythongh-139871: Add `bytearray.take_bytes([n])` to efficiently extract `bytes` (pythonGH-140128) pythongh-140601: Refactor ElementTree.iterparse() tests (pythonGH-141499) pythongh-135801: Add the module parameter to compile() etc (pythonGH-139652) pythongh-140260: fix data race in `_struct` module initialization with subinterpreters (python#140909) pythongh-137109: refactor warning about threads when forking (python#141438) pythongh-141004: Document `PyRun_InteractiveOneObject` (pythonGH-141405) pythongh-124111: Fix TCL 9 thread detection (pythonGH-128103) pythongh-141442: Add escaping to iOS testbed arguments (python#141443) pythongh-140936: Fix JIT assertion crash at finalization if some generator is alive (pythonGH-140969) Add details about JIT build infrastructure and updating dependencies to `Tools/jit` (python#141167) pythongh-141412: Use reliable target URL for urllib example (pythonGH-141428) ...

* 'main' of github.com:python/cpython: (464 commits) pythongh-140601: Add ResourceWarning to iterparse when not closed (pythonGH-140603) pythongh-137969: Fix double evaluation of `ForwardRef`s which rely on globals (python#140974) pythongh-139109: A new tracing JIT compiler frontend for CPython (pythonGH-140310) pythongh-141004: Document `PyErr_RangedSyntaxLocationObject` (python#141521) pythongh-140873: Add support of non-descriptor callables in functools.singledispatchmethod() (pythonGH-140884) pythongh-139653: Add PyUnstable_ThreadState_SetStackProtection() (python#139668) pythongh-141004: Document `PyCode_Optimize` (pythonGH-141378) pythongh-141004: Document C APIs for dictionary keys, values, and items (pythonGH-141009) pythongh-137959: Fix `TIER1_TO_TIER2` macro name in JIT InternalDocs (pythonGH-141496) pythongh-139871: Add `bytearray.take_bytes([n])` to efficiently extract `bytes` (pythonGH-140128) pythongh-140601: Refactor ElementTree.iterparse() tests (pythonGH-141499) pythongh-135801: Add the module parameter to compile() etc (pythonGH-139652) pythongh-140260: fix data race in `_struct` module initialization with subinterpreters (python#140909) pythongh-137109: refactor warning about threads when forking (python#141438) pythongh-141004: Document `PyRun_InteractiveOneObject` (pythonGH-141405) pythongh-124111: Fix TCL 9 thread detection (pythonGH-128103) pythongh-141442: Add escaping to iOS testbed arguments (python#141443) pythongh-140936: Fix JIT assertion crash at finalization if some generator is alive (pythonGH-140969) Add details about JIT build infrastructure and updating dependencies to `Tools/jit` (python#141167) pythongh-141412: Use reliable target URL for urllib example (pythonGH-141428) ...

PyErr_RangedSyntaxLocationObject

13b12f9

StanFromIreland requested review from ZeroIntensity and pablogsal November 13, 2025 17:42

bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Nov 13, 2025

github-project-automation bot added this to Docs PRs Nov 13, 2025

github-project-automation bot moved this to Todo in Docs PRs Nov 13, 2025

bedevere-app bot mentioned this pull request Nov 13, 2025

Document the entire C API #141004

Open

pablogsal approved these changes Nov 13, 2025

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting review labels Nov 13, 2025

pablogsal merged commit 196f151 into python:main Nov 13, 2025
39 checks passed

bedevere-app bot removed the awaiting merge label Nov 13, 2025

github-project-automation bot moved this from Todo to Done in Docs PRs Nov 13, 2025

pablogsal added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Nov 13, 2025

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Nov 13, 2025

bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Nov 13, 2025

StanFromIreland deleted the PyErr_RangedSyntaxLocationObject branch November 13, 2025 18:01

ZeroIntensity reviewed Nov 13, 2025

View reviewed changes

		Similar to :c:func:`PyErr_SyntaxLocationObject`, but also sets the
		end_lineno and end_col_offset information for the current exception.

	void
	PyErr_RangedSyntaxLocationObject(PyObject *filename, int lineno, int col_offset,
	int end_lineno, int end_col_offset) {
	PyErr_SyntaxLocationObjectEx(filename, lineno, col_offset, end_lineno, end_col_offset);
	}

Uh oh!

gh-141004: Document PyErr_RangedSyntaxLocationObject #141521

gh-141004: Document PyErr_RangedSyntaxLocationObject #141521

Uh oh!

Conversation

StanFromIreland commented Nov 13, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pablogsal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

miss-islington-app bot commented Nov 13, 2025

Uh oh!

miss-islington-app bot commented Nov 13, 2025

Uh oh!

bedevere-app bot commented Nov 13, 2025

Uh oh!

bedevere-app bot commented Nov 13, 2025

Uh oh!

StanFromIreland commented Nov 13, 2025

Uh oh!

ZeroIntensity Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

StanFromIreland Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

ZeroIntensity Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

StanFromIreland Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

ZeroIntensity Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gh-141004: Document `PyErr_RangedSyntaxLocationObject` #141521

gh-141004: Document `PyErr_RangedSyntaxLocationObject` #141521

StanFromIreland commented Nov 13, 2025 •

edited by github-actions bot

Loading