Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commite1552fd

Browse files
authored
gh-101100: Clean up Doc/c-api/exceptions.rst and Doc/c-api/sys.rst (GH-114825)
1 parentcc573c7 commite1552fd

File tree

3 files changed

+29
-20
lines changed

3 files changed

+29
-20
lines changed

‎Doc/c-api/exceptions.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ an error value).
396396
..c:function::intPyErr_ResourceWarning(PyObject *source, Py_ssize_t stack_level, const char *format, ...)
397397
398398
Function similar to:c:func:`PyErr_WarnFormat`, but *category* is
399-
:exc:`ResourceWarning` and it passes *source* to:func:`warnings.WarningMessage`.
399+
:exc:`ResourceWarning` and it passes *source* to:class:`!warnings.WarningMessage`.
400400
401401
..versionadded::3.6
402402
@@ -732,7 +732,7 @@ Exception Classes
732732
This creates a class object derived from:exc:`Exception` (accessible in C as
733733
:c:data:`PyExc_Exception`).
734734
735-
The :attr:`__module__` attribute of the new class is set to the first part (up
735+
The :attr:`!__module__` attribute of the new class is set to the first part (up
736736
to the last dot) of the *name* argument, and the class name is set to the last
737737
part (after the last dot). The *base* argument can be used to specify alternate
738738
base classes; it can either be only one class or a tuple of classes. The *dict*
@@ -904,8 +904,8 @@ because the :ref:`call protocol <call>` takes care of recursion handling.
904904
905905
Marks a point where a recursive C-level call is about to be performed.
906906
907-
If:c:macro:`USE_STACKCHECK` is defined, this function checks if the OS
908-
stack overflowed using:c:func:`PyOS_CheckStack`.In this is the case, it
907+
If:c:macro:`!USE_STACKCHECK` is defined, this function checks if the OS
908+
stack overflowed using:c:func:`PyOS_CheckStack`.If this is the case, it
909909
sets a:exc:`MemoryError` and returns a nonzero value.
910910
911911
The function then checks if the recursion limit is reached. If this is the
@@ -1158,11 +1158,11 @@ These are compatibility aliases to :c:data:`PyExc_OSError`:
11581158
+-------------------------------------+----------+
11591159
| C Name | Notes |
11601160
+=====================================+==========+
1161-
| :c:data:`PyExc_EnvironmentError` | |
1161+
| :c:data:`!PyExc_EnvironmentError` | |
11621162
+-------------------------------------+----------+
1163-
| :c:data:`PyExc_IOError` | |
1163+
| :c:data:`!PyExc_IOError` | |
11641164
+-------------------------------------+----------+
1165-
| :c:data:`PyExc_WindowsError` | [2]_ |
1165+
| :c:data:`!PyExc_WindowsError` | [2]_ |
11661166
+-------------------------------------+----------+
11671167
11681168
.. versionchanged:: 3.3

‎Doc/c-api/sys.rst

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
Operating System Utilities
66
==========================
77

8+
89
..c:function:: PyObject*PyOS_FSPath(PyObject *path)
910
1011
Return the file system representation for *path*. If the object is a
@@ -97,27 +98,30 @@ Operating System Utilities
9798
9899
..c:function::intPyOS_CheckStack()
99100
101+
.. index:: single: USE_STACKCHECK (C macro)
102+
100103
Return true when the interpreter runs out of stack space. This is a reliable
101-
check, but is only available when :c:macro:`USE_STACKCHECK` is defined (currently
104+
check, but is only available when :c:macro:`!USE_STACKCHECK` is defined (currently
102105
on certain versions of Windows using the Microsoft Visual C++ compiler).
103-
:c:macro:`USE_STACKCHECK` will be defined automatically; you should never
106+
:c:macro:`!USE_STACKCHECK` will be defined automatically; you should never
104107
change the definition in your own code.
105108
106109
110+
..c:type::void (*PyOS_sighandler_t)(int)
111+
112+
107113
..c:function:: PyOS_sighandler_tPyOS_getsig(int i)
108114
109115
Return the current signal handler for signal *i*. This is a thin wrapper around
110116
either :c:func:`!sigaction` or :c:func:`!signal`. Do not call those functions
111-
directly! :c:type:`PyOS_sighandler_t` is a typedef alias for :c:expr:`void
112-
(\*)(int)`.
117+
directly!
113118
114119
115120
.. c:function:: PyOS_sighandler_t PyOS_setsig(int i, PyOS_sighandler_t h)
116121
117122
Set the signal handler for signal *i* to be *h*;return the old signal handler.
118123
This is a thin wrapper around either:c:func:`!sigaction` or:c:func:`!signal`. Do
119-
not call those functions directly!:c:type:`PyOS_sighandler_t` is a typedef
120-
alias for:c:expr:`void (\*)(int)`.
124+
not call those functions directly!
121125
122126
..c:function::wchar_t*Py_DecodeLocale(const char* arg, size_t *size)
123127
@@ -342,10 +346,8 @@ accessible to C code. They all work with the current interpreter thread's
342346
silently abort the operation by raising an error subclassed from
343347
:class:`Exception` (other errors will not be silenced).
344348
345-
The hook function is of type :c:expr:`int (*)(const char *event, PyObject
346-
*args, void *userData)`, where *args* is guaranteed to be a
347-
:c:type:`PyTupleObject`. The hook function is always called with the GIL
348-
held by the Python interpreter that raised the event.
349+
The hook function is always called with the GIL held by the Python
350+
interpreter that raised the event.
349351
350352
See :pep:`578` for a detailed description of auditing. Functions in the
351353
runtime and standard library that raise events are listed in the
@@ -354,12 +356,21 @@ accessible to C code. They all work with the current interpreter thread's
354356
355357
.. audit-event:: sys.addaudithook "" c.PySys_AddAuditHook
356358
357-
If the interpreter is initialized, this function raisesa auditing event
359+
If the interpreter is initialized, this function raisesan auditing event
358360
``sys.addaudithook`` with no arguments. If any existing hooks raise an
359361
exception derived from :class:`Exception`, the new hook will not be
360362
added and the exception is cleared. As a result, callers cannot assume
361363
that their hook has been added unless they control all existing hooks.
362364
365+
.. c:namespace:: NULL
366+
.. c:type:: int (*Py_AuditHookFunction) (const char *event, PyObject *args, void *userData)
367+
368+
The type of the hook function.
369+
*event* is the C string event argument passed to:c:func:`PySys_Audit` or
370+
:c:func:`PySys_AuditTuple`.
371+
*args* is guaranteed to be a:c:type:`PyTupleObject`.
372+
*userData* is the argument passed to PySys_AddAuditHook().
373+
363374
..versionadded::3.8
364375
365376

‎Doc/tools/.nitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,12 @@
33
# Keep lines sorted lexicographically to help avoid merge conflicts.
44

55
Doc/c-api/descriptor.rst
6-
Doc/c-api/exceptions.rst
76
Doc/c-api/float.rst
87
Doc/c-api/init.rst
98
Doc/c-api/init_config.rst
109
Doc/c-api/intro.rst
1110
Doc/c-api/module.rst
1211
Doc/c-api/stable.rst
13-
Doc/c-api/sys.rst
1412
Doc/c-api/type.rst
1513
Doc/c-api/typeobj.rst
1614
Doc/extending/extending.rst

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp