def test_deprecate_option_help(): """Verify help message of a deprecated option.""" config = Configuration() config.add_option('option', option_type=str, deprecate=dict(version='v1.0', alternative='None! T_T'), help='A useless option!') assert config.help('option') == '(DEPRECATED) A useless option!'
def test_help_option_with_default(): """Verify adding documentation to options with default value.""" config = Configuration() config.add_option("option", option_type=str, default="a", help="A useless option!") assert config.help("option") == "A useless option! (default: a)"
def test_help_option_with_default(): """Verify adding documentation to options with default value.""" config = Configuration() config.add_option('option', option_type=str, default='a', help='A useless option!') assert config.help('option') == 'A useless option! (default: a)'
def test_deprecate_option_help(): """Verify help message of a deprecated option.""" config = Configuration() config.add_option( "option", option_type=str, deprecate=dict(version="v1.0", alternative="None! T_T"), help="A useless option!", ) assert config.help("option") == "(DEPRECATED) A useless option!"
def test_help_nested_option(): """Verify adding documentation to a nested option.""" config = Configuration() config.add_option("option", option_type=str, help="A useless option!") config.nested = Configuration() config.nested.add_option("option", option_type=str, help="A useless nested option!") assert config.help("nested.option") == "A useless nested option!" assert config.nested.help("option") == "A useless nested option!"
def test_help_nested_option(): """Verify adding documentation to a nested option.""" config = Configuration() config.add_option('option', option_type=str, help='A useless option!') config.nested = Configuration() config.nested.add_option('option', option_type=str, help='A useless nested option!') assert config.help('nested.option') == 'A useless nested option!' assert config.nested.help('option') == 'A useless nested option!'
def test_no_help_option(): """Verify not adding documentation to options.""" config = Configuration() config.add_option("option", option_type=str) assert config.help("option") == "Undocumented"
def test_help_option(): """Verify adding documentation to options.""" config = Configuration() config.add_option("option", option_type=str, help="A useless option!") assert config.help("option") == "A useless option!"
def test_help_option(): """Verify adding documentation to options.""" config = Configuration() config.add_option('option', option_type=str, help='A useless option!') assert config.help('option') == 'A useless option!'