o
9jT @ s d Z ddlmZ ddlmZ ddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z g dZ
eZdZdZG dd d eZG d
d d eZG d d
d
eZG dd deZG dd deZG dd deZG dd deZG dd deZG dd deZG dd deZ G d d d e Z e Z G d d d Z G d d! d!e Z!G d"d# d#e Z"G d$d% d%e Z#G d&d' d'eZ$G d(d) d)e$Z%G d*d+ d+e%Z&G d,d- d-eZ'G d.d/ d/eZ(dS )0a Configuration file parser.
A configuration file consists of sections, lead by a "[section]" header,
and followed by "name: value" entries, with continuations and such in
the style of RFC 822.
Intrinsic defaults can be specified by passing them into the
ConfigParser constructor as a dictionary.
class:
ConfigParser -- responsible for parsing a list of
configuration files, and managing the parsed database.
methods:
__init__(defaults=None, dict_type=_default_dict, allow_no_value=False,
delimiters=('=', ':'), comment_prefixes=('#', ';'),
inline_comment_prefixes=None, strict=True,
empty_lines_in_values=True, default_section='DEFAULT',
interpolation=, converters=):
Create the parser. When `defaults` is given, it is initialized into the
dictionary or intrinsic defaults. The keys must be strings, the values
must be appropriate for %()s string interpolation.
When `dict_type` is given, it will be used to create the dictionary
objects for the list of sections, for the options within a section, and
for the default values.
When `delimiters` is given, it will be used as the set of substrings
that divide keys from values.
When `comment_prefixes` is given, it will be used as the set of
substrings that prefix comments in empty lines. Comments can be
indented.
When `inline_comment_prefixes` is given, it will be used as the set of
substrings that prefix comments in non-empty lines.
When `strict` is True, the parser won't allow for any section or option
duplicates while reading from a single source (file, string or
dictionary). Default is True.
When `empty_lines_in_values` is False (default: True), each empty line
marks the end of an option. Otherwise, internal empty lines of
a multiline option are kept as part of the value.
When `allow_no_value` is True (default: False), options without
values are accepted; the value presented for these is None.
When `default_section` is given, the name of the special section is
named accordingly. By default it is called ``"DEFAULT"`` but this can
be customized to point to any other valid section name. Its current
value can be retrieved using the ``parser_instance.default_section``
attribute and may be modified at runtime.
When `interpolation` is given, it should be an Interpolation subclass
instance. It will be used as the handler for option value
pre-processing when using getters. RawConfigParser objects don't do
any sort of interpolation, whereas ConfigParser uses an instance of
BasicInterpolation. The library also provides a ``zc.buildbot``
inspired ExtendedInterpolation implementation.
When `converters` is given, it should be a dictionary where each key
represents the name of a type converter and each value is a callable
implementing the conversion from string to the desired datatype. Every
converter gets its corresponding get*() method on the parser object and
section proxies.
sections()
Return all the configuration section names, sans DEFAULT.
has_section(section)
Return whether the given section exists.
has_option(section, option)
Return whether the given option exists in the given section.
options(section)
Return list of configuration options for the named section.
read(filenames, encoding=None)
Read and parse the iterable of named configuration files, given by
name. A single filename is also allowed. Non-existing files
are ignored. Return list of successfully read files.
read_file(f, filename=None)
Read and parse one configuration file, given as a file object.
The filename defaults to f.name; it is only used in error
messages (if f has no `name` attribute, the string `` is used).
read_string(string)
Read configuration from a given string.
read_dict(dictionary)
Read configuration from a dictionary. Keys are section names,
values are dictionaries with keys and values that should be present
in the section. If the used dictionary type preserves order, sections
and their keys will be added in order. Values are automatically
converted to strings.
get(section, option, raw=False, vars=None, fallback=_UNSET)
Return a string value for the named option. All % interpolations are
expanded in the return values, based on the defaults passed into the
constructor and the DEFAULT section. Additional substitutions may be
provided using the `vars` argument, which must be a dictionary whose
contents override any pre-existing defaults. If `option` is a key in
`vars`, the value from `vars` is used.
getint(section, options, raw=False, vars=None, fallback=_UNSET)
Like get(), but convert value to an integer.
getfloat(section, options, raw=False, vars=None, fallback=_UNSET)
Like get(), but convert value to a float.
getboolean(section, options, raw=False, vars=None, fallback=_UNSET)
Like get(), but convert value to a boolean (currently case
insensitively defined as 0, false, no, off for False, and 1, true,
yes, on for True). Returns False or True.
items(section=_UNSET, raw=False, vars=None)
If section is given, return a list of tuples with (name, value) for
each option in the section. Otherwise, return a list of tuples with
(section_name, section_proxy) for each section, including DEFAULTSECT.
remove_section(section)
Remove the given file section and all its options.
remove_option(section, option)
Remove the given option from the given section.
set(section, option, value)
Set the given option.
write(fp, space_around_delimiters=True)
Write the configuration state in .ini format. If
`space_around_delimiters` is True (the default), delimiters
between keys and values are surrounded by spaces.
)MutableMapping)ChainMapN)NoSectionErrorDuplicateOptionErrorDuplicateSectionError
NoOptionErrorInterpolationErrorInterpolationDepthError InterpolationMissingOptionErrorInterpolationSyntaxError ParsingErrorMissingSectionHeaderError ConfigParserSafeConfigParserRawConfigParser
InterpolationBasicInterpolationExtendedInterpolationLegacyInterpolation SectionProxyConverterMapping DEFAULTSECTMAX_INTERPOLATION_DEPTHDEFAULT
c @ s& e Zd ZdZdddZdd ZeZdS ) Errorz'Base class for ConfigParser exceptions. c C s || _ t| | d S N)message Exception__init__)selfmsg r# #/usr/lib/python3.10/configparser.pyr s zError.__init__c C | j S r )r r! r# r# r$ __repr__ zError.__repr__N)r )__name__
__module__ __qualname____doc__r r' __str__r# r# r# r$ r s
r c @ e Zd ZdZdd ZdS )r z2Raised when no section matches a requested option.c C s$ t | d|f || _|f| _d S )NzNo section: %r)r r sectionargsr! r/ r# r# r$ r s zNoSectionError.__init__Nr) r* r+ r, r r# r# r# r$ r r c @ e Zd ZdZdddZdS )r a Raised when a section is repeated in an input source.
Possible repetitions that raise this exception are: multiple creation
using the API or in strict parsers when a section is found more than once
in a single input file, string or dictionary.
Nc C s t |dg}|d ur)dt |g}|d ur |d| |d || |}n|dd t| d| || _|| _ || _
|||f| _ d S )N already existsWhile reading from [line {0:2d}]z
: section r zSection r ) reprappendformatextendinsertr r joinr/ sourcelinenor0 )r! r/ r> r? r" r r# r# r$ r s
z DuplicateSectionError.__init__NNr2 r# r# r# r$ r s r c @ r4 )r zRaised by strict parsers when an option is repeated in an input source.
Current implementation raises this exception only when an option is found
more than once in a single file, string or dictionary.
Nc C s t |dt |dg}|d ur-dt |g}|d ur |d| |d || |}n|dd t| d| || _|| _ || _
|| _ ||||f| _ d S ) Nz in section r5 r6 r7 z : option r zOption r )
r8 r9 r: r; r< r r r= r/ optionr> r? r0 )r! r/ rA r> r? r" r r# r# r$ r s"
z DuplicateOptionError.__init__r@ r2 r# r# r# r$ r s r c @ r. )r z!A requested option was not found.c C s. t | d||f || _|| _||f| _d S )NzNo option %r in section: %rr r rA r/ r0 )r! rA r/ r# r# r$ r s zNoOptionError.__init__Nr2 r# r# r# r$ r r3 r c @ r. )r z0Base class for interpolation-related exceptions.c C s( t | | || _|| _|||f| _d S r rB )r! rA r/ r" r# r# r$ r s zInterpolationError.__init__Nr2 r# r# r# r$ r r3 r c @ r. )r
zAA string substitution required a setting which was not available.c C s8 d ||||}t| ||| || _||||f| _d S )NzBad value substitution: option {!r} in section {!r} contains an interpolation key {!r} which is not a valid option name. Raw value: {!r})r: r r referencer0 )r! rA r/ rawvalrC r" r# r# r$ r s z(InterpolationMissingOptionError.__init__Nr2 r# r# r# r$ r
r3 r
c @ s e Zd ZdZdS )r zRaised when the source text contains invalid syntax.
Current implementation raises this exception when the source text into
which substitutions are made does not conform to the required syntax.
N)r) r* r+ r, r# r# r# r$ r s r c @ r. )r z0Raised when substitutions are nested too deeply.c C s0 d ||t|}t| ||| |||f| _d S )NzRecursion limit exceeded in value substitution: option {!r} in section {!r} contains an interpolation key which cannot be substituted in {} steps. Raw value: {!r})r: r r r r0 )r! rA r/ rD r" r# r# r$ r s z InterpolationDepthError.__init__Nr2 r# r# r# r$ r r3 r c @ s< e Zd ZdZd
ddZedd Zejdd Zdd ZdS ) r z>Raised when a configuration file does not follow legal syntax.Nc C sP |r|rt d|s|st d|r|}t| d| || _g | _|f| _d S )Nz:Cannot specify both `filename' and `source'. Use `source'.z%Required argument `source' not given.z"Source contains parsing errors: %r)
ValueErrorr r r> errorsr0 )r! r> filenamer# r# r$ r - s zParsingError.__init__c C s t jdtdd | jS )zDeprecated, use `source'.NThe 'filename' attribute will be removed in Python 3.12. Use 'source' instead.
stacklevelwarningswarnDeprecationWarningr> r& r# r# r$ rG < s
zParsingError.filenamec C s t jdtdd || _dS )zDeprecated, user `source'.rH rI rJ NrL r! valuer# r# r$ rG F s
c C s* | j ||f | jd||f 7 _d S )Nz
[line %2d]: %s)rF r9 r )r! r? liner# r# r$ r9 P s zParsingError.appendr@ ) r) r* r+ r, r propertyrG setterr9 r# r# r# r$ r * s
r c @ r. )r
z@Raised when a key-value pair is found before any section header.c C s8 t | d|||f || _|| _|| _|||f| _d S )Nz7File contains no section headers.
file: %r, line: %d
%r)r r r> r? rR r0 )r! rG r? rR r# r# r$ r X s z"MissingSectionHeaderError.__init__Nr2 r# r# r# r$ r
U r3 r
c @ s0 e Zd ZdZdd Zdd Zdd Zdd Zd
S ) r zBDummy interpolation that passes the value through with no changes.c C |S r r# )r! parserr/ rA rQ defaultsr# r# r$
before_getl zInterpolation.before_getc C rU r r# r! rV r/ rA rQ r# r# r$
before_seto rY zInterpolation.before_setc C rU r r# rZ r# r# r$ before_readr rY zInterpolation.before_readc C rU r r# rZ r# r# r$ before_writeu rY zInterpolation.before_writeN)r) r* r+ r, rX r[ r\ r] r# r# r# r$ r i s r c @ 2 e Zd ZdZedZdd Zdd Zdd Z d S )
r a! Interpolation as implemented in the classic ConfigParser.
The option values can contain format strings which refer to other values in
the same section, or values in the special default section.
For example:
something: %(dir)s/whatever
would resolve the "%(dir)s" to the value of dir. All reference
expansions are done late, on demand. If a user needs to use a bare % in
a configuration file, she can escape it by writing %%. Other % usage
is considered a user error and raises `InterpolationSyntaxError`.z
%\(([^)]+)\)sc C $ g }| ||||||d d|S N r _interpolate_somer= r! rV r/ rA rQ rW Lr# r# r$ rX
z BasicInterpolation.before_getc C < | dd}| jd|}d|v r td||df |S )Nz%%r %1invalid interpolation syntax in %r at position %dreplace_KEYCREsubrE findr! rV r/ rA rQ tmp_valuer# r# r$ r[ z BasicInterpolation.before_setc
C sb |j ||d|d}|tkrt||||r|d} | dk r%|| d S | dkr8||d | || d }|dd }
|
dkrN|d |dd }n]|
dkr| j|} | d u rdt||d| || d} ||
d }z|| }
W n t y t |||| d w d|
v r|
||||
|||d n||
n t||d |f |sd S d S )
NTrawfallbackrh r ra rI ('bad interpolation variable reference %rz/'%%' must be followed by '%%' or '(', found: %r)getr r rn r9 rl matchr optionxformgroupendKeyErrorr
rc )r! rV rA accumrestr/ mapdepthrD pcmvarvr# r# r$ rc sX
z$BasicInterpolation._interpolate_someN
r) r* r+ r, recompilerl rX r[ rc r# r# r# r$ r y s
r c @ r^ )
r zyAdvanced variant of interpolation, supports the syntax used by
`zc.buildout`. Enables interpolation between sections.z
\$\{([^}]+)\}c C r_ r` rb rd r# r# r$ rX rf z ExtendedInterpolation.before_getc C rg )Nz$$r $ri rj ro r# r# r$ r[ rq z ExtendedInterpolation.before_setc C s |j ||d|d}|tkrt||||r|d} | dk r%|| d S | dkr8||d | || d }|dd }
|
dkrN|d |dd }n|
dkr| j|} | d u rdt||d| | d d } ||
d }|}
|}z7t | dkr| | d }|| }n#t | dkr| d }
| | d }|j |
|dd
}n t||d |f W n t
ttfy t|||d | d w d|v r| |||||
t|j|
dd
|d n|| n t||d |f |sd S d S )
NTrr r r ra rI {rv :)rs zMore than one ':' found: %rz-'$' must be followed by '$' or '{', found: %r)rw r r rn r9 rl rx r rz splitr{ lenry r| r r r
r= rc dictitems)r! rV rA r} r~ r/ r r rD r r r pathsectoptr r# r# r$ rc st
z'ExtendedInterpolation._interpolate_someNr r# r# r# r$ r s
r c @ s6 e Zd ZdZedZdd Zdd Ze dd Z
d S )
r z{Deprecated interpolation used in old versions of ConfigParser.
Use BasicInterpolation or ExtendedInterpolation instead.z%\(([^)]*)\)s|.c
C s |}t }|r@|d8 }|r=d|v r=tj| j|d}| j||}z|| }W n ty< } z t|||| jd d d } ~ ww n|s|rLd|v rLt ||||S )Nra z%()rV r )
r functoolspartial_interpolation_replacerl rm r| r
r0 r )
r! rV r/ rA rQ varsrD r rk er# r# r$ rX s0
z LegacyInterpolation.before_getc C rU r r# rZ r# r# r$ r[ % rY z LegacyInterpolation.before_setc C s( | d}|d u r
| S d|| S )Nra z%%(%s)s)rz ry )rx rV sr# r# r$ r ( s
z*LegacyInterpolation._interpolation_replaceN) r) r* r+ r, r r rl rX r[ staticmethodr r# r# r# r$ r s
r c
s6 e Zd ZdZdZdZdZe Ze
ee j Z e
ej
dde j Ze
ej
dde j Ze
dZddddd d d d d
Zd ed fd d
d ddeeedddZdd Zdd Zdd Zdd Zdd Zdddd Zddd d Z ded d!Z dfd#d$Z ddd%d&Z d d ed'd(d)Z d*d+ Z!d d ed'd,d-Z"d d ed'd.d/Z#d d ed'd0d1Z$d d ed'd2d3Z%ed d f fd4d5 Z&d6d7 Z'd8d9 Z(d:d; Z)dddd?Z+d@dA Z,dBdC Z-dDdE Z.dFdG Z/dHdI Z0dJdK Z1dLdM Z2dNdO Z3dPdQ Z4dRdS Z5dTdU Z6dVdW Z7dXdY Z8dZd[ Z9d\d] Z:d^d^d^d_d`daZ;eS )hr z,ConfigParser that does not do interpolation.z
\[ # [
(?P.+) # very permissive!
\] # ]
a
(?P