Clarification through Code Examples
I've been asking myself the same question, so I came up with these two snippets, which clarify how sys.stdin and input() differ by emulating the latter with the former:
import sys
def my_input(prompt=''):
print(prompt, end='') # prompt with no newline
for line in sys.stdin:
if '\n' in line: # We want to read only the first line and stop there
break
return line.rstrip('\n')
Here is a more condensed version:
import sys
def my_input(prompt=''):
print(prompt, end='')
return sys.stdin.readline().rstrip('\n')
Both these snippets differ from the input() function in that they do not detect the End Of File (see below).
Clarification through Documentation
This is how the official documentation describes the function input():
input([prompt])
If the prompt argument is present, it is written to standard output without a trailing newline. The function then reads a line from input, converts it to a string (stripping a trailing newline), and returns that. When EOF is read, EOFError is raised.
And here's how sys.stdin is described:
sys.stdin
File object used by the interpreter for standard input.
stdin is used for all interactive input (including calls to input());
These streams (sys.stdin, sys.stdout and sys.stderr) are regular text files like those returned by the open() function. [...]
So whereas input() is a function, sys.stdin is an object (a File object).
As such, it has a number of attributes, which you can explore in the interpreter, with:
> dir(sys.stdin)
['_CHUNK_SIZE',
'__class__',
'__del__',
'__delattr__',
'__dict__',
'__dir__',
...
'truncate',
'writable',
'write',
'write_through',
'writelines']
and which you can display individually, for instance:
> sys.stdin.mode
r
It also has methods, such as readline(), which "reads a single line from the file; a newline character (\n) is left at the end of the string, and is only omitted on the last line of the file if the file doesn’t end in a newline. This makes the return value unambiguous; if f.readline() returns an empty string, the end of the file has been reached, while a blank line is represented by '\n', a string containing only a single newline." (1)
Full implementation
This last method allows us to fully emulate the input() function, including its EOF Exception error:
def my_input(prompt=''):
print(prompt, end='')
line = sys.stdin.readline()
if line == '': # readline() returns an empty string only if EOF has been reached
raise EOFError('EOF when reading a line')
else:
return line.rstrip('\n')
Answer from kotchwane on Stack OverflowClarification through Code Examples
I've been asking myself the same question, so I came up with these two snippets, which clarify how sys.stdin and input() differ by emulating the latter with the former:
import sys
def my_input(prompt=''):
print(prompt, end='') # prompt with no newline
for line in sys.stdin:
if '\n' in line: # We want to read only the first line and stop there
break
return line.rstrip('\n')
Here is a more condensed version:
import sys
def my_input(prompt=''):
print(prompt, end='')
return sys.stdin.readline().rstrip('\n')
Both these snippets differ from the input() function in that they do not detect the End Of File (see below).
Clarification through Documentation
This is how the official documentation describes the function input():
input([prompt])
If the prompt argument is present, it is written to standard output without a trailing newline. The function then reads a line from input, converts it to a string (stripping a trailing newline), and returns that. When EOF is read, EOFError is raised.
And here's how sys.stdin is described:
sys.stdin
File object used by the interpreter for standard input.
stdin is used for all interactive input (including calls to input());
These streams (sys.stdin, sys.stdout and sys.stderr) are regular text files like those returned by the open() function. [...]
So whereas input() is a function, sys.stdin is an object (a File object).
As such, it has a number of attributes, which you can explore in the interpreter, with:
> dir(sys.stdin)
['_CHUNK_SIZE',
'__class__',
'__del__',
'__delattr__',
'__dict__',
'__dir__',
...
'truncate',
'writable',
'write',
'write_through',
'writelines']
and which you can display individually, for instance:
> sys.stdin.mode
r
It also has methods, such as readline(), which "reads a single line from the file; a newline character (\n) is left at the end of the string, and is only omitted on the last line of the file if the file doesn’t end in a newline. This makes the return value unambiguous; if f.readline() returns an empty string, the end of the file has been reached, while a blank line is represented by '\n', a string containing only a single newline." (1)
Full implementation
This last method allows us to fully emulate the input() function, including its EOF Exception error:
def my_input(prompt=''):
print(prompt, end='')
line = sys.stdin.readline()
if line == '': # readline() returns an empty string only if EOF has been reached
raise EOFError('EOF when reading a line')
else:
return line.rstrip('\n')
Here's something to get you started:
The builtin function input reads a line of input from the standard input stream, optionally with a message prompt. Be careful with the prompt, though, because the result of:
result = input('Do you want to do whatever? ') ## doesn't work how you'd expect
if result.lower() in ('y', 'ye', 'yes', 'yup', 'ya'):
do_whatever()
...
else:
do_something_else()
...
..will include the prompt string as well (and so will never be equal to 'y'/'yes'/etc). In my opinion, it is better to print the prompt string first and then call input with no args, like so:
print('Do you want to do whatever?')
result = input() ## notice that there is no prompt string passed to input()
if result.lower() in ('y', 'ye', 'yes', 'yup', 'ya'):
do_whatever()
...
else:
do_something_else()
...
So, to recap, the builtin function input reads input from the standard input stream (sys.stdin), and the builtin function print prints output to the standard output stream (sys.stdout). There's a third one as well, the standard error stream (sys.stderr), to which unhandled exceptions get printed.
Usually, you don't have to worry about it too much. It's just when building IDEs and frameworks and such.
Videos
So you have used Python's "pre built in functions", presumably like this:
file_object = open('filename')
for something in file_object:
some stuff here
This reads the file by invoking an iterator on the file object which happens to return the next line from the file.
You could instead use:
file_object = open('filename')
lines = file_object.readlines()
which reads the lines from the current file position into a list.
Now, sys.stdin is just another file object, which happens to be opened by Python before your program starts. What you do with that file object is up to you, but it is not really any different to any other file object, its just that you don't need an open.
for something in sys.stdin:
some stuff here
will iterate through standard input until end-of-file is reached. And so will this:
lines = sys.stdin.readlines()
Your first question is really about different ways of using a file object.
Second, where is it reading from? It is reading from file descriptor 0 (zero). On Windows it is file handle 0 (zero). File descriptor/handle 0 is connected to the console or tty by default, so in effect it is reading from the keyboard. However it can be redirected, often by a shell (like bash or cmd.exe) using syntax like this:
myprog.py < input_file.txt
That alters file descriptor zero to read a file instead of the keyboard. On UNIX or Linux this uses the underlying call dup2(). Read your shell documentation for more information about redirection (or maybe man dup2 if you are brave).
It is reading from the standard input - and it should be provided by the keyboard in the form of stream data.
It is not required to provide a file, however you can use redirection to use a file as standard input.
In Python, the readlines() method reads the entire stream, and then splits it up at the newline character and creates a list of each line.
lines = sys.stdin.readlines()
The above creates a list called lines, where each element will be a line (as determined by the end of line character).
You can read more about this at the input and output section of the Python tutorial.
If you want to prompt the user for input, use the input() method (in Python 2, use raw_input()):
user_input = input('Please enter something: ')
print('You entered: {}'.format(user_input))
Hi, just wondering if using input() or sys.stdin is the preferred method for reading from stdin in python. What are the differences and what is more readable/pythonesque?
# Using input()
while True:
try:
line = input()
...
except EOFError:
break
# Using sys.stdin
for line in sys.stdin:
line = line.strip()
...Hey everyone, I just want to talk about reading in data from standard input and the 4 main ways it can be done.
I'm not going to talk about the input() or raw_input() functions today, instead ill be talking about how to read from standard input using the sys module.
To get access to the sys module we first need to import it
import sys
Ok now we have access to this module, there are 3 ways to read from standard input:
-
sys.stdin.read([size])
-
sys.stdin.readline()
-
sys.stdin.readlines()
Lets look at how all of these work first and the ways to use them.
First off we can read lines directly from the console, this will look something like this
lines = sys.stdin.read() print(lines) $ python3 stdin.py Line1 Line 2 **END** Line 1 Line 2
Our lines variable looks like this: "Line1\nLine2"
Here when we run our program, it waits until it we pass some data through the console window. We specify end of input using ctrl+z on windows and I believe ctrl+d on linux.
The sys.stdin.read() function also has an optional parameter for the size of the data we want to read. For example if we pass 10 then it reads 10 characters including any newline characters.
The read() function will read everything, or the size of data specified, and return it as one string. This is useful for small amounts of data but if we read large files this way, it can use up a lot of memory.
The second way is sys.stdin.readline() which is self explanatory and reads a single line from standard input with a newline character at the end.
line = sys.stdin.readline() print(line) $ python3 stdin.py hello hello
The next way is sys.stdin.readlines(). I find myself using this way most often. With this way, we read lines from the console and are returned a list containing all the lines we entered.
lines = sys.stdin.readlines() print(lines) $ python3 stdin.py line1 line2 line3 ['line1\n', 'line2\n', 'line3\n']
This is very useful if we wish to process a file line by line although, we do have a large list sitting in memory which we may not want with large files. I will show you how to read from files in a moment.
Reading from files:
To read from a file we can do this a couple of ways, we can open and read the file within our program.
with open('FILENAME', [rw]) as our_file:
for line in our_file:
print(line)The optional [rw] specifies whether we wish to open the file for reading, r or writing, w. This will work depending on the access permission on the file. You can check this on linux from the command line by navigating to your directory where the file is and typing:
$ ls -l
This will display the access permissions of the file in that directory.
An error will be thrown if you try to read or write without having permission to do so.
If the file name you entered doesn't exist, an empty file will be created for you.
The use of with open() here is very useful as it closes our file for us when we are finished.
Another way to read a file is passing it at the command line
$ python3 stdin.py < FILENAME.txt
Presuming FILENAME.txt looks like this:
Line 1 Line 2 Line 3
Running the following program, we get the following output:
import sys lines = sys.stdin.readlines() print(lines) $ python3 stdin.py < FILENAME.txt ['Line 1\n', 'Line 2\n', 'Line 3']
I dont want to talk to much about the different ways of reading and writing files as I only wanted to talk about the different methods we have available to use for reading so I wont discuss any further ways of reading.
If we wish to strip the newline characters from our lines we can use the strip() method, I'm going to use a list comprehension here as it is a good example of their usage:
lines = [line.strip() for line in sys.stdin.readlines()] print(lines) $ python3 stdin.py < FILENAME.txt ['Line 1', Line 2', 'Line 3']
Whats the list comprehension doing? It uses a for loop to loop through each line in standard input, takes each line and strips it then appends it to our list, lines.
Now our newline characters are gone.
We covered a fair bit of stuff here and got the chance to see some extra things in use such as list comprehensions. If you found anything here confusing, play around with it yourself, after all its one of the best ways to learn.