Sign In
Sign In

How to Make a Calculator in Python

How to Make a Calculator in Python
Hostman Team
Technical writer
Python
23.11.2023
Reading time: 13 min

In recent years, the digital world has increasingly embraced cloud systems. Services have demonstrated their convenience and reliability by instantly processing enormous amounts of information. But today, let's revisit the basics of modern technology and show you how to write a calculator program from scratch.

As we start working on the calculator, let's remember what it consists of and how it functions. We'll be creating an analog of a simple desktop calculator that every student has. By reading this article and completing all the tasks, you'll obtain ready-to-use Python code for a basic calculator.

A desktop calculator includes:

  • Buttons with digits

  • Buttons with mathematical operations

  • Display

  • Microchips inside

The functions of a desktop calculator include:

  • Addition

  • Subtraction

  • Division

  • Multiplication

  • Clearing an operation

  • Saving a result

  • Calculating a percentage

  • Taking the square root of a number

To understand the principles of writing a calculator, let's take the minimal set of functions from this list:

  •     Inputting numbers

  •     Displaying the result

  •     Addition

  •     Subtraction

  •     Division

  •     Multiplication

You can write the code directly in an online editor.

For example:

Examples of mathematical operation code

Mathematical operations we will use:

2+2 
4

10-5
5

3*3
9

12/4
3.0

Displaying a value

To see the result, you need to display it on the screen. For this purpose, there's a function called print(), which displays the arguments in parentheses in the console.

print(4 * 4) 
16

This function will serve as an equivalent to the display of our calculator.

-

Saving the result in a variable

To avoid performing calculations inside the print() function, we'll store them in variables.

result = 16 / 8

Later, we can print the value of the variable to the console.

print(result) 
2.0

Reading strings

Now that we've covered the display, let's use Python 3 to create keyboard input. We have buttons with digits on the keyboard, and to pass them to the program, we use the input() function. When called, it reads any characters from the keyboard until the Enter key is pressed. After that, it returns the result as a string of the entered characters. Let's see how it works:

text = input() # Hi 
Hi

Let's display the result on the screen.

print(text) 
Hi

If you pass text into the input() function, it is displayed on the screen before the string is read.

username = input('Enter your name: ') # John 
print(username)
Enter your name: John
John

Concatenating and formatting strings

To make the output more user-friendly, we can add explanations to it. For this, we use string concatenation.

print('Hello, ' + username + '!') 
Hello, John!

Another way to combine text with data is by using formatted strings. To do this, you need to place the character f before the quotation marks, and write the data directly inside the string within curly braces. This functionality was introduced in Python version 3.6.0.

print(f'Hello, {username}!') 
Hello, John!

Converting strings to numbers

Now that we can perform mathematical operations, read data from the keyboard, and display the result nicely in the console, let's finally write the first version of our calculator! For simplicity, let it only add numbers for now, but this will already be a complete example of a Python program.

# Read the data = input('Enter the first number: ') 
b = input('Enter the second number: ')​

# Perform calculations
result = a + b

# Display the result in the console
print(f'The sum of {a} and {b} is: {result}')

Enter the first number: 12
Enter the second number: 55
The sum of 12 and 55 is: 1255

Something went wrong. The numbers didn't add up; they were concatenated as text. The issue is that input() in Python returns a string input from the keyboard, even if you entered only numbers. This behavior is more explicit, aligning with Python's philosophy: "Explicit is better than implicit." To fix this error, we'll use the function for converting a string to a number: int(). Let's see how num int input works:

num = int(input()) 
print(num + 10)
32
42

Let's modify our program.

# Read the data = int(input('Enter the first number: ')) 
b = int(input('Enter the second number: '))

# Perform calculations
result = a + b

# Display the result in the console
print(f'The sum of {a} and {b} is: {result}')

Enter the first number: 12
Enter the second number: 55
The sum of 12 and 55 is: 67

Handling incorrect data

But what if the user enters letters or other characters instead of numbers? When trying to convert such a string to a number, Python will raise an error and stop the program's execution.

int(input('Enter the first number: ')) 
Enter the first number: abc
------------------------------------------------------------------------

ValueError  Traceback (most recent call last)
C:\Temp\ipykernel_5404\317567321.py in <module>
----> 1 int(input('Enter the first number: '))

ValueError: invalid literal for int() with base 10: 'abc'

You can promptly identify such errors and change the default behavior when they occur, such as prompting the user to enter the number again. However, this is a separate topic for discussion, so for the context of this article, let's assume that the user always enters correct data.

Creating Functions

So, we have almost all the components needed to write a complete calculator. Let's expand the functionality of the current version to include all the mathematical operations we planned:

  • Addition

  • Subtraction

  • Division

  • Multiplication

To improve the readability of the code, let's divide these operations into separate functions. See how it's done with the addition operation.

# Addition
def sum(a, b):
   result = a + b
   return result

We define a function using the keyword def, provide its name within parentheses, and specify the parameters it takes. Inside the function body, we write what it should do and return the result using the return keyword.

Note that the function body is indented - this is the rule for creating functions. Otherwise, there will be an error.

def test():
print(123)
 File "C:\Temp\ipykernel_5404\353670293.py", line 2
   print(123)
   ^
IndentationError: expected an indented block

The result of a function can also be stored in a variable for later use.

x = sum(10, 15)
print(x) 

# Output:
25

Similarly, let's create the other calculation functions.

# Subtraction
def subtract(a, b):
   result = a - b
   return result

# Multiplication
def multiply(a, b):
   result = a * b
   return result

# Division
def divide(a, b):
   result = a / b
   return result

Conditional Statements

The operation functions are ready. Now, let's write a simple Python code that allows the user to choose these operations. We'll use familiar keyboard input and conditional statements. Conditional statements work quite simply. Their names are self-explanatory.

If the condition is true, for example, 2 == 2, 
then execute one block of code;
otherwise,
execute another block of code.

The placeholders for twos can be variables, functions returning values, strings, and even mathematical operations. Let's see how this looks in code with a password check example. Let's assume the correct password is: qwerty.

# Ask the user for a password
password = input('Enter the password: ')

# Check if it matches the intended password
if password == 'qwerty':
    print('Correct!')
else:
    print('Incorrect password')
Enter the password: abc
Incorrect password

# Ask the user for a password
password = input('Enter the password: ')

# Check if it matches the intended password
if password == 'qwerty':
    print('Correct!')
else:
    print('Incorrect password')
Enter the password: qwerty
Correct!

Note that code blocks are also indented, just like in functions. The colon is also required.

Now, let's apply the knowledge we've gained to our calculator. We'll ask the user which operation they want to perform and, depending on the input, call the corresponding calculation function. Initially, we'll simply display the selected operation or a message that such an operation does not exist. In the next step, we'll replace the text with the operation call and integrate it with the existing calculator logic.

# Prepare a message for the user about available mathematical operations.# You can store multi-line text in triple quotes.
message = '''
Please enter the symbol of the operation you want to perform and press Enter:

+ : Addition
- : Subtraction
/ : Division
* : Multiplication

Your choice: 
'''

# Ask the user for the desired action
operation = input(message)

# Display the message about the selected operation or that it doesn't exist
if operation == '+':
    print('Addition')
elif operation == '-':
    print('Subtraction')
elif operation == '/':
    print('Division')
elif operation == '*':
    print('Multiplication')
else:
    print('Unknown operation')

Combine Everything

Let's encapsulate all the calculation logic inside a function so that we can conveniently call it within the script.

def calculate(a, b, operation):
    result = None

    if operation == '+':
        result = sum(a, b)
    elif operation == '-':
        result = subtract(a, b)
    elif operation == '/':
        result = divide(a, b)
    elif operation == '*':
        result = multiply(a, b)
    else:
        print('Unknown operation')

  return result

Let's also add a function for requesting the operation.

def ask_operation():
    message = '''

Please enter the symbol of the operation you want to perform and press Enter:
+ : Addition
- : Subtraction
/ : Division
* : Multiplication
^ or ** : Exponentiation

Your choice:
'''

    # Ask the user for the desired action
    operation = input(message)

  return operation

Now, wrap all the steps of interacting with the calculator in the conditional body of the calculate function

def run_calculator():    
# Ask for data
    a = int(input('Enter the first number: '))
    b = int(input('Enter the second number: '))

    # Ask for the operation type
    operation = ask_operation()
 
# Perform calculations
    result = calculate(a, b, operation)

    # Display the result in the console
  print(f'Calculation result: {result}')

Test it out!

run_calculator()
Enter the first number: 15
Enter the second number: 15

Please enter the symbol of the operation you want to perform and press Enter:

+ : Addition
- : Subtraction
/ : Division
* : Multiplication
^ or ** : Exponentiation

Your choice:
*

Calculation result: 225

It works! Congratulations, you've just written your calculator.

Extending Functionality and Improving Code

Adding Operations

Thanks to the fact that the calculation functions are now separate modules (sum, subtract, etc.), we can easily extend the functionality of the calculator.

Let's add the exponentiation operation.

def pow(a, b):
   result = a ** b
   return result

Add the operation to the calculate function.

def calculate(a, b, operation):    
  result = None

    if operation == '+':
        result = sum(a, b)

    elif operation == '-':
        result = subtract(a, b)

    elif operation == '/':
        result = divide(a, b)

    elif operation == '*':
        result = multiply(a, b)

    # Exponentiation
    elif operation == '^' or operation == '**':
        result = pow(a, b)

    else:
        print('Unknown operation')

  return result

Let's also provide explanations in the ask_operation function.

def ask_operation():
    message = '''

    Please enter the symbol of the operation you want to perform and press Enter:
    + : Addition
    - : Subtraction
    / : Division
    * : Multiplication
    ^ or ** : Exponentiation

    Your choice: 
    '''

    # Ask the user for the desired action
    operation = input(message)

    return operation

Check it by running the run_calculator function.

run_calculator()

Enter the first number: 2
Enter the second number: 8

Please enter the symbol of the operation you want to perform and press Enter:
+ : Addition
- : Subtraction
/ : Division
* : Multiplication
^ or ** : Exponentiation

Your choice: **

Calculation result: 256

Testing and Error Handling

Currently, if we enter an unknown operation, the calculator will display a message that such an operation doesn't exist and leave everything as is. Moreover, it will display messages about the obtained result, which should not exist by definition. Let's see:

run_calculator()
Enter the first number: 3
Enter the second number: 5

Please enter the symbol of the operation you want to perform and press Enter:
+ : Addition
- : Subtraction
/ : Division
* : Multiplication
^ or ** : Exponentiation

Your choice: &
Unknown operation
Calculation result: None

Nothing disastrous happened, but there's no benefit either. This process, where we try to input incorrect data into the program and observe how it reacts, is called testing. It's a separate profession, but every professional programmer should be able to perform basic tests.

Loops

Let's change the program behavior and allow the user to repeatedly choose the desired operation. To achieve this, we'll place the code with the operation request inside a while loop. The principle of a while loop is similar to conditional statements. It checks a condition for truthfulness and, if it's true, executes a block of code. After execution, the loop repeats - the condition is checked, and the loop's body is executed again. Thus, to exit the loop, we need to change the checked condition to false. Exiting a loop is a crucial moment. If the exit logic is not properly thought out, the loop can continue infinitely, which is not always desirable.

Here's a simple example. We'll print everything the user enters into the console until an empty line is entered.

text = None

while text != '':
 text = input('Write something or leave the line empty to finish:\n')
print(f'You entered: {text}\n')

print('Program termination')
Write something or leave the line empty to finish:
123
You entered: 123

Write something or leave the line empty to finish:
test
You entered: test

Write something or leave the line empty to finish:
You entered:

Program termination

Now, let's apply this to the calculator. To do this, we'll modify the ask_operation function.

def ask_operation():
    message = '''

    Please enter the symbol of the operation you want to perform and press Enter:
    + : Addition
    - : Subtraction
    / : Division
    * : Multiplication
    ^ or ** : Exponentiation

    Your choice: 
    '''

    # Create a list of available operations
    correct_operations = ['+', '-', '/', '*', '^', '**']

    # Ask the user for the desired action for the first time
    operation = input(message)

     # Start a loop if the operation is not in the list
    while operation not in correct_operations:
        print('Such operation is not available. Please try again.')
        operation = input(message)

    return operation

Calculations will not be performed until a correct operation is entered. The test is successful.

Conclusion

Today, it's easy to find calculators of various types: built into different applications, websites with calculators, standard physical calculators, and diverse engineering modifications, including interesting calculators like Python's ipcalc, which allows subnet IP calculations. But what can be better than something made and customized with your own hands?

If you want to build a web service using Python, you can rent a cloud server at competitive prices with Hostman.

Python
23.11.2023
Reading time: 13 min

Similar

Python

The Walrus Operator in Python

The first question newcomers often ask about the walrus operator in Python is: why such a strange name? The answer lies in its appearance. Look at the Python walrus operator: :=. Doesn't it resemble a walrus lounging on a beach, with the symbols representing its "eyes" and "tusks"? That's how it earned the name. How the Walrus Operator Works Introduced in Python 3.8, the walrus operator allows you to assign a value to a variable while returning that value in a single expression. Here's a simple example: print(apples = 7) This would result in an error because print expects an expression, not an assignment. But with the walrus operator: print(apples := 7) The output will be 7. This one-liner assigns the value 7 to apples and returns it simultaneously, making the code compact and clear. Practical Examples Let’s look at a few examples of how to use the walrus operator in Python. Consider a program where users input phrases. The program stops if the user presses Enter. In earlier versions of Python, you'd write it like this: expression = input('Enter something or just press Enter: ') while expression != '': print('Great!') expression = input('Enter something or just press Enter: ') print('Bored? Okay, goodbye.') This works, but we can simplify it using the walrus operator, reducing the code from five lines to three: while (expression := input('Enter something or just press Enter: ')) != '': print('Great!') print('Bored? Okay, goodbye.') Here, the walrus operator allows us to assign the user input to expression directly inside the while loop, eliminating redundancy. Key Features of the Walrus Operator: The walrus operator only assigns values within other expressions, such as loops or conditions. It helps reduce code length while maintaining clarity, making your scripts more efficient and easier to read. Now let's look at another example of the walrus operator within a conditional expression, demonstrating its versatility in Python's modern syntax. Using the Walrus Operator with Conditional Constructs Let’s write a phrase, assign it to a variable, and then find a word in this phrase using a condition: phrase = 'But all sorts of things and weather must be taken in together to make up a year and a sphere...' word = phrase.find('things') if word != -1: print(phrase[word:]) The expression [word:] allows us to get the following output: things and weather must be taken in together to make up a year and a sphere... Now let's shorten the code using the walrus operator. Instead of: word = phrase.find('things') if word != -1: print(phrase[word:]) we can write: if (word := phrase.find('things')) != -1: print(phrase[word:]) In this case, we saved a little in volume but also reduced the number of lines. Note that, despite the reduced time for writing the code, the walrus operator doesn’t always simplify reading it. However, in many cases, it’s just a matter of habit, so with practice, you'll learn to read code with "walruses" easily. Using the Walrus Operator with Numeric Expressions Lastly, let’s look at an example from another area where using the walrus operator helps optimize program performance: numerical operations. We will write a simple program to perform exponentiation: def pow(number, power): print('Calling pow') result = 1 while power: result *= number power -= 1 return result Now, let’s enter the following in the interpreter: >>> [pow(number, 2) for number in range(3) if pow(number, 2) % 2 == 0] We get the following output: Calling pow Calling pow Calling pow Calling pow Calling pow [0, 4, 16] Now, let's rewrite the input in the interpreter using the walrus operator: >>> [p for number in range(3) if (p := pow(number, 2)) % 2 == 0] Output: Calling pow Calling pow Calling pow [0, 4, 16] As we can see, the code hasn’t shrunk significantly, but the number of function calls has nearly been halved, meaning the program will run faster! Conclusion In conclusion, the walrus operator (:=) introduced in Python 3.8 streamlines code by allowing assignment and value retrieval in a single expression. This operator enhances readability and efficiency, particularly in loops and conditional statements. Through practical examples, we’ve seen how it reduces line counts and minimizes redundant function calls, leading to faster execution. With practice, developers can master the walrus operator, making their code cleaner and more concise. On our app platform you can deploy Python applications, such as Celery, Django, FastAPI and Flask. 
23 October 2024 · 4 min to read
Python

Python String Functions

As the name suggests, Python 3 string functions are designed to perform various operations on strings. There are several dozen string functions in the Python programming language. In this article, we will cover the most commonly used ones and several special functions that may be less popular but are still useful. They can be helpful not only for formatting but also for data validation. List of Basic String Functions for Text Formatting First, let’s discuss string formatting functions, and to make the learning process more enjoyable, we will use texts generated by a neural network in our examples. capitalize() — Converts the first character of the string to uppercase, while all other characters will be in lowercase: >>> phrase = 'the shortage of programmers increases the significance of DevOps. After the presentation, developers start offering their services one after another, competing with each other for DevOps.' >>> phrase.capitalize() 'The shortage of programmers increases the significance of devops. after the presentation, developers start offering their services one after another, competing with each other for devops.' casefold() — Returns all elements of the string in lowercase: >>> phrase = 'Cloud providers offer scalable computing resources and services over the internet, enabling businesses to innovate quickly. They support various applications, from storage to machine learning, while ensuring reliability and security.' >>> phrase.casefold() 'cloud providers offer scalable computing resources and services over the internet, enabling businesses to innovate quickly. they support various applications, from storage to machine learning, while ensuring reliability and security.' center() — This method allows you to center-align strings: >>> text = 'Python is great for writing AI' >>> newtext = text.center(40, '*') >>> print(newtext) *****Python is great for writing AI***** A small explanation: The center() function has two arguments: the first (length of the string for centering) is mandatory, while the second (filler) is optional. In the operation above, we used both. Our string consists of 30 characters, so the remaining 10 were filled with asterisks. If the second attribute were omitted, spaces would fill the gaps instead. upper() and lower() — convert all characters to uppercase and lowercase, respectively: >>> text = 'Projects using Internet of Things technology are becoming increasingly popular in Europe.' >>> text.lower() 'projects using internet of things technology are becoming increasingly popular in europe.' >>> text.upper() 'PROJECTS USING INTERNET OF THINGS TECHNOLOGY ARE BECOMING INCREASINGLY POPULAR IN EUROPE.' replace() — is used to replace a part of the string with another element: >>> text.replace('Europe', 'USA') 'Projects using Internet of Things technology are becoming increasingly popular in the USA.' The replace() function also has an optional count attribute that specifies the maximum number of replacements if the element to be replaced occurs multiple times in the text. It is specified in the third position: >>> text = 'hooray hooray hooray' >>> text.replace('hooray', 'hip', 2) 'hip hip hooray' strip() — removes identical characters from the edges of a string: >>> text = 'ole ole ole' >>> text.strip('ole') 'ole' If there are no symmetrical values, it will remove what is found on the left or right. If the specified characters are absent, the output will remain unchanged: >>> text.strip('ol') 'e ole ole' >>> text.strip('le') 'ole ole o' >>> text.strip('ura') 'ole ole ole' title() — creates titles, capitalizing each word: >>> texttitle = 'The 5G revolution: transforming connectivity. How next-gen networks are shaping our digital future' >>> texttitle.title() 'The 5G Revolution: Transforming Connectivity. How Next-Gen Networks Are Shaping Our Digital Future' expandtabs() — changes tabs in the text, which helps with formatting: >>> clublist = 'Milan\tReal\tBayern\tArsenal' >>> print(clublist) Milan Real Bayern Arsenal >>> clublist.expandtabs(1) 'Milan Real Bayern Arsenal' >>> clublist.expandtabs(5) 'Milan Real Bayern Arsenal' String Functions for Value Checking Sometimes, it is necessary to count a certain number of elements in a sequence or check if a specific value appears in the text. The following string functions solve these and other tasks. count() — counts substrings (individual elements) that occur in a string. Let's refer again to our neural network example: >>> text = "Cloud technologies significantly accelerate work with neural networks and AI. These technologies are especially important for employees of large corporations operating in any field — from piloting spacecraft to training programmers." >>> element = "o" >>> number = text.count(element) >>> print("The letter 'o' appears in the text", number, "time(s).") The letter 'o' appears in the text 19 time(s). As a substring, you can specify a sequence of characters (we'll use text from the example above): >>> element = "ob" >>> number = text.count(element) >>> print("The combination 'ob' appears in the text", number, "time(s).") The combination 'in' appears in the text 5 time(s). Additionally, the count() function has two optional numerical attributes that specify the search boundaries for the specified element: >>> element = "o" >>> number = text.count(element, 20, 80) >>> print("The letter 'o' appears in the specified text fragment", number, "time(s).") The letter 'o' appears in the specified text fragment 6 time(s). The letter 'o' appears in the specified text fragment 6 time(s). find() — searches for the specified value in the string and returns the smallest index. Again, we will use the example above: >>> print(text.find(element)) 7 This output means that the first found letter o is located at position 7 in the string (actually at position 8, because counting in Python starts from zero). Note that the interpreter ignored the capital letter O, which is located at position zero. Now let's combine the two functions we've learned in one code: >>> text = "Cloud technologies significantly accelerate work with neural networks and AI. These technologies are especially important for employees of large corporations operating in any field — from piloting spacecraft to training programmers." >>> element = "o" >>> number = text.count(element, 20, 80) >>> print("The letter 'o' appears in the specified text fragment", number, "time(s), and the first time in the whole text at", (text.find(element)), "position.") The letter 'o' appears in the specified text fragment 3 time(s), and the first time in the whole text at 7 position. index() — works similarly to find(), but will raise an error if the specified value is absent: Traceback (most recent call last): File "C:\Python\text.py", line 4, in <module> print(text.index(element)) ValueError: substring not found Here's what the interpreter would return when using the find() function in this case: -1 This negative position indicates that the value was not found. enumerate() — a very useful function that not only iterates through the elements of a list or tuple, returning their values, but also returns the ordinal number of each element: team_scores = [78, 74, 56, 53, 49, 47, 44] for number, score in enumerate(team_scores, 1): print(str(number) + '-th team scored ' + str(score) + ' points.') To output the values with their ordinal numbers, we introduced a few variables: number for ordinal numbers, score for the values of the list, and str indicates a string. And here’s the output: 1-th team scored 78 points. 2-th team scored 74 points. 3-th team scored 56 points. 4-th team scored 53 points. 5-th team scored 49 points. 6-th team scored 47 points. 7-th team scored 44 points. Note that the second attribute of the enumerate() function is the number 1, otherwise Python would start counting from zero. len() — counts the length of an object, i.e., the number of elements that make up a particular sequence: >>> len(team_scores) 7 This way, we counted the number of elements in the list from the example above. Now let's ask the neural network to write a string again and count the number of characters in it: >>> network = 'It is said that artificial intelligence excludes the human factor. But do not forget that the human factor is still present in the media and government structures.' >>> len(network) 162 Special String Functions in Python join() — allows you to convert lists into strings: >>> cities = ['New York', 'Los Angeles', 'Chicago', 'Houston', 'Phoenix', 'Philadelphia', 'San Antonio'] >>> cities_str = ', '.join(cities) >>> print('Cities in one line:', cities_str) Cities in one line: New York, Los Angeles, Chicago, Houston, Phoenix, Philadelphia, San Antonio print() — provides a printed representation of any object in Python: >>> cities = ['New York', 'Los Angeles', 'Chicago', 'Houston', 'Phoenix', 'Philadelphia', 'San Antonio'] >>> print(cities) ['New York', 'Los Angeles', 'Chicago', 'Houston', 'Phoenix', 'Philadelphia', 'San Antonio'] type() — returns the type of the object: >>> type(cities) <class 'list'> We found out that the object from the previous example is a list. This is useful for beginners, as they may initially confuse lists with tuples, which have different functionalities and are handled differently by the interpreter. map() — is a fairly efficient replacement for a for loop, allowing you to iterate over the elements of an iterable object, applying a built-in function to each of them. For example, let's convert a list of string values into integers using the int function: >>> numbers_list = ['4', '7', '11', '12', '17'] >>> list(map(int, numbers_list)) [4, 7, 11, 12, 17] As we can see, we used the list() function, "wrapping" the map() function in it—this was necessary to avoid the following output: >>> numbers_list = ['4', '7', '11', '12', '17'] >>> map(int, numbers_list) <map object at 0x0000000002E272B0> This is not an error; it simply produces the ID of the object, and the program will continue to run. However, the list() method is useful in such cases to get the desired list output. Of course, we haven't covered all string functions in Python. Still, this set will already help you perform a large number of operations with strings and carry out various transformations (programmatic and mathematical). On our app platform you can deploy Python applications, such as Celery, Django, FastAPI and Flask. 
23 October 2024 · 9 min to read
Python

Deploying Python Applications with Gunicorn

In this article, we’ll show how to set up an Ubuntu 20.04 server and install and configure the components required for deploying Python applications. We’ll configure the WSGI server Gunicorn to interact with our application. Gunicorn will serve as an interface that converts client requests via the HTTP protocol into Python function calls executed by the application. Then, we will configure Nginx as a reverse proxy server for Gunicorn, which will forward requests to the Gunicorn server. Additionally, we will cover securing HTTP connections with an SSL certificate or using other features like load balancing, caching, etc. These details can be helpful when working with cloud services like those provided by Hostman. Creating a Python Virtual Environment To begin, we need to update all packages: sudo apt update Ubuntu provides the latest version of the Python interpreter by default. Let’s check the installed version using the following command: python3 --version Example output: Python 3.10.12 We’ll set up a virtual environment to ensure that our project has its own dependencies, separate from other projects. First, install the virtualenv package, which allows you to create virtual environments: sudo apt-get install python3-venv python3-dev Next, create a folder for your project and navigate into it: mkdir myappcd myapp Now, create a virtual environment: python3 -m venv venv And create a folder for your project: mkdir app Your project directory should now contain two items: app and venv. You can verify this using the standard Linux command to list directory contents: ls Expected output: myapp venv You need to activate the virtual environment so that all subsequent components are installed locally for the project: source venv/bin/activate Installing and Configuring Gunicorn Gunicorn (Green Unicorn) is a Python WSGI HTTP server for UNIX. It is compatible with various web frameworks, fast, easy to implement, and uses minimal server resources. To install Gunicorn, run the following command: pip install gunicorn WSGI and Python WSGI (Web Server Gateway Interface) is the standard interface between a Python application running on the server side and the web server itself, such as Nginx. A WSGI server interacts with the application, allowing you to run code when handling requests. Typically, the application is provided as an object named application in a Python module, which is made available to the server. In the standard wsgi.py file, there is usually a callable application. For example, let’s create such a file using the nano text editor: nano wsgi.py Add the following simple code to the file: from aiohttp import web async def index(request): return web.Response(text="Welcome home!") app = web.Application() app.router.add_get('/', index) In the code above, we import aiohttp, a library that provides an asynchronous HTTP client built on top of asyncio. HTTP requests are a classic example of where asynchronous handling is ideal, as they involve waiting for server responses, during which other code can execute efficiently. This library allows sequential requests to be made without waiting for the first response before sending a new one. It’s common to run aiohttp servers behind Nginx. Running the Gunicorn Server You can launch the server using the following command template: gunicorn [OPTIONS] [WSGI_APP] Here, [WSGI_APP] consists of $(MODULE_NAME):$(VARIABLE_NAME) and [OPTIONS] is a set of parameters for configuring Gunicorn. A simple command would look like this: gunicorn wsgi:app To restart Gunicorn, you can use: sudo systemctl restart gunicorn Systemd Integration systemd is a system and service manager that allows for strict control over processes, resources, and permissions. We’ll create a socket that systemd will listen to, automatically starting Gunicorn in response to traffic. Configuring the Gunicorn Service and Socket First, create the service configuration file: sudo nano /etc/systemd/system/gunicorn.service Add the following content to the file: [Unit] Description=gunicorn daemon Requires=gunicorn.socket After=network.target [Service] Type=notify User=someuser Group=someuser RuntimeDirectory=gunicorn WorkingDirectory=/home/someuser/myapp ExecStart=/path/to/venv/bin/gunicorn wsgi:app ExecReload=/bin/kill -s HUP $MAINPID KillMode=mixed TimeoutStopSec=5 PrivateTmp=true [Install] WantedBy=multi-user.target Make sure to replace /path/to/venv/bin/gunicorn with the actual path to the Gunicorn executable within your virtual environment. It will likely look something like this: /home/someuser/myapp/venv/bin/gunicorn. Next, create the socket configuration file: sudo nano /etc/systemd/system/gunicorn.socket Add the following content: [Unit] Description=gunicorn socket [Socket] ListenStream=/run/gunicorn.sock SocketUser=www-data [Install] WantedBy=sockets.target Enable and start the socket with: systemctl enable --now gunicorn.socket Configuring Gunicorn Let's review some useful parameters for Gunicorn in Python 3. You can find all possible parameters in the official documentation. Sockets -b BIND, --bind=BIND — Specifies the server socket. You can use formats like: $(HOST), $(HOST):$(PORT). Example: gunicorn --bind=127.0.0.1:8080 wsgi:app This command will run your application locally on port 8080. Worker Processes -w WORKERS, --workers=WORKERS — Sets the number of worker processes. Typically, this number should be between 2 to 4 per server core. Example: gunicorn --workers=2 wsgi:app Process Type -k WORKERCLASS, --worker-class=WORKERCLASS — Specifies the type of worker process to run. By default, Gunicorn uses the sync worker type, which is a simple synchronous worker that handles one request at a time. Other worker types may require additional dependencies. Asynchronous worker processes are available using Greenlets (via Eventlet or Gevent). Greenlets are a cooperative multitasking implementation for Python. The corresponding parameters are eventlet and gevent. We will use an asynchronous worker type compatible with aiohttp: gunicorn wsgi:app --bind localhost:8080 --worker-class aiohttp.GunicornWebWorker Access Logging You can enable access logging using the --access-logfile flag. Example: gunicorn wsgi:app --access-logfile access.log Error Logging To specify an error log file, use the following command: gunicorn wsgi:app --error-logfile error.log You can also set the verbosity level of the error log output using the --log-level flag. Available log levels in Gunicorn are: debug info warning error critical By default, the info level is set, which omits debug-level information. Installing and Configuring Nginx First, install Nginx with the command: sudo apt install nginx Let’s check if the Nginx service can connect to the socket created earlier: sudo -u www-data curl --unix-socket /run/gunicorn.sock http If successful, Gunicorn will automatically start, and you'll see the HTML code from the server in the terminal. Nginx configuration involves adding config files for virtual hosts. Each proxy configuration should be stored in the /etc/nginx/sites-available directory. To enable each proxy server, create a symbolic link to it in /etc/nginx/sites-enabled. When Nginx starts, it automatically loads all proxy servers in this directory. Create a new configuration file: sudo nano /etc/nginx/sites-available/myconfig.conf Then create a symbolic link with the command: sudo ln -s /etc/nginx/sites-available/myconfig.conf /etc/nginx/sites-enabled Nginx must be restarted after any changes to the configuration file to apply the new settings. First, check the syntax of the configuration file: nginx -t Then reload Nginx: nginx -s reload Conclusion Gunicorn is a robust and versatile WSGI server for deploying Python applications, offering flexibility with various worker types and integration options like Nginx for load balancing and reverse proxying. Its ease of installation and configuration, combined with detailed logging and scaling options, make it an excellent choice for production environments. By utilizing Gunicorn with frameworks like aiohttp and integrating it with Nginx, you can efficiently serve Python applications with improved performance and resource management.
23 October 2024 · 7 min to read

Do you have questions,
comments, or concerns?

Our professionals are available to assist you at any moment,
whether you need help or are just unsure of where to start.
Email us
Hostman's Support