How to Use subprocess.Popen in Python: Syntax and Examples

Use subprocess.Popen in Python to start a new process and interact with it. You create a Popen object with the command and options, then use methods like communicate() to send input and get output.

Syntax

The basic syntax of subprocess.Popen is creating a Popen object with the command and optional parameters.

• args: The command to run, as a list or string.
• stdin, stdout, stderr: Control input/output streams.
• shell: Whether to run the command through the shell.
• text: If True, input/output are strings instead of bytes.

python

p = subprocess.Popen(args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=False, text=True)

Example

This example runs the echo command to print a message, captures the output, and prints it in Python.

python

import subprocess

# Start the process
process = subprocess.Popen(['echo', 'Hello from Popen!'], stdout=subprocess.PIPE, text=True)

# Get the output and wait for the process to finish
output, _ = process.communicate()

print('Output:', output.strip())

Output

Output: Hello from Popen!

Common Pitfalls

Common mistakes when using subprocess.Popen include:

• Not using communicate() to read output, which can cause deadlocks.
• Forgetting to set text=True to get string output instead of bytes.
• Using shell=True unnecessarily, which can be a security risk.
• Not handling errors or checking the process exit code.

python

import subprocess

# Wrong: reading output without communicate (can hang)
# process = subprocess.Popen(['ls'], stdout=subprocess.PIPE)
# output = process.stdout.read()  # May cause deadlock

# Right: use communicate()
process = subprocess.Popen(['ls'], stdout=subprocess.PIPE, text=True)
output, _ = process.communicate()
print(output)

Quick Reference

Parameter	Description
args	Command and arguments to run (list or string)
stdin	Standard input stream (e.g., subprocess.PIPE)
stdout	Standard output stream (e.g., subprocess.PIPE)
stderr	Standard error stream (e.g., subprocess.PIPE)
shell	Run command through shell if True (use carefully)
text	If True, input/output are strings, not bytes
communicate()	Method to send input and read output safely

Key Takeaways

Use subprocess.Popen to start and control external processes in Python.

Always use communicate() to safely read output and avoid deadlocks.

Set text=True to work with strings instead of bytes for input/output.

Avoid shell=True unless necessary to reduce security risks.

Check process exit codes to handle errors properly.