ftag.cli_utils

Classes

HelpFormatter

Help message formatter which retains formatting of all help text.

Functions

valid_path(→ pathlib.Path)

Check if the given string is a valid path.

Module Contents

ftag.cli_utils.valid_path(string: str) → pathlib.Path

Check if the given string is a valid path.

Parameters:

string (str) – Input path as string

Returns:

Output path as Path object

Return type:

Path

Raises:

FileNotFoundError – If the given input path as string doesn’t exist

class ftag.cli_utils.HelpFormatter(prog, indent_increment=2, max_help_position=24, width=None)

Bases: argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter

Help message formatter which retains formatting of all help text.

Only the name of this class is considered a public API. All the methods provided by the class are considered an implementation detail.