py-sql-cleaner 命令

常用示例

说明

py-sql-cleaner is a Python CLI that finds triple-quoted SQL strings inside Python files and reformats or extracts them using SQLGlot. It is intended for ETL and data-engineering projects where SQL is embedded in `.py` files rather than kept in separate `.sql` files. The tool is conservative by default. f-strings, Jinja templates and other runtime placeholders are detected but skipped instead of being rewritten, so formatting cannot silently change a query that depends on interpolation. py-sql-cleaner never connects to a database and never executes SQL. The supported dialects (`generic`, `mysql`, `postgres`, `redshift`) only select SQLGlot's parser and formatter mode, not full database validation. The `check` subcommand exits non-zero when formatting would change a file, making it suitable as a pre-commit hook or CI gate next to `black`, `ruff` and similar formatters.

参数

list _file_

Show every embedded SQL block found in the file.

format _file_

Reformat embedded SQL in place.

extract _file_

Write each SQL block to a separate `.sql` file.

check _file_

Exit non-zero if formatting would change the file.

dialects

Print supported SQL dialects.

-d, --dialect _NAME_

Select dialect: `generic`, `mysql`, `postgres`, `redshift`.

--dry-run

Print the formatted result instead of writing it.

--out-dir _DIR_

Output directory for `extract`.

--version

Print the installed version.