docker-compose not printing stdout in Python app

PythonDockerDocker Compose

Python Problem Overview


When using a print() statement in a Python app running inside a Docker container that's managed by Docker Compose, only sys.stderr output is logged. Vanilla print() statements aren't seen, so this:

print("Hello? Anyone there?")

... never shows up in the regular logs:

enter image description here

(You can see other logs explicitly printed by other libs in my app, but none of my own calls.)

How can I avoid my print() calls being ignored?

Python Solutions


Solution 1 - Python

By default, Python buffers output to sys.stdout.

There are a few options:

1. Call an explicit flush

Refactor the original print statement to include a flush=True keyword, like:

print("Hello? Anyone there?", flush=True)

Note: This will cause the entire buffer to flush, not just the same print call. So if there are 'bare' print function calls elsewhere (i.e. without flush=True) that weren't explicitly unbuffered, these will always be flushed too.

You could achieve the same thing with:

import sys
sys.stdout.flush()

This option is useful if you want the most control of when the flushing will occur.

2. Unbuffer the entire app via the PYTHONUNBUFFERED env var

Drop the following into the environment section of your docker-compose.yml file:

PYTHONUNBUFFERED: 1

This will cause all output to stdout to be flushed immediately.

3. Run python with -u

Like option #2 above, this will cause Python to run 'unbuffered' across the full execution lifetime of your app. Just run with python -u <entrypoint.py> - no need for the environment variable.

Solution 2 - Python

Simple, if you add the option -u in the line of the Dockerfile it will print your logs:

CMD ["python", "-u", "my_python_script.py"]

No need of changing an environment variable or change all the prints statements of your program.

Solution 3 - Python

Using pytest, the solution for me was to add the -s option.

For example, in my scenario where I also needed verbose mode on, I had to put pytest -sv.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionLee BensonView Question on Stackoverflow
Solution 1 - PythonLee BensonView Answer on Stackoverflow
Solution 2 - PythonIgnacio PeletierView Answer on Stackoverflow
Solution 3 - PythonAndreaView Answer on Stackoverflow