python (3.11.7)
e d Z ddlmZ ddlmZ ddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z g dZ
eZdZdZ G d d e Z G d
d e Z G d d
e Z G d de Z G d de Z G d de Z G d de Z G d de Z G d de Z G d de Z G d d e Z e Z G d d Z G d d!e Z! G d" d#e Z" G d$ d%e Z# G d& d'e Z$ G d( d)e$ Z% G d* d+e% Z& G d, d-e Z' G d. d/e Z(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=<unset>, converters=<unset>):
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.buildout``
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 $ e Zd ZdZddZd ZeZdS )Errorz'Base class for ConfigParser exceptions. c J || _ t | | d S N)message Exception__init__)selfmsgs @/BuggyBox/python/3.11.7/bootstrap/lib/python3.11/configparser.pyr# zError.__init__ s% 4%%%%% c | j S r )r! r$ s r& __repr__zError.__repr__ s
|r' N)r )__name__
__module__ __qualname____doc__r# r* __str__ r' r& r r s> 11& & & & GGGr' r c e Zd ZdZd ZdS )r z2Raised when no section matches a requested option.c ` t | d| || _ |f| _ d S )Nz No section: )r r# sectionargsr$ r3 s r& r# zNoSectionError.__init__ s1
tt :;;; K r' Nr+ r, r- r. r# r0 r' r& r r s) << r' r c e Zd ZdZddZdS )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 t | dg}|hdt | g}|(| d | | d | | |}n| dd t
| d | || _ || _ || _
|||f| _ d S )N already existsWhile reading from [line {0:2d}]z
: section r zSection r ) reprappendformatextendinsertr r# joinr3 sourcelinenor4 )r$ r3 rB rC r% r! s r& r# z DuplicateSectionError.__init__ s G}} /0 ,d6ll;G! / 6 6v > >??? NN< ( ( ( NN3 CC JJq* % % %
tRWWS\\*** ff- r' NNr6 r0 r' r& r r s2 . . . . . .r' r c e Zd ZdZddZdS )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 t | dt | dg}|hdt | g}|(| d | | d | | |}n| dd t
| d | || _ || _ || _
|| _ ||||f| _ d S ) Nz in section r9 r: r; z : option r zOption r )
r< r= r> r? r@ r r# rA r3 optionrB rC r4 )r$ r3 rG rB rC r% r! s r& r# z DuplicateOptionError.__init__ s F||^T']] " ,d6ll;G! / 6 6v > >??? NN; ' ' ' NN3 CC JJq) $ $ $
tRWWS\\*** fff5 r' rD r6 r0 r' r& r r s2 6 6 6 6 6 6r' r c e Zd ZdZd ZdS )r z!A requested option was not found.c v t | d|d| || _ || _ ||f| _ d S )Nz
No option z
in section: r r# rG r3 r4 )r$ rG r3 s r& r# zNoOptionError.__init__ sJ
tt ) * * * W% r' Nr6 r0 r' r& r r s) ++& & & & &r' r c e Zd ZdZd ZdS )r z0Base class for interpolation-related exceptions.c l t | | || _ || _ |||f| _ d S r rJ )r$ rG r3 r% s r& r# zInterpolationError.__init__ s6
tS!!! Wc* r' Nr6 r0 r' r& r r s) ::+ + + + +r' r c e Zd ZdZd ZdS )r zAA string substitution required a setting which was not available.c 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# referencer4 )r$ rG r3 rawvalrO r% s r& r# z(InterpolationMissingOptionError.__init__ sV !!'F!K!K ##D&'3???"Wfi8 r' Nr6 r0 r' r& r r s) KK9 9 9 9 9r' r c 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. r0 r' r& r r s r' r c e Zd ZdZd ZdS )r
z0Raised when substitutions are nested too deeply.c 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# r4 )r$ rG r3 rP r% s r& r# z InterpolationDepthError.__init__ sU &*A ! !
##D&'3???Wf- r' Nr6 r0 r' r& r
r
s) ::. . . . .r' r
c V e Zd ZdZddZed Zej d Zd ZdS )r
z>Raised when a configuration file does not follow legal syntax.Nc |r|rt d |s|st d |r|}t | d|z || _ 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# rB errorsr4 )r$ rB filenames r& r# zParsingError.__init__- s - . .
. & DEE E
F
t AF JKKK J r' c H t j dt d | j S )zDeprecated, use `source'.NThe 'filename' attribute will be removed in Python 3.12. Use 'source' instead.
stacklevelwarningswarnDeprecationWarningrB r) s r& rX zParsingError.filename< s1
$ 1
{r' c L t j dt d || _ dS )zDeprecated, user `source'.rZ r[ r\ Nr^ r$ values r& rX zParsingError.filenameF s4
$ 1
r' c h | j ||f | xj d||fz z
c_ d S )Nz
[line %2d]: %s)rW r= r! )r$ rC lines r& r= zParsingError.appendP s: FD>*** ,~== r' rD ) r+ r, r- r. r# propertyrX setterr= r0 r' r& r
r
* su HH
X _ _ > > > > >r' r
c e Zd ZdZd ZdS )r z@Raised when a key-value pair is found before any section header.c t | d|||fz || _ || _ || _ |||f| _ d S )Nz7File contains no section headers.
file: %r, line: %d
%r)r r# rB rC rf r4 )r$ rX rC rf s r& r# z"MissingSectionHeaderError.__init__X sV
G
vt $
% & & & vt, r' Nr6 r0 r' r& r r U s) JJ- - - - -r' r c * e Zd ZdZd Zd Zd Zd ZdS )r zBDummy interpolation that passes the value through with no changes.c |S r r0 )r$ parserr3 rG rd defaultss r&
before_getzInterpolation.before_getl r' c |S r r0 r$ rm r3 rG rd s r&
before_setzInterpolation.before_seto rp r' c |S r r0 rr s r& before_readzInterpolation.before_readr rp r' c |S r r0 rr s r& before_writezInterpolation.before_writeu rp r' N)r+ r, r- r. ro rs ru rw r0 r' r& r r i sV LL r' r c D e Zd ZdZ ej d Zd Zd Zd Z dS )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 f g }| ||||||d d | S N r _interpolate_somerA r$ rm r3 rG rd rn Ls r& ro z BasicInterpolation.before_get 7 vvq%(ANNNwwqzzr' c | dd }| j d| }d|v r't d|| d fz |S )Nz%%r %1invalid interpolation syntax in %r at position %dreplace_KEYCREsubrV findr$ rm r3 rG rd tmp_values r& rs z BasicInterpolation.before_set p MM$++ L$$R33 ) +.3Y^^C5H5H-I J K K
K r' c
| ||d| }|t k rt ||| |r| d } | dk r| | d S | dk r'| |d | || d }|dd }
|
dk r | d |dd }n|
dk r| j | } | t ||d|z | | d } ||
d } || }
n!# t $ r t |||| d w xY wd|
v r |
||||
|||dz n*| |
nt ||d | |d S d S )
NTrawfallbackr r r{ r[ ('bad interpolation variable reference %rz+'%' must be followed by '%' or '(', found: )getr r
r r= r matchr optionxformgroupendKeyErrorr r} )r$ rm rG accumrestr3 mapdepthrP pcmvarvs r& r} z$BasicInterpolation._interpolate_some s/ GVEE * * *)&'6BB B " + #A1uu T"""1uu T"1"X&&&ABBxQqS ACxx S!!!ABBxcL&&t,,9267ADHJ J J ((44AEEGGHH~@CAA @ @ @9 6 6;?@@ !88**665!+2CD D D D LLOOOO.GG#'4*+ + +? " + " + " + " + " +s E E*N
r+ r, r- r. recompiler ro rs r} r0 r' r& r r y sa I I bj)**G
'+ '+ '+ '+ '+r' r c D e Zd ZdZ ej d Zd Zd Zd Z dS )r zyAdvanced variant of interpolation, supports the syntax used by
`zc.buildout`. Enables interpolation between sections.z
\$\{([^}]+)\}c f g }| ||||||d d | S rz r| r~ s r& ro z ExtendedInterpolation.before_get r r' c | dd }| j d| }d|v r't d|| d fz |S )Nz$$r $r r r s r& rs z ExtendedInterpolation.before_set r r' c
6 | ||d| }|t k rt ||| |r`| d } | dk r| | d S | dk r'| |d | || d }|dd }
|
dk r!| d |dd }n|
dk r| j | } | t ||d|z | d d } ||
d }|}
|} t | dk r$| | d }|| }nct | dk r<| d }
| | d }| |
|d
}nt ||d | nA# t t t f$ r' t! |||d | d w xY wd|v rA| |||||
t' | |
d
|dz n*| | nt ||d | |^d S d S )
NTr r r r{ r[ {r :)r zMore than one ':' found: z+'$' must be followed by '$' or '{', found: )r r r
r r= r r r r splitr lenr r r r r rA r} dictitems)r$ rm rG r r r3 r r rP r r r pathsectoptr s r& r} z'ExtendedInterpolation._interpolate_some s GVEE * * *)&'6BB B / + #A1uu T"""1uu T"1"X&&&ABBxQqS ACxx S!!!ABBxcL&&t,,9267ADHJ J Jwwqzz'',,AEEGGHH~ K4yyA~~ $ 0 0a 9 9 H Ta #Aw $ 0 0a 9 9 "JJtSdJ ; ; 6 "GG=AT C E E E !.-@ K K K9 $ A AFJKK !88**63q$+/ Tt 0L0L+M+M+0196 6 6 6 LLOOOO.GG#'4*+ + +Y / + / + / + / + / +s
BG$ $>H"Nr r0 r' r& r r s_ > > bj)**G
4+ 4+ 4+ 4+ 4+r' r c d e Zd ZdZ ej d Z fdZd Zd Z e
d Z xZ S )r z{Deprecated interpolation used in old versions of ConfigParser.
Use BasicInterpolation or ExtendedInterpolation instead.z%\(([^)]*)\)s|.c r t j |i | t j dt d d S )NzLegacyInterpolation has been deprecated since Python 3.2 and will be removed from the configparser module in Python 3.13. Use BasicInterpolation or ExtendedInterpolation instead.r[ r\ superr# r_ r` ra r$ r4 kwargs __class__s r& r# z LegacyInterpolation.__init__ sO $)&)))
G
1
r' c @ |}t }|r{|dz }|rqd|v rmt j | j | }| j || } ||z }n1# t $ r#} t |||| j d d d } ~ ww xY wn|{|rd|v rt ||| |S )Nr{ z%()rm r )
r functoolspartial_interpolation_replacer r r r r4 r
)
r$ rm r3 rG rd varsrP r r es
r& ro z LegacyInterpolation.before_get s ' QJE
#+D,G39; ; ; ((%88F !DLEE F F F9 < <AEFF CTU]])&'6BB B s A
B A<<Bc |S r r0 rr s r& rs z LegacyInterpolation.before_set. rp r' c | d }|| S d| | z S )Nr{ z%%(%s)s)r r )r rm ss r& r z*LegacyInterpolation._interpolation_replace1 s= KKNN 9;;== v 1 1! 4 44 4r' )
r+ r, r- r. r r r r# ro rs staticmethodr
__classcell__r s @r& r r s @ @ bj+,,G
( 5 5 \5 5 5 5 5r' r c
e Zd ZdZdZdZdZ e Z e j
ee j Z e j
e
d e j Z e j
e
d e j Z e j
d Zddddd d d d d
Zd ed fd d
d ddeeeddZd Zd Zd Zd Zd Zd<dZd<dZ d=dZ d>dZ d<dZ d d ed d Z d Z!d d ed d Z"d d ed d Z#d d ed d!Z$d d ed d"Z%ed d f fd# Z&d$ Z'd% Z(d& Z)d<d'Z*d?d(Z+d) Z,d* Z-d+ Z.d, Z/d- Z0d. Z1d/ Z2d0 Z3d1 Z4d2 Z5d3 Z6d4 Z7d5 Z8d6 Z9d7 Z:d8d8d8d9d:Z;e<d; Z= xZ>S )@r z,ConfigParser that does not do interpolation.z
\[ # [
(?P<header>.+) # very permissive!
\] # ]
a
(?P<option>.*?) # very permissive!
\s*(?P<vi>{delim})\s* # any number of space/tab,
# followed by any of the
# allowed delimiters,
# followed by any space/tab
(?P<value>.*)$ # everything up to eol
a
(?P<option>.*?) # very permissive!
\s*(?: # any number of space/tab,
(?P<vi>{delim})\s* # optionally followed by
# any of the allowed
# delimiters, followed by any
# space/tab
(?P<value>.*))?$ # everything up to eol
z=|:delimz\STF)1yestrueon0nofalseoffN=r )#;)
delimiterscomment_prefixesinline_comment_prefixesstrictempty_lines_in_valuesdefault_section
interpolation
convertersc || _ | | _ | | _ t | | _ | | _ t
| | | j | < t | | _ |dk r|r| j n| j
| _ nd d |D } |r>t j | j | t j | _ n=t j | j | t j | _ t |pd | _ t |pd | _ || _ || _ || _ | | _ |
| _ | j t4 u r | j | _ | j t9 | _ t; | j t8 s$t= dt? | j | t4 ur| j | |r| ! | d S d S )Nr |c 3 > K | ]}t j | V d S r )r escape).0ds r& <genexpr>z+RawConfigParser.__init__.<locals>.<genexpr>t s* ::!1 ::::::r' r r0 zSinterpolation= must be None or an instance of Interpolation; got an object of type )"_dict _sections _defaultsr _converters_proxiesr tuple _delimiters OPTCRE_NVOPTCRE_optcrerA r r _OPT_NV_TMPLr> VERBOSE _OPT_TMPL_comment_prefixes_inline_comment_prefixes_strict_allow_no_value_empty_lines_in_valuesr _interpolation_UNSET_DEFAULT_INTERPOLATIONr
isinstance TypeErrortypeupdate_read_defaults)
r$ rn dict_typeallow_no_valuer r r r r r r r r s
r& r# zRawConfigParser.__init__c s.
+D11
)5dO)L)L
o& ,, # #-;L4>>DLL::z:::::A
6 !z$*;*B*B*B*K*K*,* 6 6 "z$.*?*?a*?*H*H*,* 6 6 !&'7'=2!>!> (-.E.K(L(L% - &;# , + & ( ("&"=D &"///D $-}== F*.t/B*C*CF F
V # # # #J / / / * ) ) ) ) ) * *r' c | j S r )r r) s r& rn zRawConfigParser.defaults s
~ r' c N t | j S )z3Return a list of section names, excluding [DEFAULT])listr keysr) s r& sectionszRawConfigParser.sections s DN''))***r' c || j k rt d|z || j v rt | | | j |< t | | | j |< dS )zCreate a new section in the configuration.
Raise DuplicateSectionError if a section by the specified name
already exists. Raise ValueError if name is DEFAULT.
zInvalid section name: %rN)r rV r r r r r r5 s r& add_sectionzRawConfigParser.add_section sq d* * * 7' ABB B dn $ $'00 0"&**,,w !-dG!<!<
g r' c || j v S )z~Indicate whether the named section is present in the configuration.
The DEFAULT section is not acknowledged.
)r r5 s r& has_sectionzRawConfigParser.has_section s
$.((r' c | j | }n # t $ r t | dw xY w| | j t
| S )z9Return a list of option names for the given section name.N)r copyr r r r r r )r$ r3 optss r& optionszRawConfigParser.options sv 4>'*//11DD 4 4 4 ))t 3 4 DN###DIIKK s " =c t |t t t j f r|g}t j | }g }|D ]} t || 5 }| || ddd n # 1 swxY w Y n# t $ r Y Ow xY wt |t j rt j
| }| | |S )a Read and parse a filename or an iterable of filenames.
Files that cannot be opened are silently ignored; this is
designed so that you can specify an iterable of potential
configuration file locations (e.g. current directory, user's
home directory, systemwide directory), and all existing
configuration files in the iterable will be read. A single
filename may also be given.
Return list of successfully read files.
)encodingN) r strbytesosPathLikeio
text_encodingopen_readOSErrorfspathr= )r$ filenamesr
read_okrX fps r& readzRawConfigParser.read s& i#ubk!: ; ; $" I#H--! % %H
(X666 -"JJr8,,,- - - - - - - - - - - - - - -
(BK00
/ 9X.. NN8 $ $ $ $s6 BA:. B:A> >BA> B
BBc l | |j }n# t $ r d}Y nw xY w| || dS )aP Like read() but the argument must be a file-like object.
The `f` argument must be iterable, returning one line at a time.
Optional second argument is the `source` specifying the name of the
file being read. If not given, it is taken from f.name. If `f` has no
`name` attribute, `<???>` is used.
Nz<???>)nameAttributeErrorr )r$ frB s r& read_filezRawConfigParser.read_file sU >
!!
!
!
!
!
1f s <string>c Z t j | }| || dS )z'Read configuration from a given string.N)r StringIOr )r$ stringrB sfiles r& read_stringzRawConfigParser.read_string s+ F## uf%%%%%r' <dict>c D t }| D ]\ }}t | } | | n## t t
f$ r | j r||v r Y nw xY w| | | D ]\ }}| t | }|t | }| j r||f|v rt ||| | ||f | ||| dS )a 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.
All types held in the dictionary are converted to strings during
reading, including section names, option names and keys.
Optional second argument is the `source` specifying the name of the
dictionary being read.
N)
setr r r r rV r addr r )r$
dictionaryrB elements_addedr3 r keyrd s r& read_dictzRawConfigParser.read_dict sR ' - - / / . .MGT'llG
))))):6
< G~$=$=
w ' ' ' "jjll
.
.
U&&s3xx00$ JJE< EWcNn$D$D.wVDDD ""GS>222#u----
. . .s A A.-A.c l t j dt d | || dS )z"Deprecated, use read_file instead.zMThis method will be removed in Python 3.12. Use 'parser.read_file()' instead.r[ r\ )rB N)r_ r` ra r )r$ r rX s r& readfpzRawConfigParser.readfp sC
0 1
r(+++++r' r r r c F | || }n # t $ r |t u r |cY S w xY w| | } || }n+# t $ r |t u rt || |cY S w xY w|s||S | j | |||| S )a] Get an option value for a given section.
If `vars` is provided, it must be a dictionary. The option is looked up
in `vars` (if provided), `section`, and in `DEFAULTSECT` in that order.
If the key is not found and `fallback` is provided, it is used as
a fallback value. `None` can be provided as a `fallback` value.
If interpolation is enabled and the optional argument `raw` is False,
all interpolations are expanded in the return values.
Arguments `raw`, `vars`, and `fallback` are keyword only.
The section DEFAULT is special.
)
_unify_valuesr r r r r r ro )r$ r3 rG r r r r rd s r& r zRawConfigParser.get
s ""7D11AA 6!!
!!&)) fIEE 6!!#FG444 5%-L&11$235 5
5s 22 A %A<;A<c 2 | | j ||fi | S r )r )r$ r3 convrG r s r& _getzRawConfigParser._get2 s( tHDHWf7777888r' c p | j |||f||d|S # t t f$ r |t u r |cY S w xY w)N)r r )r6 r r r )r$ r3 rG r5 r r r r s r& _get_convzRawConfigParser._get_conv5 sp 49WdF '$ ' ' %' '
'
. 6!!OOO s 55c 4 | j ||t f|||d|S Nr1 )r8 intr$ r3 rG r r r r s r& getintzRawConfigParser.getint@ s7 t~gvs ;$'/; ;39; ; ;r' c 4 | j ||t f|||d|S r: )r8 floatr< s r& getfloatzRawConfigParser.getfloatE s7 t~gvu ;#D'/; ;39; ; ;r' c 4 | j ||| j f|||d|S r: )r8 _convert_to_booleanr< s r&
getbooleanzRawConfigParser.getbooleanJ s@ t~gvt/G O"%D8O OGMO O Or' c
t u r t S j j n*# t $ r j k rt Y nw xY wt }|r2| D ] \ }}| | < fd|rfdfd|D S )a Return a list of (name, value) tuples for each option in a section.
All % interpolations are expanded in the return values, based on the
defaults passed into the constructor, unless the optional argument
`raw` is true. Additional substitutions may be provided using the
`vars` argument, which must be a dictionary whose contents overrides
any pre-existing defaults.
The section DEFAULT is special.
c L j | | S r )r ro )rG r r3 r$ s r& <lambda>z'RawConfigParser.items.<locals>.<lambda>g s) d&9&D&DT VQvY'+ '+ r' c | S r r0 )rG r s r& rF z'RawConfigParser.items.<locals>.<lambda>j s !F) r' c * g | ]}| | fS r0 r0 )r rG value_getters r&
<listcomp>z)RawConfigParser.items.<locals>.<listcomp>k s( GGG6 f--.GGGr' )
r r r r r r r r r r r r r )
r$ r3 r r orig_keysr- rd r rI r s
`` @@r& r zRawConfigParser.itemsO s< f 77==?? " N ! ! .
HHT^G, - - - - . . .$...$W--- /. . NN 1 "jjll
1
1
U+0$""3''((+ + + + + + 43333LGGGGYGGGGs A* *$BBc ^ | D ]}| | }| |= ||fc S t )zRemove a section from the parser and return it as
a (section_name, section_proxy) tuple. If no section is present, raise
KeyError.
The section DEFAULT is never returned because it cannot be removed.
)r r r$ r- rd s r& popitemzRawConfigParser.popitemm s@ ==?? CIES : r' c * | S r )lower)r$ optionstrs r& r zRawConfigParser.optionxformz s r' c |r || j k r | | }|| j v S || j vrdS | | }|| j | v p|| j v S )zCheck for the existence of a given option in a given section.
If the specified `section` is None or an empty string, DEFAULT is
assumed. If the specified `section` does not exist, returns False.F)r r r r )r$ r3 rG s r&
has_optionzRawConfigParser.has_option} s 1'T%999%%f--FT^+ +
DN
*
*5%%f--FdnW 55 0 /
1r' c |r | j | ||| }|r || j k r| j }n- | j | }n # t
$ r t
| dw xY w||| | < dS )zSet an option.N)r rs r r r r r r )r$ r3 rG rd sectdicts r& r) zRawConfigParser.set s :'224&38: :E 8'T%999~HH
8 >'2
8
8
8$W--47
8-2!!&))***s
A A c Z |r!d | j d }n
| j d }| j r4| || j | j | | j D ]7}| ||| j | | 8dS )aO Write an .ini-format representation of the configuration state.
If `space_around_delimiters` is True (the default), delimiters
between keys and values are surrounded by spaces.
Please note that comments in the original configuration file are not
preserved when writing the configuration back.
z {} r N)r> r r _write_sectionr r r )r$ r space_around_delimitersr r3 s r& writezRawConfigParser.write s # $
d .q 122AA #A > ? D$8$(N$8$8$:$:A
?
?
?~ D DG G $w 7 = = ? ?
D
D
D
D D Dr' c | d | |D ]}\ }}| j | ||| }|| j s'|t | dd z }nd}| d || ~| d dS )z-Write a single section to the specified `fp`.z[{}]
N
z
r z{}{}
)rY r> r rw r r r )r$ r section_name
section_items delimiterr- rd s r& rW z RawConfigParser._write_section s
..///' 2 2JC'44T<5:< <E (< !CJJ$6$6tV$D$DD HHX__S%00 1 1 1 1
r' c |r || j k r| j }n- | j | }n # t $ r t | dw xY w| | }||v }|r||= |S )zRemove an option.N)r r r r r r )r$ r3 rG rU existeds r&
remove_optionz RawConfigParser.remove_option s 8'T%999~HH
8 >'2
8
8
8$W--47
8!!&))H$ ! s
% A c < || j v }|r| j |= | j |= |S )zRemove a file section.)r r )r$ r3 r` s r& remove_sectionz RawConfigParser.remove_section s/ T^+ 'w'
g&r' c z || j k r$| | st | | j | S r )r r r r r$ r- s r& __getitem__zRawConfigParser.__getitem__ s< $& & &t/?/?/D/D &3-- }S!!r' c || v r | | |u rd S || j k r| j n(|| j v r | j | | ||i d S r )r r clearr r. rM s r& __setitem__zRawConfigParser.__setitem__ s $;;49-- F $& & & N " " " "
DN
"
" N3 % % ' ' ' U|$$$$$r' c || j k rt d | | st | | | d S )Nz"Cannot remove the default section.)r rV r r rc re s r& __delitem__zRawConfigParser.__delitem__ s[ $& & & ABB B $$ 3-- C r' c B || j k p| | S r )r r re s r& __contains__z RawConfigParser.__contains__ s# d**Cd.>.>s.C.CCr' c 0 t | j dz S )Nr{ )r r r) s r& __len__zRawConfigParser.__len__ s 4>""Q&&r' c f t j | j f| j S r ) itertoolschainr r r r) s r& __iter__zRawConfigParser.__iter__ s( 4 68K8K8M8MNNNr' c t }d}d}d}d}d}d} t |d D ]\ }}
t j } d | j D } | t j k r| ri }
| D ]c\ }}|
||dz }|dk r%||
|< |dk s#|dk r-|
|dz
rt | | } d|
} | t j k r| | j D ]-}|
| rd} n.| t j k rd} |
d|
}|s?| j r*| '|%|r#|| ||
d n t j }g| j |
}|r| nd}|%|r#||k r ||
| |}| j | }|r| d }|| j v r?| j r||v rt- ||| | j | }| | n^|| j k r| j }nK| }|| j |< t7 | | | j |< | | d}|t; |||
| j | }|r| d d
d \ }}}|s| | |||
} | |! }| j r||f|v rtE |||| | ||f | |
}|g||< |d||< | | |||
} | # | r| dS ) aX Parse a sectioned configuration file.
Each section in a configuration file contains a header, indicated by
a name in square brackets (`[]`), plus key/value options, indicated by
`name` and `value` delimited with a specific substring (`=` or `:` by
default).
Values can span multiple lines, as long as they are indented deeper
than the first line of the value. Depending on the parser's mode, blank
lines may be treated as parts of multiline values or ignored.
Configuration files may include comments, prefixed by specific
characters (`#` and `;` by default). Comments may appear on their own
in an otherwise empty line or may be entered in lines holding values or
section names. Please note that comments get stripped off when reading configuration files.
Nr r{ )startc i | ]}|d S )r0 )r r s r&
<dictcomp>z)RawConfigParser._read.<locals>.<dictcomp> s L L Lq" L L Lr' rw r headerrG vird )$r) enumeratesysmaxsizer r r isspaceminr strip
startswithr r= NONSPACECREsearchru SECTCREr r r r r r* r r r r r r r
_handle_errorr rstripr _join_multiline_values)r$ r fpnamer, cursectsectnameoptnamerC indent_levelr rf
comment_startinline_prefixes
next_prefixesprefixindexrd first_nonspacecur_indent_levelmorz optvals r& r zRawConfigParser._read s " %b 2 2 2 \ H \ HLFD KM L Ld.K L L LO 3;..?. "
%4%:%:%<%< B BMFE IIfeAg 6 6E {{ ,1M&) zzeaiiDqM4I4I4K4Ki(+M5(A(A
"/ 3;..?. 0
::<<**622 $%ME ++ $
- (..00E
.
/ &- + , (4 (//333 $';L ! - 4 4T : :N9G N~ 3 3 5 5 5Q ## <// ''.... 0 \''.. .H !xx 1 1H 4>11 < @H,F,F"7&8>#@ #@ @"&.":&**84444!T%999"&."&**,,3:x02>tX2N2N
h/&**8444 "GG _3FFDIII ++E22B H.0hhxw.O.O+V & L $ 2 21ffd K KA"&"2"27>>3C3C"D"D L G %w /> A A"6x7=v#G #G G&**Hg+>??? "-%+\\^^F06xGG , , 04GG , , ! . .q&&$ G G ##%%% G r' c x | j | j f}t j |f| j }|D ]{\ }}| D ]a\ }}t
|t r'd | }| j
| ||| ||< b|d S )Nr[ ) r r rq rr r r r r rA r r ru )r$ rn all_sectionsr3 r r vals r& r z&RawConfigParser._join_multiline_valuesn s ' 7 {'+~';';'='=? ? , K K GW $]]__
K
K c c4(( 2 ))C..//11C $ 3 ? ?@G@Dc!K !K
K K Kr' c t | D ]"\ }}|| j | | < #dS )zTRead the defaults passed in the initializer.
Note: values can be non-string.N)r r r )r$ rn r- rd s r& r z RawConfigParser._read_defaultsz sH #..** : :JC49DN4++C00 1 1 : :r' c n |st | }| |t | |S r )r
r= r< )r$ excr rC rf s r& r z RawConfigParser._handle_error s6 ' v&&C
64::&&&
r' c 4 i } | j | }n+# t $ r || j k rt | dY nw xY wi }|rC| D ].\ }}|t | }||| | < /t ||| j S )zCreate a sequence of lookups with 'vars' taking priority over
the 'section' which takes priority over the DEFAULTSECT.
N) r r r r r r r _ChainMapr )r$ r3 r sectiondictvardictr- rd s r& r3 z RawConfigParser._unify_values s
8 .1KK 8 8 8$...$W--47 /. 8 7 "jjll
7
7
U$ JJE16((--..+t~>>>s
%::c | | j vrt d|z | j | S )zJReturn a boolean value translating from other types if necessary.
zNot a boolean: %s)rP BOOLEAN_STATESrV rc s r& rB z#RawConfigParser._convert_to_boolean sD ;;== 3 3 3 05 899 9"5;;==11r' r )r3 rG rd c t |t st d t |t st d | j r|r&t |t st d dS dS )a Raises a TypeError for non-string values.
The only legal non-string value if we allow valueless
options is None, so we need to check if the value is a
string if:
- we do not allow valueless options, or
- we allow valueless options but the value is not None
For compatibility reasons this method is not used in classic set()
for RawConfigParsers. It is invoked in every case for mapping protocol
access and in ConfigParser.set().
z section names must be stringszoption keys must be stringsz option values must be stringsN)r r r r )r$ r3 rG rd s r& _validate_value_typesz%RawConfigParser._validate_value_types s '3'' = ;<< <&#&& ; 9:: :# Au A eS))
A ?@@@
A
A A Ar' c | j S r )r r) s r& r zRawConfigParser.converters s r' r )r! )r' )T)?r+ r, r- r.
_SECT_TMPLr r r r r r r r r> r r r r
_default_dictr r r# rn r r r r r r r& r. r0 r r6 r8 r= r@ rC r rN r rS r) rY rW ra rc rf ri rk rm ro rs r r r r r3 rB r rg r r r s @r& r r : sB 66 J
I L +]__bjRZ00G
RZ ((u(55rz
B
BF
<..U.;;RZHHI "*U##K d$ eM MN !%
%+*5?",d D!, %& +* +* +* +* +*Z + + +
= = = ) ) )! ! ! 6
& & & &
. . . .>, , , , +0dV #5 #5 #5 #5 #5J9 9 9 7<$! .3 ; ; ; ; ;
054 ; ; ; ; ;
27T "O O O O O
#D H H H H H H< ! ! ! 1 1 1 3 3 3 3 D D D D(
" " "
% % %! ! !D D D' ' 'O O Ox x xt
K
K
K: : : ? ? ?(2 2 2 02"B A A A A A* X r' r c H e Zd ZdZ e Zd fd Z fdZd Z xZ S )r z(ConfigParser implementing interpolation.Nc | | || t ||| dS )zmSet an option. Extends RawConfigParser.set by validating type and
interpolation syntax on the value.rG rd N)r r r) )r$ r3 rG rd r s r& r) zConfigParser.set s>
""&">>>
GVU+++++r' c v | | t | dS )zCreate a new section in the configuration. Extends
RawConfigParser.add_section by validating if the section name is
a string.)r3 N)r r r )r$ r3 r s r& r zConfigParser.add_section s:
""7"333
G$$$$$r' c | j }t | _ | | j |i || _ dS # || _ w xY w)zReads the defaults passed in the initializer, implicitly converting
values to strings like the rest of the API.
Does not perform interpolation for backwards compatibility.
N)r r r. r )r$ rn hold_interpolations r& r zConfigParser._read_defaults sY 5!%!4 "///D NND 0(; < < <"4D "4D 4 4 4 4s 6A A
r )
r+ r, r- r. r r r) r r r r s @r& r r sz 22 / / 1 1, , , , , , % % % % % 5 5 5 5 5 5 5r' r c " e Zd ZdZ fdZ xZS )r z8ConfigParser alias for backwards compatibility purposes.c r t j |i | t j dt d d S )NzThe SafeConfigParser class has been renamed to ConfigParser in Python 3.2. This alias will be removed in Python 3.12. Use ConfigParser directly instead.r[ r\ r r s r& r# zSafeConfigParser.__init__ sN $)&)))
2
1
r' )r+ r, r- r. r# r r s @r& r r s> BB
r' r c e Zd ZdZd Zd Zd Zd Zd Zd Z d Z
d Z d
Z e
d Ze
d Zddd
d
ddZd
S )r z+A proxy for a single section from a parser.c || _ || _ |j D ]A}d|z }t j | j t
|| }t | || BdS )z@Creates a view on a section of the specified `name` in `parser`.r _implN)_parser_namer r r r getattrsetattr)r$ rm r r5 r- getters r& r# zSectionProxy.__init__ sk
% ' 'D$,C &txwvs7K7KLLLF D#v & & & & ' 'r' c 6 d | j S )Nz
<Section: {}>)r> r r) s r& r* zSectionProxy.__repr__ s %%dj111r' c | j | j | st | | j | j | S r )r rS r r r re s r& rf zSectionProxy.__getitem__ sD |&&tz377 3-- |
C000r' c | | j || | j | j || S )Nr )r r r) r rM s r& ri zSectionProxy.__setitem__ s9 **#U*CCC|
C777r' c | j | j | r | j | j | st | d S r )r rS r ra r re s r& rk zSectionProxy.__delitem__ sP ''
C88 **4:s;; 3-- r' c B | j | j | S r )r rS r re s r& rm zSectionProxy.__contains__ s |&&tz3777r' c D t | S r )r _optionsr) s r& ro zSectionProxy.__len__ s 4==??###r' c N | S r )r rs r) s r& rs zSectionProxy.__iter__ s }}'')))r' c | j | j j k r | j | j S | j S r )r r r r rn r) s r& r zSectionProxy._options s@ : 5 5 5<''
33 3<((** *r' c | j S r )r r) s r& rm zSectionProxy.parser s |r' c | j S r )r r) s r& r zSectionProxy.name s zr' NF)r r r c D |s | j j } || j |f|||d|S )zGet an option value.
Unless `fallback` is provided, `None` will be returned if the option
is not found.
r1 )r r r )r$ rG r r r r r s r& r zSectionProxy.get sI %L$EuTZ 2St &2 2*02 2 2r' r )r+ r, r- r. r# r* rf ri rk rm ro rs r rg rm r r r0 r' r& r r s 55' ' '2 2 21 1 1
8 8 8
8 8 8$ $ $* * *+ + + X X
2D
2
2
2
2
2
2
2r' r c V e Zd ZdZ ej d Zd Zd Zd Z d Z
d Z d Z d S )
r a/ Enables reuse of get*() methods between the parser and section proxies.
If a parser class implements a getter directly, the value for the given
key will be ``None``. The presence of the converter name here enables
section proxies to find and use the implementation on the parser class.
z^get(?P<name>.+)$c || _ i | _ t | j D ]^}| j | }|r"t t
| j | sAd | j | d < _d S )Nr )r _datadir GETTERCREr callabler r )r$ rm r r s r& r# zConverterMapping.__init__8 s
$,'' / /F$$V,,A
HWT\6%B%B C C
*.DJqwwv ' ' / /r' c | j | S r )r re s r& rf z ConverterMapping.__getitem__A s z# r' c d|z }n># t $ r1 t d |t | w xY w|dk rt d || j |< t j | j j | }||_ t | j || | j D ].}t j |j | }t ||| /d S )Nr z Incompatible key: {} (type: {})z)Incompatible key: cannot use "" as a name)r5 r )
r rV r> r r r r r r8 converterr valuesr )r$ r- rd kfuncproxyr s r& ri z ConverterMapping.__setitem__D s 8 AA 8 8 8 &sDII 6 68 8
8 8
:: HII I
3 !7eDDD a&&&\((** & &E &uy===F E1f % % % % & &s ;Ac d|pd z }n # t $ r t | w xY w| j |= t j | j f| j D ]#} t || # t $ r Y w xY wd S )Nr ) r r r rq rr r r delattrr )r$ r- r insts r& rk z ConverterMapping.__delitem__T s %AA 3-- JsO OT\OT\5H5H5J5JKK D
a !
s
$$A55
BBc * t | j S r )iterr r) s r& rs zConverterMapping.__iter__b s DJ r' c * t | j S r )r r r) s r& ro zConverterMapping.__len__e s 4: r' N)
r+ r, r- r. r r r r# rf ri rk rs ro r0 r' r& r r . s
/00I/ / / & & & r' r ))r. collections.abcr collectionsr r r r rq r r r| r_ __all__r r r r r" r r r r r r r r r
r
r objectr r r r r r r r r r r0 r' r& <module>r s' K KZ + * * * * * - - - - - -
5 5 5
I
U . . . . .E . . .46 6 6 6 65 6 6 66& & & & &E & & &+ + + + + + + + 9 9 9 9 9&8 9 9 9 1
.
.
.
.
. 0
.
.
.(> (> (> (> (>5 (> (> (>V - - - - - - - -"
E+ E+ E+ E+ E+ E+ E+ E+PG+ G+ G+ G+ G+M G+ G+ G+T,5 ,5 ,5 ,5 ,5- ,5 ,5 ,5^~ ~ ~ ~ ~ n ~ ~ ~ B 5 5 5 5 5? 5 5 5@
|
C2 C2 C2 C2 C2> C2 C2 C2L8 8 8 8 8 ~ 8 8 8 8 8 r' 
Browse
Usage
Versions