_docsweeper.command_line#

Command line interface.

_docsweeper.command_line.parse_args(files, vcs_command_set_type, vcs_executable, config, no_follow_rename)#

Validate command line arguments and transform them into a configuration object.

Parameters

  • files (Tuple[Path]) – list of files that are to be analyzed

  • vcs_command_set_type (Type[VCSCommandSet]) – type of the version control command set that is to be used

  • vcs_executable (Optional[Path]) – location of the executable of the version control system

  • config (ConfigParser) – .ini configuration file

  • no_follow_rename (Optional[bool]) – if True, do not follow renames

Returns

the configuration object

Return type

_ParsedArgs

_docsweeper.command_line.run(parsed_args, **kwargs)#

Run the analysis using the configuration in parsed_args.

Registered as a callback to parse_args().

Parameters

parsed_args (_ParsedArgs) – command configuration as returned by parse_args()

Return type

None

# noqa: DAR101

class _docsweeper.command_line._ParsedArgs#

Bases: TypedDict

Holds parsed command line arguments in a form usable by internal classes.

files: Sequence[pathlib.Path]#

list of files that are to be analyzed

vcs_command_set_config: _docsweeper.version_control.VCSCommandSetConfig#

configuration for the version control command set

vcs_command_set_type: Type[_docsweeper.version_control.VCSCommandSet]#

the type of version control command set used