Python OS Module – Use Underlying Operating System Functionality

Click to share! ⬇️

Welcome to this tutorial on the Python OS module! The OS module is a powerful tool that allows you to interact with and utilize the functionality of the underlying operating system. Whether you’re working with files and directories, managing processes, or handling environment variables, the OS module offers a variety of functions to make your life easier as a developer.

How To Import the Python OS Module
How To Navigate the File System with Python OS
How To Create, Rename, and Delete Files and Directories
How To Check File and Directory Permissions
How To Change File and Directory Permissions
How To Execute System Commands and Programs
How To Work with Environment Variables
How To Manage Processes Using the Python OS Module
How To Use the Python OS Path Module for Path Manipulation
How To Handle OS-Specific Features and Compatibility Issues

In this tutorial, we’ll explore the different ways you can use the Python OS module to leverage operating system functionality. As you progress, you’ll gain a deeper understanding of how Python can interact with the OS and how you can use these interactions to create more powerful and versatile applications. We’ll cover topics like navigating the file system, executing system commands, managing processes, and handling OS-specific features.

By the end of this tutorial, you’ll have a solid foundation in using the Python OS module and will be equipped with the skills to write scripts and applications that can effectively utilize the capabilities of the underlying operating system. So, let’s dive in and start learning about the Python OS module!

How To Import the Python OS Module

Before you can start using the Python OS module, you’ll need to import it into your Python script or application. The OS module is a part of Python’s standard library, which means you don’t need to install any additional packages to use it. Importing the OS module is as simple as using the import statement. Here’s how to do it:

import os

With this single line of code, you’ve imported the OS module and made its functionality available for use in your script. Now, you can access the various functions and methods provided by the OS module by using the os namespace.

For example, if you want to use the os.getcwd() function to get the current working directory, you would write:

import os

current_working_directory = os.getcwd()
print("Current working directory:", current_working_directory)

This code imports the OS module, retrieves the current working directory using the os.getcwd() function, and then prints the result.

As you proceed through the tutorial, you’ll learn more about the different functions and methods available in the OS module and how you can use them to interact with the underlying operating system.

How To Navigate the File System with Python OS

The Python OS module provides several functions that allow you to navigate and interact with the file system. In this section, we’ll cover some of the most commonly used functions to help you work with files and directories.

Get the current working directory

To retrieve the current working directory, use the os.getcwd() function:

import os

current_working_directory = os.getcwd()
print("Current working directory:", current_working_directory)

Change the current working directory

To change the current working directory, use the os.chdir() function and provide the target directory as an argument:

import os

os.chdir("/path/to/your/target/directory")

List files and directories in a directory

To list the contents of a directory, use the os.listdir() function. By default, it lists the contents of the current working directory, but you can provide a path as an argument to list the contents of a specific directory:

import os

directory_contents = os.listdir()
print("Contents of the current working directory:", directory_contents)

specific_directory_contents = os.listdir("/path/to/your/target/directory")
print("Contents of the specific directory:", specific_directory_contents)

Create a new directory

To create a new directory, use the os.mkdir() function and provide the name of the new directory as an argument:

import os

os.mkdir("new_directory")

Create nested directories

To create nested directories, use the os.makedirs() function and provide the path of the nested directories as an argument:

import os

os.makedirs("parent_directory/child_directory")

Remove a directory

To remove an empty directory, use the os.rmdir() function and provide the name of the directory as an argument:

import os

os.rmdir("empty_directory")

Remove a directory with contents

To remove a directory along with its contents, use the shutil.rmtree() function from the shutil module:

import os
import shutil

shutil.rmtree("directory_with_contents")

These are some basic functions provided by the Python OS module to navigate and interact with the file system. As you continue exploring the OS module, you’ll find even more functions to work with files and directories, manage file permissions, and interact with the operating system in various ways.

How To Create, Rename, and Delete Files and Directories

The Python OS module provides various functions that allow you to create, rename, and delete files and directories. In this section, we’ll explore some of the most commonly used functions for these tasks.

Create a new file

To create a new file, you can use the open() function with the ‘w’ (write) mode. If the file does not exist, it will be created:

with open("new_file.txt", "w") as file:
    file.write("This is a new file.")

Rename a file or directory

To rename a file or directory, use the os.rename() function, providing the current name and the new name as arguments:

import os

os.rename("old_file.txt", "new_file.txt")
os.rename("old_directory", "new_directory")

Delete a file

To delete a file, use the os.remove() function, providing the file name as an argument:

import os

os.remove("file_to_delete.txt")

Create a new directory

To create a new directory, use the os.mkdir() function, providing the directory name as an argument:

import os

os.mkdir("new_directory")

Create nested directories

To create nested directories, use the os.makedirs() function, providing the path of the nested directories as an argument:

import os

os.makedirs("parent_directory/child_directory")

Rename a directory

Renaming a directory is the same as renaming a file, using the os.rename() function:

import os

os.rename("old_directory_name", "new_directory_name")

Remove an empty directory

To remove an empty directory, use the os.rmdir() function, providing the directory name as an argument:

import os

os.rmdir("empty_directory")

Remove a directory with contents

To remove a directory along with its contents, use the shutil.rmtree() function from the shutil module:

import os
import shutil

shutil.rmtree("directory_with_contents")

These functions give you the ability to create, rename, and delete files and directories using the Python OS module. With these tools, you can create scripts and applications that interact with the file system and manage files and directories effectively.

How To Check File and Directory Permissions

File and directory permissions are essential for controlling access to resources on your operating system. The Python OS module provides functions to check and manage these permissions. In this section, we’ll cover how to check file and directory permissions using the OS module.

Check file or directory permissions with os.stat()

To check the permissions of a file or directory, you can use the os.stat() function. This function returns an object containing various attributes, including permissions:

import os

file_stat = os.stat("file.txt")
print("File permissions:", oct(file_stat.st_mode)[-3:])

In the example above, os.stat() is used to retrieve the metadata of a file, and the file permissions are displayed in octal representation (for example, ‘644’ or ‘755’).

Check if a file or directory is readable, writable, or executable

You can use the following functions to check if a file or directory is readable, writable, or executable:

os.access(path, os.R_OK): Check if the file is readable
os.access(path, os.W_OK): Check if the file is writable
os.access(path, os.X_OK): Check if the file is executable

Here’s an example:

import os

file_path = "file.txt"

if os.access(file_path, os.R_OK):
    print("The file is readable")
else:
    print("The file is not readable")

if os.access(file_path, os.W_OK):
    print("The file is writable")
else:
    print("The file is not writable")

if os.access(file_path, os.X_OK):
    print("The file is executable")
else:
    print("The file is not executable")

This code checks the readability, writability, and executability of a file and prints the results.

By using the Python OS module, you can easily check file and directory permissions and ensure that your scripts and applications are interacting with resources securely and as intended.

How To Change File and Directory Permissions

Changing file and directory permissions is essential when you need to manage access to resources on your operating system. The Python OS module provides functions to change these permissions. In this section, we’ll cover how to change file and directory permissions using the OS module.

Change file or directory permissions with os.chmod()

To change the permissions of a file or directory, use the os.chmod() function, providing the path and the new permissions as arguments. Permissions are usually represented in octal notation, such as 0o644 or 0o755.

Here’s an example of changing the permissions of a file to read and write for the owner, read for the group, and read for others (octal: 0o644):

import os

file_path = "file.txt"
new_permissions = 0o644

os.chmod(file_path, new_permissions)

Change file or directory permissions using symbolic constants

Instead of using octal notation, you can use symbolic constants provided by the stat module, which makes your code more readable. Here’s an example of using symbolic constants to change file permissions:

import os
import stat

file_path = "file.txt"

# Read and write for the owner, read for the group and others
new_permissions = stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP | stat.S_IROTH

os.chmod(file_path, new_permissions)

Add or remove specific permissions

You can also add or remove specific permissions without changing the others. To do this, first retrieve the current permissions using os.stat(), modify them, and then apply the new permissions using os.chmod():

import os
import stat

file_path = "file.txt"
file_stat = os.stat(file_path)

# Add write permission for the owner
new_permissions = file_stat.st_mode | stat.S_IWUSR

# Remove write permission for the group and others
new_permissions &= ~stat.S_IWGRP & ~stat.S_IWOTH

os.chmod(file_path, new_permissions)

How To Execute System Commands and Programs

The Python OS module provides a convenient way to execute system commands and programs from within your Python script or application. In this section, we’ll cover different methods for executing system commands and external programs using the Python OS module.

Using os.system()

The simplest way to execute a system command or an external program is by using the os.system() function. It takes a command string as an argument and returns the exit code of the command.

import os

exit_code = os.system("ls -l")
print("Exit code:", exit_code)

Please note that os.system() is considered less secure and less flexible than using the subprocess module, which is recommended for more complex use cases.

Using os.popen()

The os.popen() function allows you to run a command and read its output as if it were a file. This can be useful if you need to process the output of the command within your script:

import os

command_output = os.popen("ls -l")
output_lines = command_output.readlines()

for line in output_lines:
    print(line.strip())

Again, the subprocess module is recommended for more complex use cases, as it provides greater security and flexibility.

Using the subprocess module

The subprocess module provides a powerful and secure way to manage additional processes, interact with their input/output/error pipes, and obtain their return codes. The subprocess.run() function is the recommended approach to execute system commands and external programs:

import subprocess

result = subprocess.run(["ls", "-l"], capture_output=True, text=True)
print("Exit code:", result.returncode)
print("Command output:\n", result.stdout)

In the example above, subprocess.run() is used to execute the ls -l command. The capture_output=True argument captures the command’s output, while the text=True argument converts the output to a string.

How To Work with Environment Variables

Environment variables are a set of key-value pairs that can store system configuration data or settings for an application. They are useful for passing configuration options and setting runtime behavior without modifying the source code. The Python OS module provides a convenient way to access and manipulate environment variables. In this section, we’ll cover how to work with environment variables using the OS module.

Access environment variables with os.environ

The os.environ object is a dictionary-like mapping that allows you to access and modify the environment variables of the current process. Here’s an example of how to access an environment variable:

import os

path_variable = os.environ.get("PATH")
print("PATH environment variable:", path_variable)

In this example, the os.environ.get() method is used to retrieve the value of the “PATH” environment variable.

Set an environment variable

To set an environment variable, you can use the os.environ object and simply assign a value to a key:

import os

os.environ["MY_ENV_VAR"] = "my_value"

Keep in mind that changes made to the os.environ object are only applied to the current process and will not persist once the process exits.

Check if an environment variable exists

You can check if an environment variable exists by using the os.environ.get() method or the in keyword:

import os

if "MY_ENV_VAR" in os.environ:
    print("MY_ENV_VAR exists")
else:
    print("MY_ENV_VAR does not exist")

Delete an environment variable

To delete an environment variable, you can use the del keyword:

import os

if "MY_ENV_VAR" in os.environ:
    del os.environ["MY_ENV_VAR"]

This will remove the environment variable from the os.environ object and the current process.

How To Manage Processes Using the Python OS Module

The Python OS module provides several functions that allow you to manage and interact with processes. In this section, we’ll cover some of the most commonly used functions for managing processes using the OS module.

Get the current process ID

To get the current process ID, you can use the os.getpid() function:

import os

current_process_id = os.getpid()
print("Current process ID:", current_process_id)

Get the parent process ID

To get the parent process ID, use the os.getppid() function:

import os

parent_process_id = os.getppid()
print("Parent process ID:", parent_process_id)

Create a new process with os.fork()

The os.fork() function creates a new process by duplicating the current process. The new process, called the child process, is an exact copy of the parent process, except for a few values, like the process ID. The os.fork() function returns 0 in the child process and the child’s process ID in the parent process.

Please note that os.fork() is only available on Unix-based systems.

import os

pid = os.fork()

if pid == 0:
    # This is the child process
    print("I am the child process with PID:", os.getpid())
else:
    # This is the parent process
    print("I am the parent process with PID:", os.getpid())
    print("I just created a child process with PID:", pid)

Wait for a child process to finish using os.wait()

The os.wait() function suspends the execution of the parent process until a child process terminates. This is useful for synchronizing the execution of multiple processes. The function returns a tuple containing the child’s process ID and the termination status.

import os

pid = os.fork()

if pid == 0:
    # This is the child process
    print("I am the child process with PID:", os.getpid())
else:
    # This is the parent process
    print("I am the parent process with PID:", os.getpid())
    print("Waiting for the child process to finish...")

    child_pid, status = os.wait()
    print("Child process with PID:", child_pid, "has finished with status:", status)

Please note that for more advanced process management and inter-process communication, the multiprocessing and subprocess modules are recommended, as they provide greater flexibility and control over the creation and management of processes.

How To Use the Python OS Path Module for Path Manipulation

The Python OS module includes a submodule called os.path, which provides a set of functions for working with file and directory paths. These functions allow you to perform common path manipulation tasks, such as joining and splitting paths, checking if a path exists, and more. In this section, we’ll cover some of the most commonly used functions in the os.path module.

Join two or more paths using os.path.join()

The os.path.join() function combines multiple path components into a single path string, ensuring that the appropriate path separator is used for the current operating system:

import os

path1 = "my_directory"
path2 = "my_file.txt"

combined_path = os.path.join(path1, path2)
print("Combined path:", combined_path)

Split a path using os.path.split()

The os.path.split() function splits a path into its head (directory) and tail (file) components:

import os

path = "my_directory/my_file.txt"

head, tail = os.path.split(path)
print("Head:", head)
print("Tail:", tail)

Get the file extension using os.path.splitext()

The os.path.splitext() function splits a path into its root and extension components:

import os

path = "my_file.txt"

root, extension = os.path.splitext(path)
print("Root:", root)
print("Extension:", extension)

Check if a path exists using os.path.exists()

The os.path.exists() function checks if a path (file or directory) exists:

import os

path = "my_file.txt"

if os.path.exists(path):
    print("The path exists")
else:
    print("The path does not exist")

Check if a path is a file or directory using os.path.isfile() and os.path.isdir()

The os.path.isfile() and os.path.isdir() functions can be used to check if a path is a file or a directory, respectively:

import os

path = "my_file.txt"

if os.path.isfile(path):
    print("The path is a file")
elif os.path.isdir(path):
    print("The path is a directory")
else:
    print("The path is not a file or directory")

Get the absolute path using os.path.abspath()

The os.path.abspath() function converts a relative path to an absolute path:

import os

relative_path = "my_directory/my_file.txt"
absolute_path = os.path.abspath(relative_path)

print("Absolute path:", absolute_path)

How To Handle OS-Specific Features and Compatibility Issues

When writing Python scripts and applications, you may need to handle features or behaviors that are specific to certain operating systems. To ensure your code works seamlessly across different platforms, it’s essential to detect the underlying operating system and handle compatibility issues accordingly. In this section, we’ll cover some techniques to handle OS-specific features and compatibility issues in Python.

Detect the operating system using os.name and sys.platform

You can use the os.name attribute and the sys.platform attribute to detect the underlying operating system:

import os
import sys

print("os.name:", os.name)
print("sys.platform:", sys.platform)

For example, os.name will return 'posix' on Unix-based systems (e.g., Linux and macOS) and 'nt' on Windows systems. The sys.platform attribute provides more detailed information about the operating system, such as 'linux', 'darwin', or 'win32'.

Use conditional statements to handle OS-specific code

After detecting the operating system, you can use conditional statements to handle OS-specific code:

import os
import sys

if os.name == "posix":
    print("This is a Unix-based system")
    # Handle Unix-specific code
elif os.name == "nt":
    print("This is a Windows-based system")
    # Handle Windows-specific code

if sys.platform == "linux":
    print("This is a Linux system")
    # Handle Linux-specific code
elif sys.platform == "darwin":
    print("This is a macOS system")
    # Handle macOS-specific code
elif sys.platform == "win32":
    print("This is a Windows system")
    # Handle Windows-specific code

Use the os.path module for path manipulation

The os.path module provides a set of functions for working with file and directory paths in a platform-independent manner. By using the os.path module, you can ensure that your code works correctly with different path separators and conventions on various operating systems:

import os

# Join paths in a platform-independent manner
path = os.path.join("my_directory", "my_file.txt")

# Check if a path exists
if os.path.exists(path):
    print("The path exists")

Use third-party libraries for cross-platform compatibility

There are several third-party libraries available that can help you handle OS-specific features and compatibility issues in a more convenient and efficient manner. Some popular libraries include:

shutil: A built-in Python module that provides a higher-level interface for file operations, including copying, moving, and removing files and directories.
pathlib: A built-in Python module that offers a more object-oriented approach to path manipulation and is available in Python 3.4 and later.
psutil: A third-party library that provides an interface for retrieving information about running processes and system utilization (CPU, memory, disks, network, sensors).

By using these libraries and techniques, you can ensure that your Python scripts and applications are compatible with different operating systems and can handle OS-specific features and behaviors gracefully.