format_python

format_python

Formatting Standards

• Use exactly 4 spaces for indentation (never tabs)
• Use double quotes for all string literals consistently
• Write one import per line, grouped stdlib → third party → first party → local, to prevent the E401 multiple-imports error
• Use absolute imports, and import from the typing module only when a built-in type will not do
• Import only the modules, names, and types you use, and remove unused imports immediately to prevent F401 errors
• Use snake_case for variables/functions, PascalCase for classes, UPPER_CASE for constants
• Keep lines under 88 characters, break long lines at logical points with proper indentation

Code Quality Standards

• Write valid Python syntax that passes all linter checks
• Use specific exception types like ValueError, FileNotFoundError
• Assign error messages to variables before raising exceptions
• Remove unused variables, and use _ for intentionally unused values, to prevent F841 errors
• Use modern type hints: dict[str, Any] instead of Dict[str, Any], str | None instead of Optional[str]
• Use f-strings for general formatting, use % formatting in logging statements
• Use is/is not for None comparisons, use in/not in for membership testing
• Avoid single-letter variable names except for loop counters
• Don't shadow built-in names like list, dict, str, id, type
• Use context managers (with statements) for all file operations and resource cleanup
• Use logger = logging.getLogger(__name__) for module-level logging
• Use logging instead of print statements for all output

Code Structure

• Follow this exact order: docstring → imports → constants → classes → functions → main guard
• Write functions with single responsibility, clear parameters, and early returns for better readability
• Use clear, descriptive class names; apply proper decorators (@classmethod, @staticmethod) for class methods
• Validate all input parameters when necessary, especially for public functions