The sys module exposes variables and functions that are tied directly to the Python interpreter itself, such as command-line arguments, the module search path, and standard input/output streams.

Syntax

import sys
sys.argv
sys.exit(1)
sys.path
sys.stdout

Deep Dive Course

sys.argv is a list of command-line arguments passed to the script, with the script's own name as the first element. sys.exit(code) terminates the program immediately, optionally with an exit status code that other programs or shell scripts can check. sys.path is the list of directories Python searches when resolving an import statement, and modifying it, rarely necessary, changes where imports are found. sys.stdout and sys.stderr give direct access to the standard output and error streams, which is what print() uses internally by default.

1Understanding sys Module

💡

Use a nonzero exit code to signal failure from a command-line script, and zero for success — many surrounding tools and CI pipelines check this exit code to decide whether the script succeeded.

editor.html

import sys
print(sys.argv)

localhost:3000

2Practical Example

Here is a real-world application of sys Module showing how it is used in production Python code.

editor.html

import sys

def main():
    if len(sys.argv) < 2:
        print("Usage: script.py <name>", file=sys.stderr)
        sys.exit(1)
    print(f"Hello, {sys.argv[1]}!")

main()

localhost:3000

3Best Practices

Follow these guidelines when working with sys Module:

1. Use sys.argv, or better, the argparse module, to accept command-line arguments in scripts instead of hardcoding values

2. Call sys.exit() with a nonzero code to signal failure from a script, so calling shells/CI pipelines can detect it

3. Print diagnostic or error messages to sys.stderr instead of standard output, so they don't get mixed into a program's normal piped output

⚠️

Tip: Use a nonzero exit code to signal failure from a command-line script, and zero for success — many surrounding tools and CI pipelines check this exit code to decide whether the script succeeded.

editor.html

import sys
print(sys.argv)

localhost:3000

Examples

Example 01Basic Usage

import sys
print(sys.argv)

Example 02Advanced Example

import sys

def main():
    if len(sys.argv) < 2:
        print("Usage: script.py <name>", file=sys.stderr)
        sys.exit(1)
    print(f"Hello, {sys.argv[1]}!")

main()

Best Practices

Use sys.argv, or better, the argparse module, to accept command-line arguments in scripts instead of hardcoding values
Call sys.exit() with a nonzero code to signal failure from a script, so calling shells/CI pipelines can detect it
Print diagnostic or error messages to sys.stderr instead of standard output, so they don't get mixed into a program's normal piped output

Interview Question

Why would a command-line script call sys.exit with a nonzero code instead of just letting the function return normally after printing an error?▼

Hint: Think about how other programs or shell scripts detect success or failure.

When a program finishes without calling sys.exit() explicitly, it exits with status code 0 by default, which conventionally means success. Shell scripts, CI pipelines, and other programs that invoke your script often check its exit code to decide what to do next — a nonzero exit code is the standard signal that something went wrong. Just printing an error message and returning normally would still report success, exit code 0, to anything checking that code, silently hiding the failure from automated tooling.

Exercises

MediumPractice using sys Module in a real scenario.

View Solution

import sys
print(sys.argv)

Frequently Asked Questions

Why would a command-line script call sys.exit with a nonzero code instead of just letting the function return normally after printing an error?▼

Related Functions

os-moduleprint()import-statement