confattr package

Submodules

• confattr.config module
  • Config
    • Config.default_config_id
    • Config.get_value()
    • Config.help
    • Config.instances
    • Config.is_value_valid()
    • Config.iter_instances()
    • Config.key
    • Config.pop_key_changer()
    • Config.push_key_changer()
    • Config.set_value()
    • Config.type
    • Config.value
    • Config.wants_to_be_exported()
  • ConfigId
  • DictConfig
    • DictConfig.Sort
      • DictConfig.Sort.ENUM_VALUE
      • DictConfig.Sort.NAME
      • DictConfig.Sort.NONE
    • DictConfig.format_key()
    • DictConfig.get()
    • DictConfig.items()
    • DictConfig.iter_configs()
    • DictConfig.keys()
    • DictConfig.new_config()
    • DictConfig.values()
  • ExplicitConfig
    • ExplicitConfig.is_value_valid()
  • InstanceSpecificDictMultiConfig
  • MultiConfig
    • MultiConfig.check_config_id
    • MultiConfig.config_ids
    • MultiConfig.get_value()
    • MultiConfig.reset()
    • MultiConfig.set_value()
    • MultiConfig.value
    • MultiConfig.values
  • MultiDictConfig
    • MultiDictConfig.new_config()
  • TimingError
  • is_mapping_with_enum_keys()
• confattr.configfile module
  • ArgPos
    • ArgPos.argument_pos
    • ArgPos.i0
    • ArgPos.i1
    • ArgPos.in_between
  • ArgumentParser
    • ArgumentParser.error()
  • ConfigFile
    • ConfigFile.COMMENT
    • ConfigFile.COMMENT_PREFIXES
    • ConfigFile.ENTER_GROUP_PREFIX
    • ConfigFile.ENTER_GROUP_SUFFIX
    • ConfigFile.ITEM_SEP
    • ConfigFile.KEY_SEP
    • ConfigFile.check_config_id
    • ConfigFile.command_dict
    • ConfigFile.commands
    • ConfigFile.config_directory
    • ConfigFile.config_id
    • ConfigFile.config_instances
    • ConfigFile.config_name
    • ConfigFile.config_path
    • ConfigFile.context_file_name
    • ConfigFile.context_line
    • ConfigFile.context_line_number
    • ConfigFile.create_formatter()
    • ConfigFile.enable_config_ids
    • ConfigFile.enter_group()
    • ConfigFile.env_variables
    • ConfigFile.envprefix
    • ConfigFile.expand()
    • ConfigFile.expand_config()
    • ConfigFile.expand_config_match()
    • ConfigFile.expand_env()
    • ConfigFile.expand_env_match()
    • ConfigFile.find_arg()
    • ConfigFile.format_any_value()
    • ConfigFile.format_value()
    • ConfigFile.get_app_dirs()
    • ConfigFile.get_command()
    • ConfigFile.get_completions()
    • ConfigFile.get_completions_command()
    • ConfigFile.get_completions_command_name()
    • ConfigFile.get_completions_enter_group()
    • ConfigFile.get_completions_for_expand()
    • ConfigFile.get_completions_for_expand_config()
    • ConfigFile.get_completions_for_expand_env()
    • ConfigFile.get_completions_for_file_name()
    • ConfigFile.get_env_name()
    • ConfigFile.get_help()
    • ConfigFile.get_help_config_id()
    • ConfigFile.get_save_path()
    • ConfigFile.is_comment()
    • ConfigFile.iter_config_instances()
    • ConfigFile.iter_config_paths()
    • ConfigFile.iter_user_site_config_paths()
    • ConfigFile.load()
    • ConfigFile.load_env()
    • ConfigFile.load_file()
    • ConfigFile.load_without_resetting_config_id()
    • ConfigFile.parse_error()
    • ConfigFile.parse_line()
    • ConfigFile.parse_split_line()
    • ConfigFile.parse_value()
    • ConfigFile.parse_value_part()
    • ConfigFile.quote()
    • ConfigFile.quote_path()
    • ConfigFile.reo_config
    • ConfigFile.reo_env
    • ConfigFile.save()
    • ConfigFile.save_file()
    • ConfigFile.save_to_open_file()
    • ConfigFile.save_to_writer()
    • ConfigFile.set_save_default_arguments()
    • ConfigFile.set_ui_callback()
    • ConfigFile.show_line_always
    • ConfigFile.split_line()
    • ConfigFile.split_line_ignore_errors()
    • ConfigFile.split_one_symbol_command()
    • ConfigFile.write_config_id()
    • ConfigFile.write_help()
  • ConfigFileArgparseCommand
    • ConfigFileArgparseCommand.add_enum_argument()
    • ConfigFileArgparseCommand.after_positional_argument_marker()
    • ConfigFileArgparseCommand.get_action_for_option()
    • ConfigFileArgparseCommand.get_action_for_positional_argument()
    • ConfigFileArgparseCommand.get_completions()
    • ConfigFileArgparseCommand.get_completions_for_action()
    • ConfigFileArgparseCommand.get_completions_for_option_argument()
    • ConfigFileArgparseCommand.get_completions_for_option_name()
    • ConfigFileArgparseCommand.get_completions_for_positional_argument()
    • ConfigFileArgparseCommand.get_help()
    • ConfigFileArgparseCommand.get_option_name_if_it_takes_an_argument()
    • ConfigFileArgparseCommand.get_position()
    • ConfigFileArgparseCommand.init_parser()
    • ConfigFileArgparseCommand.is_option_start()
    • ConfigFileArgparseCommand.parser
    • ConfigFileArgparseCommand.run()
    • ConfigFileArgparseCommand.run_parsed()
  • ConfigFileCommand
    • ConfigFileCommand.add_help_to()
    • ConfigFileCommand.aliases
    • ConfigFileCommand.config_file
    • ConfigFileCommand.create_formatter()
    • ConfigFileCommand.delete_command_type()
    • ConfigFileCommand.get_command_types()
    • ConfigFileCommand.get_completions()
    • ConfigFileCommand.get_help()
    • ConfigFileCommand.get_help_attr_or_doc_str()
    • ConfigFileCommand.get_name()
    • ConfigFileCommand.get_names()
    • ConfigFileCommand.get_short_description()
    • ConfigFileCommand.help
    • ConfigFileCommand.name
    • ConfigFileCommand.run()
    • ConfigFileCommand.save()
    • ConfigFileCommand.should_write_heading
    • ConfigFileCommand.ui_notifier
  • ConfigFileWriter
    • ConfigFileWriter.write_command()
    • ConfigFileWriter.write_heading()
    • ConfigFileWriter.write_line()
  • DEFAULT_COMMAND
  • Echo
    • Echo.get_completions()
    • Echo.init_parser()
    • Echo.run_parsed()
  • FormattedWriter
    • FormattedWriter.write_command()
    • FormattedWriter.write_heading()
    • FormattedWriter.write_line()
    • FormattedWriter.write_lines()
  • Help
    • Help.format_table()
    • Help.get_completions_for_action()
    • Help.init_parser()
    • Help.max_width
    • Help.max_width_name
    • Help.min_width_sep
    • Help.run_parsed()
    • Help.tab_size
  • HelpWriter
    • HelpWriter.write_command()
    • HelpWriter.write_heading()
    • HelpWriter.write_line()
  • Include
    • Include.extensions
    • Include.get_completions_for_action()
    • Include.get_home()
    • Include.help_config_id
    • Include.home
    • Include.init_parser()
    • Include.run_parsed()
  • Message
    • Message.ENVIRONMENT_VARIABLES
    • Message.file_name
    • Message.format_file_name()
    • Message.format_file_name_msg_line()
    • Message.format_msg_line()
    • Message.line
    • Message.line_number
    • Message.lvl
    • Message.message
    • Message.no_context
    • Message.notification_level
    • Message.reset()
  • MultipleParseExceptions
  • NotificationLevel
    • NotificationLevel.ERROR
    • NotificationLevel.INFO
    • NotificationLevel.get()
    • NotificationLevel.get_instances()
    • NotificationLevel.new()
  • ParseException
  • PathType
    • PathType.expand()
  • SaveKwargs
    • SaveKwargs.commands
    • SaveKwargs.comments
    • SaveKwargs.config_instances
    • SaveKwargs.ignore
    • SaveKwargs.ignore_commands
    • SaveKwargs.no_multi
  • SectionLevel
    • SectionLevel.SECTION
    • SectionLevel.SUB_SECTION
    • SectionLevel.descending
  • Set
    • Set.FLAGS_RAW
    • Set.KEY_VAL_SEP
    • Set.add_config_help()
    • Set.add_help_for_data_types()
    • Set.add_help_to()
    • Set.get_completions()
    • Set.get_completions_for_key()
    • Set.get_completions_for_ranger_style_arg()
    • Set.get_completions_for_value()
    • Set.get_completions_for_vim_style_arg()
    • Set.get_data_type_name_to_help_map()
    • Set.get_help_for_data_types()
    • Set.is_vim_style()
    • Set.iter_config_instances_to_be_saved()
    • Set.last_name
    • Set.parse_key_and_set_value()
    • Set.raw
    • Set.run()
    • Set.save()
    • Set.save_config_instance()
    • Set.set_multiple()
    • Set.set_value()
    • Set.set_with_spaces()
    • Set.write_config_help()
  • TextIOWriter
    • TextIOWriter.write_line_raw()
  • UiNotifier
    • UiNotifier.notification_level
    • UiNotifier.set_ui_callback()
    • UiNotifier.show()
    • UiNotifier.show_error()
    • UiNotifier.show_info()
  • UnknownCommand
    • UnknownCommand.name
    • UnknownCommand.run()
• confattr.subprocess_pipe module
  • run_and_pipe()
  • split_list()
• confattr.types module
  • AbstractType
    • AbstractType.__str__()
    • AbstractType.get_instances()
    • AbstractType.help
    • AbstractType.type_name
  • CaseInsensitiveRegex
    • CaseInsensitiveRegex.help
  • OptionalExistingDirectory
    • OptionalExistingDirectory.expand()
    • OptionalExistingDirectory.help
    • OptionalExistingDirectory.type_name
  • Regex
    • Regex.help
    • Regex.type_name
  • SubprocessCommand
    • SubprocessCommand.cmd
    • SubprocessCommand.env
    • SubprocessCommand.has_python_callback()
    • SubprocessCommand.help
    • SubprocessCommand.is_installed()
    • SubprocessCommand.parse_str()
    • SubprocessCommand.python_callbacks
    • SubprocessCommand.register_python_callback()
    • SubprocessCommand.replace()
    • SubprocessCommand.run()
    • SubprocessCommand.type_name
    • SubprocessCommand.unregister_python_callback()
  • SubprocessCommandWithAlternatives
    • SubprocessCommandWithAlternatives.SEP
    • SubprocessCommandWithAlternatives.WC_FILE_NAME
    • SubprocessCommandWithAlternatives.editor()
    • SubprocessCommandWithAlternatives.get_preferred_command()
    • SubprocessCommandWithAlternatives.help
    • SubprocessCommandWithAlternatives.replace()
    • SubprocessCommandWithAlternatives.run()
    • SubprocessCommandWithAlternatives.type_name
  • TYPE_CONTEXT

Module contents

Config Attributes

A python library to read and write config files with a syntax inspired by vimrc and ranger config.