[Python-checkins] bpo-37014: Update docstring and Documentation of fileinput.FileInput(). (GH-13545)

Ezio Melotti webhook-mailer at python.org
Sun Jun 2 17:01:53 EDT 2019


https://github.com/python/cpython/commit/aca273e2401ca3151e15e984f400233b7f255e15
commit: aca273e2401ca3151e15e984f400233b7f255e15
branch: master
author: Michele Angrisano <michele.angrisano at gmail.com>
committer: Ezio Melotti <ezio.melotti at gmail.com>
date: 2019-06-02T23:01:49+02:00
summary:

bpo-37014: Update docstring and Documentation of fileinput.FileInput(). (GH-13545)

* bpo-37014: Update docstring and Documentation of fileinput.FileInput()

* Explain the behavior of fileinput.FileInput() when reading stdin.

* Update blurb.

* bpo-37014: Fix typo in the docstring and documentation.

files:
M Doc/library/fileinput.rst
M Lib/fileinput.py
M Misc/ACKS

diff --git a/Doc/library/fileinput.rst b/Doc/library/fileinput.rst
index 14be492f55a6..f5e5280a1363 100644
--- a/Doc/library/fileinput.rst
+++ b/Doc/library/fileinput.rst
@@ -23,8 +23,9 @@ The typical use is::
 
 This iterates over the lines of all files listed in ``sys.argv[1:]``, defaulting
 to ``sys.stdin`` if the list is empty.  If a filename is ``'-'``, it is also
-replaced by ``sys.stdin``.  To specify an alternative list of filenames, pass it
-as the first argument to :func:`.input`.  A single file name is also allowed.
+replaced by ``sys.stdin`` and the optional arguments *mode* and *openhook*
+are ignored.  To specify an alternative list of filenames, pass it as the
+first argument to :func:`.input`.  A single file name is also allowed.
 
 All files are opened in text mode by default, but you can override this by
 specifying the *mode* parameter in the call to :func:`.input` or
diff --git a/Lib/fileinput.py b/Lib/fileinput.py
index d868e74cd5e9..c1b0ec9a8ed0 100644
--- a/Lib/fileinput.py
+++ b/Lib/fileinput.py
@@ -8,9 +8,9 @@
 
 This iterates over the lines of all files listed in sys.argv[1:],
 defaulting to sys.stdin if the list is empty.  If a filename is '-' it
-is also replaced by sys.stdin.  To specify an alternative list of
-filenames, pass it as the argument to input().  A single file name is
-also allowed.
+is also replaced by sys.stdin and the optional arguments mode and
+openhook are ignored.  To specify an alternative list of filenames,
+pass it as the argument to input().  A single file name is also allowed.
 
 Functions filename(), lineno() return the filename and cumulative line
 number of the line that has just been read; filelineno() returns its
diff --git a/Misc/ACKS b/Misc/ACKS
index 5c23df8c5899..082fa567f23a 100644
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -55,6 +55,7 @@ Juancarlo Añez
 Chris Angelico
 Jérémy Anger
 Jon Anglin
+Michele Angrisano
 Ankur Ankan
 Heidi Annexstad
 Ramchandra Apte



More information about the Python-checkins mailing list