autoflake ¤
Callable for autoflake.
Functions:
-
run
–Run
autoflake
.
run ¤
run(
*files: str,
config: str | None = None,
check: bool | None = None,
check_diff: bool | None = None,
imports: list[str] | None = None,
remove_all_unused_imports: bool | None = None,
recursive: bool | None = None,
jobs: int | None = None,
exclude: list[str] | None = None,
expand_star_imports: bool | None = None,
ignore_init_module_imports: bool | None = None,
remove_duplicate_keys: bool | None = None,
remove_unused_variables: bool | None = None,
remove_rhs_for_unused_variables: bool | None = None,
ignore_pass_statements: bool | None = None,
ignore_pass_after_docstring: bool | None = None,
quiet: bool | None = None,
verbose: bool | None = None,
stdin_display_name: str | None = None,
in_place: bool | None = None,
stdout: bool | None = None
) -> int
Run autoflake
.
Parameters:
-
*files
(str
, default:()
) –Files to format.
-
config
(str | None
, default:None
) –Explicitly set the config file instead of auto determining based on file location.
-
check
(bool | None
, default:None
) –Return error code if changes are needed.
-
check_diff
(bool | None
, default:None
) –Return error code if changes are needed, also display file diffs.
-
imports
(list[str] | None
, default:None
) –By default, only unused standard library imports are removed; specify a comma-separated list of additional modules/packages.
-
remove_all_unused_imports
(bool | None
, default:None
) –Remove all unused imports (not just those from the standard library).
-
recursive
(bool | None
, default:None
) –Drill down directories recursively.
-
jobs
(int | None
, default:None
) –Number of parallel jobs; match CPU count if value is 0 (default: 0).
-
exclude
(list[str] | None
, default:None
) –Exclude file/directory names that match these comma-separated globs.
-
expand_star_imports
(bool | None
, default:None
) –Expand wildcard star imports with undefined names; this only triggers if there is only one star import in the file; this is skipped if there are any uses of
__all__
ordel
in the file. -
ignore_init_module_imports
(bool | None
, default:None
) –Exclude
__init__.py
when removing unused imports. -
remove_duplicate_keys
(bool | None
, default:None
) –Remove all duplicate keys in objects.
-
remove_unused_variables
(bool | None
, default:None
) –Remove unused variables.
-
remove_rhs_for_unused_variables
(bool | None
, default:None
) –Remove RHS of statements when removing unused variables (unsafe).
-
ignore_pass_statements
(bool | None
, default:None
) –Ignore all pass statements.
-
ignore_pass_after_docstring
(bool | None
, default:None
) –Ignore pass statements after a newline ending on
\"\"\"
. -
quiet
(bool | None
, default:None
) –Suppress output if there are no issues.
-
verbose
(bool | None
, default:None
) –Print more verbose logs (you can repeat
-v
to make it more verbose). -
stdin_display_name
(str | None
, default:None
) –The name used when processing input from stdin.
-
in_place
(bool | None
, default:None
) –Make changes to files instead of printing diffs.
-
stdout
(bool | None
, default:None
) –Print changed text to stdout. defaults to true when formatting stdin, or to false otherwise.
Source code in src/duty/callables/autoflake.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
|