Python Subprocess Library

Python Subprocess Library is a A single executable, or sequence of executable and arguments. Learn More about it here.

Parameter Details
A single executable, or sequence of executable and arguments - ,
args
'ls' ['ls', '-la']
Run under a shell? The default shell to on POSIX.
shell
/bin/sh
Working directory of the child process.
cwd

Python Subprocess Library: More flexibility with Popen

Using subprocess.Popen give more fine-grained control over launched processes than subprocess.call.

Launching a subprocess

process = subprocess.Popen([r'C:\path\to\app.exe', 'arg1', '--flag', 'arg'])

The signature for Popen is very similar to the call function; however, Popen will return immediately instead of waiting for the subprocess to complete like call does.

Waiting on a subprocess to complete

process = subprocess.Popen([r'C:\path\to\app.exe', 'arg1', '--flag', 'arg'])
process.wait()

Reading output from a subprocess

process = subprocess.Popen([r'C:\path\to\app.exe'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)

This will block until process completes stdout, stderr = process.communicate() print stdout
print stderr

Interactive access to running subprocesses

You can read and write on stdin and stdout even while the subprocess hasn’t completed. This could be useful when automating functionality in another program.

Writing to a subprocess

process = subprocess.Popen([r'C:\path\to\app.exe'], stdout = subprocess.PIPE, stdin = subprocess.PIPE)

process.stdin.write('line of input\n') # Write input
line = process.stdout.readline() # Read a line from stdout

Do logic on line read.

However, if you only need one set of input and output, rather than dynamic interaction, you should use communicate() rather than directly accessing stdin and stdout.

Reading a stream from a subprocess

In case you want to see the output of a subprocess line by line, you can use the following snippet:

process = subprocess.Popen(, stdout=subprocess.PIPE)
while process.poll() is None:
output_line = prrocess.stdout.readline()

in the case the subcommand output do not have EOL character, the above snippet does not work. You can then read the output character by character as follows:

process = subprocess.Popen(, stdout=subprocess.PIPE)
while process.poll() is None:
output_line = process.stdout.read(1)

The 1 specified as argument to the read method tells read to read 1 character at time. You can specify to read as many characters you want using a different number. Negative number or 0 tells to read to read as a single string until the EOF is encountered (see here).

In both the above snippets, the process.poll() is None until the subprocess finishes. This is used to exit the loop once there is no more output to read.

The same procedure could be applied to the stderr of the subprocess.

Python Subprocess Library: Calling External Commands

The simplest use case is using the subprocess.call function. It accepts a list as the first argument. The first item in the list should be the external application you want to call. The other items in the list are arguments that will be passed to that application.

subprocess.call([r'C:\path\to\app.exe', 'arg1', '--flag', 'arg'])

For shell commands, set shell=True and provide the command as a string instead of a list.

subprocess.call('echo "Hello, world"', shell=True)

Note that the two command above return only the exit status of the subprocess. Moreover, pay attention when using shell=True since it provides security issues (see here).

If you want to be able to get the standard output of the subprocess, then substitute the subprocess.call with subprocess.check_output. For more advanced use, refer to this.

How to create the command list argument

The subprocess method that allows running commands needs the command in form of a list (at least using shell_mode=True).

The rules to create the list are not always straightforward to follow, especially with complex commands. Fortunately, there is a very helpful tool that allows doing that: shlex. The easiest way of creating the list to be used as command is the following:

import shlex
cmd_to_subprocess = shlex.split(command_used_in_the_shell)

A simple example:

import shlex
shlex.split('ls --color -l -t -r')
out: ['ls', '--color', '-l', '-t', '-r']

Learn More

Must Read Python Interview Questions

• 165+ Python Interview Questions & Answers

200+ Python Tutorials With Coding Examples

Python Language Basics Tutorial	Python String Representations of Class Instances
Python For Beginners Tutorial	Python Debugging Tutorial
Python Data Types Tutorial	Reading and Writing CSV File Using Python
Python Indentation Tutorial	Writing to CSV in Python from String/List
Python Comments and Documentation Tutorial	Python Dynamic Code Execution Tutorial
Python Date And Time Tutorial	Python Code Distributing using Pyinstaller
Python Date Formatting Tutorial	Python Data Visualization Tutorial
Python Enum Tutorial	Python Interpreter Tutorial
Python Set Tutorial	Python Args and Kwargs
Python Mathematical Operators Tutorial	Python Garbage Collection Tutorial
Python Bitwise Operators Tutorial	Python Pickle Data Serialisation
Python Bolean Operators Tutorial	Python Binary Data Tutorial
Python Operator Precedance Tutorial	Python Idioms Tutorial
Python Variable Scope And Binding Tutorial	Python Data Serialization Tutorial
Python Conditionals Tutorial	Python Multiprocessing Tutorial
Python Comparisons Tutorial	Python Multithreading Tutorial
Python Loops Tutorial	Python Processes and Threads
Python Arrays Tutorial	Python Concurrency Tutorial
Python Multidimensional Arrays Tutorial	Python Parallel Computation Tutorial
Python List Tutorial	Python Sockets Module Tutorial
Python List Comprehensions Tutorial	Python Websockets Tutorial
Python List Slicing Tutorial	Sockets Encryption Decryption in Python
Python Grouby() Tutorial	Python Networking Tutorial
Python Linked Lists Tutorial	Python http Server Tutorial
Linked List Node Tutorial	Python Flask Tutorial
Python Filter Tutorial	Introduction to Rabbitmq using Amqpstorm Python
Python Heapq Tutorial	Python Descriptor Tutorial
Python Tuple Tutorial	Python Tempflile Tutorial
Python Basic Input And Output Tutorial	Input Subset and Output External Data Files using Pandas in Python
Python Files And Folders I/O Tutorial	Unzipping Files in Python Tutorial
Python os.path Tutorial	Working with Zip Archives in Python
Python Iterables And Iterators Tutorial	gzip in Python Tutorial
Python Functions Tutorial	Stack in Python Tutorial
Defining Functions With List Arguments In Python	Working with Global Interpreter Lock (GIL)
Functional Programming In Python	Python Deployment Tutorial
Partial Functions In Python	Python Logging Tutorial
Decorators Function In Python	Python Server Sent Events Tutorial
Python Classes Tutorial	Python Web Server Gateway Interface (WSGI)
Python Metaclasses Tutorial	Python Alternatives to Switch Statement
Python String Formatting Tutorial	Python Packing and Unpacking Tutorial
Python String Methods Tutorial	Accessing Python Sourcecode and Bytecode
Using Loops Within Functions In Python	Python Mixins Tutorial
Python Importing Modules Tutorial	Python Attribute Access Tutorial
Difference Betweeb Module And Package In Python	Python Arcpy Tutorial
Python Math Module Tutorial	Python Abstract Base Class Tutorial
Python Complex Math Tutorial	Python Plugin and Extension Classes
Python Collections Module Tutorial	Python Immutable Datatypes Tutorial
Python Operator Module Tutorial	Python Incompatibilities Moving from Python 2 to Python 3
Python JSON Module Tutorial	Python 2to3 Tool Tutorial
Python Sqlite3 Module Tutorial	Non-Official Python implementations
Python os Module Tutorial	Python Abstract Syntax Tree
Python Locale Module Tutorial	Python Unicode and Bytes
Python Itertools Module Tutorial	Python Serial Communication (pyserial)
Python Asyncio Module Tutorial	Neo4j and Cypher using Py2Neo
Python Random Module Tutorial	Basic Curses with Python
Python Functools Module Tutorial	Templates in Python
Python dis Module Tutorial	Python Pillow
Python Base64 Module Tutorial	Python CLI subcommands with precise help output
Python Queue Module Tutorial	Python Database Access
Python Deque Module Tutorial	Connecting Python to SQL Server
Python Webbrowser Module Tutorial	Python and Excel
Python tkinter Tutorial	Python Turtle Graphics
Python pyautogui Module Tutorial	Python Persistence
Python Indexing And Slicing Tutorial	Python Design Patterns
Python Plotting With Matplotlib Tutorial	Python hashlib
Python Graph Tool Tutorial	Creating a Windows Service Using Python
Python Generators Tutorial	Mutable vs Immutable (and Hashable) in Python
Python Reduce Tutorial	Python configparser
Python Map Function Tutorial	Python Optical Character Recognition
Python Exponentiation Tutorial	Python Virtual Environments
Python Searching Tutorial	Python Virtual Environment – virtualenv
Sorting Minimum And Maximum In Python	Python Virtual environment with virtualenvwrapper
Python Print Function Tutorial	Create virtual environment with virtualenvwrapper in windows
Python Regular Expressions Regex Tutorial	Python sys Tutorial
Copying Data In Python Tutorial	ChemPy – Python package
Python Context Managers (“with” Statement) Tutorial	Python pygame
Python Name Special Variable Tutorial	Python pyglet
Checking Path Existence And Permissions In Python	Working with Audio in Python
Creating Python Packages Tutorial	Python pyaudio
Usage of pip Module In Python Tutorial	Python shelve
Python PyPi Package Manager Tutorial	IoT Programming with Python and Raspberry PI
Parsing Command Line Arguments In Python	kivy – Cross-platform Python Framework for NUI Development
Python Subprocess Library Tutorial	Pandas Transform
Python setup.py Tutorial	Python vs. JavaScript
Python Recursion Tutorial	Call Python from C#
Python Type Hints Tutorial	Python Writing Extensions
Python Exceptions Tutorial	Python Lex-Yacc
Raise Custom Exceptions In Python	Python Unit Testing
Python Commonwealth Exceptions Tutorial	Python py.test
Python urllib Tutorial	Python Profiling
Web Scraping With Python Tutorial	Python Speed of Program
Python HTML Parsing Tutorial	Python Performance Optimization
Manipulating XML In Python	Python Security and Cryptography
Python Requests Post Tutorial	Secure Shell Connection in Python
Python Distribution Tutorial	Python Anti Patterns
Python Property Objects Tutorial	Python Common Pitfalls
Python Overloading Tutorial	Python Hidden Features
Python Polymorphism Tutorial	Python For Machine Learning
Python Method Overriding Tutorial	Python Interview Questions And Answers For Experienced
Python User Defined Methods Tutorial	Python Coding Interview Questions And Answers

Other Python Tutorials

• What is Python?
• Python Advantages
• Python For Beginners
• Python For Machine Learning
• Machine Learning For Beginners
• 130+ Python Projects With Source Code On GitHub