Mateusz
0023f51deb
gh-98240: Updated Path.rename docs, when it is atomic (GH-98245)
2022-10-28 16:31:37 -07:00
domragusa
e089f23bbb
gh-84538: add strict argument to pathlib.PurePath.relative_to (GH-19813)
...
By default, :meth:`pathlib.PurePath.relative_to` doesn't deal with paths that are not a direct prefix of the other, raising an exception in that instance. This change adds a *walk_up* parameter that can be set to allow for using ``..`` to calculate the relative path.
example:
```
>>> p = PurePosixPath('/etc/passwd')
>>> p.relative_to('/etc')
PurePosixPath('passwd')
>>> p.relative_to('/usr')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "pathlib.py", line 940, in relative_to
raise ValueError(error_message.format(str(self), str(formatted)))
ValueError: '/etc/passwd' does not start with '/usr'
>>> p.relative_to('/usr', strict=False)
PurePosixPath('../etc/passwd')
```
https://bugs.python.org/issue40358
Automerge-Triggered-By: GH:brettcannon
2022-10-28 16:20:14 -07:00
cburroughs
72fa57a8fe
Fix typo in contextvars docs ( #98823 )
2022-10-28 22:13:48 +01:00
Skip Montanaro
b27b57c6e4
argparse
docs: normalize constant references (#98765 )
2022-10-28 13:15:39 +01:00
Nikita Sobolev
c144e57b31
gh-98657: [docs] array.typecodes
is a module-level attribute ( #98729 )
...
* gh-98657: [docs] `array.typecodes` is a module-level attribute
* Update array.rst
2022-10-28 12:26:01 +02:00
Stanley
8cd21c2c5d
gh-65002: Make note that null bytes are used to pad bytes ( #98635 )
2022-10-28 12:21:28 +02:00
Erlend E. Aasland
723ebe76e7
gh-96143: Improve perf profiler docs ( #96445 )
2022-10-27 14:06:48 +01:00
Mark Shannon
22863df7ca
GH-96793: Change FOR_ITER
to not pop the iterator on exhaustion. (GH-96801)
...
Change FOR_ITER to have the same stack effect regardless of whether it branches or not.
Performance is unchanged as FOR_ITER (and specialized forms jump over the cleanup code).
2022-10-27 11:55:03 +01:00
Erlend E. Aasland
365852a03a
gh-98716: Revert gh-96081: Escape lone stars in sqlite3 docs ( #98720 )
2022-10-26 16:53:46 +02:00
Philipp A
5e74bad93c
gh-98644: point people to tomllib from configparser’s docs ( #98645 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-26 07:06:20 -07:00
fancidev
216f45e4fe
gh-98348: Mention ReferenceError in weakref.proxy documentation ( #98355 )
2022-10-25 20:48:24 -07:00
Stanley
268129a74f
docs: Change links to label refs ( #98454 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-25 20:26:28 -07:00
Stanley
0ca6a4d640
gh-77753: Add example for values that compare equal in stdtypes ( #98497 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-25 19:54:27 -07:00
Stanley
4196ee5c8b
gh-84747: Add async for
comment for StreamReader ( #98633 )
2022-10-25 19:16:18 -07:00
Jelle Zijlstra
5d8bf2b106
gh-97937: dis docs: add adaptive=False ( #97939 )
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Brandt Bucher <brandtbucher@gmail.com>
2022-10-25 15:58:04 -07:00
Eclips4
be0cf82ae4
gh-98602: [typing docs] Use quotes for forward reference in TypeVarTuple example ( #98605 )
2022-10-25 16:32:52 +01:00
Nikita Sobolev
5076108872
gh-98623: Fix base classes in typing.rst
( #98626 )
2022-10-25 07:06:13 -07:00
Nikita Sobolev
e3b9dd8e87
gh-98507: [typing docs] Rephrase "now supports []
" to "now supports subscripting" ( #98508 )
2022-10-24 19:10:25 +01:00
Kumar Aditya
2fdcc6f2cb
GH-91635: clarify docs about closing of transport in asyncio ( #98563 )
2022-10-24 10:52:02 -07:00
Nikita Sobolev
1a217f9ffc
gh-98500: Fix typing docs for *View
classes ( #98511 )
2022-10-24 10:47:32 -07:00
Omkaar
b6d5d5b60a
gh-98561: Fix a typo in typing (GH-98562)
2022-10-23 22:05:08 +08:00
C.A.M. Gerlach
8f30267ab4
gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section ( #98304 )
2022-10-22 20:12:04 +01:00
Clément Robert
327fc1c6fa
[Enum docs]: fix order of arguments to isinstance() ( #98542 )
2022-10-22 12:29:00 +01:00
Stanley
d9407b174c
gh-51511: Note that codecs.open()'s encoding parameter affects automatic conversion to binary mode ( #94370 )
2022-10-21 16:01:05 -07:00
Ethan Furman
3e95ffc7ae
gh-98298: [Enum] document ReprEnum, global_enum, and show_flag_values (GH-98455)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-21 15:36:41 -07:00
Noam Cohen
a371a7e03e
gh-95023: Added os.setns and os.unshare functions ( #95046 )
...
Added os.setns and os.unshare to easily switch between namespaces
on Linux.
Co-authored-by: Christian Heimes <christian@python.org>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Victor Stinner <vstinner@python.org>
2022-10-20 11:08:54 +02:00
Phil Elson
1a6bacb31f
[doc] Refresh the venv introduction documentation, and correct the statement about VIRTUAL_ENV (GH-98350)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-19 15:49:34 +01:00
Raymond Hettinger
a53f637368
Fix markup indentation (GH-98424)
...
Fix markup
2022-10-18 20:14:41 -05:00
Raymond Hettinger
f4ead4874b
General improvements to the itertools docs (GH-98408)
2022-10-18 14:09:34 -05:00
Julien Palard
2eb503e4dd
Doc: Found some remaining default roles. (GH-98392)
2022-10-18 15:46:18 +02:00
Julien Palard
0bbea545e3
Doc: missing underscore in hyperlink. (GH-98391)
2022-10-18 15:28:19 +02:00
Raymond Hettinger
de3ece769a
GH-98363: Add itertools.batched() (GH-98364)
2022-10-17 18:53:45 -05:00
Raymond Hettinger
70732d8a4c
Move random selection recipes from itertools.rst to random.rst (GH-98369)
2022-10-17 17:30:49 -05:00
Victor Stinner
1863302d61
gh-97669: Create Tools/build/ directory ( #97963 )
...
Create Tools/build/ directory. Move the following scripts from
Tools/scripts/ to Tools/build/:
* check_extension_modules.py
* deepfreeze.py
* freeze_modules.py
* generate_global_objects.py
* generate_levenshtein_examples.py
* generate_opcode_h.py
* generate_re_casefix.py
* generate_sre_constants.py
* generate_stdlib_module_names.py
* generate_token.py
* parse_html5_entities.py
* smelly.py
* stable_abi.py
* umarshal.py
* update_file.py
* verify_ensurepip_wheels.py
Update references to these scripts.
2022-10-17 12:01:00 +02:00
Joannah Nanjekye
5c9302d03a
gh-85525: Remove extra row in doc ( #98337 )
...
* remove extra row
* 📜 🤖 Added by blurb_it.
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
2022-10-16 13:43:31 -04:00
Stanley
79fd6ccdbe
gh-85299: Add note warning about entry point guard for asyncio example ( #93457 )
2022-10-16 10:04:43 -07:00
Vinay Sajip
f6b1e4048d
gh-98307: Add docstring and documentation for SysLogHandler.createSocket (GH-98319)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-16 09:15:46 +01:00
Kumar Aditya
660f10248b
GH-94597: Deprecate child watcher getters and setters ( #98215 )
...
This is the next step for deprecating child watchers.
Until we've removed the API completely we have to use it, so this PR is mostly suppressing a lot of warnings when using the API internally.
Once the child watcher API is totally removed, the two child watcher implementations we actually use and need (Pidfd and Thread) will be turned into internal helpers.
2022-10-15 16:09:30 -07:00
Raymond Hettinger
3a639bbeac
Improve speed. Reduce auxiliary memory to 16.6% of the main array. (GH-98294)
2022-10-15 16:05:28 -05:00
Simon Legner
02389658a4
docs(typing): harmonize "See PEP x for more details" ( #97927 )
2022-10-15 12:17:51 -07:00
Raymond Hettinger
f4370318d6
Faster sieve() recipe ( #98287 )
2022-10-15 12:43:58 -05:00
Joannah Nanjekye
bf786e6901
gh-85455: Add missing doc strings and improve docs ( #21573 )
...
* Add missing doc strings and improve docs
* Use imperative form
* Modify docstring wording
2022-10-15 09:31:06 -04:00
Joannah Nanjekye
05c042e707
gh-85525: Indicate supported sound header formats ( #21575 )
...
* Indicate supported sound header formats
* modify file names
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-15 09:30:05 -04:00
Julien Palard
3c4cbd177f
gh-91485: Doc: Using Python syntax to document builtin Python functions. (GH-96579)
2022-10-15 12:19:35 +02:00
Shantanu
c39a0c3354
gh-65046: Link to logging cookbook from asyncio docs ( #98207 )
2022-10-11 21:42:57 -07:00
Stanley
3b33c2010a
Formatting fixes in contextlib docs ( #98111 )
2022-10-11 20:56:32 -07:00
Shantanu
ed6344eed0
gh-96130: Rephrase use of "typecheck" verb for clarity ( #98144 )
...
I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
2022-10-11 19:37:58 -07:00
Stanley
f0a680007f
gh-71616: Add note to warn against general translation of saxutils.escape() ( #93450 )
...
* Add note to warn against general translation of saxutils.escape()
* Use more direct wording
2022-10-11 05:27:49 -04:00
Vinay Sajip
6a757da080
gh-88452: Add a warning about non-portability of environments. (GH-98155)
2022-10-10 19:27:52 +01:00
Stanley
187e853690
gh-83940: os docs: Improve wording for getenv/getenvb ( #98113 )
2022-10-10 06:43:01 -07:00