class documentation

class ConfigFile(ConfigDict):

View In Hierarchy

A Git configuration file, like .git/config or ~/.gitconfig.

Class Method from_file Read configuration from a file-like object.
Class Method from_path Read configuration from a file on disk.
Method __init__ Create a new ConfigDict.
Method write_to_file Write configuration to a file-like object.
Method write_to_path Write configuration to a file on disk.
Instance Variable path Undocumented

Inherited from ConfigDict:

Method __delitem__ Undocumented
Method __eq__ Undocumented
Method __getitem__ Undocumented
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 (via ConfigDict):

Method get_boolean Retrieve a configuration setting as boolean.
Method has_section Check if a specified section exists.
@classmethod
def from_file(cls, f):

Read configuration from a file-like object.

Parameters
f:BinaryIOUndocumented
Returns
ConfigFileUndocumented
@classmethod
def from_path(cls, path):

Read configuration from a file on disk.

Parameters
path:strUndocumented
Returns
ConfigFileUndocumented
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 write_to_file(self, f):

Write configuration to a file-like object.

Parameters
f:BinaryIOUndocumented
def write_to_path(self, path=None):

Write configuration to a file on disk.

Parameters
path:Optional[str]Undocumented
path: Optional[str] =

Undocumented