Shantanu
831d58d786
bpo-39691: Clarify io.open_code behavior (GH-19824)
2020-05-01 18:52:10 +01:00
Géry Ogam
3b58a70d9c
Improve the io module documentation (GH-15099)
...
* Update io.rst
* Apply suggestions from code review
Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com>
Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>
2019-09-11 15:55:13 +01:00
Benjamin Peterson
2a3d4d9c53
Document default parameter of .seek() in the signature. (GH-14691)
2019-07-10 19:43:04 -07:00
Steve Dower
44f91c388a
bpo-37390: Add audit event table to documentations (GH-14406)
...
Also updates some (unreleased) event names to be consistent with the others.
2019-06-27 10:47:59 -07:00
Steve Dower
60419a7e96
bpo-37363: Add audit events for a range of modules (GH-14301)
2019-06-24 08:42:54 -07:00
Harmon
35068bd059
Add missing single quote in io.TextIOWrapper.reconfigure documentation (GH-14246)
...
Add a missing single quote character in the documentation for `io.TextIOWrapper.reconfigure`.
2019-06-19 14:01:26 -07:00
Steve Dower
b82e17e626
bpo-36842: Implement PEP 578 (GH-12613)
...
Adds sys.audit, sys.addaudithook, io.open_code, and associated C APIs.
2019-05-23 08:45:22 -07:00
Christopher Head
b13552c4d7
Indicate that seek and tell are mandatory on BufferedRandom. (GH-11216)
...
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.
2019-04-12 08:50:40 -07:00
Steve Palmer
7b97ab35b2
closes bpo-35848: Move all documentation regarding the readinto out of 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.
2019-04-08 21:35:27 -07:00
Emmanuel Arias
522630a746
bpo-36006: Fix versionchanged directive alignment in io module documentation (GH-11881)
...
https://bugs.python.org/issue36006
2019-02-15 11:02:38 -08:00
Serhiy Storchaka
2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)
2018-12-19 08:09:46 +02:00
Srinivas Thatiparthy (శ్రీనివాస్ తాటిపర్తి)
cd449806fa
Minor grammar improvement to io documentation. (GH-10329)
...
Independently of -> Independent of
2018-11-11 20:06:18 -08:00
Stéphane Wirtel
e483f02423
bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)
2018-10-26 12:52:11 +02:00
Andrés Delfino
b6bb77c2b8
bpo-33804: Document that the argument for io.TextIOBase.read() is optional (GH-7510)
2018-07-07 23:17:16 +03:00
Elena Oat
7ffd4c58fa
bpo-22069: Update TextIO documentation (GH-6609)
...
Clarify that flush is implied when the call to write contains a newline character.
2018-05-14 10:48:01 -04:00
INADA Naoki
507434fd50
bpo-15216: io: TextIOWrapper.reconfigure() accepts encoding, errors and newline (GH-2343)
2017-12-21 09:59:53 +09:00
Sanyam Khurana
1b74f9b77a
bpo-22671: Clarify and test default read method implementations ( #4568 )
...
Original patch written by Martin Panter, enhanced by Sanyam Khurana.
2017-12-11 14:42:09 +01:00
Antoine Pitrou
3c2817b688
Fix bpo-30526: Add TextIOWrapper.reconfigure() and a TextIOWrapper.write_through attribute ( #1922 )
...
* Fix bpo-30526: Add TextIOWrapper.reconfigure()
* Apply Nick's improved wording
* Update Misc/NEWS
2017-06-03 12:32:28 +02:00
Martin Panter
4e946792d7
Issue #23214 : Fix formatting of -1
2016-10-21 23:00:10 +00:00
Martin Panter
ccb2c0e310
Issue #23214 : Implement optional BufferedReader, BytesIO read1() argument
2016-10-20 23:48:14 +00:00
Serhiy Storchaka
4adf01caae
Issue #19795 : Improved more markups of True/False.
2016-10-19 18:30:05 +03:00
Terry Jan Reedy
fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Martin Panter
6bb91f3b6e
Issue #20699 : Document that “io” methods accept bytes-like objects
...
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.
2016-05-28 00:41:57 +00:00
Serhiy Storchaka
e5ea1abf91
Issue #27036 : Fixed formatting references to "bytes-like object" in plural.
2016-05-18 13:54:54 +03:00
Martin Panter
994815e1d7
Issue #22413 : Merge StringIO doc from 3.4 into 3.5
2015-10-10 10:15:21 +00:00
Martin Panter
cfad54344f
Issue #22413 : Document newline effect on StringIO initializer and getvalue
...
Also add to comment in the C code.
2015-10-10 03:01:20 +00:00
Yury Selivanov
4dde587405
whatsnew/3.5: Sync whatsnew with versionadded/versionchanged doc tags
2015-09-11 00:48:21 -04:00
Martin Panter
0e8e78e15d
Issue #25030 : Merge seek() doc fixes from 3.4 into 3.5
2015-09-11 04:39:31 +00:00
Martin Panter
db4220ea09
Issue #25030 : Do not document seek() as if it accepts keyword arguments
...
Patch from Shiyao Ma.
2015-09-11 03:58:30 +00:00
Steve Dower
fe0a41aae4
Issue #23668 : Adds support for os.truncate and os.ftruncate on Windows
2015-03-20 19:50:46 -07:00
Serhiy Storchaka
32ca3dcb97
Issue #23099 : Closing io.BytesIO with exported buffer is rejected now to
...
prevent corrupting exported buffer.
2015-02-03 09:30:51 +02:00
Serhiy Storchaka
c057c3859c
Issue #23099 : Closing io.BytesIO with exported buffer is rejected now to
...
prevent corrupting exported buffer.
2015-02-03 02:00:18 +02:00
Serhiy Storchaka
07985ef387
Issue #22286 : The "backslashreplace" error handlers now works with
...
decoding and translating.
2015-01-25 22:56:57 +02:00
Serhiy Storchaka
166ebc4e5d
Issue #19676 : Added the "namereplace" error handler.
2014-11-25 13:57:17 +02:00
Robert Collins
933430ab69
Issue #17401 : document closefd in io.FileIO docs and add to repr
...
closefd was documented in the open docs but not the matching FileIO
class documented. Further, closefd, part of the core state for the
object was not shown.
In review it was noted that the open docs are a little confusing about
the interaction between closefd and paths, so tweaked them at the same
time.
2014-10-18 13:32:43 +13:00
Zachary Ware
efe030c609
Closes #22004 : Merge with 3.4
2014-07-18 09:14:55 -05:00
Zachary Ware
0069eac0e5
Issue #22004 : Correct an argument name.
2014-07-18 09:11:48 -05:00
Benjamin Peterson
2a1a49063b
reflow to 80 chars
2014-06-22 14:19:07 -07:00
Benjamin Peterson
a96fea03e8
add BufferedIOBase.readinto1 ( closes #20578 )
...
Patch by Nikolaus Rath.
2014-06-22 14:17:44 -07:00
Benjamin Peterson
ef8abfc082
document IOBase.__del__'s behavior ( closes #21764 )
...
Patch from Nikolaus Rath.
2014-06-14 18:51:34 -07:00
Larry Hastings
3732ed2414
Merge in all documentation changes since branching 3.4.0rc1.
2014-03-15 21:13:56 -07:00
Antoine Pitrou
9c2389d282
Issue #20423 : fix documentation of io.StringIO's newline parameter
2014-02-02 22:49:03 +01:00
Antoine Pitrou
be7ff9f2f9
Issue #20423 : fix documentation of io.StringIO's newline parameter
2014-02-02 22:48:25 +01:00
Serhiy Storchaka
0e90e99188
Issue #19795 : Improved markup of True/False constants.
2013-11-29 12:19:53 +02:00
Serhiy Storchaka
fbc1c26803
Issue #19795 : Improved markup of True/False constants.
2013-11-29 12:17:13 +02:00
Serhiy Storchaka
98b28fddd8
Issue #18758 : Fixed and improved cross-references.
2013-10-13 23:12:09 +03:00
Serhiy Storchaka
bfdcd436f0
Issue #18758 : Fixed and improved cross-references.
2013-10-13 23:09:14 +03:00
Serhiy Storchaka
3c41154331
Issue #17003 : Unified the size argument names in the io module with common
...
practice.
2013-09-16 23:18:10 +03:00
Victor Stinner
daf455554b
Issue #18571 : Implementation of the PEP 446: file descriptors and file handles
...
are now created non-inheritable; add functions os.get/set_inheritable(),
os.get/set_handle_inheritable() and socket.socket.get/set_inheritable().
2013-08-28 00:53:59 +02:00
Ezio Melotti
ed3cd7e445
#13510 : clarify that f.readlines() is note necessary to iterate over a file. Patch by Dan Riti.
2013-04-15 19:08:31 +03:00