b.c.BranchConfig(Config) : class documentation

Part of bzrlib.config View In Hierarchy

Known subclasses: bzrlib.tests.test_commit.BranchWithHooks, bzrlib.tests.test_commit.MustSignConfig

A configuration object giving the policy for a branch.
Method __init__ Undocumented
Method config_id Returns a unique ID for the config.
Method set_user_option Undocumented
Method remove_user_option Undocumented
Method has_explicit_nickname Return true if a nickname has been explicitly assigned.
Method _get_branch_data_config Undocumented
Method _get_location_config Undocumented
Method _get_global_config Undocumented
Method _get_best_value This returns a user option from local, tree or global config.
Method _get_safe_value This variant of get_best_value never returns untrusted values.
Method _get_user_id Return the full user id for the branch.
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_option See Config._get_user_option.
Method _get_sections See IniBasedConfig.get_sections().
Method _get_options Undocumented
Method _gpg_signing_command See Config.gpg_signing_command.
Method _post_commit See Config.post_commit.
Method _get_nickname Undocumented
Method _get_explicit_nickname Undocumented
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.

Inherited from Config:

Method get_editor Get the users pop up editor.
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
Method _get_alias Undocumented
def __init__(self, branch):
overrides bzrlib.config.Config.__init__
Undocumented
def config_id(self):
overrides bzrlib.config.Config.config_id
Returns a unique ID for the config.
def _get_branch_data_config(self):
Undocumented
def _get_location_config(self):
Undocumented
def _get_global_config(self):
Undocumented
def _get_best_value(self, option_name):
This returns a user option from local, tree or global config.

They are tried in that order. Use get_safe_value if trusted values are necessary.

def _get_safe_value(self, option_name):
This variant of get_best_value never returns untrusted values.

It does not return values from the branch data, because the branch may not be controlled by the user.

We may wish to allow locations.conf to control whether branches are trusted in the future.

def _get_user_id(self):
Return the full user id for the branch.

e.g. "John Hacker <jhacker@example.com>" This is looked up in the email controlfile for the branch.

def _get_change_editor(self):
Undocumented
def _get_signature_checking(self):
overrides bzrlib.config.Config._get_signature_checking
See Config._get_signature_checking.
def _get_signing_policy(self):
overrides bzrlib.config.Config._get_signing_policy
See Config._get_signing_policy.
def _get_user_option(self, option_name):
overrides bzrlib.config.Config._get_user_option
See Config._get_user_option.
def _get_sections(self, name=None):
See IniBasedConfig.get_sections().
def _get_options(self, sections=None):
Undocumented
def set_user_option(self, name, value, store=STORE_BRANCH, warn_masked=False):
Undocumented
def remove_user_option(self, option_name, section_name=None):
Undocumented
def _gpg_signing_command(self):
overrides bzrlib.config.Config._gpg_signing_command
See Config.gpg_signing_command.
def _post_commit(self):
overrides bzrlib.config.Config._post_commit
See Config.post_commit.
def _get_nickname(self):
overrides bzrlib.config.Config._get_nickname
Undocumented
def has_explicit_nickname(self):
Return true if a nickname has been explicitly assigned.
def _get_explicit_nickname(self):
Undocumented
def _log_format(self):
overrides bzrlib.config.Config._log_format
See Config.log_format.
def _validate_signatures_in_log(self):
overrides bzrlib.config.Config._validate_signatures_in_log
See Config.validate_signatures_in_log.
def _acceptable_keys(self):
overrides bzrlib.config.Config._acceptable_keys
See Config.acceptable_keys.
API Documentation for Bazaar, generated by pydoctor at 2022-06-16 00:25:16.