Python Environment Audit - Code Explanation

Goal of the Script

This Python script creates a detailed Python installation and environment audit report. It examines the active Python interpreter, virtual environments, PATH settings, Anaconda installation, Conda configuration, and related environment variables.

The script writes the audit results to a text report file for troubleshooting and documenting the Python environment configuration.

Code Description

The script uses Python built-in libraries including os, sys, subprocess, pathlib, contextlib, and datetime. These modules support system inspection, file handling, command execution, output redirection, and report generation.

Output File

The script creates:

• PythonInstallationAuditReport.txt

The report contains information about the installed Python environment, Anaconda installation, Conda settings, and system configuration.

Major Audit Sections

The generated report includes the following sections:

• Current Python Interpreter
  • Python version
  • Python executable location
  • Current and base environment prefixes
  • Operating system platform
• Python-Related PATH Entries
  • Searches PATH entries containing Python or Conda locations.
• Python Environment Variables
  • Displays variables beginning with PYTHON or containing CONDA.
• Python and Conda Executable Checks
  • Uses Windows where commands to locate Python and Conda executables.
• Active Python Details
  • Identifies whether the active Python installation is Anaconda.
• Anaconda Installation Check
  • Checks common Anaconda installation locations.
  • Verifies the existence of python.exe and conda.exe.
• Summary
  • Displays the active Python executable.
  • Displays the current working directory.
  • Reports the active Conda environment when available.

Python Concepts Demonstrated

• Importing Python modules
• Defining and calling custom functions
• Formatted strings (f-strings)
• File input/output operations
• Context managers using with
• Exception handling with try/except
• Loops and conditional statements
• Object-oriented file handling with pathlib.Path
• Executing operating system commands with subprocess

Key Functions and Methods

• print_header()
  • Creates formatted section headings in the report.
• datetime.now()
  • Adds the report generation timestamp.
• Path.exists()
  • Checks whether files and folders exist.
• subprocess.run()
  • Executes external commands such as where python and where conda.
• redirect_stdout()
  • Redirects printed output into the audit report file.

Summary

This script demonstrates a practical Python system-audit workflow. It combines operating system inspection, environment analysis, file handling, and report generation to document a Python installation.

The resulting report is useful for diagnosing Python, Anaconda, and Conda environment configuration issues.