Introduction
The Python programming language is a great tool to use when working with numbers and evaluating mathematical expressions. This quality can be utilized to make useful programs.
This tutorial presents a learning exercise that outlines how to make a command-line calculator program in Python 3. This calculator will be able to perform only basic arithmetic, but the final step of this guide serves as a starting point for how you might improve the code to create a more robust calculator.
We’ll be using math operators, variables, conditional statements, functions, and handle user input to make our calculator.
Prerequisites
For this tutorial, you should have Python 3 installed on your local computer and have a programming environment set up on the machine. If you need to install Python or set up the environment, you can do so by following the appropriate guide for your operating system.
Step 1 — Prompt Users for Input
Calculators work best when a human provides equations for the computer to solve. You’ll start writing your program at the point where the human enters the numbers that they would like the computer to work with.
First, you’ll create a file for your program. For this example, we’ll use the text editor nano and name the file calculator.py:
nano calculator.py
Next, you’ll add contents to this file to run your program. For this program, you’ll have the user input two numbers, so instruct the program to prompt the user for two numbers. You can do this by using Python’s built-in input() function to accept user-generated input from the keyboard. Inside of the parentheses of the input() function you can pass a string to prompt the user, and then assign the user’s input to a variable. Keep in mind that when asking for input, it can be helpful to include a space at the end of your string so that there is a space between the user’s input and the prompting string:
calculator.py
number_1 = input('Enter your first number: ')
number_2 = input('Enter your second number: ')
After writing two lines, you should save the program before running it. If you’re using nano, you can exit by pressing CTRL + X then Y and ENTER.
Run your program with the following command:
python calculator.py
This will begin your program’s prompts and you can respond in the terminal window:
Enter your first number: 5
Enter your second number: 7
If you run this program a few times and vary your input, you’ll notice that you can enter whatever you want when prompted, including words, symbols, whitespace, or the enter key. This is because input() takes data in as strings and doesn’t know that you’re looking for numbers.
You’ll want to use numbers in this program for two reasons:
to enable the program to perform mathematical calculations
to validate that the user’s input is a numerical string
Depending on the needs of your calculator, you may want to convert the string that comes in from the input() function to either an integer or a float. For this tutorial, whole numbers suit our purpose, so wrap the input() function in the int() function to convert the input to the integer data type:
calculator.py
number_1 = int(input('Enter your first number: '))
number_2 = int(input('Enter your second number: '))
Now, if you run the program and input two integers you won’t run into an error:
Enter your first number: 23
Enter your second number: 674
But, if you enter letters, symbols, or any other non-integers, you’ll encounter the following error:
Enter your first number: sammy
Traceback (most recent call last):
File "testing.py", line 1, in <module>
number_1 = int(input('Enter your first number: '))
ValueError: invalid literal for int() with base 10: 'sammy'
So far, you’ve set up two variables to store user input in the form of integer data types. You can also experiment with converting the input to floats.
Step 2 — Adding Operators
Before the program is complete, you’ll add a total of four mathematical operators: + for addition, - for subtraction, * for multiplication, and / for division.
As you build out the program, you’ll want to make sure that each part is functioning correctly, so start with setting up addition. You’ll add the two numbers within a print function so that the person using the calculator will be able to see the contents:
calculator.py
number_1 = int(input('Enter your first number: '))
number_2 = int(input('Enter your second number: '))
print(number_1 + number_2)
Run the program and type in two numbers when prompted to ensure that it is working as expected:
Enter your first number: 8
Enter your second number: 3
11
The output shows that the program is working correctly. Now, add some more context for the user to be fully informed throughout the runtime of the program. To do this, use string formatters to help properly format the text and provide feedback. You want the user to receive confirmation about the numbers they are entering and the operator that is being used alongside the produced result:
calculator.py
number_1 = int(input('Enter your first number: '))
number_2 = int(input('Enter your second number: '))
print('{} + {} = '.format(number_1, number_2))
print(number_1 + number_2)
Now, when you run the program, you’ll have extra output that will let the user confirm the mathematical expression that is being performed by the program:
Enter your first number: 90
Enter your second number: 717
90 + 717 =
807
Using the string formatters provides the users with more feedback.
At this point, you can add the rest of the operators to the program with the same format used for addition:
calculator.py
number_1 = int(input('Enter your first number: '))
number_2 = int(input('Enter your second number: '))
# Addition
print('{} + {} = '.format(number_1, number_2))
print(number_1 + number_2)
# Subtraction
print('{} - {} = '.format(number_1, number_2))
print(number_1 - number_2)
# Multiplication
print('{} * {} = '.format(number_1, number_2))
print(number_1 * number_2)
# Division
print('{} / {} = '.format(number_1, number_2))
print(number_1 / number_2)
Here, you’re adding the remaining operators, -, *, and / into the program above. If you run the program at this point, the program will execute all of the operations above. However, you want to limit the program to perform one operation at a time. To do this, you’ll use conditional statements.
Step 3 — Adding Conditional Statements
The goal of the calculator.py program is for the user to be able to choose among the different operators. Start by adding some information at the top of the program, along with a choice to make, so that the person knows what to do.
Write a string on a few different lines by using triple quotes:
'''
Please type in the math operation you would like to complete:
+ for addition
- for subtraction
* for multiplication
/ for division
'''
This program uses each of the operator symbols for users to make their choice, so if the user wants division to be performed, they will type /. You could choose whatever symbols you want, though, like 1 for addition, or b for subtraction.
Because you’re asking users for input, you want to use the input() function. Put the string inside of the input() function, and pass the value of that input to a variable, which you’ll name operation:
calculator.py
operation = input('''
Please type in the math operation you would like to complete:
+ for addition
- for subtraction
* for multiplication
/ for division
''')
number_1 = int(input('Enter your first number: '))
number_2 = int(input('Enter your second number: '))
print('{} + {} = '.format(number_1, number_2))
print(number_1 + number_2)
print('{} - {} = '.format(number_1, number_2))
print(number_1 - number_2)
print('{} * {} = '.format(number_1, number_2))
print(number_1 * number_2)
print('{} / {} = '.format(number_1, number_2))
print(number_1 / number_2)
At this point, if you run the program nothing will happen, no matter what you input at the first prompt. To correct this, add some conditional statements into the program. Because of how you have structured the program, the if statement will be where the addition is performed, there will be 3 else-if or elif statements for each of the other operators, and the else statement will be put in place to handle an error if the user did not input an operator symbol:
calculator.py
operation = input('''
Please type in the math operation you would like to complete:
+ for addition
- for subtraction
* for multiplication
/ for division
''')
number_1 = int(input('Enter your first number: '))
number_2 = int(input('Enter your second number: '))
if operation == '+':
print('{} + {} = '.format(number_1, number_2))
print(number_1 + number_2)
elif operation == '-':
print('{} - {} = '.format(number_1, number_2))
print(number_1 - number_2)
elif operation == '*':
print('{} * {} = '.format(number_1, number_2))
print(number_1 * number_2)
elif operation == '/':
print('{} / {} = '.format(number_1, number_2))
print(number_1 / number_2)
else:
print('You have not typed a valid operator, please run the program again.')
To walk through this program, first it prompts the user to put in an operation symbol. For example, say the user inputs * to multiply. Next, the program asks for two numbers, and the user inputs 58 and 40. At this point, the program shows the equation performed and the product:
Please type in the math operation you would like to complete:
+ for addition
- for subtraction
* for multiplication
/ for division
*
Please enter the first number: 58
Please enter the second number: 40
58 * 40 =
2320
Because of how you structured the program, if the user enters % when asked for an operation at the first prompt, they won’t receive feedback to try again until after entering numbers. You may want to consider other possible options for handling various situations.
At this point, you have a fully functional program, but you can’t perform a second or third operation without running the program again. The next step involves defining a few functions to add this functionality to the program.
Step 4 — Defining Functions
To handle the ability to perform the program as many times as the user wants, you’ll define some functions. First, put your existing code block into a function. Name the function calculate() and add an additional layer of indentation within the function itself. To ensure the program runs, you’ll also call the function at the bottom of the file:
calculator.py
# Define our function
def calculate():
operation = input('''
Please type in the math operation you would like to complete:
+ for addition
- for subtraction
* for multiplication
/ for division
''')
number_1 = int(input('Please enter the first number: '))
number_2 = int(input('Please enter the second number: '))
if operation == '+':
print('{} + {} = '.format(number_1, number_2))
print(number_1 + number_2)
elif operation == '-':
print('{} - {} = '.format(number_1, number_2))
print(number_1 - number_2)
elif operation == '*':
print('{} * {} = '.format(number_1, number_2))
print(number_1 * number_2)
elif operation == '/':
print('{} / {} = '.format(number_1, number_2))
print(number_1 / number_2)
else:
print('You have not typed a valid operator, please run the program again.')
# Call calculate() outside of the function
calculate()
Next, create a second function made up of more conditional statements. In this block of code, you want to give the user the choice as to whether they want to calculate again or not. You can base this off of the calculator conditional statements, but in this case, you’ll only have one if, one elif, and one else to handle errors.
Name this function again(), and add it after the def calculate(): code block:
calculator.py
...
# Define again() function to ask user if they want to use the calculator again
def again():
# Take input from user
calc_again = input('''
Do you want to calculate again?
Please type Y for YES or N for NO.
''')
# If user types Y, run the calculate() function
if calc_again == 'Y':
calculate()
# If user types N, say good-bye to the user and end the program
elif calc_again == 'N':
print('See you later.')
# If user types another key, run the function again
else:
again()
# Call calculate() outside of the function
calculate()
Although there is some error-handling with the else statement above, you could probably make it clearer to accept, say, a lower-case y and n in addition to the upper-case Y and N. To do that, add the string function str.upper():
calculator.py
...
def again():
calc_again = input('''
Do you want to calculate again?
Please type Y for YES or N for NO.
''')
# Accept 'y' or 'Y' by adding str.upper()
if calc_again.upper() == 'Y':
calculate()
# Accept 'n' or 'N' by adding str.upper()
elif calc_again.upper() == 'N':
print('See you later.')
else:
again()
...
At this point, you should add the again() function to the end of the calculate() function so that it will trigger the code that asks the user whether or not they would like to continue:
calculator.py
def calculate():
operation = input('''
Please type in the math operation you would like to complete:
+ for addition
- for subtraction
* for multiplication
/ for division
''')
number_1 = int(input('Please enter the first number: '))
number_2 = int(input('Please enter the second number: '))
if operation == '+':
print('{} + {} = '.format(number_1, number_2))
print(number_1 + number_2)
elif operation == '-':
print('{} - {} = '.format(number_1, number_2))
print(number_1 - number_2)
elif operation == '*':
print('{} * {} = '.format(number_1, number_2))
print(number_1 * number_2)
elif operation == '/':
print('{} / {} = '.format(number_1, number_2))
print(number_1 / number_2)
else:
print('You have not typed a valid operator, please run the program again.')
# Add again() function to calculate() function
again()
def again():
calc_again = input('''
Do you want to calculate again?
Please type Y for YES or N for NO.
''')
if calc_again.upper() == 'Y':
calculate()
elif calc_again.upper() == 'N':
print('See you later.')
else:
again()
calculate()
You can now run your program with python calculator.py in your terminal window and you’ll be able to calculate as many times as you would like.
Step 5 — Improving the Code
Now you have a nice, fully functional program. However, there is a lot more you can do to improve this code. You can add a welcome function, for example, that welcomes people to the program at the top of the program’s code, like this:
def welcome():
print('''
Welcome to Calculator
''')
...
# Don’t forget to call the function
welcome()
calculate()
There are opportunities to introduce more error-handling throughout the program. For starters, you can ensure that the program continues to run even if the user types plankton when asked for a number. As the program is right now, if number_1 and number_2 are not integers, the user will get an error and the program will stop running. Also, for cases when the user selects the division operator (/) and types in `` for their second number (number_2), the user will receive a ZeroDivisionError: division by zero error. For this, you may want to use exception handling with the try ... except statement.
This exercise limited you to four operators, but you can add additional operators, as in:
...
operation = input('''
Please type in the math operation you would like to complete:
+ for addition
- for subtraction
* for multiplication
/ for division
** for power
% for modulo
''')
...
# Don’t forget to add more conditional statements to solve for power and modulo
Additionally, you may want to rewrite part of the program with a loop statement.
There are many ways to handle errors and modify and improve each and every coding project. It is important to keep in mind that there is no single correct way to solve a problem that we are presented with.
Conclusion
This tutorial walked through one possible approach to building a calculator on the command line. After completing this tutorial, you’ll be able to modify and improve the code and work on other projects that require user input on the command line.
We are interested in seeing your solutions to this basic command-line calculator project! Please feel free to post your calculator projects in the comments.
Next, you may want to create a text-based game like tic-tac-toe or rock-paper-scissors.
