@@ -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
@@ -564,7 +564,7 @@ process and user.
564
564
.. note ::
565
565
566
566
On some platforms, including FreeBSD and macOS, setting ``environ `` may
567
- cause memory leaks. Refer to the system documentation for :c:func: `putenv `.
567
+ cause memory leaks. Refer to the system documentation for :c:func: `! putenv `.
568
568
569
569
.. audit-event :: os.putenv key,value os.putenv
570
570
@@ -646,15 +646,15 @@ process and user.
646
646
647
647
.. function :: setpgrp()
648
648
649
- Call the system call :c:func: `setpgrp ` or ``setpgrp(0, 0) `` depending on
649
+ Call the system call :c:func: `! setpgrp ` or ``setpgrp(0, 0) `` depending on
650
650
which version is implemented (if any). See the Unix manual for the semantics.
651
651
652
652
.. availability :: Unix, not Emscripten, not WASI.
653
653
654
654
655
655
.. function :: setpgid(pid, pgrp, /)
656
656
657
- Call the system call :c:func: `setpgid ` to set the process group id of the
657
+ Call the system call :c:func: `! setpgid ` to set the process group id of the
658
658
process with id *pid * to the process group with id *pgrp *. See the Unix manual
659
659
for the semantics.
660
660
@@ -1077,7 +1077,7 @@ as internal buffering of data.
1077
1077
.. function :: fsync(fd)
1078
1078
1079
1079
Force write of file with filedescriptor *fd * to disk. On Unix, this calls the
1080
- native :c:func: `fsync ` function; on Windows, the MS :c:func: `_commit ` function.
1080
+ native :c:func: `! fsync ` function; on Windows, the MS :c:func: `! _commit ` function.
1081
1081
1082
1082
If you're starting with a buffered Python :term: `file object ` *f *, first do
1083
1083
``f.flush() ``, and then do ``os.fsync(f.fileno()) ``, to ensure that all internal
@@ -2304,7 +2304,7 @@ features:
2304
2304
2305
2305
.. function :: lstat(path, *, dir_fd=None)
2306
2306
2307
- Perform the equivalent of an :c:func: `lstat ` system call on the given path.
2307
+ Perform the equivalent of an :c:func: `! lstat ` system call on the given path.
2308
2308
Similar to :func: `~os.stat `, but does not follow symbolic links. Return a
2309
2309
:class: `stat_result ` object.
2310
2310
@@ -3147,14 +3147,16 @@ features:
3147
3147
3148
3148
Windows file attributes: ``dwFileAttributes `` member of the
3149
3149
``BY_HANDLE_FILE_INFORMATION `` structure returned by
3150
- :c:func: `GetFileInformationByHandle `. See the ``FILE_ATTRIBUTE_* ``
3150
+ :c:func: `!GetFileInformationByHandle `.
3151
+ See the :const: `!FILE_ATTRIBUTE_* <stat.FILE_ATTRIBUTE_ARCHIVE> `
3151
3152
constants in the :mod: `stat ` module.
3152
3153
3153
3154
.. attribute :: st_reparse_tag
3154
3155
3155
- When :attr: `st_file_attributes ` has the `` FILE_ATTRIBUTE_REPARSE_POINT ` `
3156
+ When :attr: `st_file_attributes ` has the :const: ` ~stat. FILE_ATTRIBUTE_REPARSE_POINT `
3156
3157
set, this field contains the tag identifying the type of reparse point.
3157
- See the ``IO_REPARSE_TAG_* `` constants in the :mod: `stat ` module.
3158
+ See the :const: `IO_REPARSE_TAG_* <stat.IO_REPARSE_TAG_SYMLINK> `
3159
+ constants in the :mod: `stat ` module.
3158
3160
3159
3161
The standard module :mod: `stat ` defines functions and constants that are
3160
3162
useful for extracting information from a :c:struct: `stat ` structure. (On
@@ -3212,7 +3214,7 @@ features:
3212
3214
3213
3215
.. function :: statvfs(path)
3214
3216
3215
- Perform a :c:func: `statvfs ` system call on the given path. The return value is
3217
+ Perform a :c:func: `! statvfs ` system call on the given path. The return value is
3216
3218
an object whose attributes describe the filesystem on the given path, and
3217
3219
correspond to the members of the :c:struct: `statvfs ` structure, namely:
3218
3220
:attr: `f_bsize `, :attr: `f_frsize `, :attr: `f_blocks `, :attr: `f_bfree `,
@@ -4303,7 +4305,7 @@ written in Python, such as a mail server's external command delivery program.
4303
4305
setpgroup=None, resetids=False, setsid=False, setsigmask=(), \
4304
4306
setsigdef=(), scheduler=None)
4305
4307
4306
- Wraps the :c:func: `posix_spawn ` C library API for use from Python.
4308
+ Wraps the :c:func: `! posix_spawn ` C library API for use from Python.
4307
4309
4308
4310
Most users should use :func: `subprocess.run ` instead of :func: `posix_spawn `.
4309
4311
@@ -4339,44 +4341,44 @@ written in Python, such as a mail server's external command delivery program.
4339
4341
Performs ``os.dup2(fd, new_fd) ``.
4340
4342
4341
4343
These tuples correspond to the C library
4342
- :c:func: `posix_spawn_file_actions_addopen `,
4343
- :c:func: `posix_spawn_file_actions_addclose `, and
4344
- :c:func: `posix_spawn_file_actions_adddup2 ` API calls used to prepare
4345
- for the :c:func: `posix_spawn ` call itself.
4344
+ :c:func: `! posix_spawn_file_actions_addopen `,
4345
+ :c:func: `! posix_spawn_file_actions_addclose `, and
4346
+ :c:func: `! posix_spawn_file_actions_adddup2 ` API calls used to prepare
4347
+ for the :c:func: `! posix_spawn ` call itself.
4346
4348
4347
4349
The *setpgroup * argument will set the process group of the child to the value
4348
4350
specified. If the value specified is 0, the child's process group ID will be
4349
4351
made the same as its process ID. If the value of *setpgroup * is not set, the
4350
4352
child will inherit the parent's process group ID. This argument corresponds
4351
- to the C library :c:macro: `POSIX_SPAWN_SETPGROUP ` flag.
4353
+ to the C library :c:macro: `! POSIX_SPAWN_SETPGROUP ` flag.
4352
4354
4353
4355
If the *resetids * argument is ``True `` it will reset the effective UID and
4354
4356
GID of the child to the real UID and GID of the parent process. If the
4355
4357
argument is ``False ``, then the child retains the effective UID and GID of
4356
4358
the parent. In either case, if the set-user-ID and set-group-ID permission
4357
4359
bits are enabled on the executable file, their effect will override the
4358
4360
setting of the effective UID and GID. This argument corresponds to the C
4359
- library :c:macro: `POSIX_SPAWN_RESETIDS ` flag.
4361
+ library :c:macro: `! POSIX_SPAWN_RESETIDS ` flag.
4360
4362
4361
4363
If the *setsid * argument is ``True ``, it will create a new session ID
4362
- for ``posix_spawn ``. *setsid * requires :c:macro: `POSIX_SPAWN_SETSID `
4363
- or :c:macro: `POSIX_SPAWN_SETSID_NP ` flag. Otherwise, :exc: `NotImplementedError `
4364
+ for ``posix_spawn ``. *setsid * requires :c:macro: `! POSIX_SPAWN_SETSID `
4365
+ or :c:macro: `! POSIX_SPAWN_SETSID_NP ` flag. Otherwise, :exc: `NotImplementedError `
4364
4366
is raised.
4365
4367
4366
4368
The *setsigmask * argument will set the signal mask to the signal set
4367
4369
specified. If the parameter is not used, then the child inherits the
4368
4370
parent's signal mask. This argument corresponds to the C library
4369
- :c:macro: `POSIX_SPAWN_SETSIGMASK ` flag.
4371
+ :c:macro: `! POSIX_SPAWN_SETSIGMASK ` flag.
4370
4372
4371
4373
The *sigdef * argument will reset the disposition of all signals in the set
4372
4374
specified. This argument corresponds to the C library
4373
- :c:macro: `POSIX_SPAWN_SETSIGDEF ` flag.
4375
+ :c:macro: `! POSIX_SPAWN_SETSIGDEF ` flag.
4374
4376
4375
4377
The *scheduler * argument must be a tuple containing the (optional) scheduler
4376
4378
policy and an instance of :class: `sched_param ` with the scheduler parameters.
4377
4379
A value of ``None `` in the place of the scheduler policy indicates that is
4378
4380
not being provided. This argument is a combination of the C library
4379
- :c:macro: `POSIX_SPAWN_SETSCHEDPARAM ` and :c:macro: `POSIX_SPAWN_SETSCHEDULER `
4381
+ :c:macro: `! POSIX_SPAWN_SETSCHEDPARAM ` and :c:macro: `! POSIX_SPAWN_SETSCHEDULER `
4380
4382
flags.
4381
4383
4382
4384
.. audit-event :: os.posix_spawn path,argv,env os.posix_spawn
@@ -4389,7 +4391,7 @@ written in Python, such as a mail server's external command delivery program.
4389
4391
setpgroup=None, resetids=False, setsid=False, setsigmask=(), \
4390
4392
setsigdef=(), scheduler=None)
4391
4393
4392
- Wraps the :c:func: `posix_spawnp ` C library API for use from Python.
4394
+ Wraps the :c:func: `! posix_spawnp ` C library API for use from Python.
4393
4395
4394
4396
Similar to :func: `posix_spawn ` except that the system searches
4395
4397
for the *executable * file in the list of directories specified by the
@@ -4570,7 +4572,7 @@ written in Python, such as a mail server's external command delivery program.
4570
4572
4571
4573
Use *show_cmd * to override the default window style. Whether this has any
4572
4574
effect will depend on the application being launched. Values are integers as
4573
- supported by the Win32 :c:func: `ShellExecute ` function.
4575
+ supported by the Win32 :c:func: `! ShellExecute ` function.
4574
4576
4575
4577
:func: `startfile ` returns as soon as the associated application is launched.
4576
4578
There is no option to wait for the application to close, and no way to retrieve
@@ -4580,7 +4582,7 @@ written in Python, such as a mail server's external command delivery program.
4580
4582
:func: `os.path.normpath ` function to ensure that paths are properly encoded for
4581
4583
Win32.
4582
4584
4583
- To reduce interpreter startup overhead, the Win32 :c:func: `ShellExecute `
4585
+ To reduce interpreter startup overhead, the Win32 :c:func: `! ShellExecute `
4584
4586
function is not resolved until this function is first called. If the function
4585
4587
cannot be resolved, :exc: `NotImplementedError ` will be raised.
4586
4588
0 commit comments