3
��S^ � @ sV d dl Z d dlZd dlZd dlmZmZmZmZ d dlZd dl m
Z
da edKedLedMedNiZ dddddddddddddddd�Z
eeeeed �Zd
d � Zd Zd
ZdZdZdZdZe� ZdOZd$Zd%Zd&Zd'd(d'd(d(dd'dddd(d(d)� Z d*d+� Z G d,d!� d!e �Z G d-d.� d.e�Z e � Z!d/d0� Z"G d1d� de#�Z$G d2d� de$�Z%G d3d� de$�Z&G d4d � d e'�Z(G d5d� de$�Z)G d6d� de$�Z*G d7d� de$�Z+G d8d � d e+�Z,G d9d � d e$�Z-G d:d � d e+�Z.G d;d � d e$�Z/G d<d=� d=e�Z0G d>d?� d?e0�Z1G d@dA� dAe0�Z2e1e2dB�Z3dCdD� Z4G dEdF� dFe5�Z6G dGd� de6�Z7G dHd� de�Z8dPdId"�Z9f fdJd#�Z:dS )Q� N)�BOM_UTF8� BOM_UTF16� BOM_UTF16_BE� BOM_UTF16_LE)� __version__�utf_8�utf16_be�utf_16�utf16_le)r �u16�utf16zutf-16r � utf_16_bezutf-16ber
� utf_16_lezutf-16ler �u8�utf�utf8zutf-8)r r r r
Nc C s t j| j� �dkS )Nr )�BOM_LIST�get�lower)�encoding� r � /usr/lib/python3.6/configobj.py�
match_utf8D s r z'%s'z"%s"z%sz
'"z"""%s"""z'''%s'''�DEFAULT_INDENT_TYPE�DEFAULT_INTERPOLATION�ConfigObjError� NestingError�
ParseError�DuplicateError�ConfigspecError� ConfigObj� SimpleVal�InterpolationError�InterpolationLoopError�MissingInterpolationOption�RepeatSectionError� ReloadError� UnreprError� UnknownType�flatten_errors�get_extra_values� configparserz �
TF) �
interpolation� raise_errors� list_values� create_empty�
file_error�
configspec� stringify� indent_typer �default_encoding�unrepr�write_empty_valuesc C s> t d krdd l a d| } t j| �}|j� d j� d j� d S )Nr za=� )�compiler�parse� getChildren)�s�pr r r �getObj� s
r> c @ s e Zd ZdS )r( N)�__name__�
__module__� __qualname__r r r r r( � s 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 krt|jj��t |�S )N)�mr( � __class__r? )�self�or r r �build� s z
Builder.buildc C s t t| j|j� ��S )N)�list�maprG r; )rE rF r r r �
build_List� s zBuilder.build_Listc C s |j S )N)�value)rE rF r r r � build_Const� s zBuilder.build_Constc C s6 i }t t| j|j� ��}x|D ]}t|�||< q W |S )N)�iterrI rG r; �next)rE rF �d�iZelr r r �
build_Dict� s
zBuilder.build_Dictc C s t | j|��S )N)�tuplerJ )rE rF r r r � build_Tuple� s zBuilder.build_Tuplec C s6 |j dkrd S |j dkr dS |j dkr*dS td��d S )N�None�TrueT�FalseFzUndefined Name)�namer( )rE rF r r r �
build_Name� s
zBuilder.build_Namec C sh t t| j|j� ��\}}y t|�}W n tk
r@ td��Y nX t|t� sX|j dkr`td��|| S )NZAddg )
rH rI rL r; �float� TypeErrorr( �
isinstance�complex�real)rE rF r] �imagr r r � build_Add� s zBuilder.build_Addc C s | j |j�}t||j�S )N)rG �expr�getattrZattrname)rE rF �parentr r r �
build_Getattr� s zBuilder.build_Getattrc C s | j |j� d � S )Nr )rL r; )rE rF r r r �build_UnarySub� s zBuilder.build_UnarySubc C s | j |j� d �S )Nr )rL r; )rE rF r r r �build_UnaryAdd� s zBuilder.build_UnaryAddN)
r? r@ rA rG rJ rL rQ rS rX r_ rc rd re r r r r rB � s
rB c C s | s| S dd l }|j| �S )Nr )�astZ literal_eval)r< rf r r r r6 � s r6 c @ s e Zd ZdZddd�ZdS )r zk
This is the base class for all errors that ConfigObj raises.
It is a subclass of SyntaxError.
� Nc C s || _ || _tj| |� d S )N)�line� line_number� SyntaxError�__init__)rE �messageri rh r r r rk � s zConfigObjError.__init__)rg Nrg )r? r@ rA �__doc__rk r r r r r � s c @ s e Zd ZdZdS )r zE
This error indicates a level of nesting that doesn't match.
N)r? r@ rA rm r r r r r � s 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.
N)r? r@ rA rm r r r r r � s c @ s e Zd ZdZdd� ZdS )r& zW
A 'reload' operation failed.
This exception is a subclass of ``IOError``.
c C s t j| d� d S )Nz#reload failed, filename is not set.)�IOErrorrk )rE r r r rk � s zReloadError.__init__N)r? r@ rA rm rk r r r r r& � s c @ s e Zd ZdZdS )r z:
The keyword or section specified already exists.
N)r? r@ rA rm r r r r r � s c @ s e Zd ZdZdS )r z7
An error occured whilst parsing a configspec.
N)r? r@ rA rm r r r r r � s c @ s e Zd ZdZdS )r" z,Base class for the two interpolation errors.N)r? r@ rA rm r r r r r" � s c @ s e Zd ZdZdd� ZdS )r# z=Maximum interpolation depth exceeded in string interpolation.c C s t j| d| � d S )Nz*interpolation loop detected in value "%s".)r" rk )rE �optionr r r rk s z InterpolationLoopError.__init__N)r? r@ rA rm rk r r r r r# s c @ s e Zd ZdZdS )r% zk
This error indicates additional sections in a section with a
``__many__`` (repeated) section.
N)r? r@ rA rm r r r r r% s c @ s e Zd ZdZdd� ZdS )r$ z0A value specified for interpolation was missing.c C s d| }t j| |� d S )Nz%missing option "%s" in interpolation.)r" rk )rE ro �msgr r r rk s z#MissingInterpolationOption.__init__N)r? r@ rA rm rk r r r r r$ s c @ s e Zd ZdZdS )r' z An error parsing in unrepr mode.N)r? r@ rA rm r r r r r' s c @ s> e Zd ZdZejd�ZdZdd� 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.
z
%\(([^)]*)\)s�%c C s
|| _ d S )N)�section)rE rs r r r rk * s z InterpolationEngine.__init__c s0 �j |kr|S � �fdd�� � ||�ji �}|S )Nc s� | |j f|krt| ��d|| |j f< �jj|�}xz|r��j|�\}}}|dkrT|}n� ||||�}|j� \} }
dj|d| � |||
d� f�}| t|� } �jj|| �}q2W || |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.
r8 Nrg )rW r# �_KEYCRE�search� _parse_match�span�join�len) �keyrK rs Z backtrail�match�k�vr< Z replacement�start�endZnew_search_start)�recursive_interpolaterE r r r� 4 s z>InterpolationEngine.interpolate.<locals>.recursive_interpolate)�_cookiers )rE rz rK r )r� rE r � interpolate/ s
,z InterpolationEngine.interpolatec C s� | j jj}d| j j_| j }x^|j|�}|dk r<t|t� r<P |jdi �j|�}|dk rdt|t� rdP |j|krpP |j}q W || j j_|dkr�t|��||fS )z�Helper function to fetch values from owning section.
Returns a 2-tuple: the value, and the section where it was found.
FN�DEFAULT)rs �mainr- r r[ �Sectionrb r$ )rE rz Z save_interpZcurrent_section�valr 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)rE r{ r r r rv � s z InterpolationEngine._parse_matchN) r? r@ rA rm �re�compilert r� rk r� r� rv r r r r rq s
5"rq c @ s& e Zd ZdZdZejd�Zdd� ZdS )�ConfigParserInterpolationzBehaves like ConfigParser.rr z
%\(([^)]*)\)sc C s" |j d�}| j|�\}}|||fS )Nr8 )�groupr� )rE r{ rz rK rs r r r rv � s
z&ConfigParserInterpolation._parse_matchN) r? r@ rA rm r� r� r� rt rv r r r r r� � s
r� c @ s4 e Zd ZdZdZdZejdejej B �Z
dd� Z dS )�TemplateInterpolationz Behaves like string.Template.�$z�
\$(?:
(?P<escaped>\$) | # Two $ signs
(?P<named>[_a-z][_a-z0-9]*) | # $name format
{(?P<braced>[^}]*)} # ${name} format
)
c C s\ |j d�p|j d�}|d k r4| j|�\}}|||fS |j d�d k rNd | jd fS d |j � d fS )NZnamedZbracedZescaped)r� r� �
_delimiter)rE r{ rz rK rs r r r rv � s
z"TemplateInterpolation._parse_matchN) r? r@ rA rm r� r� r� r� �
IGNORECASE�VERBOSErt rv r r r r r� � s r� )r+ �templatec G s | j | f|�� S )N)�__new__)�cls�argsr r r �
__newobj__� s r� c @ s$ e Zd ZdZdd� Zdd� ZdDdd�Zd d
� Zd d � Zd
d� Z dEdd�Z
dd� Z dFdd�Z dd� Z
efdd�Zdd� 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 dHd6d7�Z d8d9� Z d:d;� Z!d<d=� Z"d>d?� 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 j| |d � | jj|d � d S )Nr r8 )�dict�update�__dict__)rE �stater r r � __setstate__� s zSection.__setstate__c C s t | �| jf}t| jf|fS )N)r� r� r� rD )rE r� r r r �
__reduce__� s zSection.__reduce__Nc C sX |dkr i }t j| � || _|| _|| _|| _| j� x |j� D ]\}}|| |< q@W 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� rk rb r� �depthrW � _initialise�items)rE rb r� r� �indictrW �entryrK r r r rk � s
zSection.__init__c C s: g | _ g | _i | _i | _d | _g | _i | _g | _d| _d S )NF) �scalars�sections�comments�inline_commentsr2 �defaults�default_values� extra_values�_created)rE r r r r� s zSection._initialisec C sv y
| j }W n^ tk
rh | jj}|dkr.t}|j� }tj|d �}|d krVd| j_|S || � }| _ Y nX |j||�S )NTF) Z_interpolation_engine�AttributeErrorr� r- r r �interpolation_enginesr r� )rE rz rK ZenginerW Zclass_r r r � _interpolate s
zSection._interpolatec sf t j���}�jjrbt|tj�r,�j�|�S t|t�rb��fdd�� � fdd�|D �}||krb|S |S )z+Fetch the item and do string interpolation.c s t | tj�r�j� | �S | S )N)r[ �six� string_typesr� )r� )rz rE r r �_check/ s z#Section.__getitem__.<locals>._checkc s g | ] }� |��qS r r )�.0r� )r� r r �
<listcomp>3 s z'Section.__getitem__.<locals>.<listcomp>) r� � __getitem__r� r- r[ r� r� r� rH )rE rz r� �newr )r� rz rE r r� ( s
zSection.__getitem__Fc
C sN t |tj�std| ��|| jkr6g | j|< d| j|< || jkrL| jj|� t |t�rz|| krj| j j
|� t j | ||� n�t |t �r�| r�|| kr�| j j
|� | j
d }t j | |t| || j||d�� n�|| kr�| jj
|� | jj�s<t |tj�r�nHt |ttf��r0x6|D ] }t |tj��s
td| ���q
W n td| ��t j | ||� 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.rg r8 )r� rW zValue is not a string "%s".N)r[ r� r� �
ValueErrorr� r� r� �remover� r� �appendr� � __setitem__r� r� r� r3 rH rR rZ )rE rz rK r6 Z new_depthr� r r r r� 9 sF
zSection.__setitem__c C sD t j| |� || jkr$| jj|� n | jj|� | j|= | j|= dS )z-Remove items from the sequence when deleting.N)r� � __delitem__r� r� r� r� r� )rE rz r r r r� t s
zSection.__delitem__c C s" y| | S t k
r |S X dS )z>A version of ``get`` that doesn't bypass string interpolation.N)�KeyError)rE rz �defaultr r r r s z Section.getc C s x|D ]}|| | |< qW dS )zD
A version of update that uses our ``__setitem__``.
Nr )rE r� r� r r r r� � s
zSection.updatec C s: y | | }W n" t k
r. |tkr&� |}Y nX | |= |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)rE rz 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� )rE Zsequencerz r� r r r �popitem� s zSection.popitemc C s8 t j| � 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� r2 r� r� )rE r r r r� � s
z
Section.clearc C s. y| | S t k
r( || |< | | S X dS )z:A version of setdefault that sets sequence if appropriate.N)r� )rE rz r� r r r �
setdefault� s
zSection.setdefaultc C s t t| j| j t | j� ���S )z8D.items() -> list of D's (key, value) pairs, as 2-tuples)rH �zipr� r� �values)rE r r r r� � s z
Section.itemsc C s | j | j S )z D.keys() -> list of D's keys)r� r� )rE 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� rz )rE r r r� � s z"Section.values.<locals>.<listcomp>)r� r� )rE r )rE r r� � s zSection.valuesc C s t t| j� ��S )z=D.iteritems() -> an iterator over the (key, value) items of D)rM rH r� )rE r r r � iteritems� s zSection.iteritemsc C s t | j| j �S )z.D.iterkeys() -> an iterator over the keys of D)rM r� r� )rE r r r �iterkeys� s zSection.iterkeysc C s t t| j� ��S )z2D.itervalues() -> an iterator over the values of D)rM rH r� )rE r r r �
itervalues� s zSection.itervaluesc s0 �fdd�� ddj � fdd��j�j D �� S )zx.__repr__() <==> repr(x)c s* y� | S t k
r$ tj� | �S X d S )N)r$ r� r� )rz )rE r r �_getval� s z!Section.__repr__.<locals>._getvalz{%s}z, c s$ g | ] }d t |�t � |��f �qS )z%s: %s)�repr)r� rz )r� r r r� � s z$Section.__repr__.<locals>.<listcomp>)rx r� r� )rE r )r� rE r �__repr__� s zSection.__repr__zx.__str__() <==> str(x)c C s` i }xV| D ]N}| | }t |t�r*|j� }n&t |t�r>t|�}nt |t�rPt|�}|||< q
W |S )a0
Return a deepcopy of self as a dictionary.
All members that are ``Section`` instances are recursively turned to
ordinary dictionaries - by calling their ``dict`` method.
>>> n = a.dict()
>>> n == a
1
>>> n is a
0
)r[ r� r� rH rR )rE Znewdictr� �
this_entryr r r r� � s
z Section.dictc C sV xPt |j� �D ]@\}}|| krFt| | t�rFt|t�rF| | j|� q|| |< qW 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)rH r� r[ r� �merge)rE r� rz r� r r r r� s
z
Section.mergec C s� || j kr| j }n || jkr$| j}n td| ��|j|�}| | }tj| |� tj| ||� |j|� |j||� | 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� )rE ZoldkeyZnewkey�the_list�posr� ZcommZinline_commentr r r �rename, s"
zSection.renameTc K s i }xtt t| j��D ]b}| j| }y$|| |f|�}| j| }|||< W q tk
rt |r^� n| j| }d||< Y qX qW x�t t| j��D ]~}| j| }|r�y|| |f|� W n. tk
r� |rƂ n| j| }d||< Y nX | j| }| | j|f||d�|��||< q�W |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)�rangery r� � Exceptionr� �walk) rE Zfunctionr. r� Zkeywargs�outrP r� r� r r r r� J s: /
z Section.walkc C sn | | }|dkrdS |dkr dS y(t |tj�s6t� �n| jj|j� S W n tk
rh td| ��Y nX 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� )rE rz 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'
)�int)rE rz 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...
)rY )rE rz r r r �as_float� s zSection.as_floatc C s$ | | }t |ttf�r 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[ rR rH )rE rz �resultr r r �as_list� s zSection.as_listc C s2 | j | }tj| ||� || jkr.| jj|� |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� )rE rz r� r r r �restore_default s
zSection.restore_defaultc C s: x| j D ]}| j|� qW x| jD ]}| | j� q"W 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)rE rz rs r r r r� s
zSection.restore_defaults)NN)F)N)N)TF)&r? r@ rA rm r� r� rk 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� � sH
;
T,r� c @ s� e Zd ZdZejdej�Zejdej�Zejdej�Z ejdej�Z
ejdej�Z ejd�Z ejd�Z
ejd �Zejd
�Ze efe
efd �Zd d
d d
d d
d d
d�ZdFdd�Zdd� ZdGdd�Zdd� 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'd<d=� Z(dId>d?�Z)dJd@dA�Z*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
(?:(?<!,)) # Empty value
)? # last item in a list - or string value
)|
(,) # alternatively a single comma - empty list
)
\s*(\#.*)? # optional comment
$z�
(
(?:".*?")| # double quotes
(?:'.*?')| # single quotes
(?:[^'",\#]?.*?) # unquoted
)
\s*,\s* # comma
a ^
(
(?:".*?")| # double quotes
(?:'.*?')| # single quotes
(?:[^'"\#].*?)| # unquoted
(?:) # Empty value
)
\s*(\#.*)? # optional comment
$z^'''(.*?)'''\s*(#.*)?$z^"""(.*?)"""\s*(#.*)?$z^(.*?)'''\s*(#.*)?$z^(.*?)"""\s*(#.*)?$)z'''z"""TF)�yes�noZonZoff�1�0�trueZfalseNc
C s� || _ tj| | d| � |p g }||||||| |
| | |
|d� }|dkrJ|}n|ddl}|jdtdd� x |D ]}|tkrhtd| ��qhW x@ttj � �D ]0\}}||kr�|||< || }||kr�|||< q�W |r�d|d < | j
|� |d
}|| _ | j ||� dS ) a�
Parse a config file or create a config file object.
``ConfigObj(infile=None, configspec=None, encoding=None,
interpolation=True, raise_errors=False, list_values=True,
create_empty=False, file_error=False, stringify=True,
indent_type=None, default_encoding=None, unrepr=False,
write_empty_values=False, _inspec=False)``
r ) r2 r r- r. r/ r0 r1 r3 r4 r5 r6 r7 NzUPassing in an options dictionary to ConfigObj() is deprecated. Use **options instead.� )�
stacklevelzUnrecognised option "%s".Fr/ r2 )
�_inspecr� rk �warnings�warn�DeprecationWarning�OPTION_DEFAULTSrZ rH r� r� �_original_configspec�_load)rE �infile�optionsr2 r r- r. r/ r0 r1 r3 r4 r5 r6 r7 r� Z_optionsr� r� rK Z
keyword_valuer r r rk � s<
zConfigObj.__init__c s" t |tj�r�|| _tjj|�rBt|d��}|j� p4g }W d Q R X n@| j rXt
d| j ��n*| j r~t|d��}|j d� W d Q R X g }n�t |t
tf�r�t
|�}n�t |t��rt |t�rʇ fdd�� � || � nx|D ]}|| | |< q�W | `|d k r�| j|� nd | _d S t|dt�tk �r(|j� �p$g }ntd��|�r�| j|�}xN|D ]F}| �sF|d dk�rd�qFx"dD ]}|j|��rj|| _P �qjW P �qFW d
d� |D �}| j|� | j�r�d| jd j }t | j�d k�r�d| } t | �}
n
| jd }
| j|
_ | |
_ |
�| `|d k�rd | _n
| j|� d S )N�rbz Config file not found: "%s".�wrg c sJ x| j D ]}| | ||< qW x(| jD ] }i ||< � | | || � q$W d S )N)r� r� )Z
in_section� this_sectionr� rs )� set_sectionr r r� � s
z$ConfigObj._load.<locals>.set_section�readz>infile must be a filename, file like object, or list of lines.r8 �
�
�
c S s g | ]}|j d ��qS )z
)�rstrip)r� rh r r r r� s z#ConfigObj._load.<locals>.<listcomp>z at line %s.r z2Parsing failed with several errors.
First error %s���)r� r� )r� r� r� )!r[ r� r� �filename�os�path�isfile�open� readlinesr1 rn r0 �writerH rR r� r �_errors�_handle_configspecr2 ra r� r� rZ � _handle_bom�endswith�newlines�_parseri ry r �errors�config) rE r� r2 �hZcontentr� rh r �inforp �errorr )r� r r� � sh
zConfigObj._loadc C s� |d kr t }d | _g | _|d | _|d | _|d | _|d | _|d | _|d | _|d | _ |d | _
|d | _ d
| _ d | _
|d | _|d | _g | _g | _d | _| jr�d
| _tj| � d S )
Nr. r- r/ r0 r1 r3 r4 r r5 Fr7 r6 )r� r� r r. r- r/ r0 r1 r3 r4 r r5 �BOMr r7 r6 �initial_comment�
final_commentr2 r� r� r� )rE r� r r r r� 0 s.
zConfigObj._initialisec s0 �fdd�� ddj � fdd��j�j D �� S )Nc s* y� | S t k
r$ tj� | �S X d S )N)r$ r� r� )rz )rE r r r� Q s z#ConfigObj.__repr__.<locals>._getvalzConfigObj({%s})z, c s$ g | ] }d t |�t � |��f �qS )z%s: %s)r� )r� rz )r� r r r� W s z&ConfigObj.__repr__.<locals>.<listcomp>)rx r� r� )rE r )r� rE r r� P s zConfigObj.__repr__c C sH | j dk r&| j j� tkr&| j|| j �S t|ttf�r>|d }n|}t|tj�r\| j|| j �S | j dk �r(t| j j� }|dkr�x8tt j
� �D ](\}\}}|s�q�|j |�r�| j||�S q�W | j|| j �S t | }|j |�s�| j|| j �S |t
|�d� }t|ttf��r||d< n|}d| _| j|| j �S x�tt j
� �D ]�\}\}}t|tj� �s6|j |� �rf�q6n�|| _ |�s�d| _|t
|�d� }t|ttf��r�||d< n|}t|tj��r�|jd�S t|tj��r�|jd�jd�S | j|d�S | j||�S �q6W tj�rt|t��r| j|d�S t|tj��r8|jd�jd�S | j|d�S 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 Tzutf-8)r r r �_decoder[ rH rR r� Z text_type�BOMSr� �
startswith�BOM_SETry r � binary_type�
splitlines�decodeZPY2�str)rE r� rh �encr r Zfinal_encoding�newliner r r r [ s^
zConfigObj._handle_bomc C s& t |tj�r | jr |j| j�S |S dS )z@Decode ASCII strings to unicode if a self.encoding is specified.N)r[ r� r r r )rE ZaStringr r r �_a_to_u� s zConfigObj._a_to_uc C sx t |tj�r|jd�S t |tj�r@|r6|j|�jd�S |jd�S |rtx.t|�D ]"\}}t |tj�rN|j|�||< qNW |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� r r r � enumerate)rE r� r rP rh r r r r � s
zConfigObj._decodec C s& t |tj�r | jr |j| j�S |S dS )z'Decode element to unicode if necessary.N)r[ r� r r5 r )rE rh r r r �_decode_element� s zConfigObj._decode_elementc C s t |tj�st|�S |S dS )zh
Used by ``stringify`` within validate, to turn non-string values
into strings.
N)r[ r� r� r )rE rK r r r �_str� s zConfigObj._strc C s" | j }| jrd| _ g }d}| }t|�d }d}d}�x�||k �r�|rHg }|d7 }|| } | j� }
|
sp|
jd�r�d}|j| � q6|s�|| _g }d}d}| jj| �} | dk �r�| j � \} }
}}}| r�| j
dkr�| | _
|
j d�}||j d�k� r�| j dt
||� q6||jk �rHy| j||�j}W n( tk
�rD | j d t
||� w6Y nX n<||jk�r\|j}n(||jd k�rr|}n| j d
t
||� q6| j|�}||k�r�| j d t||� q6t||| |d �}|||< ||j|< ||j|< q6| jj| �} | dk�r| j d
j| �t||� q6| j � \} }}| �r,| j
dk�r,| | _
|dd� dk�r�y| j||||�\}}}W n( tk
�r� | j dt||� w6Y njX | j�r�d}y t|�}W nN tk
�r� } z0t |�t k�r�d}nd}| j |t ||� w6W Y dd}~X nX n�| j�rTd}y t|�}W nL tk
�rP } z.t |t ��r*d}nd}| j |t ||� w6W Y dd}~X nX n<y| j |�\}}W n( tk
�r� | j dt||� w6Y nX | j|�}||k�r�| j dt||� q6|j!||dd� ||j|< ||j|< q6q6W | j
dk�r�d| _
| �r | j �r || _n |�s|| _"|| _ dS )z Actually parse the config file.Fr8 �#TN�[�]z Cannot compute the section depthz Cannot compute nesting levelzSection too nestedzDuplicate section name)rW z=Invalid line ({0!r}) (matched as neither section nor keyword)� �"""�'''z Parse error in multiline valuerg z Unknown name or type in valuez+Parse error from unrepr-ing multiline valuez!Parse error from unrepr-ing valuezParse error in valuezDuplicate keyword name)r6 r� )r! r" )#r/ r6 ry �stripr r� r
�_sectionmarkerr{ �groupsr4 �count�
_handle_errorr r� � _match_depthrb rj �_unquoter r� r� r� �_keyword�formatr �
_multiliner� �typer( r' r[ �
_handle_valuer� r )rE r� Ztemp_list_valuesZ comment_listZ
done_startr� �maxline� cur_indexZ
reset_commentrh Zsline�mat�indentZ sect_openZ sect_nameZ
sect_close�commentZ cur_depthrb rz rK �erp r r r r s�
zConfigObj._parsec C s> x$||j k r$||jkr t� �|j}qW |j |kr4|S t� �dS )z�
Given a section and a depth level, walk back through the sections
parents to see if the depth level matches a previous section.
Return a reference to the right section,
or raise a SyntaxError.
N)r� rb rj )rE Zsectr� r r r r( � s
zConfigObj._match_depthc C sB || }|d7 }dj ||�}||||�}| jr2|�| jj|� dS )z�
Handle an error according to the error settings.
Either raise the error or store it.
The error will have occured at ``cur_index``
r8 z{0} at line {1}.N)r+ r. r r� )rE �textZ
ErrorClassr� r0 rh rl r r r r r' � s zConfigObj._handle_errorc C s4 |st �|d |d kr0|d dkr0|dd� }|S )z%Return an unquoted version of a valuer r8 �"�'r� )r6 r7 r� )rj )rE rK r r r r) � s
zConfigObj._unquotec s� |r� j r|dkrdS |rjt|ttf�rj|s0dS t|�dkrR� j|d dd�d S dj� fdd �|D ��S t|tj�s�� j r�t
|�}n t d
| ��|s�d S � j o�d |ko�d
|k}|o�d|kr�d|kp�d |k}|o�| o�d|ko�d|ko�d
|k}|� s�| �o| }|�rh� j �st
}nNd |k�r0td| ��n6|d tk�r\|d tk�r\d|k�r\t
}n
� j|�}n
� j|�}|t
k�r�d
|k�r�� j �r�� j|�}|| S )a�
Return a safely quoted version of a value.
Raise a ConfigObjError if the value cannot be safely quoted.
If multiline is ``True`` (default) then use triple quotes
if necessary.
* Don't quote values that don't need it.
* Recursively quote members of a list and return a comma joined list.
* Multiline is ``False`` for lists.
* Obey list syntax for empty and single member lists.
If ``list_values=False`` then the value is only quoted if it contains
a ``\n`` (is multiline) or '#'.
If ``write_empty_values`` is set, and the value is an empty string, it
won't be quoted.
rg �,r8 r F)� multilinez, c s g | ]}� j |d d��qS )F)r9 )�_quote)r� r� )rE r r r� � s z$ConfigObj._quote.<locals>.<listcomp>zValue "%s" is not a string.z""r� r r7 r6 z#Value "%s" cannot be safely quoted.r� )r7 r[ rH rR ry r: rx r� r� r3 r rZ r/ �noquotr � wspace_plus�_get_single_quote�_get_triple_quote)rE rK r9 Zno_lists_no_quotesZ need_tripleZhash_triple_quoteZcheck_for_single�quotr )rE r r: � sB
"
zConfigObj._quotec C s4 d|kr d|kr t d| ��nd|kr,t}nt}|S )Nr7 r6 z#Value "%s" cannot be safely quoted.)r �squot�dquot)rE rK r? r r r r= % s zConfigObj._get_single_quotec C sD |j d�dkr(|j d�dkr(td| ��|j d�dkr<t}nt}|S )Nz"""r8 z'''z#Value "%s" cannot be safely quoted.r� r� r� )�findr �tdquot�tsquot)rE rK r? r r r r> / s zConfigObj._get_triple_quotec s� � j r|dfS � js6� jj|�}|dkr.t� �|j� S � jj|�}|dkrPt� �|j� \}}}}|dkrv|dkrvt� �|dk r�g |fS |dk r�|r�| r�d}n|p�d}� j|�}|dkr�||fS � jj |�}� fdd�|D �}|dk r�||g7 }||fS )z�
Given a value string, unquote, remove comment,
handle lists. (including empty and single member lists)
rg Nz""c s g | ]}� j |��qS r )r) )r� r� )rE r r r� d s z+ConfigObj._handle_value.<locals>.<listcomp>)
r� r/ � _nolistvaluer{ rj r% � _valueexpr) �
_listvalueexp�findall)rE rK r1 r/ ZsingleZ
empty_listr3 r� r )rE r r. 9 s6
zConfigObj._handle_valuec
C s� |dd� }|dd� }| j | d }| j | d }|j|�} | dk r`t| j� �}
|
j|� |
S |j|�dkrtt� �xD||k r�|d7 }|d7 }|| } | j|�dkr�|| 7 }qvP qvW t� �|j| �} | dkr�t� �| j� \}} || | |fS )z9Extract the value, where we are in a multiline situation.Nr r r8 r� r� r� )�
_triple_quoter{ rH r% r� rB rj )
rE rK r� r0 r/ r? ZnewvalueZ single_lineZ
multi_liner1 Zretvalrh r3 r r r r, j s0
zConfigObj._multilinec C s� t |t�szyt|dddd�}W nZ tk
rL } ztd| ��W Y dd}~X n. tk
rx } ztd| ��W Y dd}~X nX || _dS )zParse the configspec.T)r. r1 r� z Parsing configspec failed: %sNz Reading configspec failed: %s)r[ r r r rn r2 )rE r2 r4 r r r r � s
z ConfigObj._handle_configspecc C s� |j }|jd�}t|t�r<x |jD ]}||kr"||| _ q"W xz|jD ]p}|dkrRqD||kr�i ||< d|| _|r�|jj|g �|j|< |jj|d�|j|< t|| t�rD|| || _ qDW dS )z�
Called by validate. Handles setting the configspec on subsections
including sections to be validated by __many__
�__many__Trg N) r2 r r[ r� r� r� r� r� r� )rE rs �copyr2 �manyr� r r r �_set_configspec� s"
zConfigObj._set_configspecc C sN | j s| j| j|��}nt|�}d|| j| j|dd��| jd�|| j|�f S )z.Write an individual line, for the write methodz
%s%s%s%s%sF)r9 z = )r6 r r: r� r )rE �
indent_stringr� r� r3 r� r r r � _write_line� s zConfigObj._write_linec C s< d|| j d| �| j| j|�dd�| j d| �| j|�f S )zWrite a section marker linez
%s%s%s%s%sr F)r9 r )r r: r )rE rN r� r� r3 r r r �
_write_marker� s
zConfigObj._write_markerc C s. |sdS | j }|jd�s&|| jd�7 }|| S )zDeal with a comment.rg r z # )r4 r r )rE r3 r~ r r r �_handle_comment� s
zConfigObj._handle_commentc sB � j dkrt� _ g }� jd�}� jd�}|dkr�� j}d� _� }xB� jD ]8}� j|�}|j� }|rv|j|� rv|| }|j|� qHW � j |j } x�|j
|j D ]�}
|
|j kr�q�xF|j
|
D ]8} � j| j� �} | r�| j|� r�|| } |j| | � q�W ||
} � j|j|
�}
t| t��rF|j� j| | j |
|
�� |j� j| d�� q�|j� j| |
| |
�� q�W |� k�r�xH� jD ]>}� j|�}|j� }|�r�|j|� �r�|| }|j|� �qrW |� _|� k �r�|S � jdk�rF|dk�rF� j�r�� fdd�|D �}� j�rB� jdk�s"tj � jj � �dk�rB|�s2|jd � t |d
|d
< |S � j �pRt j!}t"|d d�dk �r�|j#d k�r�t$j%d
k�r�|dk�r�d}� j|�j&|�}|j'|��s�||7 }t|t(j)��r�|}n|j*� j�pڈ j+�p�d�}� j�r� jdk�s�t,� j��rt | }|dk �r |j|� n"t-� jd��}|j|� W dQ R X dS )a~
Write the current ConfigObj as a file
tekNico: FIXME: use StringIO instead of real files
>>> 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# F)rs c s g | ]}|j � j��qS r )�encoder )r� �l)rE r r r� / s z#ConfigObj.write.<locals>.<listcomp>r rg r �moder� Zwin32z
r� �ascii�wb).r4 r r r- r
r r# r r� r� r� r� r� r� �lstriprQ r� r[ r� rP �extendr rO r r� r r r r r r r r� �linesepra rT �sys�platformrx r r� r rR r5 r r� )rE Zoutfilers r� ZcsZcspZint_valrh Z
stripped_linerN r� Z comment_liner� r3 r �outputZ output_bytesr r )rE r r � s�
zConfigObj.writec st �dkrt�j dkrtd���r0ddlm} |�_���rt�j j�_�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 �} x�� j D ]�} | dk� r�q�| �j k�s| �jk�rZd}
d}��rf| �j k�rf� jj| g ��j| < � jj| d��j| < n d}
�| }|| � | ||
||�\}}q�W d}d � j k�r�� d }nd
� j k�r�� d
}|dk �r�x,| D ]$} �| }|| ||d||�\}}�q�W g } x<| D ]4} d}��s d�| < nd}d| }�j|��| < �q�W x<|
D ]4} d}��sJd�| < nd}d| }�j|��| < �q2W x��j
D ]�} ��k�r�| dk�r��qr�| j dk�r�| j| � �qr��rڈ jj| g ��j| < � jj| d��j| < �j����| d�}|�| < |dk�rd}n|dk�rd}nd}�qrW | �_��r<�j �r<d}|�r\��r\��r\t�j� � }|�rfdS |�rpdS �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 sP �j j| d � y�j� | ��j | < W n tt�jfk
rB Y nX y�j|||d�}W nP �jk
r� } z2� s~t|�j�r�d�| < n |�| < d}d}W Y d d }~X n�X d}d�| < �j s�|�r"�j �s
t|t
t f�r�fdd�|D �}n |o�|d k�r d}n
�j |�}||k�s|�r"|�| < � �rH|�rH| �j
k�rH�j
j| � ||fS )N)�missingFTc s g | ]}� j |��qS r )r )r� �item)rE r r r� � s z>ConfigObj.validate.<locals>.validate_entry.<locals>.<listcomp>rg )r� r� Zget_default_valuer� r� �baseErrorClass�checkr[ �_vdtMissingValuer3 rH rR r r� r� )r� �specr� r^ �ret_true� ret_falsera r4 )r2 rK r� �preserve_errorsrs rE � validatorr r �validate_entry� s:
z*ConfigObj.validate.<locals>.validate_entryTc s g | ]}|� kr|�qS r r )r� r| )r2 r r r� � s z&ConfigObj.validate.<locals>.<listcomp>c s g | ]}|� j kr|�qS r )r� )r� r| )rs r r r� � s c s g | ]}|� j kr|�qS r )r� )r� r| )rs r r r� � s rJ �
___many___rg Fz"Value %r was provided as a sectionz)Section %r was provided as a single valuer� )rf rK rs )rJ ri )r2 r� �validater] rb r
r r r r r4 rM r� r� r� r� r r� r` r� r� r� �anyr� )rE rg rf rK rs r] rh rd re Z unvalidatedZincorrect_sectionsZincorrect_scalarsr� r^ r� rL rp ra r )r2 rK r� rf rs rE rg r rj S s� $
-
zConfigObj.validatec C s | j � | j� d| _d| _dS )z@Clear ConfigObj instance and restore to 'freshly created' state.N)r� r� r2 r� )rE r r r �reset" s zConfigObj.resetc C st t | jtj�st� �| j}i }x$tD ] }|dkr2q$t| |�||< q$W | j}||d< | j� | j |� | j
||� 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.
r2 N) r[ r� r� r� r& r� ra r� r� r� r� )rE r� Zcurrent_optionsr� r2 r r r �reload- s
zConfigObj.reload)NNNNTFTFFTNNFFF)N)T)NN)FFN)-r? r@ rA rm r� r� r� r* r$ rF rG rE Z_single_line_singleZ_single_line_doubleZ_multi_line_singleZ_multi_line_doublerI r� rk r� r� r� r r r r r r r( r' r) r: r= r> r. r, r rM rO rP rQ r rj rl rm r r r r r / sx
6`
u
(
G
1#
r
O c @ s" e Zd ZdZdd� Zddd�ZdS ) 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 )N)r r` )rE r r r rk S s zSimpleVal.__init__Fc C s |r | j � �|S )z9A dummy check method, always returns the value unchanged.)r` )rE ra �memberr^ r r r ra V s zSimpleVal.checkN)F)r? r@ rA rm rk ra r r r r r! G s
c C s� |dkrg }g }|dkr t |�S |dks2t|t�r^|j|dd� d|f� |rV|j� t |�S xht|j� �D ]X\}}|dkr~qlt| j|�t�r�|j|� t | | |||� ql|j|dd� ||f� qlW |r�|j� 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� rH r� r r� r) )Zcfg�resZlevels�resultsrz r� r r r r) ] s*
c sV g }|j � fdd�| jD �� x2| jD ](}|| jkr&|j t| | � |f �� q&W |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 | ] }� |f�qS r r )r� rW )�_prependr r r� � s z$get_extra_values.<locals>.<listcomp>)rX r� r� r* )Zconfrr r� rW r )rr r r* � s
)r N)r r )r
r )r r )r r r r r r r r r! r" r# r$ r% r& r' r( r) r* )NN);r� r� rZ �codecsr r r r r� Z_versionr r9 r r r r r@ rA r; r< rD rC �objectr� �__all__r r ZMAX_INTERPOL_DEPTHr� r> r� r( rB Z_builderr6 rj r r r rn r& r r r" r# r% r$ r' rq r� r� r� r� r� r� r r! r) r* r r r r �<module> s� 7 | i "
<