Last Updated: June 01, 2026
- Introduction to Python 3 Configuration Files
- Setup of Python 3 ConfigParser
- File Format of configuration file
- Reading the configuration file from python code
- Read config from the config file using ConfigParser
- Changing the datatype of the configuration value from ConfigParser
- What to do if a value is not available from a configfile
- Conclusion
- Full Code: ConfigParser Example Code
- Reference
- Want to see more useful tips?
- Frequently Asked Questions
- Related Articles
Intermediate
Putting parameters in configuration files can take some extra effort at the start, but then can save you a lot of time and heartache in the future. We are all tempted to simply hardcode parameters directly into our code as we save precious time when we write code, but then doing this properly can take extra effort. Some of us at least create constants or store parameters in a variable, while others store them in a class variable to keep this even cleaner. Arguably the best option is store these in a configuration file. In this article you’ll learn the steps compulsory to use configuration files in python 3. It will be strictly according to the official documentation of python 3.
ConfigParser is the class used to implement configuration files in python 3. The main function of using these files is to write python programs which can easily be modified by end users easily. The main aspect of this article is to know about the complete implementation of configuration files. We will cover the three main aspects in this article which are Setup, File format and Basic API.
Python developer and educator with 15+ years building production systems across data engineering, web APIs, and AI tooling. Founder of Python How To Program — 270+ in-depth tutorials covering the modern Python stack.
Introduction to Python 3 Configuration Files
Configuration files can play a vital role in any program and its management. One of the popular approaches to separate code from configuration is to store these files in YAML, JSON or INI and not in .py format. One reason that .py files are not used is that Python 3 can be slower when it comes to reloading. You would need to restart the whole program if you stored your config in a python .py file. Also, the end user can modify the code at will if it is in .py format. Configuration files make it easier to modify or change the code. The data stored in configuration is to have separation so that the programmer can focus on code development and ensure that is clean as possible and the user only needs to touch the configuration file.
Setup of Python 3 ConfigParser
The class used to create configuration files is ConfigParser. This is a part of the standard python 3 library so no need to do any pip installation. We have to import it: “import configparser” to use it or there is another way of using it, it will work in both python2 and python 3, which is:
import configparser
File Format of configuration file
One convention that is used for the file format is to use the extension .ini (short for initial or initiation) but you can use the configuration based on your own or on clients preferences. There are different parts of configuration files.
- A configuration file consists of one or more sections.
- The section names are written in these delimiters [section name].
- The concept is similar to mapping. It consists of key-value pairs meaning there is a name of the configuration item (“key”) and the other the actual value of the configuration (“value”)
- Two operators are used to initialize or separate key-value pair assignment operator (=) or colon operator (:).
- You can even put in a comment using the # or ; prefix.
Example:
[default]
host = 192.168.1.1
port = 31
username = admin
password = admin
[database]
#database related configuration files
port = 22
forwardx11 = no
name = db_test
In the above configuration file example, we have two sections first is [default] and second is [database]. Each section has its own key-value pairs/entries like username = admin and name = db_test. So all of the key-value pairs belong to a given section, so it is easier to organise your configuration files. Finally the sentence with a prefix of # is for commenting
Reading the configuration file from python code
Now, we will talk about the method to read from the config file. As mentioned earlier, ConfigParser is the module/class used to create configuration files. First, ConfigParser object has to be initialized: config = configparser.ConfigParser(); The following are functions:
Initialization of ConfigParser
You can can initiate the configuration file with the following syntax. Here the variable “config” will contain all the values
config = configparser.ConfigParser()
Write to a Configuration file with ConfigParser
Although normally you normally edit to a configuration file in a text editor by hand, there are times where you want to programmatically write to a config file. For example, this could be to create a default config file which a user can then use as a basis to change or edit. You may also want to over-ride a config entry (after confirming with the user) that is erroneous.
Once the object is initialised, we can now write in it. There are ways through which we can initialize the section to write in the config file. We are going use the example mentioned above in file format. Let’s initialize the default section using dictionary.
Example:
config['default'] = {
"host" : "192.168.1.1",
"port" : "22",
"username" : "username",
"password" : "password"
}
Here, “default” is the name of the section (the part in the actual configuration file that had the square “[” and “]” brackets) and curly braces denote the start and end of a dictionary. Inside the dictionary are key-value pairs i.e. “host” is the key and “192.168.1.1” is the value separated by colon “:”
Now, let’s initialize the database section using empty dictionary and add the key-value pairs line by line.
Example:
config['database'] = {}
config['database']['port'] = "22"
config['database']['forwardx11'] = "no"
config['database']['name'] = "db_test"
Here, “database” is the name of the section and curly braces denote the same start and end of a dictionary. In this case, the dictionary is empty. Key-value pairs i.e. “port” is the key and “22” is the value separated by colon “=.” This method provides a lot more flexibility.
Here’s the full code so far:
import configparser
config = configparser.ConfigParser()
config['default'] = {
"host" : "192.168.1.1",
"port" : "22",
"username" : "username",
"password" : "password"
}
config['database'] = {}
config['database']['port'] = "22"
config['database']['forwardx11'] = "no"
config['database']['name'] = "db_test"
with open('test.ini', 'w') as configfile:
config.write(configfile);
After initializing the sections in config, you can now write it to a config file:
with open('test.ini', 'w') as configfile:
config.write(configfile);
Now, you will be able to see the file named test.ini created.
Read config from the config file using ConfigParser
The next step is to read the file which you just have created.
- The config file can be read by using read() method: config.read(‘test.ini’). This will read the test.ini file which you just created.
- If you want to print just the sections available in configuration file, method sections() can be used: config.sections().
- Next is getting the value of any key stored in the section. config[‘database’][‘name’]
This will give you the value which is “db_test” of the key called “name” stored in data_base section.
The following code will print out all the values stored against the keys in the default section using a for loop.
for key in config['default']:
print(config['default'][key])
Code:

Output:

Changing the datatype of the configuration value from ConfigParser
The datatype of the object of ConfigParser is string by default. This is fine for most situations, but then suppose you want to get a true/false value instead, or a number value to do maths operations. For this the string default may not work. We can typecast/covert the datatype of the object of configparser or the datatype of keys of section into any other type such as integer, float etc. In order to change the datatype of object, you have to covert it manually or by using getter methods. The best and the preferred way is to use getter methods.
There are three getter methods:
- getint();
- getfloat();
- getboolean();
Example: config['default'].getint('port')
getint() will covert the datatype of port key of section “default” into “integer”. If you use the typeof(); method on port then it will show integer type now.
There is another way of doing it:
Example: config.getboolean('data_base', 'forwardx11')
In this way, config file is invoking the getboolean() method and its takin two parameters as argument. The first is the name of the section and the other is the key whole value’s type will be changed.
What to do if a value is not available from a configfile
A fallback result can also be obtained. Fallback is the result obtained when the key or section we want to get isn’t available.
Example: config.get('default', 'database', fallback='not_database')
In this case, not_database will be returned if the “database” key isn’t available or the section default is not found.
Conclusion
We come to know about the setup i.e. importing the ConfigParser first to create configuration files. Next section was about the file format. There you can check about the basic syntax of creating a configuration file. It consists of sections and key-value pairs.
We played with the data types of keys in default and data_base sections. We can change datatypes using getter methods. Last but not the least, we studied about the basic api like write, read and about fallback.
Using configuration files is not difficult and can save a lot of time. So in your next coding work, take the extra few minutes to create a configuration file instead of hardcoding.
Full Code: ConfigParser Example Code
import configparser
config = configparser.ConfigParser()
#Set up default item for hosts using dictionary
config['default'] = {"host" : "192.168.1.1",
"port" : "22",
"username" : "username",
"password" : "password" }
#setup config item bytes
config['database'] = {}
config['database']['port'] = "22"
config['database']['forwardx11'] = "no"
config['database']['name'] = "db_test"
#Write default file
with open('test.ini', 'w') as configfile:
config.write(configfile)
#Open the file again to try to read it
config.read('test.ini')
#Print the sections
print(config.sections())
print( config['database']['name'] )
#Print each key pair
for key in config['default']:
print(config['default'][key])
#print the type of integer value
print (type (config['default'].getint('port')))
print( config.getboolean('database', 'forwardx11') )
#Print default value
print( config.get('default', 'databaseabc', fallback='not_database') )
Output:

Reference
https://docs.python.org/3/library/configparser.html
Want to see more useful tips?
How To Automate Tasks with Python: A Practical Guide
Last Updated: June 14, 2026
- Automate Tasks with Python: Quick Example
- What Is Python Automation and When Should You Use It?
- Automating File and Folder Operations
- Automating Web Data Collection
- Running Automated Jobs on a Schedule
- Running System Commands with subprocess
- Real-Life Example: Automated Downloads Folder Organizer
- Frequently Asked Questions
- Conclusion
- Related Articles
Beginner to Intermediate
You have a folder full of downloaded files named document(1).pdf, screenshot_2024.png, and report_final_v3_FINAL.xlsx. Every week you spend 20 minutes sorting them by hand. Or maybe you copy data from a website into a spreadsheet every morning, or you run the same three terminal commands every time you start work. These are the tasks Python was built to eliminate. With a few dozen lines of code you can turn a painful weekly chore into something that runs itself while you drink coffee.
Python ships with a rich standard library for automation — pathlib for file operations, subprocess for running system commands, smtplib for sending email — and the broader ecosystem adds libraries like schedule for periodic jobs and requests for web data collection. No special setup is needed beyond a standard Python 3.8+ install. For scheduling, you will need to install schedule with pip, but everything else in this article is built in.
In this guide we will cover four practical automation categories: organizing files and folders with pathlib and shutil, collecting web data with requests and BeautifulSoup, scheduling jobs to run automatically with the schedule library, and running system commands with subprocess. Each section ends with working code you can adapt to your own situation. By the end you will have a toolkit of reusable automation patterns and a complete script that organizes a messy downloads folder automatically.
Python developer and educator with 15+ years building production systems across data engineering, web APIs, and AI tooling. Founder of Python How To Program.
Automate Tasks with Python: Quick Example
Here is a self-contained script that renames and moves files in a folder based on their extension — one of the most common automation tasks you will ever write:
# sort_downloads.py
from pathlib import Path
import shutil
FOLDER = Path.home() / "Downloads"
DESTINATIONS = {
".pdf": "Documents",
".png": "Images",
".jpg": "Images",
".xlsx": "Spreadsheets",
".csv": "Spreadsheets",
".zip": "Archives",
}
for file in FOLDER.iterdir():
if file.is_file() and file.suffix in DESTINATIONS:
dest_folder = FOLDER / DESTINATIONS[file.suffix]
dest_folder.mkdir(exist_ok=True)
shutil.move(str(file), dest_folder / file.name)
print(f"Moved: {file.name} -> {DESTINATIONS[file.suffix]}/")
Output (example):
Moved: invoice_march.pdf -> Documents/
Moved: screenshot_2024.png -> Images/
Moved: sales_report.xlsx -> Spreadsheets/
The script uses Path.home() to get the user’s home directory regardless of operating system, iterdir() to loop over every item in the folder, and shutil.move() to relocate the file. The mkdir(exist_ok=True) call creates the destination folder if it does not already exist — no crash if it is there, no error if it is not. We will build a more complete version in the real-life example section, including duplicate detection and logging.
What Is Python Automation and When Should You Use It?
Automation means writing code that performs a repetitive task so you do not have to. The rule of thumb is: if you have done something manually more than three times, it is worth automating. Python is the go-to language for automation because it has concise syntax, a massive standard library, and third-party packages that cover almost every automation use case out of the box.
The table below maps common repetitive tasks to the Python tools that handle them:
| Task Type | Python Tool | When to Use |
|---|---|---|
| File/folder operations | pathlib, shutil | Renaming, moving, copying, deleting files |
| Reading/writing files | built-in open(), csv | Log parsing, report generation, data transformation |
| Web data collection | requests, BeautifulSoup | Pulling prices, headlines, tables from websites |
| Scheduled jobs | schedule, APScheduler | Running tasks daily, hourly, or on a cron-like schedule |
| System commands | subprocess | Running CLI tools, shell scripts, git, ffmpeg |
| Email sending | smtplib, yagmail | Automated reports, alerts, notifications |
A good automation script is idempotent — running it twice produces the same result as running it once. It handles edge cases (missing files, network errors, duplicate names) without crashing. And it logs what it did so you can review the results later. Keep these principles in mind as we work through each section.
Automating File and Folder Operations
The pathlib module (Python 3.4+) provides an object-oriented interface for working with file paths that is far more readable than the older os.path approach. Combined with shutil for copy/move operations, these two modules cover 90% of file automation tasks.
Finding and Filtering Files with pathlib
The glob() and rglob() methods on a Path object let you find files matching a pattern across an entire directory tree. glob() searches one level deep; rglob() (recursive glob) searches all subdirectories:
# find_files.py
from pathlib import Path
base = Path("/tmp/project") # change to your actual folder
# Find all Python files in this folder only
py_files = list(base.glob("*.py"))
print("Python files (top-level):", [f.name for f in py_files])
# Find all log files anywhere in the tree
log_files = list(base.rglob("*.log"))
print("Log files (all depths):", [f.relative_to(base) for f in log_files])
# Find files larger than 1 MB
large_files = [f for f in base.rglob("*") if f.is_file() and f.stat().st_size > 1_000_000]
print("Files over 1MB:", [f.name for f in large_files])
Output (example):
Python files (top-level): ['app.py', 'utils.py', 'config.py']
Log files (all depths): [PosixPath('logs/app.log'), PosixPath('logs/error.log')]
Files over 1MB: ['dataset.csv', 'backup.tar.gz']
f.stat().st_size returns the file size in bytes. The expression f.relative_to(base) strips the base directory from the path so you see logs/app.log instead of the full absolute path. Both are useful for building reports of what your script found before it starts moving anything.
Renaming and Copying Files Safely
Before moving or renaming files in an automation script, always check whether the destination already exists. Blindly overwriting a file can cause data loss that is impossible to reverse:
# safe_copy.py
from pathlib import Path
import shutil
def safe_copy(src: Path, dest_dir: Path) -> Path:
"""Copy src into dest_dir, appending a counter if the name already exists."""
dest_dir.mkdir(parents=True, exist_ok=True)
dest = dest_dir / src.name
if dest.exists():
counter = 1
while dest.exists():
stem = src.stem
dest = dest_dir / f"{stem}_{counter}{src.suffix}"
counter += 1
shutil.copy2(str(src), dest) # copy2 preserves metadata (timestamps)
return dest
# Demo
src_file = Path("/tmp/report.pdf")
src_file.write_text("dummy content") # create test file
result = safe_copy(src_file, Path("/tmp/archive"))
print(f"Copied to: {result}")
result2 = safe_copy(src_file, Path("/tmp/archive")) # simulate duplicate
print(f"Duplicate handled: {result2}")
Output:
Copied to: /tmp/archive/report.pdf
Duplicate handled: /tmp/archive/report_1.pdf
The shutil.copy2() function copies the file content AND preserves the original modification time, which is important when you want archive copies to retain their original dates. The counter loop ensures you never silently overwrite an existing file — a critical safety net for any file automation script.
Automating Web Data Collection
Web scraping lets your scripts pull data from websites automatically. The standard approach uses requests to download HTML and BeautifulSoup to parse it. Install both with pip install requests beautifulsoup4.
Fetching and Parsing a Web Page
We will use quotes.toscrape.com, a site built specifically for scraping practice. It serves reliable HTML with a stable structure, so this code will continue to work without modification.
Here is the HTML structure of each quote on that page, so you can see exactly what the selectors are targeting:
<!-- HTML structure of each quote on quotes.toscrape.com -->
<div class="quote">
<span class="text">"The world as we have created it..."</span>
<span>
by <small class="author">Albert Einstein</small>
</span>
<div class="tags">
<a class="tag" href="/tag/change/page/1/">change</a>
</div>
</div>
Now the scraping code:
# scrape_quotes.py
import requests
from bs4 import BeautifulSoup
def scrape_quotes(url: str) -> list[dict]:
response = requests.get(url, timeout=10)
response.raise_for_status() # raises HTTPError for 4xx/5xx responses
soup = BeautifulSoup(response.text, "html.parser")
results = []
for quote_div in soup.select("div.quote"):
text_elem = quote_div.select_one("span.text")
author_elem = quote_div.select_one("small.author")
tag_elems = quote_div.select("a.tag")
# Defensive: check before accessing .text
text = text_elem.text.strip() if text_elem else "Unknown"
author = author_elem.text.strip() if author_elem else "Unknown"
tags = [t.text for t in tag_elems]
results.append({"quote": text, "author": author, "tags": tags})
return results
quotes = scrape_quotes("https://quotes.toscrape.com")
for q in quotes[:3]:
print(f'{q["author"]}: {q["quote"][:60]}...')
print(f' Tags: {", ".join(q["tags"])}')
print()
Output:
Albert Einstein: "The world as we have created it is a process of...
Tags: change, deep-thoughts, thinking, world
J.K. Rowling: "It is our choices, Harry, that show what we truly a...
Tags: abilities, choices
Albert Einstein: "There are only two ways to live your life. One is...
Tags: inspirational, life, live, miracle, miracles
response.raise_for_status() is a one-line safety net — it raises a requests.HTTPError if the server returns a 4xx or 5xx status code instead of silently continuing with bad data. The defensive checks (text_elem.text if text_elem else "Unknown") protect against pages where an element is missing, which happens constantly on real-world sites.
Saving Scraped Data to CSV
Collecting data is only half the job — you need to store it somewhere useful. Writing to CSV with Python’s built-in csv module keeps the output format-agnostic and readable in any spreadsheet application:
# save_to_csv.py
import csv
import requests
from bs4 import BeautifulSoup
def scrape_quotes(url):
resp = requests.get(url, timeout=10)
resp.raise_for_status()
soup = BeautifulSoup(resp.text, "html.parser")
results = []
for div in soup.select("div.quote"):
text = div.select_one("span.text")
author = div.select_one("small.author")
results.append({
"quote": text.text.strip() if text else "",
"author": author.text.strip() if author else "",
})
return results
quotes = scrape_quotes("https://quotes.toscrape.com")
output_file = "quotes.csv"
with open(output_file, "w", newline="", encoding="utf-8") as f:
writer = csv.DictWriter(f, fieldnames=["author", "quote"])
writer.writeheader()
writer.writerows(quotes)
print(f"Saved {len(quotes)} quotes to {output_file}")
Output:
Saved 10 quotes to quotes.csv
Always pass encoding="utf-8" when writing CSV files — without it, non-ASCII characters (curly quotes, accented letters, em-dashes) will cause encoding errors or garbled output on Windows. The newline="" argument is also required by Python’s csv module to prevent extra blank lines on Windows.
Running Automated Jobs on a Schedule
Writing the automation code is only half the job. You also need it to run at the right time, without you having to remember to start it. The schedule library provides a clean Python API for defining when jobs should run — every minute, every day at 9am, every Monday, and so on. Install it with pip install schedule.
Basic Scheduling with the schedule Library
The schedule library works with a simple event loop: you register jobs with schedule.every(), then call schedule.run_pending() in a loop to check whether any jobs are due:
# basic_schedule.py
import schedule
import time
from datetime import datetime
def morning_report():
print(f"[{datetime.now():%H:%M:%S}] Good morning! Running daily report...")
# your actual report logic goes here
def hourly_check():
print(f"[{datetime.now():%H:%M:%S}] Hourly check complete.")
# Schedule the jobs
schedule.every().day.at("09:00").do(morning_report)
schedule.every().hour.do(hourly_check)
schedule.every(30).minutes.do(lambda: print("30-min heartbeat"))
print("Scheduler running. Press Ctrl+C to stop.")
while True:
schedule.run_pending()
time.sleep(30) # check every 30 seconds to save CPU
Output (example at 09:00:00):
Scheduler running. Press Ctrl+C to stop.
[09:00:00] Good morning! Running daily report...
[09:00:00] Hourly check complete.
[09:00:00] 30-min heartbeat
[09:30:00] 30-min heartbeat
[10:00:00] Hourly check complete.
The time.sleep(30) inside the loop is important — without a sleep, the loop burns 100% of one CPU core doing nothing. Sleeping 30 seconds means jobs can fire up to 30 seconds late (acceptable for most automation), while using negligible CPU. If you need second-level precision, use time.sleep(1) instead.
Handling Errors in Scheduled Jobs
When a job in a scheduled loop raises an unhandled exception, the whole process crashes and no more jobs run. Wrap your job functions with a try/except to log errors and keep the loop running:
# robust_schedule.py
import schedule
import time
import logging
from datetime import datetime
logging.basicConfig(
filename="automation.log",
level=logging.INFO,
format="%(asctime)s %(levelname)s %(message)s",
)
def run_safely(job_func):
"""Decorator that catches exceptions and logs them without crashing the loop."""
def wrapper():
try:
job_func()
logging.info(f"{job_func.__name__} completed successfully")
except Exception as exc:
logging.error(f"{job_func.__name__} failed: {exc}", exc_info=True)
return wrapper
def daily_scrape():
# Simulating a job that sometimes fails
import random
if random.random() < 0.3:
raise ConnectionError("Network unavailable")
print("Scraped data successfully.")
schedule.every().day.at("08:00").do(run_safely(daily_scrape))
while True:
schedule.run_pending()
time.sleep(60)
The run_safely decorator wraps any function so that exceptions are caught, logged to a file, and the scheduler continues. The exc_info=True argument tells Python's logging module to include the full traceback in the log file -- essential for debugging failures that happen at 3am while you are asleep.
Running System Commands with subprocess
Sometimes the right tool for a job is a command-line program, not a Python library. subprocess.run() lets your Python script launch any system command and capture its output, making it easy to orchestrate CLI tools like git, ffmpeg, or database utilities.
Basic subprocess Usage
# run_commands.py
import subprocess
# Run a command and capture its output
result = subprocess.run(
["python3", "--version"],
capture_output=True,
text=True, # decode bytes to str automatically
check=False, # don't raise on non-zero exit code
)
print("Return code:", result.returncode)
print("Stdout:", result.stdout.strip())
print("Stderr:", result.stderr.strip())
# Run a command that lists files (works on macOS/Linux)
ls_result = subprocess.run(
["ls", "-la", "/tmp"],
capture_output=True,
text=True,
)
print("\nFirst 3 lines of /tmp listing:")
for line in ls_result.stdout.strip().split("\n")[:3]:
print(" ", line)
Output:
Return code: 0
Stdout: Python 3.11.4
Stderr:
First 3 lines of /tmp listing:
total 0
drwxrwxrwt 20 root wheel 640 Jun 12 09:31 .
drwxr-xr-x 20 root wheel 640 May 18 11:02 ..
Always use a list for the command argument (["ls", "-la", "/tmp"]) rather than a string ("ls -la /tmp"). The list form avoids shell injection vulnerabilities -- if any part of the command comes from user input, a string passed to shell=True can execute arbitrary shell commands. The list form is always safer.
Practical Example: Automating Git Operations
Here is a real-world use case -- a script that automatically stages, commits, and pushes changes in a git repository. This is useful for automating backup commits or syncing generated files:
# git_autocommit.py
import subprocess
from datetime import datetime
from pathlib import Path
def git_run(args: list[str], cwd: Path) -> subprocess.CompletedProcess:
"""Run a git command in the specified directory."""
return subprocess.run(
["git"] + args,
capture_output=True,
text=True,
cwd=cwd,
)
def auto_commit(repo_path: Path, message: str = None) -> bool:
"""Stage all changes and commit if there is anything to commit."""
# Check for changes
status = git_run(["status", "--porcelain"], repo_path)
if not status.stdout.strip():
print("No changes to commit.")
return False
if message is None:
message = f"Auto-commit {datetime.now():%Y-%m-%d %H:%M}"
# Stage all changes
git_run(["add", "-A"], repo_path)
# Commit
commit = git_run(["commit", "-m", message], repo_path)
if commit.returncode == 0:
print(f"Committed: {message}")
return True
else:
print(f"Commit failed: {commit.stderr.strip()}")
return False
# Usage (change to your actual repo path)
repo = Path("/tmp/my-project")
repo.mkdir(exist_ok=True)
auto_commit(repo, "Automated daily backup")
Output (when changes exist):
Committed: Automated daily backup
The helper function git_run() takes the git subcommand as a list and prepends "git", keeping the calling code clean. The cwd=cwd argument tells subprocess where to run the command -- without it, git would operate on whatever directory the script itself lives in, which is almost never what you want.
Real-Life Example: Automated Downloads Folder Organizer
We will now build a complete, production-ready script that watches your Downloads folder and organizes files into subfolders by type. It handles duplicates, logs every action, and can be scheduled to run automatically.
# downloads_organizer.py
import shutil
import logging
from pathlib import Path
from datetime import datetime
# --- Configuration ---
DOWNLOADS_DIR = Path.home() / "Downloads"
LOG_FILE = Path.home() / "downloads_organizer.log"
RULES = {
"Documents": [".pdf", ".doc", ".docx", ".txt", ".rtf"],
"Images": [".jpg", ".jpeg", ".png", ".gif", ".svg", ".webp", ".heic"],
"Videos": [".mp4", ".mov", ".mkv", ".avi", ".m4v"],
"Audio": [".mp3", ".m4a", ".flac", ".wav", ".aac"],
"Archives": [".zip", ".tar", ".gz", ".rar", ".7z"],
"Code": [".py", ".js", ".html", ".css", ".json", ".sh", ".ipynb"],
"Data": [".csv", ".xlsx", ".xls", ".tsv", ".parquet"],
}
# Build reverse lookup: extension -> folder name
EXT_MAP = {ext: folder for folder, exts in RULES.items() for ext in exts}
# --- Logging setup ---
logging.basicConfig(
filename=LOG_FILE,
level=logging.INFO,
format="%(asctime)s %(levelname)s %(message)s",
)
def unique_dest(dest: Path) -> Path:
"""Append a counter to avoid overwriting existing files."""
if not dest.exists():
return dest
counter = 1
while True:
candidate = dest.parent / f"{dest.stem}_{counter}{dest.suffix}"
if not candidate.exists():
return candidate
counter += 1
def organize(dry_run: bool = False) -> dict:
"""Move files from Downloads into categorized subfolders."""
stats = {"moved": 0, "skipped": 0, "unknown": 0}
for item in DOWNLOADS_DIR.iterdir():
if not item.is_file():
continue
folder_name = EXT_MAP.get(item.suffix.lower())
if folder_name is None:
logging.info(f"SKIP (unknown type): {item.name}")
stats["unknown"] += 1
continue
dest_dir = DOWNLOADS_DIR / folder_name
dest = unique_dest(dest_dir / item.name)
if dry_run:
print(f"[DRY RUN] Would move: {item.name} -> {folder_name}/")
else:
dest_dir.mkdir(exist_ok=True)
shutil.move(str(item), dest)
logging.info(f"MOVED: {item.name} -> {folder_name}/{dest.name}")
stats["moved"] += 1
return stats
if __name__ == "__main__":
print(f"Organizing {DOWNLOADS_DIR} ...")
result = organize(dry_run=False)
summary = f"Done. Moved: {result['moved']}, Unknown: {result['unknown']}"
print(summary)
logging.info(summary)
Output (example):
Organizing /Users/alice/Downloads ...
Done. Moved: 12, Unknown: 3
The dry_run=True mode lets you preview what the script would do without actually moving anything -- run it first to confirm the output looks right. The unique_dest() function guarantees you never silently overwrite a file with the same name in the destination folder. You can schedule this script to run daily using the schedule library covered earlier, or on macOS/Linux you can add it to your crontab with crontab -e for OS-level scheduling without a Python process running continuously.
Frequently Asked Questions
What is the difference between shutil and pathlib for file operations?
pathlib is for path manipulation and simple operations: checking if a file exists, reading its metadata, renaming it within the same filesystem. shutil is for heavier operations: copying files (with or without metadata), moving files across filesystems, and deleting entire directory trees. In practice you often use both -- pathlib to build and check paths, shutil to actually move or copy the files. Use shutil.move() for moves (it handles cross-filesystem moves gracefully) and shutil.copy2() when you want to preserve file modification times.
Should I use the schedule library or cron for scheduled tasks?
It depends on your setup. The schedule library is pure Python and works identically on Windows, macOS, and Linux -- great for scripts you want to be portable or that run within an existing Python process. Cron (on Linux/macOS) and Task Scheduler (on Windows) are OS-level schedulers that are more reliable for long-running production tasks because they survive reboots automatically and do not require a Python process to stay running. For personal automation scripts on a development machine, schedule is simpler. For server deployments, lean on cron or a process manager like systemd.
When is it safe to use subprocess with shell=True?
Use shell=True only when the entire command is a string literal you control completely -- for example, a hardcoded one-liner like subprocess.run("ls -la /tmp | wc -l", shell=True). Never pass user input, command-line arguments, or any external data into a shell=True command string; doing so opens a shell injection vulnerability where an attacker can execute arbitrary commands. The list form (["ls", "-la", "/tmp"]) is safe with external data because each list element is passed directly to the OS without going through a shell interpreter.
How do I avoid getting blocked when scraping websites?
The main causes of blocks are too-fast request rates, missing request headers, and large-volume scraping. Add a delay between requests using time.sleep(random.uniform(1, 3)) -- randomized delays look more human than a fixed interval. Always set a User-Agent header in your requests session to identify your scraper politely: session.headers.update({"User-Agent": "MyBot/1.0 (research project)"}). Always check the site's robots.txt file before scraping -- if the path you want to scrape is listed as disallowed, respect it. For sites that require JavaScript to load content, switch to a tool like playwright or selenium instead of requests.
Why should automation scripts log to a file instead of just printing?
When a script runs unattended -- on a schedule overnight or as a background process -- there is no terminal to see the output. File logging means you can review what happened after the fact, including any errors. Python's built-in logging module automatically records timestamps, log levels (INFO, WARNING, ERROR), and full tracebacks on exceptions. Set up a RotatingFileHandler for long-running scripts to cap the log file size so it does not grow indefinitely: from logging.handlers import RotatingFileHandler, then RotatingFileHandler("script.log", maxBytes=1_000_000, backupCount=3) keeps the last 3MB of logs and discards older entries automatically.
How do I make an automation script safe to run multiple times?
Design for idempotency -- the script should produce the same result whether it runs once or ten times. For file organization scripts, this means checking if a file already exists in the destination before moving it (and using a counter suffix for duplicates, as shown in the real-life example). For database or API writes, check for existing records before inserting. For web scraping pipelines, track which pages or records have already been collected in a CSV or SQLite database, and skip them on subsequent runs. The general pattern is: check state first, act only if the desired state is not already present.
Conclusion
We have covered four practical automation categories in this guide: file and folder operations with pathlib and shutil, web data collection with requests and BeautifulSoup, scheduled jobs with the schedule library, and system command automation with subprocess. The real-life Downloads Organizer script ties these concepts together into a complete, production-ready tool with duplicate handling, configurable rules, dry-run mode, and file logging.
The best next step is to adapt the Downloads Organizer to your own situation -- add more file types, change the destination folders, or hook it into schedule to run automatically every morning. Once you have the pattern down, you will start seeing automation opportunities everywhere: renaming podcast downloads, archiving old project folders, pulling daily exchange rates from an API, or auto-committing generated reports to git.
For deeper reading, the official Python documentation covers pathlib, shutil, and subprocess in full detail. The schedule library docs have examples for every scheduling pattern you might need. And BeautifulSoup4's documentation is an excellent reference for parsing more complex HTML structures.
Related Articles
Continue Learning Python
Tutorials you might also find useful:
Frequently Asked Questions
What is ConfigParser used for in Python?
ConfigParser is a built-in Python module for reading and writing configuration files in INI format. It handles settings organized into sections with key-value pairs, making it easy to store and retrieve application configuration without hardcoding values.
What format does ConfigParser use?
ConfigParser uses the INI file format with sections in square brackets ([section]), followed by key-value pairs using = or : as delimiters. Comments start with # or ;. There is always a [DEFAULT] section for fallback values.
How do I read a config file with ConfigParser?
Create a ConfigParser() instance, call config.read('filename.ini'), then access values with config['section']['key'] or config.get('section', 'key'). Use getint(), getfloat(), or getboolean() for type conversion.
Can ConfigParser handle nested sections?
No, ConfigParser does not support nested sections natively. For nested configuration structures, consider using TOML (tomllib in Python 3.11+), YAML (PyYAML), or JSON configuration files instead.
What is the difference between ConfigParser and JSON for configuration?
ConfigParser uses human-friendly INI format with sections and is ideal for simple settings. JSON supports nested structures and lists but lacks comments. ConfigParser has built-in type conversion methods and a DEFAULT section for fallback values, while JSON requires manual type handling.
Related Articles
- How To Use TOML for Configuration Files
- Managing Environment Variables with dotenv
- How To Use Pathlib for File Paths
Continue Learning Python
Tutorials you might also find useful:
- How To Use Python TOML For Configuration Files Instead of INI
- How To Use Python dynaconf for Configuration Management
- How To Work with ZIP Files in Python
- How To Use Python tempfile for Temporary Files and Directories
- How To Read and Write CSV Files in Python
- How To Read and Write JSON Files in Python
Trackbacks/Pingbacks