Python Build a CLI with Input Files and Output Files

Build a CLI that accepts a source file and writes a separate result file.

What It Does and Why It Matters

Arguments should supply paths; application logic should validate them and avoid overwriting the input accidentally. Read text with a chosen encoding and write output to a known destination. Use a temporary directory for examples so learners do not alter real files.

For production tools, consider atomic writes, file-size limits and clear failure messages.

Step-by-Step Example

Start with the complete example below. Read the inputs and predict what the final print statement will show before you run it.

from pathlib import Path
from tempfile import TemporaryDirectory
def uppercase_file(source, destination):
    destination.write_text(source.read_text(encoding="utf-8").upper(), encoding="utf-8")
with TemporaryDirectory() as folder:
    src = Path(folder) / "input.txt"
    dst = Path(folder) / "output.txt"
    src.write_text("hello", encoding="utf-8")
    uppercase_file(src, dst)
    print(dst.read_text(encoding="utf-8").strip())

How the Code Works

The imports make these standard-library tools available: pathlib, tempfile.
The definition of uppercase_file creates reusable behavior; its body runs only when called or instantiated as appropriate.
The structured block controls error handling or resource lifetime, including what happens when an operation fails.
The print calls display the results. Compare these results with the method’s documented return type and the input used.

Expected output:

HELLO

For the demonstrated inputs, Python displays 'HELLO'. This result follows from the operation described above; change one input at a time to understand which rule matters.

What to Notice

Pay attention to the accepted input types, the returned value and the boundary behavior. Predict what changes if you replace the example input with an empty, zero, negative or missing value, where that value is meaningful for this operation.

If the task uses a library function, inspect its documented exceptions and return type before reusing it inside a larger function.

Where You Would Use This

This is useful for scripts, maintenance commands and automated workflows. Treat inputs as untrusted, keep normal results separate from errors, and choose exit codes consistently. Keep reusable logic outside the command-line parser so it can be tested independently.

Practice Exercise

Add argparse arguments --input and --output to the function above.

Before running your edited example, write down the result you expect. Then test at least one valid boundary or deliberately invalid value, using appropriate exception handling where necessary.

Reference: official Python documentation for the complete API contract and version notes.

Common Beginner Mistakes

Allowing source and destination to refer to the same path without an explicit overwrite policy.
Overlooking the documented condition: use a temporary directory for examples so learners do not alter real files.

Key Takeaways

Build a CLI that accepts a source file and writes a separate result file.
Arguments should supply paths; application logic should validate them and avoid overwriting the input accidentally.
Add argparse arguments --input and --output to the function above.