dulwich.config.Config

class documentation

class Config:

A Git configuration.

Method	`get`	Retrieve the contents of a configuration setting.
Method	`get_boolean`	Retrieve a configuration setting as boolean.
Method	`get_multivar`	Retrieve the contents of a multivar configuration setting.
Method	`has_section`	Check if a specified section exists.
Method	`items`	Iterate over the configuration pairs for a specific section.
Method	`sections`	Iterate over the sections.
Method	`set`	Set a configuration value.

def get(self, section: SectionLike, name: NameLike) -> Value: ¶

overridden in dulwich.config.ConfigDict, dulwich.config.StackedConfig

Retrieve the contents of a configuration setting.

Parameters
section:`SectionLike`	Tuple with section name and optional subsection name
name:`NameLike`	Variable name

Returns
`Value`	Contents of the setting

Raises
`KeyError`	if the value is not set

def get_boolean(self, section: SectionLike, name: NameLike, default: bool) -> bool:

def get_boolean(self, section: SectionLike, name: NameLike) -> bool | None:

Retrieve a configuration setting as boolean.

Parameters
section:`SectionLike`	Tuple with section name and optional subsection name
name:`NameLike`	Name of the setting, including section and possible subsection.
default:`bool \| None`	Default value if setting is not found

Returns
`bool \| None`	Contents of the setting

def get_multivar(self, section: SectionLike, name: NameLike) -> Iterator[Value]: ¶

overridden in dulwich.config.ConfigDict, dulwich.config.StackedConfig

Retrieve the contents of a multivar configuration setting.

Parameters
section:`SectionLike`	Tuple with section name and optional subsection namee
name:`NameLike`	Variable name

Returns
`Iterator[Value]`	Contents of the setting as iterable

Raises
`KeyError`	if the value is not set

def has_section(self, name: Section) -> bool: ¶

Check if a specified section exists.

Parameters
name:`Section`	Name of section to check for

Returns
`bool`	boolean indicating whether the section exists

def items(self, section: SectionLike) -> Iterator[tuple[Name, Value]]: ¶

overridden in dulwich.config.ConfigDict

Iterate over the configuration pairs for a specific section.

Parameters
section:`SectionLike`	Tuple with section name and optional subsection namee

Returns
`Iterator[tuple[Name, Value]]`	Iterator over (name, value) pairs

def sections(self) -> Iterator[Section]: ¶

overridden in dulwich.config.ConfigDict, dulwich.config.StackedConfig

Iterate over the sections.

Returns: Iterator over section tuples

def set(self, section: SectionLike, name: NameLike, value: ValueLike | bool): ¶

overridden in dulwich.config.ConfigDict, dulwich.config.StackedConfig

Set a configuration value.

Parameters
section:`SectionLike`	Tuple with section name and optional subsection namee
name:`NameLike`	Name of the configuration value, including section and optional subsection
value:`ValueLike \| bool`	value of the setting