Debugging Python in Docker: A Tutorial for Inexperienced persons

Picture by Writer | Ideogram

# Introduction

 
Docker has simplified how we develop, ship, and run purposes by offering constant environments throughout completely different methods. Nonetheless, this consistency comes with a trade-off: debugging turns into deceptively advanced for newcomers when your purposes — together with Python purposes — are working inside Docker containers.

For these new to Docker, debugging Python purposes can really feel like attempting to repair a automobile with the hood welded shut. You recognize one thing’s unsuitable, however you may’t fairly see what’s occurring inside.

This beginner-friendly tutorial will train you tips on how to get began with debugging Python in Docker.

# Why is Debugging in Docker Completely different?

 
Earlier than we dive in, let’s perceive why Docker makes debugging difficult. While you’re working Python domestically in your machine, you may:

• See error messages instantly
• Edit recordsdata and run them once more
• Use your favourite debugging instruments
• Verify what recordsdata exist and what’s in them

However when Python runs inside a Docker container, it is usually trickier and fewer direct, particularly for those who’re a newbie. The container has its personal file system, its personal setting, and its personal working processes.

# Setting Up Our Instance

 
Let’s begin with a easy Python program that has a bug. Don’t be concerned about Docker but; let’s first perceive what we’re working with.

Create a file known as app.py:

def calculate_sum(numbers):
    complete = 0
    for num in numbers:
        complete += num
        print(f"Including {num}, complete is now {complete}")
    return complete

def important():
    numbers = [1, 2, 3, 4, 5]
    outcome = calculate_sum(numbers)
    print(f"Ultimate outcome: {outcome}")
    
    # This line will trigger our program to crash!
    division_result = 10 / 0
    print(f"Division outcome: {division_result}")

if __name__ == "__main__":
    important()

Should you run this usually with python3 app.py, you may see it calculates the sum accurately however then crashes with a “division by zero” error. Straightforward to identify and repair, proper?

Now let’s see what occurs when this easy software runs inside a Docker container.

# Creating Your First Docker Container

 
We have to inform Docker tips on how to bundle our Python program. Create a file known as `Dockerfile`:

FROM python:3.11-slim

WORKDIR /app

COPY app.py .

CMD ["python3", "app.py"]

Let me clarify every line:

• FROM python:3.11-slim tells Docker to begin with a pre-made Linux system that already has Python put in
• WORKDIR /app creates an `/app` folder contained in the container and units it because the working listing
• COPY app.py . copies your app.py file out of your pc into the `/app` folder contained in the container
• CMD ["python3", "app.py"] tells Docker what command to run when the container begins

Now let’s construct and run this container:

docker construct -t my-python-app .
docker run my-python-app

You will see the output, together with the error, however then the container stops and exits. This leaves you to determine what went unsuitable contained in the remoted container.

# 1. Operating an Interactive Debugging Session

 
The primary debugging ability you want is studying tips on how to get inside a working container and verify for potential issues.

As a substitute of working your Python program instantly, let’s begin the container and get a command immediate inside it:

docker run -it my-python-app /bin/bash

Let me break down these new flags:

• -i means “interactive” — it retains the enter stream open so you may sort instructions
• -t allocates a “pseudo-TTY” — mainly, it makes the terminal work correctly
• /bin/bash overrides the traditional command and offers you a bash shell as a substitute

Now that you’ve a terminal contained in the container, you may run instructions like so:

# See what listing you are in
pwd

# Checklist recordsdata within the present listing
ls -la

# Have a look at your Python file
cat app.py

# Run your Python program
python3 app.py

You will additionally see the error:

root@fd1d0355b9e2:/app# python3 app.py
Including 1, complete is now 1
Including 2, complete is now 3
Including 3, complete is now 6
Including 4, complete is now 10
Including 5, complete is now 15
Ultimate outcome: 15
Traceback (most up-to-date name final):
  File "/app/app.py", line 18, in 
    important()
  File "/app/app.py", line 14, in important
    division_result = 10 / 0
                      ~~~^~~
ZeroDivisionError: division by zero

Now you may:

• Edit the file proper right here within the container (although you may want to put in an editor first)
• Discover the setting to know what’s completely different
• Take a look at small items of code interactively

Repair the division by zero error (possibly change `10 / 0` to `10 / 2`), save the file, and run it once more.

The issue is fastened. While you exit the container, nevertheless, you lose observe of adjustments you made. This brings us to our subsequent approach.

# 2. Utilizing Quantity Mounting for Reside Edits

 
Would not it’s good for those who might edit recordsdata in your pc and have these adjustments robotically seem contained in the container? That is precisely what quantity mounting does.

docker run -it -v $(pwd):/app my-python-app /bin/bash

The brand new half right here is -v $(pwd):/app:

• $(pwd) outputs the present listing path.
• :/app maps your present listing to /app contained in the container.
• Any file you alter in your pc instantly adjustments contained in the container too.

Now you may:

1. Edit app.py in your pc utilizing your favourite editor
2. Contained in the container, run python3 app.py to check your adjustments
3. Maintain enhancing and testing till it really works

Here is a pattern output after altering the divisor to 2:

root@3790528635bc:/app# python3 app.py
Including 1, complete is now 1
Including 2, complete is now 3
Including 3, complete is now 6
Including 4, complete is now 10
Including 5, complete is now 15
Ultimate outcome: 15
Division outcome: 5.0

That is helpful since you get to make use of your acquainted enhancing setting in your pc and the very same setting contained in the container as effectively.

# 3. Connecting a Distant Debugger from Your IDE

 
Should you’re utilizing an Built-in Growth Atmosphere (IDE) like VS Code or PyCharm, you may really join your IDE’s debugger on to code working inside a Docker container. This provides you the complete energy of your IDE’s debugging instruments.

Edit your `Dockerfile` like so:

FROM python:3.11-slim

WORKDIR /app

# Set up the distant debugging library
RUN pip set up debugpy

COPY app.py .

# Expose the port that the debugger will use
EXPOSE 5678

# Begin this system with debugger assist
CMD ["python3", "-m", "debugpy", "--listen", "0.0.0.0:5678", "--wait-for-client", "app.py"]

What this does:

• pip set up debugpy installs Microsoft’s debugpy library.
• EXPOSE 5678 tells Docker that our container will use port 5678.
• The CMD begins our program by the debugger, listening on port 5678 for a connection. No adjustments to your Python code are wanted.

Construct and run the container:

docker construct -t my-python-app .
docker run -p 5678:5678 my-python-app

The -p 5678:5678 maps port 5678 from contained in the container to port 5678 in your pc.

Now in VS Code, you may arrange a debug configuration (in .vscode/launch.json) to hook up with the container:

{
    "model": "0.2.0",
    "configurations": [
        {
            "name": "Python: Remote Attach",
            "type": "python",
            "request": "attach",
            "connect": {
                "host": "localhost",
                "port": 5678
            }
        }
    ]
}

While you begin debugging in VS Code, it would hook up with your container, and you’ll set breakpoints, examine variables, and step by code identical to you’d with native code.

# Frequent Debugging Issues and Options

 
⚠️ “My program works on my pc however not in Docker”

This normally means there is a distinction within the setting. Verify:

• Python model variations.
• Lacking dependencies.
• Completely different file paths.
• Atmosphere variables.
• File permissions.

⚠️ “I am unable to see my print statements”

• Use python -u to keep away from output buffering.
• Ensure you’re working with -it in order for you interactive output.
• Verify in case your program is definitely working as meant (possibly it is exiting early).

⚠️ “My adjustments aren’t displaying up”

• Ensure you’re utilizing quantity mounting (-v).
• Verify that you simply’re enhancing the proper file.
• Confirm the file is copied into the container.

⚠️ “The container exits instantly”

• Run with /bin/bash to examine the container’s state.
• Verify the error messages with docker logs container_name.
• Make certain your CMD within the Dockerfile is appropriate.

# Conclusion

 
You now have a fundamental toolkit for debugging Python in Docker:

1. Interactive shells (docker run -it ... /bin/bash) for exploring and fast fixes
2. Quantity mounting (-v $(pwd):/app) for enhancing in your native file system
3. Distant debugging for utilizing your IDE’s full capabilities

After this, you may strive utilizing Docker Compose for managing advanced purposes. For now, begin with these easy methods. Most debugging issues may be solved simply by getting contained in the container and poking round.

The secret’s to be methodical: perceive what ought to be occurring, work out what is definitely occurring, after which bridge the hole between the 2. Completely satisfied debugging!
 
 

Bala Priya C is a developer and technical author from India. She likes working on the intersection of math, programming, information science, and content material creation. Her areas of curiosity and experience embrace DevOps, information science, and pure language processing. She enjoys studying, writing, coding, and occasional! At the moment, she’s engaged on studying and sharing her data with the developer neighborhood by authoring tutorials, how-to guides, opinion items, and extra. Bala additionally creates partaking useful resource overviews and coding tutorials.