summaryrefslogtreecommitdiffstats
path: root/Doc/library/io.rst
Commit message (Collapse)AuthorAgeFilesLines
* docs: module page titles should not start with a link to themselves (#117099)Ned Batchelder2024-05-081-2/+2
|
* Correct description of inheriting from another class (#114660)Skip Montanaro2024-02-011-12/+12
| | | | "inherits <someclass>" grates to this reader. I think it should be "inherits from <someclass>".
* gh-110631: Fix reST indentation in `Doc/library` (#110685)Ezio Melotti2023-10-111-5/+5
| | | Fix wrong indentation in the Doc/library dir.
* gh-107801: Improve the accuracy of io.IOBase.seek docs (#108268)Erlend E. Aasland2023-08-291-12/+14
| | | | | | | - Add param docstrings - Link to os.SEEK_* constants - Mention the return value in the initial paragraph Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-107801: Document io.TextIOWrapper.tell (#108265)Erlend E. Aasland2023-08-271-1/+9
|
* gh-107801: Improve the accuracy of io.TextIOWrapper.seek docs (#107933)Erlend E. Aasland2023-08-221-0/+16
| | | | | | | Clearly document the supported seek() operations: - Rewind to the start of the stream - Restore a previous stream position (given by tell()) - Fast-forward to the end of the stream
* Docs: Fix Sphinx warnings in io.rst (#107903)Erlend E. Aasland2023-08-171-35/+36
| | | | | | - Mark up parameter and argument names properly - If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-106909: Use role :const: for referencing module constants (GH-106910)Serhiy Storchaka2023-07-211-1/+1
|
* gh-91485: Avoid unnecessary use of non-Python syntax in io docs (#101177)Shantanu2023-01-201-2/+2
|
* Docs: Fix backtick errors found by sphinx-lint (#97998)Hugo van Kemenade2022-10-071-3/+3
| | | Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* gh-95691: Doc BufferedWriter and BufferedReader (#95703)1809092022-10-051-1/+1
|
* gh-90301: Doc: Add references to PEP 686 (#96816)Inada Naoki2022-10-041-7/+9
| | | Doc: Add references to PEP 686.
* GH-95880: Clarify StringIO append/overwrite behavior. (GH-96104)Raymond Hettinger2022-08-211-2/+6
|
* gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)Adam Turner2022-06-211-1/+1
| | | | | | | | | * Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)" This reverts commit 5c1f15b4b1024cbf0acc85832f0c623d1a4605fd * Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)" This reverts commit b63a620014b67a6e63d10783149c41baaf59def8.
* gh-91952: Make TextIOWrapper.reconfigure() supports "locale" encoding (GH-91982)Inada Naoki2022-05-011-0/+3
|
* gh-85864: io docs: Add missing position-only parameters (#91950)slateny2022-04-301-17/+17
|
* gh-85864: Mark positional-only args in io docs (#91683)slateny2022-04-231-10/+10
|
* gh-91156: Fix `encoding="locale"` in UTF-8 mode (GH-70056)Inada Naoki2022-04-141-3/+2
|
* bpo-47000: Make `io.text_encoding()` respects UTF-8 mode (GH-32003)Inada Naoki2022-04-041-3/+8
| | | Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
* bpo-25415: Remove confusing sentence from IOBase docstrings (PR-31631)slateny2022-03-041-7/+4
|
* Fix typo in io.rst (GH-30218)David Gilbertson2021-12-261-1/+1
|
* bpo-43126: Expand docs on io.IOBase.readlines() method (#27061)andrei kulakov2021-07-131-0/+3
| | | Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* bpo-43510: Implement PEP 597 opt-in EncodingWarning. (GH-19481)Inada Naoki2021-03-291-0/+81
| | | | | | | | | | | See [PEP 597](https://www.python.org/dev/peps/pep-0597/). * Add `-X warn_default_encoding` and `PYTHONWARNDEFAULTENCODING`. * Add EncodingWarning * Add io.text_encoding() * open(), TextIOWrapper() emits EncodingWarning when encoding is omitted and warn_default_encoding is enabled. * _pyio.TextIOWrapper() uses UTF-8 as fallback default encoding used when failed to import locale module. (used during building Python) * bz2, configparser, gzip, lzma, pathlib, tempfile modules use io.text_encoding(). * What's new entry
* Doc: io: Remove "In-memory streams" section (GH-24927)Inada Naoki2021-03-251-10/+0
|
* bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)Julien Palard2021-01-251-1/+1
|
* [doc] Fix erroneous backslashes in signatures and names (GH-23658)Andre Delfino2020-12-171-1/+1
| | | | | The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch). The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.
* bpo-39691: Clarify io.open_code behavior (GH-19824)Shantanu2020-05-011-4/+5
|
* Improve the io module documentation (GH-15099)Géry Ogam2019-09-111-55/+61
| | | | | | | | | | * Update io.rst * Apply suggestions from code review Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com> Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>
* Document default parameter of .seek() in the signature. (GH-14691)Benjamin Peterson2019-07-111-2/+2
|
* bpo-37390: Add audit event table to documentations (GH-14406)Steve Dower2019-06-271-1/+1
| | | Also updates some (unreleased) event names to be consistent with the others.
* bpo-37363: Add audit events for a range of modules (GH-14301)Steve Dower2019-06-241-1/+1
|
* Add missing single quote in io.TextIOWrapper.reconfigure documentation ↵Harmon2019-06-191-1/+1
| | | | | (GH-14246) Add a missing single quote character in the documentation for `io.TextIOWrapper.reconfigure`.
* bpo-36842: Implement PEP 578 (GH-12613)Steve Dower2019-05-231-0/+21
| | | Adds sys.audit, sys.addaudithook, io.open_code, and associated C APIs.
* Indicate that seek and tell are mandatory on BufferedRandom. (GH-11216)Christopher Head2019-04-121-3/+3
| | | | | | | For BufferedReader and BufferedWriter, seek and tell operations are optional (they may or may not exist based on the underlying stream). For BufferedRandom, they are mandatory: a BufferedRandom should not be constructed over an unseekable underlying stream. Document this.
* closes bpo-35848: Move all documentation regarding the readinto out of ↵Steve Palmer2019-04-091-8/+6
| | | | | | | IOBase. (GH-11893) Move all documentation regarding the readinto method into either io.RawIOBase or io.BufferedIOBase. Corresponding changes to documentation in the _pyio.py module.
* bpo-36006: Fix versionchanged directive alignment in io module documentation ↵Emmanuel Arias2019-02-151-2/+2
| | | | | (GH-11881) https://bugs.python.org/issue36006
* bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)Serhiy Storchaka2018-12-191-1/+1
|
* Minor grammar improvement to io documentation. (GH-10329)Srinivas Thatiparthy (శ్రీనివాస్ తాటిపర్తి)2018-11-121-1/+1
| | | Independently of -> Independent of
* bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)Stéphane Wirtel2018-10-261-1/+1
|
* bpo-33804: Document that the argument for io.TextIOBase.read() is optional ↵Andrés Delfino2018-07-071-1/+1
| | | | (GH-7510)
* bpo-22069: Update TextIO documentation (GH-6609)Elena Oat2018-05-141-1/+1
| | | Clarify that flush is implied when the call to write contains a newline character.
* bpo-15216: io: TextIOWrapper.reconfigure() accepts encoding, errors and ↵INADA Naoki2017-12-211-5/+13
| | | | newline (GH-2343)
* bpo-22671: Clarify and test default read method implementations (#4568)Sanyam Khurana2017-12-111-5/+8
| | | Original patch written by Martin Panter, enhanced by Sanyam Khurana.
* Fix bpo-30526: Add TextIOWrapper.reconfigure() and a ↵Antoine Pitrou2017-06-031-0/+18
| | | | | | | | | | TextIOWrapper.write_through attribute (#1922) * Fix bpo-30526: Add TextIOWrapper.reconfigure() * Apply Nick's improved wording * Update Misc/NEWS
* Issue #23214: Fix formatting of -1Martin Panter2016-10-211-1/+1
|
* Issue #23214: Implement optional BufferedReader, BytesIO read1() argumentMartin Panter2016-10-201-6/+15
|
* Issue #19795: Improved more markups of True/False.Serhiy Storchaka2016-10-191-1/+1
|
* Issue #22558: Add remaining doc links to source code for Python-coded modules.Terry Jan Reedy2016-06-111-0/+5
| | | | | Reformat header above separator line (added if missing) to a common format. Patch by Yoni Lavi.
* Issue #20699: Document that “io” methods accept bytes-like objectsMartin Panter2016-05-281-16/+27
| | | | | | | | This matches the usage of ZipFile and BufferedWriter. This still requires return values to be bytes() objects. Also document and test that the write() methods should only access their argument before they return.
* Issue #27036: Fixed formatting references to "bytes-like object" in plural.Serhiy Storchaka2016-05-181-1/+1
|
generated by cgit v0.12 at 2025-09-03 07:22:07 (GMT)