@@ -215,7 +215,7 @@ process and user.
215
215
216
216
On some platforms, including FreeBSD and macOS, setting ``environ `` may
217
217
cause memory leaks. Refer to the system documentation for
218
- :c:func: `putenv `.
218
+ :c:func: `! putenv `.
219
219
220
220
You can delete items in this mapping to unset environment variables.
221
221
:func: `unsetenv ` will be called automatically when an item is deleted from
@@ -553,7 +553,7 @@ process and user.
553
553
.. note ::
554
554
555
555
On some platforms, including FreeBSD and macOS, setting ``environ `` may
556
- cause memory leaks. Refer to the system documentation for :c:func: `putenv `.
556
+ cause memory leaks. Refer to the system documentation for :c:func: `! putenv `.
557
557
558
558
.. audit-event :: os.putenv key,value os.putenv
559
559
@@ -597,15 +597,15 @@ process and user.
597
597
598
598
.. function :: setpgrp()
599
599
600
- Call the system call :c:func: `setpgrp ` or ``setpgrp(0, 0) `` depending on
600
+ Call the system call :c:func: `! setpgrp ` or ``setpgrp(0, 0) `` depending on
601
601
which version is implemented (if any). See the Unix manual for the semantics.
602
602
603
603
.. availability :: Unix, not Emscripten, not WASI.
604
604
605
605
606
606
.. function :: setpgid(pid, pgrp, /)
607
607
608
- Call the system call :c:func: `setpgid ` to set the process group id of the
608
+ Call the system call :c:func: `! setpgid ` to set the process group id of the
609
609
process with id *pid * to the process group with id *pgrp *. See the Unix manual
610
610
for the semantics.
611
611
@@ -971,7 +971,7 @@ as internal buffering of data.
971
971
.. function :: fsync(fd)
972
972
973
973
Force write of file with filedescriptor *fd * to disk. On Unix, this calls the
974
- native :c:func: `fsync ` function; on Windows, the MS :c:func: `_commit ` function.
974
+ native :c:func: `! fsync ` function; on Windows, the MS :c:func: `! _commit ` function.
975
975
976
976
If you're starting with a buffered Python :term: `file object ` *f *, first do
977
977
``f.flush() ``, and then do ``os.fsync(f.fileno()) ``, to ensure that all internal
@@ -2127,7 +2127,7 @@ features:
2127
2127
2128
2128
.. function :: lstat(path, *, dir_fd=None)
2129
2129
2130
- Perform the equivalent of an :c:func: `lstat ` system call on the given path.
2130
+ Perform the equivalent of an :c:func: `! lstat ` system call on the given path.
2131
2131
Similar to :func: `~os.stat `, but does not follow symbolic links. Return a
2132
2132
:class: `stat_result ` object.
2133
2133
@@ -2936,14 +2936,16 @@ features:
2936
2936
2937
2937
Windows file attributes: ``dwFileAttributes `` member of the
2938
2938
``BY_HANDLE_FILE_INFORMATION `` structure returned by
2939
- :c:func: `GetFileInformationByHandle `. See the ``FILE_ATTRIBUTE_* ``
2939
+ :c:func: `!GetFileInformationByHandle `.
2940
+ See the :const: `!FILE_ATTRIBUTE_* <stat.FILE_ATTRIBUTE_ARCHIVE> `
2940
2941
constants in the :mod: `stat ` module.
2941
2942
2942
2943
.. attribute :: st_reparse_tag
2943
2944
2944
- When :attr: `st_file_attributes ` has the `` FILE_ATTRIBUTE_REPARSE_POINT ` `
2945
+ When :attr: `st_file_attributes ` has the :const: ` ~stat. FILE_ATTRIBUTE_REPARSE_POINT `
2945
2946
set, this field contains the tag identifying the type of reparse point.
2946
- See the ``IO_REPARSE_TAG_* `` constants in the :mod: `stat ` module.
2947
+ See the :const: `IO_REPARSE_TAG_* <stat.IO_REPARSE_TAG_SYMLINK> `
2948
+ constants in the :mod: `stat ` module.
2947
2949
2948
2950
The standard module :mod: `stat ` defines functions and constants that are
2949
2951
useful for extracting information from a :c:struct: `stat ` structure. (On
@@ -2982,7 +2984,7 @@ features:
2982
2984
2983
2985
.. function :: statvfs(path)
2984
2986
2985
- Perform a :c:func: `statvfs ` system call on the given path. The return value is
2987
+ Perform a :c:func: `! statvfs ` system call on the given path. The return value is
2986
2988
an object whose attributes describe the filesystem on the given path, and
2987
2989
correspond to the members of the :c:struct: `statvfs ` structure, namely:
2988
2990
:attr: `f_bsize `, :attr: `f_frsize `, :attr: `f_blocks `, :attr: `f_bfree `,
@@ -4063,7 +4065,7 @@ written in Python, such as a mail server's external command delivery program.
4063
4065
setpgroup=None, resetids=False, setsid=False, setsigmask=(), \
4064
4066
setsigdef=(), scheduler=None)
4065
4067
4066
- Wraps the :c:func: `posix_spawn ` C library API for use from Python.
4068
+ Wraps the :c:func: `! posix_spawn ` C library API for use from Python.
4067
4069
4068
4070
Most users should use :func: `subprocess.run ` instead of :func: `posix_spawn `.
4069
4071
@@ -4099,44 +4101,44 @@ written in Python, such as a mail server's external command delivery program.
4099
4101
Performs ``os.dup2(fd, new_fd) ``.
4100
4102
4101
4103
These tuples correspond to the C library
4102
- :c:func: `posix_spawn_file_actions_addopen `,
4103
- :c:func: `posix_spawn_file_actions_addclose `, and
4104
- :c:func: `posix_spawn_file_actions_adddup2 ` API calls used to prepare
4105
- for the :c:func: `posix_spawn ` call itself.
4104
+ :c:func: `! posix_spawn_file_actions_addopen `,
4105
+ :c:func: `! posix_spawn_file_actions_addclose `, and
4106
+ :c:func: `! posix_spawn_file_actions_adddup2 ` API calls used to prepare
4107
+ for the :c:func: `! posix_spawn ` call itself.
4106
4108
4107
4109
The *setpgroup * argument will set the process group of the child to the value
4108
4110
specified. If the value specified is 0, the child's process group ID will be
4109
4111
made the same as its process ID. If the value of *setpgroup * is not set, the
4110
4112
child will inherit the parent's process group ID. This argument corresponds
4111
- to the C library :c:macro: `POSIX_SPAWN_SETPGROUP ` flag.
4113
+ to the C library :c:macro: `! POSIX_SPAWN_SETPGROUP ` flag.
4112
4114
4113
4115
If the *resetids * argument is ``True `` it will reset the effective UID and
4114
4116
GID of the child to the real UID and GID of the parent process. If the
4115
4117
argument is ``False ``, then the child retains the effective UID and GID of
4116
4118
the parent. In either case, if the set-user-ID and set-group-ID permission
4117
4119
bits are enabled on the executable file, their effect will override the
4118
4120
setting of the effective UID and GID. This argument corresponds to the C
4119
- library :c:macro: `POSIX_SPAWN_RESETIDS ` flag.
4121
+ library :c:macro: `! POSIX_SPAWN_RESETIDS ` flag.
4120
4122
4121
4123
If the *setsid * argument is ``True ``, it will create a new session ID
4122
- for ``posix_spawn ``. *setsid * requires :c:macro: `POSIX_SPAWN_SETSID `
4123
- or :c:macro: `POSIX_SPAWN_SETSID_NP ` flag. Otherwise, :exc: `NotImplementedError `
4124
+ for ``posix_spawn ``. *setsid * requires :c:macro: `! POSIX_SPAWN_SETSID `
4125
+ or :c:macro: `! POSIX_SPAWN_SETSID_NP ` flag. Otherwise, :exc: `NotImplementedError `
4124
4126
is raised.
4125
4127
4126
4128
The *setsigmask * argument will set the signal mask to the signal set
4127
4129
specified. If the parameter is not used, then the child inherits the
4128
4130
parent's signal mask. This argument corresponds to the C library
4129
- :c:macro: `POSIX_SPAWN_SETSIGMASK ` flag.
4131
+ :c:macro: `! POSIX_SPAWN_SETSIGMASK ` flag.
4130
4132
4131
4133
The *sigdef * argument will reset the disposition of all signals in the set
4132
4134
specified. This argument corresponds to the C library
4133
- :c:macro: `POSIX_SPAWN_SETSIGDEF ` flag.
4135
+ :c:macro: `! POSIX_SPAWN_SETSIGDEF ` flag.
4134
4136
4135
4137
The *scheduler * argument must be a tuple containing the (optional) scheduler
4136
4138
policy and an instance of :class: `sched_param ` with the scheduler parameters.
4137
4139
A value of ``None `` in the place of the scheduler policy indicates that is
4138
4140
not being provided. This argument is a combination of the C library
4139
- :c:macro: `POSIX_SPAWN_SETSCHEDPARAM ` and :c:macro: `POSIX_SPAWN_SETSCHEDULER `
4141
+ :c:macro: `! POSIX_SPAWN_SETSCHEDPARAM ` and :c:macro: `! POSIX_SPAWN_SETSCHEDULER `
4140
4142
flags.
4141
4143
4142
4144
.. audit-event :: os.posix_spawn path,argv,env os.posix_spawn
@@ -4149,7 +4151,7 @@ written in Python, such as a mail server's external command delivery program.
4149
4151
setpgroup=None, resetids=False, setsid=False, setsigmask=(), \
4150
4152
setsigdef=(), scheduler=None)
4151
4153
4152
- Wraps the :c:func: `posix_spawnp ` C library API for use from Python.
4154
+ Wraps the :c:func: `! posix_spawnp ` C library API for use from Python.
4153
4155
4154
4156
Similar to :func: `posix_spawn ` except that the system searches
4155
4157
for the *executable * file in the list of directories specified by the
@@ -4330,7 +4332,7 @@ written in Python, such as a mail server's external command delivery program.
4330
4332
4331
4333
Use *show_cmd * to override the default window style. Whether this has any
4332
4334
effect will depend on the application being launched. Values are integers as
4333
- supported by the Win32 :c:func: `ShellExecute ` function.
4335
+ supported by the Win32 :c:func: `! ShellExecute ` function.
4334
4336
4335
4337
:func: `startfile ` returns as soon as the associated application is launched.
4336
4338
There is no option to wait for the application to close, and no way to retrieve
@@ -4340,7 +4342,7 @@ written in Python, such as a mail server's external command delivery program.
4340
4342
:func: `os.path.normpath ` function to ensure that paths are properly encoded for
4341
4343
Win32.
4342
4344
4343
- To reduce interpreter startup overhead, the Win32 :c:func: `ShellExecute `
4345
+ To reduce interpreter startup overhead, the Win32 :c:func: `! ShellExecute `
4344
4346
function is not resolved until this function is first called. If the function
4345
4347
cannot be resolved, :exc: `NotImplementedError ` will be raised.
4346
4348
0 commit comments