class documentation

Git configuration stored in a dictionary.

Method __delitem__ Undocumented
Method __eq__ Undocumented
Method __getitem__ Undocumented
Method __init__ Create a new ConfigDict.
Method __iter__ Undocumented
Method __len__ Undocumented
Method __repr__ Undocumented
Method __setitem__ Undocumented
Method get Retrieve the contents of a configuration setting.
Method get_multivar Retrieve the contents of a multivar configuration setting.
Method items Iterate over the configuration pairs for a specific section.
Method sections Iterate over the sections.
Method set Set a configuration value.
Instance Variable encoding Undocumented
Class Method _parse_setting Undocumented
Method _check_section_and_name Undocumented
Instance Variable _values Undocumented

Inherited from Config:

Method get_boolean Retrieve a configuration setting as boolean.
Method has_section Check if a specified section exists.
def __delitem__(self, key):

Undocumented

Parameters
key:SectionUndocumented
def __eq__(self, other):

Undocumented

Parameters
other:objectUndocumented
Returns
boolUndocumented
def __getitem__(self, key):

Undocumented

Parameters
key:SectionUndocumented
Returns
MutableMapping[Name, Value]Undocumented
def __init__(self, values=None, encoding=None):

Create a new ConfigDict.

Parameters
values:Union[MutableMapping[Section, MutableMapping[Name, Value]], None]Undocumented
encoding:Union[str, None]Undocumented
def __iter__(self):

Undocumented

Returns
Iterator[Section]Undocumented
def __len__(self):

Undocumented

Returns
intUndocumented
def __repr__(self):

Undocumented

Returns
strUndocumented
def __setitem__(self, key, value):

Undocumented

Parameters
key:SectionUndocumented
value:MutableMapping[Name, Value]Undocumented
def get(self, section, name):

Retrieve the contents of a configuration setting.

Parameters
section:SectionLikeTuple with section name and optional subsection name
name:NameLikeVariable name
Returns
ValueContents of the setting
Raises
KeyErrorif the value is not set
def get_multivar(self, section, name):

Retrieve the contents of a multivar configuration setting.

Parameters
section:SectionLikeTuple with section name and optional subsection namee
name:NameLikeVariable name
Returns
Iterator[Value]Contents of the setting as iterable
Raises
KeyErrorif the value is not set
def items(self, section):

Iterate over the configuration pairs for a specific section.

Parameters
section:SectionTuple with section name and optional subsection namee
Returns
Iterator[Tuple[Name, Value]]Iterator over (name, value) pairs
def sections(self):

Iterate over the sections.

Returns: Iterator over section tuples

Returns
Iterator[Section]Undocumented
def set(self, section, name, value):

Set a configuration value.

Parameters
section:SectionLikeTuple with section name and optional subsection namee
name:NameLikeName of the configuration value, including section and optional subsection
value:Union[ValueLike, bool]value of the setting
encoding =

Undocumented

@classmethod
def _parse_setting(cls, name):

Undocumented

Parameters
name:strUndocumented
def _check_section_and_name(self, section, name):

Undocumented

Parameters
section:SectionLikeUndocumented
name:NameLikeUndocumented
Returns
Tuple[Section, Name]Undocumented
_values =

Undocumented