a
S^ @ sT d dl Z d dlZd dlZd dlmZmZmZmZ d dlZd dl m
Z
da edededediZ ddddd d d d
d
d
d d d d d d Z
eeeeed
Zdd ZdZdZdZdZdZdZe ZdZdZdZdZddddddddddddd Z d d Z G d d d e Z G d!d" d"eZ e Z!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,e'Z(G d-d. d.e$Z)G d/d0 d0e$Z*G d1d2 d2e$Z+G d3d4 d4e+Z,G d5d6 d6e$Z-G d7d8 d8e+Z.G d9d: d:e$Z/G d;d< d d>e0Z1G d?d@ d@e0Z2e1e2dAZ3dBdC Z4G dDdE dEe5Z6G dFdG dGe6Z7G dHdI dIeZ8dOdJdKZ9dPdMdNZ:dS )Q N)BOM_UTF8 BOM_UTF16 BOM_UTF16_BE BOM_UTF16_LE) __version__)utf_8N)utf16_beutf_16)utf16_ler )r r r r r
r )r u16utf16zutf-16r utf_16_bezutf-16ber
utf_16_lezutf-16ler u8utfutf8utf-8)r r r r
Nc C s t | dkS )Nr )BOM_LISTgetlower)encoding r -/usr/lib/python3.9/site-packages/configobj.py
match_utf8D s r z'%s'z"%s"z%sz
'"z"""%s"""z'''%s''')DEFAULT_INDENT_TYPEDEFAULT_INTERPOLATIONConfigObjError NestingError
ParseErrorDuplicateErrorConfigspecError ConfigObj SimpleValInterpolationErrorInterpolationLoopErrorMissingInterpolationOptionRepeatSectionError ReloadError UnreprError UnknownTypeflatten_errorsget_extra_values configparserz
TF)
interpolation raise_errors list_values create_empty
file_error
configspec stringify indent_typer default_encodingunreprwrite_empty_valuesc C s> t d u rdd l a d| } t | }| d d d S )Nr za= )compilerparse getChildren)spr r r getObj s
r? c @ s e Zd ZdS )r) N)__name__
__module__ __qualname__r r r r r) s r) c @ s\ e Zd Zdd Zdd Zdd Zdd Zd d
Zd d Zd
d Z dd Z
dd Z dd Z dS )Builderc C s t d u rt|jjt |S N)mr) __class__r@ selfor r r build s z
Builder.buildc C s t t| j| S rD )listmaprJ r< rG r r r
build_List s zBuilder.build_Listc C s |j S rD )valuerG r r r build_Const s zBuilder.build_Constc C s2 i }t t| j| }|D ]}t|||< q |S rD )iterrL rJ r< next)rH rI dielr r r
build_Dict s
zBuilder.build_Dictc C s t | |S rD )tuplerM rG r r r build_Tuple s zBuilder.build_Tuplec C s6 |j dkrd S |j dkr dS |j dkr*dS tdd S )NNoneTrueTFalseFzUndefined Name)namer) rG r r r
build_Name s
zBuilder.build_Namec C sd t t| j| \}}z t|}W n ty> tdY n0 t|trT|j dkr\td|| S )NZAddg )
rK rL rO r< float TypeErrorr)
isinstancecomplexreal)rH rI ra imagr r r build_Add s zBuilder.build_Addc C s | |j}t||jS rD )rJ exprgetattrattrname)rH rI parentr r r
build_Getattr s zBuilder.build_Getattrc C s | | d S Nr rO r< rG r r r build_UnarySub s zBuilder.build_UnarySubc C s | | d S ri rj rG r r r build_UnaryAdd s zBuilder.build_UnaryAddN)
r@ rA rB rJ rM rO rU rW r\ rc rh rk rl r r r r rC s
rC c C s | s| S dd l }|| S ri )astZ literal_eval)r= rm r r r r7 s r7 c @ s e Zd ZdZdddZdS )r zk
This is the base class for all errors that ConfigObj raises.
It is a subclass of SyntaxError.
Nc C s || _ || _t| | d S rD )line line_number SyntaxError__init__)rH messagerp ro r r r rr s zConfigObjError.__init__)rn Nrn r@ rA rB __doc__rr r r r r r s r c @ s e Zd ZdZdS )r zE
This error indicates a level of nesting that doesn't match.
Nr@ rA rB ru r r r r r s r c @ s e Zd ZdZdS )r z
This error indicates that a line is badly written.
It is neither a valid ``key = value`` line,
nor a valid section marker line.
Nrv r r r r r s r c @ s e Zd ZdZdd ZdS )r' zW
A 'reload' operation failed.
This exception is a subclass of ``IOError``.
c C s t | d d S )Nz#reload failed, filename is not set.)IOErrorrr rH r r r rr s zReloadError.__init__Nrt r r r r r' s r' c @ s e Zd ZdZdS )r z:
The keyword or section specified already exists.
Nrv r r r r r s r c @ s e Zd ZdZdS )r z7
An error occured whilst parsing a configspec.
Nrv r r r r r s r c @ s e Zd ZdZdS )r# z,Base class for the two interpolation errors.Nrv r r r r r# s r# c @ s e Zd ZdZdd ZdS )r$ z=Maximum interpolation depth exceeded in string interpolation.c C s t | d| d S )Nz*interpolation loop detected in value "%s".r# rr )rH optionr r r rr s z InterpolationLoopError.__init__Nrt r r r r r$ s r$ c @ s e Zd ZdZdS )r& zk
This error indicates additional sections in a section with a
``__many__`` (repeated) section.
Nrv r r r r r& s r& c @ s e Zd ZdZdd ZdS )r% z0A value specified for interpolation was missing.c C s d| }t | | d S )Nz%missing option "%s" in interpolation.ry )rH rz msgr r r rr s z#MissingInterpolationOption.__init__Nrt r r r r r% s r% c @ s e Zd ZdZdS )r( z An error parsing in unrepr mode.Nrv r r r r r( s r( c @ s> e Zd ZdZedZdZdd Zdd Z dd Z
d
d Z d S )
InterpolationEnginez
A helper class to help perform string interpolation.
This class is an abstract base class; its descendants perform
the actual work.
%\(([^)]*)\)s%c C s
|| _ d S rD section)rH r r r r rr * s z InterpolationEngine.__init__c s0 j |vr|S fdd ||ji }|S )Nc s | |j f|v rt| d|| |j f< j|}|r|\}}}|du rR|}n ||||}| \} }
d|d| |||
d f}| t| } j|| }q0|| |j f= |S )ax The function that does the actual work.
``value``: the string we're trying to interpolate.
``section``: the section in which that string was found
``backtrail``: a dict to keep track of where we've been,
to detect and prevent infinite recursion loops
This is similar to a depth-first-search algorithm.
r9 Nrn )r[ r$ _KEYCREsearch _parse_matchspanjoinlen) keyrN r Z backtrailmatchkvr= Z replacementstartendZnew_search_startrecursive_interpolaterH r r r 4 s z>InterpolationEngine.interpolate..recursive_interpolate)_cookier )rH r rN r r r interpolate/ s
,z InterpolationEngine.interpolatec C s | j jj}d| j j_| j }||}|dur8t|ts8qr|di |}|dur^t|ts^qr|j|u rjqr|j}q|| j j_|du rt|||fS )zHelper function to fetch values from owning section.
Returns a 2-tuple: the value, and the section where it was found.
FNDEFAULT)r mainr. r r_ Sectionrg r% )rH r Z save_interpZcurrent_sectionvalr r r _fetchd s
zInterpolationEngine._fetchc C s
t dS )a Implementation-dependent helper function.
Will be passed a match object corresponding to the interpolation
key we just found (e.g., "%(foo)s" or "$foo"). Should look up that
key in the appropriate config file section (using the ``_fetch()``
helper function) and return a 3-tuple: (key, value, section)
``key`` is the name of the key we're looking for
``value`` is the value found for that key
``section`` is a reference to the section where it was found
``key`` and ``section`` should be None if no further
interpolation should be performed on the resulting value
(e.g., if we interpolated "$$" and returned "$").
N)NotImplementedError)rH r r r r r s z InterpolationEngine._parse_matchN) r@ rA rB ru recompiler r rr r r r r r r r r| s
5"r| c @ s& e Zd ZdZdZedZdd ZdS )ConfigParserInterpolationzBehaves like ConfigParser.r~ r} c C s" | d}| |\}}|||fS )Nr9 )groupr rH r r rN r r r r r s
z&ConfigParserInterpolation._parse_matchN) r@ rA rB ru r r r r r r r r r r s
r c @ s4 e Zd ZdZdZdZedejej B Z
dd Z dS )TemplateInterpolationz Behaves like string.Template.$z
\$(?:
(?P\$) | # Two $ signs
(?P[_a-z][_a-z0-9]*) | # $name format
{(?P[^}]*)} # ${name} format
)
c C s\ | dp| d}|d ur4| |\}}|||fS | dd urNd | jd fS d | d fS )NZnamedZbracedZescaped)r r
_delimiterr r r r r s
z"TemplateInterpolation._parse_matchN) r@ rA rB ru r r r r
IGNORECASEVERBOSEr r r r r r r s
r )r, templatec G s | j | g|R S rD )__new__)clsargsr r r
__newobj__ s r c @ s$ e Zd ZdZdd Zdd ZdDddZd d
Zd d Zd
d Z dEddZ
dd Z dFddZ dd Z
efddZdd Zd d ZdGd d Zd d! Zd"d# Zd$d% Zd&d' Zd(d) ZeZd*d+ Zd,d- ZeZd.e_d/d0 Z d1d2 Z d3d4 Z dHd6d7Z d8d9 Z d:d; Z!dd? Z#d@dA Z$dBdC Z%dS )Ir a
A dictionary-like object that represents a section in a config file.
It does string interpolation if the 'interpolation' attribute
of the 'main' object is set to True.
Interpolation is tried first from this object, then from the 'DEFAULT'
section of this object, next from the parent and its 'DEFAULT' section,
and so on until the main object is reached.
A Section will behave like an ordered dictionary - following the
order of the ``scalars`` and ``sections`` attributes.
You can use this to change the order of members.
Iteration follows the order: scalars, then sections.
c C s$ t | |d | j|d d S )Nr r9 )dictupdate__dict__rH stater r r __setstate__ s zSection.__setstate__c C s t | | jf}t| jf|fS rD )r r r rF r r r r
__reduce__ s zSection.__reduce__Nc C sT |du r i }t | || _|| _|| _|| _| | D ]\}}|| |< q>dS )z
* parent is the section above
* depth is the depth level of this section
* main is the main ConfigObj
* indict is a dictionary to initialise the section with
N)r rr rg r depthr[ _initialiseitems)rH rg r r indictr[ entryrN r r r rr s
zSection.__init__c C s: g | _ g | _i | _i | _d | _g | _i | _g | _d| _d S )NF) scalarssectionscommentsinline_commentsr3 defaultsdefault_values extra_values_createdrx r r r r s zSection._initialisec C sx z
| j }W n` tyj | jj}|dkr,t}| }t|d }|d u rXd| j_| Y S || }| _ Y n0 |||S )NTF) Z_interpolation_engineAttributeErrorr r. r r interpolation_enginesr r )rH r rN Zenginer[ class_r r r _interpolate s
zSection._interpolatec sf t }jjrbt|tjr,|S t|trbfdd fdd|D }||krb|S |S )z+Fetch the item and do string interpolation.c s t | tjr | S | S rD )r_ six string_typesr )r )r rH r r _check/ s z#Section.__getitem__.._checkc s g | ] } |qS r r ).0r )r r r
3 z'Section.__getitem__..) r __getitem__r r. r_ r r r rK )rH r r newr )r r rH r r ( s
zSection.__getitem__Fc C sH t |tjstd| || jvr6g | j|< d| j|< || jv rL| j| t |trz|| vrj| j
| t | || nt |t r|s|| vr| j
| | j
d }t | |t| || j||d n~|| vr| j
| | jjs6t |tjrnDt |ttfr*|D ] }t |tjstd| qn td| t | || dS )a
Correctly set a value.
Making dictionary values Section instances.
(We have to special case 'Section' instances - which are also dicts)
Keys must be strings.
Values need only be strings (or lists of strings) if
``main.stringify`` is set.
``unrepr`` must be set when setting a value to a dictionary, without
creating a new sub-section.
z The key "%s" is not a string.rn r9 )r r[ zValue is not a string "%s".N)r_ r r
ValueErrorr r r remover r appendr __setitem__r r r r4 rK rV r^ )rH r rN r7 Z new_depthr r r r r 9 sJ
zSection.__setitem__c C sD t | | || jv r$| j| n | j| | j|= | j|= dS )z-Remove items from the sequence when deleting.N)r __delitem__r r r r r rH r r r r r t s
zSection.__delitem__c C s& z
| | W S t y | Y S 0 dS )z>A version of ``get`` that doesn't bypass string interpolation.NKeyErrorrH r defaultr r r r s
z Section.getc C s |D ]}|| | |< qdS )zD
A version of update that uses our ``__setitem__``.
Nr )rH r r r r r r s zSection.updatec C s8 z | | }W n t y, |tu r$ |}Y n0 | |= |S )z
'D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
If key is not found, d is returned if given, otherwise KeyError is raised'
)r MISSING)rH r r r r r r pop s
z Section.popc C s6 | j | j }|std|d }| | }| |= ||fS )zPops the first (key,val)z": 'popitem(): dictionary is empty'r )r r r )rH Zsequencer r r r r popitem s zSection.popitemc C s8 t | g | _g | _i | _i | _d| _g | _g | _dS )z
A version of clear that also affects scalars/sections
Also clears comments and configspec.
Leaves other attributes alone :
depth/main/parent are not affected
N) r clearr r r r r3 r r rx r r r r s
z
Section.clearc C s2 z
| | W S t y, || |< | | Y S 0 dS )z:A version of setdefault that sets sequence if appropriate.Nr r r r r
setdefault s
zSection.setdefaultc C s t t| j| j t | S )z8D.items() -> list of D's (key, value) pairs, as 2-tuples)rK zipr r valuesrx r r r r s z
Section.itemsc C s | j | j S )z D.keys() -> list of D's keysr r rx r r r keys s z Section.keysc s fdd j j D S )z D.values() -> list of D's valuesc s g | ] } | qS r r r r rx r r r r z"Section.values..r rx r rx r r s zSection.valuesc C s t t| S )z=D.iteritems() -> an iterator over the (key, value) items of D)rP rK r rx r r r iteritems s zSection.iteritemsc C s t | j| j S )z.D.iterkeys() -> an iterator over the keys of D)rP r r rx r r r iterkeys s zSection.iterkeysc C s t t| S )z2D.itervalues() -> an iterator over the values of D)rP rK r rx r r r
itervalues s zSection.itervaluesc s0 fdd dd fddjj D S )zx.__repr__() <==> repr(x)c s. z
| W S t y( t | Y S 0 d S rD r% r r r rx r r _getval s
z!Section.__repr__.._getvalz{%s}, c s$ g | ] }d t |t |f qS z%s: %sreprr r r r r s z$Section.__repr__..r r r rx r r rH r __repr__ s
zSection.__repr__zx.__str__() <==> str(x)c C s\ i }| D ]N}| | }t |tr(| }n&t |tr>> n = a.dict()
>>> n == a
1
>>> n is a
0
)r_ r r rK rV )rH Znewdictr
this_entryr r r r s
z Section.dictc C sR t | D ]@\}}|| v rDt| | trDt|trD| | | q || |< q dS )aQ
A recursive update - useful for merging config files.
>>> a = '''[section1]
... option1 = True
... [[subsection]]
... more_options = False
... # end of file'''.splitlines()
>>> b = '''# File is user.ini
... [section1]
... option1 = False
... # end of file'''.splitlines()
>>> c1 = ConfigObj(b)
>>> c2 = ConfigObj(a)
>>> c2.merge(c1)
>>> c2
ConfigObj({'section1': {'option1': 'False', 'subsection': {'more_options': 'False'}}})
N)rK r r_ r merge)rH r r r r r r r s z
Section.mergec C s || j v r| j }n || jv r$| j}n td| ||}| | }t| | t| || || ||| | j | }| j
| }| j |= | j
|= || j |< || j
|< dS )a
Change a keyname to another, without changing position in sequence.
Implemented so that transformations can be made on keys,
as well as on values. (used by encode and decode)
Also renames comments.
zKey "%s" not found.N) r r r indexr r r r insertr r )rH ZoldkeyZnewkeythe_listposr ZcommZinline_commentr r r rename, s"
zSection.renameTc K s i }t t| jD ]d}| j| }z(|| |fi |}| j| }|||< W q tyt |r^ n| j| }d||< Y q0 qt t| jD ]}| j| }|rz|| |fi | W n, ty |rĂ n| j| }d||< Y n0 | j| }| | j|f||d|||< q|S )a
Walk every member and call a function on the keyword and value.
Return a dictionary of the return values
If the function raises an exception, raise the errror
unless ``raise_errors=False``, in which case set the return value to
``False``.
Any unrecognised keyword arguments you pass to walk, will be pased on
to the function you pass in.
Note: if ``call_on_sections`` is ``True`` then - on encountering a
subsection, *first* the function is called for the *whole* subsection,
and then recurses into it's members. This means your function must be
able to handle strings, dictionaries and lists. This allows you
to change the key of subsections as well as for ordinary members. The
return value when called on the whole subsection has to be discarded.
See the encode and decode methods for examples, including functions.
.. admonition:: caution
You can use ``walk`` to transform the names of members of a section
but you mustn't add or delete members.
>>> config = '''[XXXXsection]
... XXXXkey = XXXXvalue'''.splitlines()
>>> cfg = ConfigObj(config)
>>> cfg
ConfigObj({'XXXXsection': {'XXXXkey': 'XXXXvalue'}})
>>> def transform(section, key):
... val = section[key]
... newkey = key.replace('XXXX', 'CLIENT1')
... section.rename(key, newkey)
... if isinstance(val, (tuple, list, dict)):
... pass
... else:
... val = val.replace('XXXX', 'CLIENT1')
... section[newkey] = val
>>> cfg.walk(transform, call_on_sections=True)
{'CLIENT1section': {'CLIENT1key': None}}
>>> cfg
ConfigObj({'CLIENT1section': {'CLIENT1key': 'CLIENT1value'}})
F)r/ call_on_sections)ranger r Exceptionr walk) rH functionr/ r ZkeywargsoutrS r r r r r r J s@ /
z Section.walkc C sn | | }|dkrdS |dkr dS z*t |tjs6t n| jj| W S W n tyh td| Y n0 dS )a_
Accepts a key as input. The corresponding value must be a string or
the objects (``True`` or 1) or (``False`` or 0). We allow 0 and 1 to
retain compatibility with Python 2.2.
If the string is one of ``True``, ``On``, ``Yes``, or ``1`` it returns
``True``.
If the string is one of ``False``, ``Off``, ``No``, or ``0`` it returns
``False``.
``as_bool`` is not case sensitive.
Any other input will raise a ``ValueError``.
>>> a = ConfigObj()
>>> a['a'] = 'fish'
>>> a.as_bool('a')
Traceback (most recent call last):
ValueError: Value "fish" is neither True nor False
>>> a['b'] = 'True'
>>> a.as_bool('b')
1
>>> a['b'] = 'off'
>>> a.as_bool('b')
0
TFz$Value "%s" is neither True nor FalseN)r_ r r r r _boolsr r )rH r r r r r as_bool s zSection.as_boolc C s t | | S )ai
A convenience method which coerces the specified value to an integer.
If the value is an invalid literal for ``int``, a ``ValueError`` will
be raised.
>>> a = ConfigObj()
>>> a['a'] = 'fish'
>>> a.as_int('a')
Traceback (most recent call last):
ValueError: invalid literal for int() with base 10: 'fish'
>>> a['b'] = '1'
>>> a.as_int('b')
1
>>> a['b'] = '3.2'
>>> a.as_int('b')
Traceback (most recent call last):
ValueError: invalid literal for int() with base 10: '3.2'
)intr r r r as_int s zSection.as_intc C s t | | S )a>
A convenience method which coerces the specified value to a float.
If the value is an invalid literal for ``float``, a ``ValueError`` will
be raised.
>>> a = ConfigObj()
>>> a['a'] = 'fish'
>>> a.as_float('a') #doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
ValueError: invalid literal for float(): fish
>>> a['b'] = '1'
>>> a.as_float('b')
1.0
>>> a['b'] = '3.2'
>>> a.as_float('b') #doctest: +ELLIPSIS
3.2...
)r] r r r r as_float s zSection.as_floatc C s$ | | }t |ttfr t|S |gS )aU
A convenience method which fetches the specified value, guaranteeing
that it is a list.
>>> a = ConfigObj()
>>> a['a'] = 1
>>> a.as_list('a')
[1]
>>> a['a'] = (1,)
>>> a.as_list('a')
[1]
>>> a['a'] = [1]
>>> a.as_list('a')
[1]
)r_ rV rK )rH r resultr r r as_list s zSection.as_listc C s2 | j | }t| || || jvr.| j| |S )a
Restore (and return) default value for the specified key.
This method will only work for a ConfigObj that was created
with a configspec and has been validated.
If there is no default value for this key, ``KeyError`` is raised.
)r r r r r r r r r restore_default s
zSection.restore_defaultc C s2 | j D ]}| | q| jD ]}| | q dS )a'
Recursively restore default values to all members
that have them.
This method will only work for a ConfigObj that was created
with a configspec and has been validated.
It doesn't delete or modify entries without default values.
N)r r r restore_defaults)rH r r r r r r s
zSection.restore_defaults)NN)F)N)N)TF)&r@ rA rB ru r r rr r r r r r r r r r r r r r r r r r __iter__r r __str__r r r r r r r r r r r r r r r sJ
;
U,r c @ s e Zd ZdZedejZedejZedejZ edejZ
edejZ edZ edZ
ed Zed
Ze efe
efd Zd d
d d
d d
d d
dZdFddZdd ZdGddZdd Zdd Zdd Zd d Zd d Zd d! Zd"d# Zd$d% Z d&d' Z d(d) Z dHd*d+Z d,d- Z d.d/ Z!d0d1 Z"d2d3 Z#d4d5 Z$d6d7 Z%d8d9 Z&d:d; Z'dd?Z)dJd@dAZ*dBdC Z+dDdE Z,dS )Kr! z2An object to read, create, and write config files.a ^ # line start
(\s*) # indentation
( # keyword
(?:".*?")| # double quotes
(?:'.*?')| # single quotes
(?:[^'"=].*?) # no quotes
)
\s*=\s* # divider
(.*) # value (including list values and comments)
$ # line end
a= ^
(\s*) # 1: indentation
((?:\[\s*)+) # 2: section marker open
( # 3: section name open
(?:"\s*\S.*?\s*")| # at least one non-space with double quotes
(?:'\s*\S.*?\s*')| # at least one non-space with single quotes
(?:[^'"\s].*?) # at least one non-space unquoted
) # section name close
((?:\s*\])+) # 4: section marker close
\s*(\#.*)? # 5: optional comment
$a ^
(?:
(?:
(
(?:
(?:
(?:".*?")| # double quotes
(?:'.*?')| # single quotes
(?:[^'",\#][^,\#]*?) # unquoted
)
\s*,\s* # comma
)* # match all list items ending in a comma (if any)
)
(
(?:".*?")| # double quotes
(?:'.*?')| # single quotes
(?:[^'",\#\s][^,]*?)| # unquoted
(?:(?| j rt|d}| d W d n1 s0 Y g }nt |t
tfrt
|}nt |tr,t |tr fdd || n|D ]}|| | |< q| `|d ur"| | nd | _d S t|dtturN| pJg }ntd|r| |}|D ]H}|rj|d d
vrqjd D ] }||r|| _ qq qqjd d
|D }| | | jr"d| jd j }t | jdkrd| } t | }
n
| jd }
| j|
_ | |
_ |
| `|d u r8d | _n
| | d S )Nrbz Config file not found: "%s".wrn c sB | j D ]}| | ||< q| jD ] }i ||< | | || q d S rD r )Z
in_section this_sectionr r set_sectionr r r s
z$ConfigObj._load..set_sectionreadz>infile must be a filename, file like object, or list of lines.)
)
r r c S s g | ]}| d qS )r )rstrip)r ro r r r r r z#ConfigObj._load..z at line %s.r r9 z2Parsing failed with several errors.
First error %s)!r_ r r filenameospathisfileopen readlinesr2 rw r1 writerK rV r r! _errors_handle_configspecr3 re r r r^ _handle_bomendswithnewlines_parserp r r errorsZconfig) rH r r3 hZcontentr ro r infor{ errorr r r r sh , (
zConfigObj._loadc C s |d u r t }d | _g | _|d | _|d | _|d | _|d | _|d | _|d | _|d | _ |d | _
|d | _ d
| _ d | _
|d | _|d | _g | _g | _d | _| jrd
| _t| d S )
Nr/ r. r0 r1 r2 r4 r5 r r6 Fr8 r7 )r r r# r/ r. r0 r1 r2 r4 r5 r r6 BOMr' r8 r7 initial_comment
final_commentr3 r r r )rH r r r r r 0 s.
zConfigObj._initialisec s0 fdd dd fddjj D S )Nc s. z
| W S t y( t | Y S 0 d S rD r r rx r r r Q s
z#ConfigObj.__repr__.._getvalzConfigObj({%s})r c s$ g | ] }d t |t |f qS r r r r r r r W s z&ConfigObj.__repr__..r rx r r r r P s
zConfigObj.__repr__c C sP | j dur&| j tvr&| || j S t|ttfr>|d }n|}t|tjr\| || j S | j dur(t| j }|dkrtt
D ],\}\}}|sq| |r| || S q| || j S t | }| |s| || j S |t
|d }t|ttfr||d< n|}d| _| || j S tt
D ]\}\}}t|tjr4| |s`q4n|| _ |sd| _|t
|d }t|ttfr||d< n|}t|tjr|d S t|tjr|dd S | |d S | || S q4tjr"t|tr"| |dS t|tjr@|ddS | |dS dS )a1
Handle any BOM, and decode if necessary.
If an encoding is specified, that *must* be used - but the BOM should
still be removed (and the BOM attribute set).
(If the encoding is wrongly specified, then a BOM for an alternative
encoding won't be discovered or removed.)
If an encoding is not specified, UTF8 or UTF16 BOM will be detected and
removed. The BOM attribute will be set. UTF16 will be decoded to
unicode.
NOTE: This method must not be called with an empty ``infile``.
Specifying the *wrong* encoding is likely to cause a
``UnicodeDecodeError``.
``infile`` must always be returned as a list of lines, but may be
passed in as a single string.
Nr r Tr )r r r _decoder_ rK rV r Z text_typeBOMSr
startswithBOM_SETr r- binary_type
splitlinesdecodeZPY2str)rH r ro encr- r Zfinal_encodingnewliner r r r% [ s`
zConfigObj._handle_bomc C s& t |tjr | jr || jS |S dS )z@Decode ASCII strings to unicode if a self.encoding is specified.N)r_ r r4 r r6 )rH ZaStringr r r _a_to_u s zConfigObj._a_to_uc C st t |tjr|dS t |tjr@|r6||dS |dS |rpt|D ]"\}}t |tjrL||||< qL|S )z
Decode infile to unicode. Using the specified encoding.
if is a string, it also needs converting to a list.
T)r_ r r r5 r4 r6 enumerate)rH r r rS ro r r r r0 s
zConfigObj._decodec C s& t |tjr | jr || jS |S dS )z'Decode element to unicode if necessary.N)r_ r r4 r6 r6 )rH ro r r r _decode_element s zConfigObj._decode_elementc C s t |tjst|S |S dS )zh
Used by ``stringify`` within validate, to turn non-string values
into strings.
N)r_ r r r7 rH rN r r r _str s zConfigObj._strc
C s, | j }| jrd| _ g }d}| }t|d }d}d}||k r|rDg }|d7 }|| } | }
|
rj|
drzd}|| q2|s|| _g }d}d}| j| } | dur| \} }
}}}| r| j
du r| | _
|
d}|| dkr| d t
|| q2||jk r@z| ||j}W n( ty< | d
t
|| Y q2Y n0 n<||jkrT|j}n(||jd krj|}n| d t
|| q2| |}||v r| d t|| q2t||| |d
}|||< ||j|< ||j|< q2| j| } | du r| d| t|| q2| \} }}| r$| j
du r$| | _
|dd dv rz| ||||\}}}W n( tyx | dt|| Y q2Y nv0 | jrd}z t|}W nZ ty } z@t |t krd}nd}| |t || W Y d}~q2W Y d}~n
d}~0 0 n| jrdd}z t|}W nX ty` } z>t |t r,d}nd}| |t || W Y d}~q2W Y d}~n
d}~0 0 n.zValue "%s" is not a string.""r r? rW rV #Value "%s" cannot be safely quoted.r )r8 r_ rK rV r r[ r r r r4 r7 r^ r0 noquotr wspace_plus_get_single_quote_get_triple_quote)rH rN rZ Zno_lists_no_quotesZ need_tripleZhash_triple_quoteZcheck_for_singlequotr rx r r[ sH
"
zConfigObj._quotec C s4 d|v r d|v r t d| nd|v r,t}nt}|S )NrW rV r^ )r squotdquotrH rN rc r r r ra % s zConfigObj._get_single_quotec C sD | ddkr(| ddkr(td| | ddkr.)
r r0 _nolistvaluer rq rE _valueexprI
_listvalueexpfindall)rH rN rQ r0 ZsingleZ
empty_listrS r r rx r rN 9 s6
zConfigObj._handle_valuec
C s |dd }|dd }| j | d }| j | d }||} | dur`t| }
|
| |
S ||dkrtt ||k r|d7 }|d7 }|| } | |dkr|| 7 }qtqqtt || } | du rt | \}} || | |fS )z9Extract the value, where we are in a multiline situation.NrB r r9 r r )
_triple_quoter rK rE r rg rq )
rH rN r rP rO rc ZnewvalueZ single_lineZ
multi_linerQ Zretvalro rS r r r rL j s0
zConfigObj._multilinec
C s t |ts~zt|dddd}W n^ tyN } ztd| W Y d}~n8d}~0 ty| } ztd| W Y d}~n
d}~0 0 || _dS )zParse the configspec.T)r/ r2 r z Parsing configspec failed: %sNz Reading configspec failed: %s)r_ r! r r rw r3 )rH r3 rT r r r r$ s
"z ConfigObj._handle_configspecc C s |j }|d}t|tr8|jD ]}||vr ||| _ q |jD ]p}|dkrLq>||vri ||< d|| _|r|j|g |j|< |j|d|j|< t|| tr>|| || _ q>dS )z
Called by validate. Handles setting the configspec on subsections
including sections to be validated by __many__
__many__Trn N) r3 r r_ r r r r r r )rH r copyr3 manyr r r r _set_configspec s"
zConfigObj._set_configspecc C sN | j s| | |}nt|}d|| | j|dd| d|| |f S )z.Write an individual line, for the write method
%s%s%s%s%sFrY z = )r7 r< r[ r r: )rH
indent_stringr r rS r r r r _write_line s zConfigObj._write_linec C s< d|| d| | j| |dd| d| | |f S )zWrite a section marker liners r@ FrY rA )r: r[ r< )rH rt r r rS r r r
_write_marker s zConfigObj._write_markerc C s. |sdS | j }|ds&|| d7 }|| S )zDeal with a comment.rn r? z # )r5 r2 r: )rH rS r r r r _handle_comment s
zConfigObj._handle_commentc sB j du rt _ g } d} d}|du r~ j}d _ } jD ]6} |}| }|rr||sr|| }|| qF j |j } |j
|j D ]}
|
|j v rq|j
|
D ]6} | } | r| |s|| } || | q||
} |j|
}
t| tr8| | | j |
|
| j| d q| | |
| |
q| u r jD ]<} |}| }|r||s|| }|| q`| _| ur|S jdu r0|du r0 jr fdd|D } jr, jdu s t j dkr,|s |d t |d
|d
< |S j p>> filename = a.filename
>>> a.filename = 'test.ini'
>>> a.write()
>>> a.filename = filename
>>> a == ConfigObj('test.ini', raise_errors=True)
1
>>> import os
>>> os.remove('test.ini')
Nr? z# Fr c s g | ]}| jqS r )encoder )r lrx r r r / r z#ConfigObj.write..r rn r moder win32r r asciiwb).r5 r r: r. r. r< rC r2 r r r r r r lstriprw r r_ r rv extendr" ru r/ r r r- r r r r r' r linesepre rz sysplatformr r& r r4 rx r6 r r )rH Zoutfiler r csZcspZint_valro Z
stripped_linert r Z comment_liner rS r9 outputZ output_bytesr* r rx r r" s
zConfigObj.writec s\ du rtj du rtdr0ddlm} |_rtj j_j j_j j_j j_j j _ j j
_
j fdd}i d}d} fdd j D } fd
d j
D }
fd d j D } j D ]} | d v rq| j vs| jv rVd}
d}rb| j vrb j| g j| < j| d
j| < n d}
| }|| | ||
||\}}qd}d j v r d }nd j v r d }|dur| D ]$} | }|| ||d||\}}qg } | D ]4} d}s d| < nd}d| }|| < q|
D ]4} d}s:d| < nd}d| }|| < q"j
D ]} u rz| dkrzq^| j du r| | q^rƈ j| g j| < j| d
j| < j| d}|| < |dkrd}n|dkrd}nd}q^| _r$js$d}|rDrDrDt }|rNdS |rXdS S )a;
Test the ConfigObj against a configspec.
It uses the ``validator`` object from *validate.py*.
To run ``validate`` on the current ConfigObj, call: ::
test = config.validate(validator)
(Normally having previously passed in the configspec when the ConfigObj
was created - you can dynamically assign a dictionary of checks to the
``configspec`` attribute of a section though).
It returns ``True`` if everything passes, or a dictionary of
pass/fails (True/False). If every member of a subsection passes, it
will just have the value ``True``. (It also returns ``False`` if all
members fail).
In addition, it converts the values from strings to their native
types if their checks pass (and ``stringify`` is set).
If ``preserve_errors`` is ``True`` (``False`` is default) then instead
of a marking a fail with a ``False``, it will preserve the actual
exception object. This can contain info about the reason for failure.
For example the ``VdtValueTooSmallError`` indicates that the value
supplied was too small. If a value (or section) is missing it will
still be marked as ``False``.
You must have the validate module to use ``preserve_errors=True``.
You can then use the ``flatten_errors`` function to turn your nested
results dictionary into a flattened list of failures - useful for
displaying meaningful error messages.
NzNo configspec supplied.r )VdtMissingValuec
sJ j | d z | j | < W n ttjfy@ Y n0 zj|||d}W nP jy } z6rxt|jrd| < n || < d}d}W Y d }~nd }~0 0 d}d| < j s|r j st|t
t frfdd|D }n |r|d u rd}n
|}||ks|r || < sB|rB| j
vrBj
| ||fS )N)missingFTc s g | ]} |qS r )r> )r itemrx r r r r z>ConfigObj.validate..validate_entry..rn )r r Zget_default_valuer r baseErrorClasscheckr_ _vdtMissingValuer4 rK rV r> r r )r specr r ret_true ret_falser rT r3 rp r preserve_errorsr rH validatorr r validate_entry s<
z*ConfigObj.validate..validate_entryTc s g | ]}| vr|qS r r r r )r3 r r r r z&ConfigObj.validate..c s g | ]}| j v r|qS r )r r r r r r r c s g | ]}| j v r|qS r )r r r r r r r )ro
___many___rn Fro r z"Value %r was provided as a sectionz)Section %r was provided as a single valuer )r rp r )r3 r validater r r. r/ r r- r' r5 rr r r r r r r r r r r anyr )rH r r rp r r r r r Z unvalidatedZincorrect_sectionsZincorrect_scalarsr r r rq r{ r r r r r S s $
-
zConfigObj.validatec C s | | d| _d| _dS )z@Clear ConfigObj instance and restore to 'freshly created' state.N)r r r3 r
rx r r r reset" s zConfigObj.resetc C sp t | jtjst | j}i }tD ] }|dkr0q"t| |||< q"| j}||d< | | | |
|| dS )z
Reload a ConfigObj from file.
This method raises a ``ReloadError`` if the ConfigObj doesn't have
a filename attribute pointing to a file.
r3 N) r_ r r r r' r re r
r r r )rH r Zcurrent_optionsr r3 r r r reload- s
zConfigObj.reload)NNNNTFTFFTNNFFF)N)T)NN)FFN)-r@ rA rB ru r r r rJ rD rk rl rj Z_single_line_singleZ_single_line_doubleZ_multi_line_singleZ_multi_line_doublern r rr r r r r% r: r0 r< r> r( rH rG rI r[ ra rb rN rL r$ rr ru rv rw r" r r r r r r r r! / s
:`
u
(
G
1#
r
P r! c @ s" e Zd ZdZdd ZdddZdS ) r" a
A simple validator.
Can be used to check that all members expected are present.
To use it, provide a configspec with all your members in (the value given
will be ignored). Pass an instance of ``SimpleVal`` to the ``validate``
method of your ``ConfigObj``. ``validate`` will return ``True`` if all
members are present, or a dictionary with True/False meaning
present/missing. (Whole missing sections will be replaced with ``False``)
c C s
t | _d S rD )r r rx r r r rr S s zSimpleVal.__init__Fc C s |r | |S )z9A dummy check method, always returns the value unchanged.)r )rH r memberr r r r r V s zSimpleVal.checkN)F)r@ rA rB ru rr r r r r r r" G s r" c C s |du rg }g }|dkr t |S |dks2t|tr^||dd d|f |rV| t |S t| D ]X\}}|dkr|qjt| |tr|| t | | ||| qj||dd ||f qj|r| t |S )a
An example function that will turn a nested dictionary of results
(as returned by ``ConfigObj.validate``) into a flat list.
``cfg`` is the ConfigObj instance being checked, ``res`` is the results
dictionary returned by ``validate``.
(This is a recursive function, so you shouldn't use the ``levels`` or
``results`` arguments - they are used by the function.)
Returns a list of keys that failed. Each member of the list is a tuple::
([list of sections...], key, result)
If ``validate`` was called with ``preserve_errors=False`` (the default)
then ``result`` will always be ``False``.
*list of sections* is a flattened list of sections that the key was found
in.
If the section was missing (or a section was expected and a scalar provided
- or vice-versa) then key will be ``None``.
If the value (or section) was missing then ``result`` will be ``False``.
If ``validate`` was called with ``preserve_errors=True`` and a value
was present, but failed the check, then ``result`` will be the exception
object returned. You can use this as a string that describes the failure.
For example *The value "3" is of the wrong type*.
NTF)
sortedr_ r r r rK r r r r* )ZcfgresZlevelsresultsr r r r r r* ] s*
r* r c sR g }| fdd| jD | jD ](}|| jvr$| t| | |f q$|S )a
Find all the values and sections not in the configspec from a validated
ConfigObj.
``get_extra_values`` returns a list of tuples where each tuple represents
either an extra section, or an extra value.
The tuples contain two values, a tuple representing the section the value
is in and the name of the extra values. For extra values in the top level
section the first member will be an empty tuple. For values in the 'foo'
section the first member will be ``('foo',)``. For members in the 'bar'
subsection of the 'foo' section the first member will be ``('foo', 'bar')``.
NOTE: If you call ``get_extra_values`` on a ConfigObj instance that hasn't
been validated it will return an empty list.
c s g | ] } |fqS r r )r r[ _prependr r r r z$get_extra_values..)r r r r+ )Zconfr r r[ r r r r+ s
r+ )NN)r );r r r codecsr r r r r Z_versionr r: r1 r r3 r rd re r_ r` ri rh objectr __all__r r ZMAX_INTERPOL_DEPTHr r? r r) rC Z_builderr7 rq r r r rw r' r r r# r$ r& r% r( r| r r r r r r r! r" r* r+ r r r r s
7 | i "
<