ToolRunner
runner.ToolRunner(qmd_files, *, keep_temp, verbose, lint_non_exec)Run built-in and custom tools across a set of Quarto files.
Attributes
| Name | Type | Description |
|---|---|---|
| qmd_files | list[str] | List of paths to .qmd files to process. |
| keep_temp | bool | If True, keep temporary Python files. |
| verbose | bool | If True, print progress messages during execution. |
| lint_non_exec | bool | If True, also process non-executable Python code chunks. |
Methods
| Name | Description |
|---|---|
| run_custom | Run one custom command across all qmd files. |
| run_formatter | Run one built-in formatter across all qmd files. |
| run_linter | Run one built-in linter across all qmd files. |
run_custom
runner.ToolRunner.run_custom(command)Run one custom command across all qmd files.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| command | list[str] | Custom command, represented as list of command-line tokens. | required |
run_formatter
runner.ToolRunner.run_formatter(formatter)Run one built-in formatter across all qmd files.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| formatter | str | Name of formatter to run. | required |
run_linter
runner.ToolRunner.run_linter(linter)Run one built-in linter across all qmd files.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| linter | str | Name of linter to run. | required |