Uvicorn server basics in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Uvicorn in the context of FastAPI?

Uvicorn is a lightweight, fast server that runs FastAPI applications. It handles incoming web requests and sends responses.

beginner

How do you start a FastAPI app using Uvicorn from the command line?

Use the command: uvicorn main:app --reload where main is the Python file and app is the FastAPI instance.

beginner

What does the --reload option do when running Uvicorn?

It makes the server restart automatically when you change your code, so you don't have to stop and start it manually.

intermediate

Why is Uvicorn considered an ASGI server?

Because it supports ASGI (Asynchronous Server Gateway Interface), allowing FastAPI to handle asynchronous code efficiently.

beginner

How can you specify a different host and port when running Uvicorn?

Add options like --host 0.0.0.0 --port 8080 to the command to change where the server listens.

What command starts a FastAPI app with Uvicorn and auto-reloads on code changes?

A uvicorn main:app --reload

B python main.py

C fastapi run main.py

D uvicorn main:app --no-reload

The --reload flag enables auto-reloading, and uvicorn main:app runs the FastAPI app.

What does Uvicorn primarily do?

A Compiles Python code

B Runs FastAPI apps as a web server

C Manages databases

D Creates HTML templates

Uvicorn is a server that runs FastAPI apps and handles web requests.

Which protocol does Uvicorn support to handle asynchronous Python code?

A ASGI

B WSGI

C HTTP/1.0

D FTP

Uvicorn supports ASGI, which is designed for asynchronous Python web apps.

How do you change the port Uvicorn listens on?

A --debug

B --host 127.0.0.1

C --reload

D --port 8080

Use --port followed by the port number to change the listening port.

What happens if you omit the --reload flag when running Uvicorn?

A The server runs in debug mode

B The server will crash

C The server won't restart automatically on code changes

D The server listens on a random port

Without --reload, you must restart the server manually after code changes.

Explain how to run a FastAPI app using Uvicorn and why the --reload option is useful.

Think about how you test changes quickly during development.

Describe what makes Uvicorn suitable for running FastAPI apps compared to older servers.

Focus on how Uvicorn handles modern Python async features.

Practice

1. What is the main purpose of running uvicorn with a FastAPI app?

easy

A. To start a server that handles web requests for the FastAPI app

B. To compile the FastAPI app into an executable file

C. To create a database connection for the FastAPI app

D. To generate API documentation automatically

Solution

1. Step 1: Understand what Uvicorn does

   Uvicorn is an ASGI server that runs your FastAPI app so it can receive and respond to web requests.

2. Step 2: Identify the purpose of running Uvicorn

   Running Uvicorn starts the server that listens for HTTP requests and sends responses from your FastAPI app.

3. Final Answer:

   To start a server that handles web requests for the FastAPI app -> Option A

4. Quick Check:

   Uvicorn runs server = A [OK]

Hint: Remember: Uvicorn runs the server for your app [OK]

Common Mistakes:

• Thinking Uvicorn compiles code
• Confusing server start with database setup
• Assuming Uvicorn generates docs automatically

2. Which of the following is the correct command to run a FastAPI app located in main.py with auto-reload enabled?

easy

A. uvicorn main:app reload

B. uvicorn main:app --reload

C. uvicorn app:main --reload

D. uvicorn main.py --reload

Solution

1. Step 1: Understand Uvicorn command syntax

   The correct syntax is uvicorn module_name:app_variable. Here, the module is main and the app variable is app.

2. Step 2: Check the options for auto-reload

   The option --reload enables auto-reload during development.

3. Final Answer:

   uvicorn main:app --reload -> Option B

4. Quick Check:

   Correct syntax with --reload = D [OK]

Hint: Use module:app format with --reload flag [OK]

Common Mistakes:

• Including .py extension in module name
• Swapping module and app names
• Missing double dashes before reload

3. Given this command: uvicorn app.main:app --host 0.0.0.0 --port 8080, what will be the effect?

medium

A. The app runs on localhost at port 80

B. The app runs only on 127.0.0.1 at port 8080

C. The app runs on all network interfaces at port 8080

D. The app runs on all interfaces at default port 8000

Solution

1. Step 1: Analyze the host option

   The host 0.0.0.0 means the server listens on all network interfaces, not just localhost.

2. Step 2: Analyze the port option

   The port is explicitly set to 8080, so the app will listen on port 8080.

3. Final Answer:

   The app runs on all network interfaces at port 8080 -> Option C

4. Quick Check:

   Host 0.0.0.0 + port 8080 = C [OK]

Hint: 0.0.0.0 means all interfaces, port sets listening port [OK]

Common Mistakes:

• Assuming 0.0.0.0 means localhost only
• Ignoring the port option
• Confusing default port 8000 with specified port

4. You run uvicorn main:app --reload but get an error: ModuleNotFoundError: No module named 'main'. What is the likely cause?

medium

A. The app variable is not named app inside main.py

B. Uvicorn requires Python 2, but you have Python 3

C. The --reload flag is not supported on your system

D. The file main.py is missing or not in the current directory

Solution

1. Step 1: Understand the error message

   The error says the module main cannot be found, meaning Python can't locate main.py.

2. Step 2: Check file location

   If main.py is missing or not in the current directory where the command runs, this error occurs.

3. Final Answer:

   The file main.py is missing or not in the current directory -> Option D

4. Quick Check:

   ModuleNotFoundError means missing file/module = B [OK]

Hint: Check if main.py exists in current folder [OK]

Common Mistakes:

• Assuming app variable name causes ModuleNotFoundError
• Blaming --reload flag for module errors
• Confusing Python version requirements

5. You want to run your FastAPI app with Uvicorn so it reloads on code changes and listens only on localhost at port 5000. Which command is correct?

hard

A. uvicorn app:app --reload --host 127.0.0.1 --port 5000

B. uvicorn app:app --reload --host 0.0.0.0 --port 5000

C. uvicorn app:app --host 127.0.0.1 --port 5000

D. uvicorn app:app --reload --port 127.0.0.1 --host 5000

Solution

1. Step 1: Identify the reload option

   The --reload flag enables auto-reload on code changes, so it must be included.

2. Step 2: Set host and port correctly

   Listening only on localhost means host should be 127.0.0.1. The port must be set to 5000 using --port 5000.

3. Step 3: Check option order and syntax

   Options order does not affect functionality, but the syntax must be correct: --host followed by IP, --port followed by port number.

4. Final Answer:

   uvicorn app:app --reload --host 127.0.0.1 --port 5000 -> Option A

5. Quick Check:

   Reload + localhost + port 5000 = A [OK]

Hint: Use --reload with --host 127.0.0.1 and --port 5000 [OK]

Common Mistakes:

• Using 0.0.0.0 for localhost only
• Swapping host and port values
• Omitting --reload for auto-reload