summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* bpo-34576: Revert doc change until it can be properly fixed (GH-9720)Ned Deily2018-10-201-8/+0
| | | | This reverts commit 3baee3b39765f5e8ec616b2b71b731b140486394.
* [3.6] bpo-33729: Fix issues with arguments parsing in hashlib. (GH-8346) ↵Serhiy Storchaka2018-10-111-13/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | (GH-8581) (GH-9657) * help(hashlib) didn't work because of incorrect module name in blake2b and blake2s classes. * Constructors blake2*(), sha3_*(), shake_*() and keccak_*() incorrectly accepted keyword argument "string" for binary data, but documented as accepting the "data" keyword argument. Now this parameter is positional-only. * Keyword-only parameters in blake2b() and blake2s() were not documented as keyword-only. * Default value for some parameters of blake2b() and blake2s() was None, which is not acceptable value. * The length argument for shake_*.digest() was wrapped out to 32 bits. * The argument for shake_128.digest() and shake_128.hexdigest() was not positional-only as intended. * TypeError messages for incorrect arguments in all constructors sha3_*(), shake_*() and keccak_*() incorrectly referred to sha3_224. Also made the following enhancements: * More accurately specified input and result types for strings, bytes and bytes-like objects. * Unified positional parameter names for update() and constructors. * Improved formatting. (cherry picked from commit f1d36d8efaecd5c84cb35e35119b283f37d83c40) (cherry picked from commit 47957dab94a4efa2fee61c9a8193f78300950769)
* bpo-34576 warn users on security for http.server (GH-9720)Miss Islington (bot)2018-10-111-0/+8
| | | | | | | It was proposed to add an warning for http.server regarding security issues. The wording was provided at bpo-26005 by @orsenthil (cherry picked from commit 1d26c72e6a9c5b28b27c158f2f196217707dbb0f) Co-authored-by: Felipe Rodrigues <felipe@felipevr.com>
* [3.6] bpo-34906: Doc: Fix typos (2) (GH-9735)Stéphane Wirtel2018-10-102-3/+3
| | | (cherry picked from commit 683281f536981da395575b5a07d6761118259fd2)
* bpo-32174: Let .chm document display non-ASCII characters properly (GH-9758)Miss Islington (bot)2018-10-082-1/+40
| | | | | | | | Let .chm document display non-ASCII characters properly Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual effect on some MBCS Windows systems. (cherry picked from commit 6261ae9b01fb8429b779169f8de37ff567c144e8) Co-authored-by: animalize <animalize@users.noreply.github.com>
* Make it clear that the msg argument to ↵Miss Islington (bot)2018-10-031-3/+3
| | | | | | | | assertWarns/assertWarnsRegex/assertRaisesRegex is keyword-only. (GH-9680) A follow up to be4e5b89204283a62e369439025f00362d0424f6. (cherry picked from commit e006b39a40e0cd6a90c68f1107853ea2ed0ed54d) Co-authored-by: Benjamin Peterson <benjamin@python.org>
* Make it clear that the msg argument to assertRaises is keyword-only. (GH-9670)Miss Islington (bot)2018-10-021-1/+1
| | | | | (cherry picked from commit be4e5b89204283a62e369439025f00362d0424f6) Co-authored-by: Benjamin Peterson <benjamin@python.org>
* bpo-31865: Fix a couple of typos in the html.unescape() docs. (GH-9664)Miss Islington (bot)2018-10-021-1/+1
| | | | | (cherry picked from commit 30534cc7172f36092e0002bb7df482edc0d539ce) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* bpo-27351: Fix ConfigParser.read() documentation and docstring (GH-8123)Miss Islington (bot)2018-09-291-5/+6
| | | | | | Switch "list" with "iterable" to match with the implementation. (cherry picked from commit e45473e3ca31e5b78dc85cab575f5bb60d5b7f8f) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* Clarify that Type[SomeTypeVar] is legal (GH-9585)Miss Islington (bot)2018-09-261-3/+6
| | | | | | | | | Currently, the docs state that when doing `Type[X]`, X is only allowed to be a class, a union of classes, and Any. This pull request amends that sentence to clarify X may also be a typevar (or a union involving classes, Any, and TypeVars). (cherry picked from commit 130717fe58abb2ab9e7938207df0c130a2562747) Co-authored-by: Michael Lee <michael.lee.0x2a@gmail.com>
* bpo-1529353: IDLE: Squeezer What's New for 3.6.7 (GH-9567)Miss Islington (bot)2018-09-251-2/+11
| | | | | (cherry picked from commit dac712d51667227ce3862fc61be6a8094b1066fa) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.6] bpo-17239: Disable external entities in SAX parser (GH-9217) (GH-9512)Christian Heimes2018-09-244-3/+43
| | | | | | | | | | | | | | | | | The SAX parser no longer processes general external entities by default to increase security. Before, the parser created network connections to fetch remote files or loaded local files from the file system for DTD and entities. Signed-off-by: Christian Heimes <christian@python.org> https://bugs.python.org/issue17239. (cherry picked from commit 17b1d5d4e36aa57a9b25a0e694affbd1ee637e45) Co-authored-by: Christian Heimes <christian@python.org> https://bugs.python.org/issue17239
* [3.6] bpo-34670: Add TLS 1.3 post handshake auth (GH-9460) (GH-9507)Christian Heimes2018-09-232-0/+46
| | | | | | | | | | | | | | | | Add SSLContext.post_handshake_auth and SSLSocket.verify_client_post_handshake for TLS 1.3 post-handshake authentication. Signed-off-by: Christian Heimes <christian@python.org>q https://bugs.python.org/issue34670. (cherry picked from commit 9fb051f032c36b9f6086b79086b4d6b7755a3d70) Co-authored-by: Christian Heimes <christian@python.org> https://bugs.python.org/issue34670
* Make docs of exitcode for subprocess.getstatusoutput more clear. (GH-9477)Miss Islington (bot)2018-09-211-2/+3
| | | | | | Make it more accurate and not limited to UNIX. (cherry picked from commit 7d161726e4ddd2b2cdd7ac58a7e9e9ea3f57a807) Co-authored-by: Xiang Zhang <angwerzx@126.com>
* bpo-33216: Improve the documentation for CALL_FUNCTION_* (GH-8338) (GH-8784)Miss Islington (bot)2018-09-171-26/+34
| | | | | (cherry picked from commit 5e99b56d6b249995a4fa2bc09c0bb03841f49572) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* closes bpo-34004: Skip lock interruption tests on musl. (GH-9224)Miss Islington (bot)2018-09-121-1/+2
| | | | | | | | | | | | | | Returning EINTR from pthread semaphore or lock acquisition is an optional POSIX feature. musl does not provide this feature, so some threadsignal tests fail when Python is built against it. There's no good way to test for musl, so we skip if we're on Linux and not using glibc pthreads. Also, hedge in the threading documentation about when we can provide interrupts from lock acquisition. (cherry picked from commit 5b10d5111d7a855297654af9045f8907b7d3dd08) Co-authored-by: Benjamin Peterson <benjamin@python.org>
* [3.6] closes bpo-25041: Document AF_PACKET socket address format. (GH-9209)Benjamin Peterson2018-09-121-14/+40
| | | | | (cherry picked from commit 731ff68eeef58babdf2b32dc9a73b141760c2be9) Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
* bpo-34365: Update date object documentation (GH-8814)Miss Islington (bot)2018-09-111-4/+3
| | | | | | | | | | Python 3.x does not fall back to comparing object addresses when comparing two `dt` objects. <!-- issue-number: [bpo-34365](https://www.bugs.python.org/issue34365) --> https://bugs.python.org/issue34365 <!-- /issue-number --> (cherry picked from commit 9c223794c754408644c16349b85dd27fdba8a926) Co-authored-by: Danish Prakash <grafitykoncept@gmail.com>
* bpo-34613: document the correct value of limit argument of ↵Miss Islington (bot)2018-09-111-1/+3
| | | | | | | | | | | | asyncio.StreamReader (GH-9121) The default value of asyncio.StreamReader *limit* is `_DEFAULT_LIMIT` instead of `None`. <!-- issue-number: [bpo-34613](https://www.bugs.python.org/issue34613) --> https://bugs.python.org/issue34613 <!-- /issue-number --> (cherry picked from commit b4ec36200a959da70eba94c19826446a8efdffdd) Co-authored-by: Bram <cortex@worlddomination.be>
* bpo-28617 Fixed docs inaccuracies about the types that support membership ↵Miss Islington (bot)2018-09-111-2/+2
| | | | | | | | | | tests (GH-9086) <!-- issue-number: [bpo-28617](https://www.bugs.python.org/issue28617) --> https://bugs.python.org/issue28617 <!-- /issue-number --> (cherry picked from commit 08bcf647d8a92e4bd47531588b284c6820b7a7ef) Co-authored-by: wim glenn <wim.glenn@gmail.com>
* Fix missing line from example shell session (GH-9143) (GH-9156)Miss Islington (bot)2018-09-111-0/+1
| | | | | (cherry picked from commit 2064bb6d576ff7016d59318038779f428b0f0f3f) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* closes bpo-34525: Fix smtplib's authobject() documentation (GH-8965)Miss Islington (bot)2018-09-101-2/+2
| | | | | (cherry picked from commit 78deb7f33227972987722bc3fed5bcb45fae869e) Co-authored-by: Sebastian Rittau <srittau@rittau.org>
* Revert "Fix misindented yaml in logging how to example (GH-8604)" (GH-9081)Miss Islington (bot)2018-09-101-3/+3
| | | | | | This reverts commit 10b59f1b019cd00c940dd7f4a74c4f667a20f25f. (cherry picked from commit 290a60bd8af7b1d7e7931aa4dd4eace60d355d76) Co-authored-by: Rémy HUBSCHER <hubscher.remy@gmail.com>
* [3.6] bpo-34246: Use no mutable default args in smtplib (GH-8554) (#9112)Pablo Galindo2018-09-081-2/+2
| | | | | | | | Some methods of the SMTP class use mutable default arguments. Specially `send_message` is affected as it mutates one of the args by appending items to it, which has side effects on further calls.. (cherry picked from commit d5fbe9b1a3d65ceeb9159c5ba999ee966a945f76) Co-authored-by: Pablo Aguiar <scorphus@gmail.com>
* Fix struct sequence glossary entry grammar (GH-9030)Miss Islington (bot)2018-09-021-1/+1
| | | | | | | | ... by removing a superfluous "either". Reported by Никита Люшненко on docs@. (cherry picked from commit 98b976a2f82ba5f50cf6846338f644ca6c64f47d) Co-authored-by: Zachary Ware <zachary.ware@gmail.com>
* Fix markup in stdtypes documentation (GH-8905)Miss Islington (bot)2018-08-251-5/+5
| | | | | (cherry picked from commit 2e5d2ea2089e111fb8e5b8c5916242da2906c399) Co-authored-by: Andrés Delfino <adelfino@gmail.com>
* Make it more clear that setUpClass runs before each class, not "class run" ↵Miss Islington (bot)2018-08-251-1/+1
| | | | | | | (GH-8844) (cherry picked from commit c33bb5d4016fb2fc8f3b6d4b0c14b73b33cdb3cf) Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
* bpo-22057: Clarify eval() documentation (GH-8812)Miss Islington (bot)2018-08-191-2/+4
| | | | | | | | | | | | | | If a globals dictionary without a '__builtins__' key is passed to eval(), a '__builtins__' key will be inserted to the dictionary: >>> eval("print('__builtins__' in globals())", {}) True (As a result of this behavior, we can use the builtins print() and globals() even if we passed a dictionary without a '__builtins__' key to eval().) (cherry picked from commit 225b05548027d55aafb11b65f6a4a2bef2f5196f) Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
* bpo-34432: doc Mention complex and decimal.Decimal on str.format not about ↵Miss Islington (bot)2018-08-181-7/+8
| | | | | | | locales (GH-8808) (GH-8810) (cherry picked from commit 93b5655c040a33f9ba4cdbd303afc8398c8413c7) Co-authored-by: Andrés Delfino <adelfino@gmail.com>
* bpo-34418: Fix HTTPErrorProcessor documentation (GH-8793)Miss Islington (bot)2018-08-171-2/+2
| | | | | | | The http_response() and https_response() methods of the HTTPErrorProcessor class have two required parameters, 'request' and 'response'. (cherry picked from commit c53aaec793e018edef4e72a3edbd338b10db10aa) Co-authored-by: Sebastian Rittau <srittau@rittau.org>
* bpo-33570: TLS 1.3 ciphers for OpenSSL 1.1.1 (GH-6976) (GH-8760)Christian Heimes2018-08-151-5/+3
| | | | | | | | | Change TLS 1.3 cipher suite settings for compatibility with OpenSSL 1.1.1-pre6 and newer. OpenSSL 1.1.1 will have TLS 1.3 cipers enabled by default. Also update multissltests to test with latest OpenSSL. Signed-off-by: Christian Heimes <christian@python.org>
* bpo-32947: Fixes for TLS 1.3 and OpenSSL 1.1.1 (GH-8761)Christian Heimes2018-08-141-0/+9
| | | | | | | | | | | | | | Backport of TLS 1.3 related fixes from 3.7. Misc fixes and workarounds for compatibility with OpenSSL 1.1.1 from git master and TLS 1.3 support. With OpenSSL 1.1.1, Python negotiates TLS 1.3 by default. Some test cases only apply to TLS 1.2. OpenSSL 1.1.1 has added a new option OP_ENABLE_MIDDLEBOX_COMPAT for TLS 1.3. The feature is enabled by default for maximum compatibility with broken middle boxes. Users should be able to disable the hack and CPython's test suite needs it to verify default options Signed-off-by: Christian Heimes <christian@python.org>
* smtplib documentation fixes (GH-8708)Miss Islington (bot)2018-08-131-4/+11
| | | | | | | | | | * SMTP.startssl: Fix doc on keyfile and certfile use * SMTP.startssl: Add missing keyfile and certfile deprecation notice * SMTP: Doc grammar fixes (cherry picked from commit da12063f2f53b7d272824863ed24260cefb22e8c) Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
* Fix misindented yaml in logging how to example (GH-8604)Miss Islington (bot)2018-08-131-3/+3
| | | | | (cherry picked from commit 10b59f1b019cd00c940dd7f4a74c4f667a20f25f) Co-authored-by: Rémy HUBSCHER <hubscher.remy@gmail.com>
* Fix the versionadded indentation in exec_module doc (GH-8719)Miss Islington (bot)2018-08-121-1/+1
| | | | | (cherry picked from commit 65b5ef02ec1f44e3a19b689a1ecf73d01c82161b) Co-authored-by: Andrés Delfino <adelfino@gmail.com>
* bpo-34379: Doc: Move note for json.dump (GH-8730)Miss Islington (bot)2018-08-111-6/+5
| | | | | (cherry picked from commit 9e840848510d20e644a19c723b803877377d3765) Co-authored-by: Evan Allrich <eallrich@gmail.com>
* Improve grammar of asynchronous iterator glossary entry (GH-8657)Miss Islington (bot)2018-08-091-3/+3
| | | | | (cherry picked from commit cf2c5e8e2867e41d34079b2e464bbbe653fb7981) Co-authored-by: Andrés Delfino <adelfino@gmail.com>
* bpo-34324: Doc README wrong directory name for venv (GH-8650)Miss Islington (bot)2018-08-091-1/+1
| | | | | | | | In the documentation, the `env` directory is specified when we execute the `make venv` command. But in the code, `make venv` will create the virtualenv inside the `venv` directory (defined by `VENVDIR`) (cherry picked from commit 599bfa18f8ebcb23af300b6855934048c3c64e7d) Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
* Make code examples in Functional Programming HOWTO to be PEP 8 compliant. ↵Miss Islington (bot)2018-08-071-23/+23
| | | | | | | (GH-8646) (cherry picked from commit db8707c8ab57d9454c838586c08199c82a3d74d9) Co-authored-by: Sergey Fedoseev <fedoseev.sergey@gmail.com>
* bpo-34319: Clarify file handler closure in pathlib.read_text (GH-8645)Miss Islington (bot)2018-08-061-1/+2
| | | | | | Patch by Terry Jan Reedy. (cherry picked from commit 5b2657fb8c5aaa98e5748e1c325c74b97ea12fd1) Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
* bpo-34273: Change 'Fixed point' to 'Fixed-point notation'. (GH-8673)Miss Islington (bot)2018-08-061-4/+4
| | | | | | | | | | | | | | | | | * bpo-34273: Change 'Fixed point' to 'Fixed-point notation'. The change in the mini language floating point and decimal table is consistent with 'Exponential notation' and clarifies that we are referring to the output notation, not an object type. * Update string.rst * Update string.rst * Update string.rst * Update string.rst (cherry picked from commit 28c7f8c8ce34a0cb848822a252a9d0a761fb42d5) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-34336: Don't promote possibility to leave out typing.Optional (GH-8677)Miss Islington (bot)2018-08-051-4/+12
| | | | | (cherry picked from commit 336c945858055059a65134d4c501a85037d70d99) Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
* Fix reST markup in unittest documentation (GH-8665)Miss Islington (bot)2018-08-031-1/+1
| | | | | (cherry picked from commit 2e5566d9e774dcde81e8139b486730917816e045) Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
* bpo-34329: Doc'd how to remove suffix of pathlib.Path() (GH-8655)Miss Islington (bot)2018-08-031-1/+5
| | | | | (cherry picked from commit 46dc4e34ed8005a688d7f3512844ef227a3465f4) Co-authored-by: Stefan Otte <stefan.otte@gmail.com>
* Improve the grammar in `range` documentation. (GH-8628)Miss Islington (bot)2018-08-031-1/+1
| | | | | | Remove unnecessary "that" in the sentence. (cherry picked from commit b6efc2cf9701adfb901eec2fe6a418893739877a) Co-authored-by: Andrés Delfino <adelfino@gmail.com>
* bpo-27910: Update documentation of traceback module (GH-6116)Miss Islington (bot)2018-08-021-17/+19
| | | | | | | | | | | | In the documentation for the traceback module, the definitions of functions extract_tb(), format_list() and classmethod StackSummary.from_list() mention the old style 4-tuples that these functions used to return or accept. Since Python 3.5, however, they return or accept a FrameSummary object instead of a 4-tuple, or a StackSummary object instead of a list of 4-tuples. Co-authored-by: torsava <torsava@redhat.com> Co-Authored-By: Berker Peksag <berker.peksag@gmail.com> (cherry picked from commit f394ee5eaf6d6d8f45e0478e77d4dbff25c6bea7)
* bpo-27671: Update FAQ about why len is function (GH-8432)Miss Islington (bot)2018-07-311-18/+19
| | | | | (cherry picked from commit c48e26dcadbff8620bb5881d3bd148fc8894d0ef) Co-authored-by: INADA Naoki <methane@users.noreply.github.com>
* Use 'for example' instead of 'in other words' in compound statement doc ↵Miss Islington (bot)2018-07-301-1/+1
| | | | | | | (GH-8401) (cherry picked from commit 6921ef7bef4eab3819b3d0fda5fa3e3b2a8c0613) Co-authored-by: Andrés Delfino <adelfino@gmail.com>
* Fix typos & formatting in Using Python on Windows doc (GH-8559)Miss Islington (bot)2018-07-301-4/+4
| | | | | (cherry picked from commit 8e7e8bd8984068e3245d64b9a21e6840880747af) Co-authored-by: Segev Finer <segev208@gmail.com>
* bpo-8145: Improve isolation_level documentation (GH-8499)Miss Islington (bot)2018-07-291-14/+22
| | | | | | Initial patch by R. David Murray. (cherry picked from commit a71fed0b7596f1c11a2fa6c1b7311157148f5f9f) Co-authored-by: Berker Peksag <berker.peksag@gmail.com>