User input and command line arguments [closed]
Asked Answered
B

12

634

How do I have a Python script that can accept user input and how do I make it read in arguments if run from the command line?

Blakeley answered 16/9, 2008 at 9:44 Comment(5)
The answer will depend upon your version of Python. Python 3.x does this a little differently than Python 2.7Forever
And Python 2.7 also does this a bit differently than the versions before 2.7, e.g. argparse instead of optparse.Haemostasis
Duplicate of How do you read from stdin in Python?, How to read/process command line arguments?. Discussed on meta.Tramp
It's not really a duplicate of the first: user input comes from /dev/tty, which is no always the same as standard input.Madeira
Concordant with the meta discussion cited by @user202729, I have cleaned up other questions that were linked here as a duplicate (in most cases, by changing them to link to one of the other two canonicals), and cast the first delete vote.Westward
C
620

To read user input you can try the cmd module for easily creating a mini-command line interpreter (with help texts and autocompletion) and raw_input (input for Python 3+) for reading a line of text from the user.

text = raw_input("prompt")  # Python 2
text = input("prompt")  # Python 3

Command line inputs are in sys.argv. Try this in your script:

import sys
print (sys.argv)

There are two modules for parsing command line options: optparse (deprecated since Python 2.7, use argparse instead) and getopt. If you just want to input files to your script, behold the power of fileinput.

The Python library reference is your friend.

Coniology answered 16/9, 2008 at 9:50 Comment(4)
raw_input was renamed to input in Python 3.x - documentation hereForever
My favourite source for this: tutorialspoint.com/python/python_command_line_arguments.htm and this looks good too: cyberciti.biz/faq/python-command-line-arguments-argv-exampleThew
sys.argv needs to be supplied with argument number, if suppose you pass a parameter as a value eg. python file_name.py 2017-02-10 and you want to use the date , it should be sys.argv[1] else it will be a list such as [file_name.py,2017-02-10]Packthread
This won't read from tty if standard input comes from somewhere else. The question doesn't make it clear what should happen in that case.Madeira
N
518
var = raw_input("Please enter something: ")
print "you entered", var

Or for Python 3:

var = input("Please enter something: ")
print("You entered: " + var)
Nita answered 16/9, 2008 at 9:48 Comment(5)
It should be noted that you don't have to import raw_input, it's a builtin function.Anode
You don't have to use str() in print concatenation since all entered data will be str(ing) type by default (even numbers).Stutz
This does not work well: it reads from standard input, which is not always a tty.Madeira
@Madeira What do you mean? There are certainly other ways to read input, too, but this works fine in the terminal. Some IDEs might have trouble because they don't let you interact with a process which reads stuff from stdin, but then that's more of a flaw of those IDEs.Limbate
@tripleee: All of my scripts are written to write their output to stdout, so I can redirect it to file or to a pipe. When these scripts ask questions to the user, they must go to tty (the user), not to the file or pipe (stdout). Likewise, the user's answers should be read from tty even if the script is reading stdin from elsewhere (although that use case is rare enough that none of my scripts need to make this distinction).Madeira
F
214

raw_input is no longer available in Python 3.x. But raw_input was renamed input, so the same functionality exists.

input_var = input("Enter something: ")
print ("you entered " + input_var) 

Documentation of the change

Forever answered 30/11, 2011 at 22:53 Comment(4)
In Python 2.7, input() doesn't convert values to strings. So if you try to do this: input_variable1 = input ("Enter the first word or phrase: "), you will get an error: Traceback (most recent call last): return eval(raw_input(prompt)) File "<string>", line 1, in <module> NameError: name 'bad' is not definedManageable
input_var = input ("Press 'E' and 'Enter' to Exit: ") NameError: name 'e' is not defined I am using Python 2.5. How, I can overcome this error.Vibrations
You can avoid the Traceback notice by using the following import which comes with Python 2.7: import fileinput result=[] for line in fileinput.input(): result.append(line)Horsetail
Here is more of the history and the rationale: python.org/dev/peps/pep-3111Sorehead
O
35

The best way to process command line arguments is the argparse module.

Use raw_input() to get user input. If you import the readline module your users will have line editing and history.

Ocreate answered 16/9, 2008 at 9:48 Comment(4)
readline only available on unix out of the box though.Farsighted
argparse is the new optparseRegrate
It's hard to imagine a sentence where "best" and argparse can be combined. It is the standard argument parser, but it is complex and hairy, and huge overkill if you simply want to loop over sys.argv[1:]Limbate
Thanks for recommending argparse. A great improvement over argument parsing I used many years ago in C. Much better than any quick hand-coded stuff I ever tried, even for simple command lines with just a few options, and --help is built in for free!Ghana
S
21

This simple program helps you in understanding how to feed the user input from command line and to show help on passing invalid argument.

import argparse
import sys

try:
     parser = argparse.ArgumentParser()
     parser.add_argument("square", help="display a square of a given number",
                type=int)
    args = parser.parse_args()

    #print the square of user input from cmd line.
    print args.square**2

    #print all the sys argument passed from cmd line including the program name.
    print sys.argv

    #print the second argument passed from cmd line; Note it starts from ZERO
    print sys.argv[1]
except:
    e = sys.exc_info()[0]
    print e

1) To find the square root of 5

C:\Users\Desktop>python -i emp.py 5
25
['emp.py', '5']
5

2) Passing invalid argument other than number

C:\Users\bgh37516\Desktop>python -i emp.py five
usage: emp.py [-h] square
emp.py: error: argument square: invalid int value: 'five'
<type 'exceptions.SystemExit'>
Sidney answered 20/5, 2015 at 5:33 Comment(0)
R
19

Careful not to use the input function, unless you know what you're doing. Unlike raw_input, input will accept any python expression, so it's kinda like eval

Romero answered 16/9, 2008 at 9:58 Comment(0)
S
13

Use 'raw_input' for input from a console/terminal.

if you just want a command line argument like a file name or something e.g.

$ python my_prog.py file_name.txt

then you can use sys.argv...

import sys
print sys.argv

sys.argv is a list where 0 is the program name, so in the above example sys.argv[1] would be "file_name.txt"

If you want to have full on command line options use the optparse module.

Pev

Sequential answered 16/9, 2008 at 9:52 Comment(0)
S
10

If you are running Python <2.7, you need optparse, which as the doc explains will create an interface to the command line arguments that are called when your application is run.

However, in Python ≥2.7, optparse has been deprecated, and was replaced with the argparse as shown above. A quick example from the docs...

The following code is a Python program that takes a list of integers and produces either the sum or the max:

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                   help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                   const=sum, default=max,
                   help='sum the integers (default: find the max)')

args = parser.parse_args()
print args.accumulate(args.integers)
Solicitor answered 26/10, 2012 at 15:29 Comment(0)
N
7

As of Python 3.2 2.7, there is now argparse for processing command line arguments.

Names answered 6/8, 2010 at 20:0 Comment(1)
argparse has also been backported and is available on PyPi pypi.python.org/pypi/argparse/1.2.1Sieber
A
7

If it's a 3.x version then just simply use:

variantname = input()

For example, you want to input 8:

x = input()
8

x will equal 8 but it's going to be a string except if you define it otherwise.

So you can use the convert command, like:

a = int(x) * 1.1343
print(round(a, 2)) # '9.07'
9.07
Apodaca answered 17/2, 2017 at 18:31 Comment(0)
M
2

In Python 2:

data = raw_input('Enter something: ')
print data

In Python 3:

data = input('Enter something: ')
print(data)
Merridie answered 1/6, 2017 at 18:0 Comment(1)
This duplicates earlier answers without adding anything.Limbate
L
2
import six

if six.PY2:
    input = raw_input

print(input("What's your name? "))
Lilialiliaceous answered 17/1, 2019 at 17:10 Comment(2)
Perhaps emphasize that import six is a facility for creating code which is compatible with both Python 2 and Python 3. These days, you probably don't need that if you are writing new code; just focus on Python 3.Limbate
Agreed! I can't remember the last time I used Python 2.Lilialiliaceous

© 2022 - 2024 — McMap. All rights reserved.