b.c.GlobalConfig(LockableConfig) : class documentation

Part of bzrlib.config View In Hierarchy

The configuration that should be used for a specific location.
Method __init__ Base class for configuration files using an ini-like syntax.
Method config_id Returns a unique ID for the config.
Class Method from_string Create a config object from a string.
Method get_editor Get the users pop up editor.
Method set_user_option Save option and its value in the configuration.
Method get_aliases Return the aliases section.
Method set_alias Save the alias in the configuration.
Method unset_alias Unset an existing alias.
Method remove_user_option Remove a user option and save the configuration file.
Method _set_option Undocumented
Method _get_sections See IniBasedConfig._get_sections().

Inherited from LockableConfig:

Method lock_write Takes a write lock in the directory containing the config file.
Method unlock Undocumented
Method break_lock Undocumented
Method _create_from_string Undocumented
Method _write_config_file Undocumented

Inherited from IniBasedConfig (via LockableConfig):

Method reload Reload the config file from disk.
Method _get_parser Undocumented
Method _get_matching_sections Return an ordered list of (section_name, extra_path) pairs.
Method _get_section Override this to define the section used by the config.
Method _get_options Return an ordered list of (name, value, section, config_id) tuples.
Method _get_option_policy Return the policy for the given (section, option_name) pair.
Method _get_change_editor Undocumented
Method _get_signature_checking See Config._get_signature_checking.
Method _get_signing_policy See Config._get_signing_policy
Method _get_user_id Get the user id from the 'email' key in the current section.
Method _get_user_option See Config._get_user_option.
Method _gpg_signing_command See Config.gpg_signing_command.
Method _log_format See Config.log_format.
Method _validate_signatures_in_log See Config.validate_signatures_in_log.
Method _acceptable_keys See Config.acceptable_keys.
Method _post_commit See Config.post_commit.
Method _string_to_signature_policy Convert a string to a signing policy.
Method _string_to_signing_policy Convert a string to a signing policy.
Method _get_alias Undocumented
Method _get_nickname Undocumented

Inherited from Config (via LockableConfig, IniBasedConfig):

Method get_change_editor Undocumented
Method get_mail_client Get a mail client to use
Method expand_options Expand option references in the string in the configuration context.
Method get_user_option Get a generic option - no special process, no default.
Method get_user_option_as_bool Get a generic option as a boolean.
Method get_user_option_as_list Get a generic option as a list - no special process, no default.
Method get_user_option_as_int_from_SI Get a generic option from a human readable size in SI units, e.g 10MB
Method gpg_signing_command What program should be used to sign signatures?
Method log_format What log format should be used
Method validate_signatures_in_log Show GPG signature validity in log
Method acceptable_keys Comma separated list of key patterns acceptable to
Method post_commit An ordered list of python functions to call.
Method user_email Return just the email component of a username.
Method username Return email-style username.
Method ensure_username Raise errors.NoWhoami if username is not set.
Method signature_checking What is the current policy for signature checking?.
Method signing_policy What is the current policy for signature checking?.
Method signature_needed Is a signature needed when committing ?.
Method gpg_signing_key GPG user-id to sign commits
Method get_alias Undocumented
Method get_nickname Undocumented
Method get_bzr_remote_path Undocumented
Method suppress_warning Should the warning be suppressed or emitted.
Method get_merge_tools Undocumented
Method find_merge_tool Undocumented
Method _expand_options_in_list Expand options in a list of strings in the configuration context.
Method _expand_options_in_string Expand options in the string in the configuration context.
Method _expand_option Undocumented
def __init__(self):
Base class for configuration files using an ini-like syntax.
Parametersfile_nameThe configuration file path.
def config_id(self):
Returns a unique ID for the config.
@classmethod
def from_string(cls, str_or_unicode, save=False):
Create a config object from a string.
Parametersstr_or_unicodeA string representing the file content. This will be utf-8 encoded.
saveWhether the file should be saved upon creation.
@deprecated_method(deprecated_in((2, 4, 0)))
def get_editor(self):
Get the users pop up editor.
@needs_write_lock
def set_user_option(self, option, value):
Save option and its value in the configuration.
def get_aliases(self):
Return the aliases section.
@needs_write_lock
def set_alias(self, alias_name, alias_command):
Save the alias in the configuration.
@needs_write_lock
def unset_alias(self, alias_name):
Unset an existing alias.
def _set_option(self, option, value, section):
Undocumented
def _get_sections(self, name=None):
See IniBasedConfig._get_sections().
@needs_write_lock
def remove_user_option(self, option_name, section_name=None):
Remove a user option and save the configuration file.
Parametersoption_nameThe option to be removed.
section_nameThe section the option is defined in, default to the default section.
API Documentation for Bazaar, generated by pydoctor at 2019-08-22 00:28:44.