o 8^k@sdZddlmZddlmZmZdZdZedkZ dZ e re Z ne Z dd Zd d ZGd d d eZGdddeZGdddeZGdddeZGdddeZddgZdS)a Augeas is a library for programmatically editing configuration files. Augeas parses configuration files into a tree structure, which it exposes through its public API. Changes made through the API are written back to the initially read files. The transformation works very hard to preserve comments and formatting details. It is controlled by *lens* definitions that describe the file format and the transformation into a tree. ) version_info)ffilibz/Nathaniel McCallum zJeff Schroeder Harald Hoyer - initial python bindings, packaging Nils Philippsen )utf8cC|r|tSdSN)encodeAUGENCstreZdZdZdZdZdZdZdZdZ dZ d Z d Z dZ dZdZd ZdZd Zd ZdZdZdZdZdZdZdZdZddZddZddefddZddZddZ d d!Z!d"d#Z"d$d%Z#d&d'Z$d(d)Z%d*d+Z&d,d-Z'd.d/Z(d0d1Z)dId3d4Z*d5d6Z+d7d8Z,d9d:Z-d;d<Z.d=d>Z/d?d@Z0dJdBdCZ1dKdEdFZ2dGdHZ3dS)LAugeasz/ Class wrapper for the Augeas library. r @r cCs|tjkrdStt|Sr)rNULLrstring)r cffistrrrr _optffistrings zAugeas._optffistringc Gst|j}|tjkrt|t|j}|d||}|t|j}|r0|d|7}|t |j}|rA|d|7}||||||)Nz: ) r aug_error_Augeas__handler/ AUG_ENOMEM MemoryErrorrDaug_error_messageaug_error_minor_messageaug_error_details) r errorclasserrmsgr#r!rr"rrrrr _raise_errors    zAugeas._raise_errorNcst|ts |dur tdt|ts|durtdt|ts#td|r)t|ntj}|r2t|ntj}tt |||fdd_ j sLt ddS)a Initialize the library. :param root: the filesystem root. If `root` is :py:obj:`None`, use the value of the environment variable :envvar:`AUGEAS_ROOT`. If that doesn't exist either, use :samp:`/`. :type root: str or None :param loadpath: a colon-separated list of directories that modules should be searched in. This is in addition to the standard load path and the directories in :envvar:`AUGEAS_LENS_LIB`. :type loadpath: str or None :param flags: a combination of values of :attr:`SAVE_BACKUP`, :attr:`SAVE_NEWFILE`, :attr:`TYPE_CHECK`, :attr:`NO_STDINC`, :attr:`SAVE_NOOP`, :attr:`NO_LOAD`, :attr:`NO_MODL_AUTOLOAD`, and :attr:`ENABLE_SPAN`. :type flags: int or :attr:`NONE` Nzroot MUST be a string or None!z"loadpath MUST be a string or None!zflag MUST be a flag!csjSr)close)xr rrsz!Augeas.__init__..zUnable to create Augeas object!) isinstance string_types TypeErrorintrrrAgcraug_initrF RuntimeError)r rootloadpathflagsrrQrrs  zAugeas.__init__cCbt|ts td|jstdtdd}t|jt ||}|dkr*| t d| |dS)z Lookup the value associated with `path`. It is an error if more than one node matches `path`. :returns: the value at the path specified :rtype: str path MUST be a string!*The Augeas object has already been closed!char*[]r0rzAugeas.get() failed) rSrTrUrFrYrnewraug_getrrNr.rDr pathvalueretrrrget   z Augeas.getcCr])z Lookup the label associated with `path`. It is an error if more than one node matches `path`. :returns: the label of the path specified :rtype: str r^r_r`r0rzAugeas.label() failed) rSrTrUrFrYrrar aug_labelrrNr.rD)r rdlabelrfrrrrjrhz Augeas.labelcCsnt|ts tdt|ts|durtd|jstdt|jt|t|}|dkr5|t ddSdS)z Set the value associated with `path` to `value`. Intermediate entries are created if they don't exist. It is an error if more than one node matches `path`. r^Nvalue MUST be a string or None!r_rzAugeas.set() failed) rSrTrUrFrYraug_setrrNr.rcrrrsets z Augeas.setcCst|tkr tdt|tkr|durtdt|tkr&|dur&td|js-tdt|jt|t|t|}|dkrF|t d|S)a5 Set the value of multiple nodes in one operation. Find or create a node matching `sub` by interpreting `sub` as a path expression relative to each node matching `base`. `sub` may be :py:obj:`None`, in which case all the nodes matching `base` will be modified. zbase MUST be a string!Nzsub MUST be a string or None!rkr_rzAugeas.setm() failed) typestrrUrFrYraug_setmrrNr.)r basesubrerfrrrsetm s  z Augeas.setmcCszt|ts tdt|tstdt|tstd|js"tdt|jt|t|t|}|dkr;|t d|S)z Use the value of node `node` as a string and transform it into a tree using the lens `lens` and store it in the tree at `path`, which will be overwritten. `path` and `node` are path expressions. lens MUST be a string!znode MUST be a string!r^r_rzAugeas.text_store() failed) rSrTrUrFrYraug_text_storerrNr.)r lensnoderdrfrrr text_store#s    zAugeas.text_storecCst|ts tdt|tstdt|tstdt|ts$td|js+tdt|jt|t|t|t|}|dkrG|t d|S)a Transform the tree at `path` into a string using lens `lens` and store it in the node `node_out`, assuming the tree was initially generated using the value of node `node_in`. `path`, `node_in`, and `node_out` are path expressions. rtznode_in MUST be a string!r^znode_out MUST be a string!r_rzAugeas.text_retrieve() failed) rSrTrUrFrYraug_text_retrieverrNr.)r rvnode_inrdnode_outrfrrr text_retrieve;s$    zAugeas.text_retrievecCsnt|tkr tdt|tkr|durtd|jstdt|jt|t|}|dkr5|t d|S)a Define a variable `name` whose value is the result of evaluating `expr`. If a variable `name` already exists, its name will be replaced with the result of evaluating `expr`. If `expr` is :py:obj:`None`, the variable `name` will be removed if it is defined. Path variables can be used in path expressions later on by prefixing them with :samp:`$`. name MUST be a string!Nzexpr MUST be a string or None!r_rzAugeas.defvar() failed) rnrorUrFrYr aug_defvarrrNr.)r nameexprrfrrrdefvarWs  z Augeas.defvarcCst|tkr tdt|tkrtdt|tkrtd|js%tdt|jt|t|t|tj }|dkr@| t d|S)a Define a variable `name` whose value is the result of evaluating `expr`, which must not be :py:obj:`None` and evaluate to a nodeset. If a variable `name` already exists, its name will be replaced with the result of evaluating `expr`. If `expr` evaluates to an empty nodeset, a node is created, equivalent to calling ``set(expr, value)`` and `name` will be the nodeset containing that single node. r}zexpr MUST be a string!zvalue MUST be a string!r_rzAugeas.defnode() failed) rnrorUrFrYr aug_defnoderrrArNr.)r rrrerfrrrdefnoders    zAugeas.defnodecCft|ts tdt|tstd|jstdt|jt|t|}|dkr1|t ddSdS)ap Move the node `src` to `dst`. `src` must match exactly one node in the tree. `dst` must either match exactly one node in the tree, or may not exist yet. If `dst` exists already, it and all its descendants are deleted before moving `src` there. If `dst` does not exist yet, it and all its missing ancestors are created. src MUST be a string!dst MUST be a string!r_rzAugeas.move() failedN) rSrTrUrFrYraug_mvrrNr.r srcdstrfrrrmove  z Augeas.movecCr)aq Copy the node `src` to `dst`. `src` must match exactly one node in the tree. `dst` must either match exactly one node in the tree, or may not exist yet. If `dst` exists already, it and all its descendants are deleted before copying `src` there. If `dst` does not exist yet, it and all its missing ancestors are created. rrr_rzAugeas.copy() failedN) rSrTrUrFrYraug_cprrNr.rrrrcopyrz Augeas.copycCsbt|ts tdt|tstd|jstdt|jt|t|}|dkr/|t d|S)zH Rename the label of all nodes matching `src` to `dst`. rrr_rzAugeas.rename() failed) rSrTrUrFrYr aug_renamerrNr.rrrrrenames   z Augeas.renameTcCspt|ts tdt|tstd|jstdt|jt|t||r'dp(d}|dkr6|t ddSdS)a Create a new sibling `label` for `path` by inserting into the tree just before `path` (if `before` is :py:obj:`True`) or just after `path` (if `before` is :py:obj:`False`). `path` must match exactly one existing node in the tree, and `label` must be a label, i.e. not contain a :samp:`/`, :samp:`*` or end with a bracketed index :samp:`[N]`. r^zlabel MUST be a string!r_r0rzAugeas.insert() failedN) rSrTrUrFrYr aug_insertrrNr.)r rdrjbeforerfrrrinserts  z Augeas.insertcCs2t|ts td|jstdt|jt|S)z Remove `path` and all its children. Returns the number of entries removed. All nodes that match `path`, and their descendants, are removed. r^r_)rSrTrUrFrYraug_rmr)r rdrrrremoves z Augeas.removecCst|ts td|jstdtd}t|jt ||}|dkr*| t d||d}g}t |D]}||tj krRt||}|t|t||q4t||S)a Return the matches of the path expression `path`. The returned paths are sufficiently qualified to make sure that they match exactly one node in the current tree. Path expressions use a very simple subset of XPath: the path `path` consists of a number of segments, separated by :samp:`/`; each segment can either be a :samp:`*`, matching any tree node, or a string, optionally followed by an index in brackets, matching tree nodes labelled with exactly that string. If no index is specified, the expression matches all nodes with that label; the index can be a positive number N, which matches exactly the *N*-th node with that label (counting from 1), or the special expression :samp:`last()` which matches the last node with the given label. All matches are done in fixed positions in the tree, and nothing matches more than one path segment. r^r_zchar***rzAugeas.match() failed: %s)rSrTrUrFrYrrar aug_matchrrNr-rangerArBappendrfree)r rdparrayrfarraymatchesiitemrrrmatchs(    z Augeas.matchc Cst|ts td|jstdtd}td}td}td}td}td}td}t|jt |||||||| } | dkrM| t d| |d} | t |dt |dt |dt |dt |dt |dfS)a Get the span according to input file of the node associated with `path`. If the node is associated with a file, a tuple of 7 elements is returned: ``(filename, label_start, label_end, value_start, value_end, span_start, span_end)``. If the node associated with `path` doesn't belong to a file or is doesn't exists, :py:obj:`ValueError` is raised. :rtype: tuple(str, int, int, int, int, int, int) r^r_zchar **zunsigned int *rzAugeas.span() failed)rSrTrUrFrYrraraug_spanrrNr.rDrV) r rdfilename label_start label_end value_start value_end span_startspan_endrffnamerrrspan#s.         z Augeas.spancC6|jstdt|j}|dkr|tddSdS)a Write all pending changes to disk. Only files that had any changes made to them are written. If :attr:`SAVE_NEWFILE` is set in the creation `flags`, create changed files as new files with the extension :samp:`.augnew`, and leave the original file unmodified. Otherwise, if :attr:`SAVE_BACKUP` is set in the creation `flags`, move the original file to a new file with extension :samp:`.augsave`. If neither of these flags is set, overwrite the original file. r_rzAugeas.save() failedN)rFrYraug_saverNrr rfrrrsaveIs  z Augeas.savecCr)aM Load files into the tree. Which files to load and what lenses to use on them is specified under :samp:`/augeas/load` in the tree; each entry :samp:`/augeas/load/NAME` specifies a 'transform', by having itself exactly one child 'lens' and any number of children labelled 'incl' and 'excl'. The value of :samp:`NAME` has no meaning. The 'lens' grandchild of :samp:`/augeas/load` specifies which lens to use, and can either be the fully qualified name of a lens :samp:`Module.lens` or :samp:`@Module`. The latter form means that the lens from the transform marked for autoloading in MODULE should be used. The 'incl' and 'excl' grandchildren of :samp:`/augeas/load` indicate which files to transform. Their value are used as glob patterns. Any file that matches at least one 'incl' pattern and no 'excl' pattern is transformed. The order of 'incl' and 'excl' entries is irrelevant. When AUG_INIT is first called, it populates :samp:`/augeas/load` with the transforms marked for autoloading in all the modules it finds. Before loading any files, :func:`load` will remove everything underneath :samp:`/augeas/files` and :samp:`/files`, regardless of whether any entries have been modified or not. r_rzAugeas.load() failedN)rFrYraug_loadrNr-rrrrloadas  z Augeas.loadcCs|ddS)z Clear all transforms beneath :samp:`/augeas/load`. If :func:`load` is called right after this, there will be no files beneath :samp:`/files`. z/augeas/load/*N)rrQrrrclear_transformsszAugeas.clear_transformsrcCs|rddl}|jdtddt|tr|g}t|tr|g}tt|D] }||||dq$tt|D] }||||dq6dS)a Add a transform beneath :samp:`/augeas/load`. :param lens: the (file)name of the lens to use :type lens: str :param incl: one or more glob patterns for the files to transform :type incl: str or list(str) :param name: deprecated parameter :param excl: zero or more glob patterns of files to exclude from transforming :type excl: str or list(str) rNz'name is now deprecated in this functionr1 stacklevelFT)warningswarnDeprecationWarningrSrTrlen transform)r rvinclrexclrrrrr add_transforms  zAugeas.add_transformFcCszt|ts tdt|tstdt|tstd|js"tdt|jt|t||}|dkr;| t ddSdS)aB Add a transform for `file` using `lens`. `excl` specifies if this the file is to be included (:py:obj:`False`) or excluded (:py:obj:`True`) from the `lens`. The `lens` may be a module name or a full lens name. If a module name is given, then lns will be the lens assumed. rtzfile MUST be a string!zexcl MUST be a boolean!r_rzAugeas.transform() failedN) rSrTrUboolrFrYr aug_transformrrNr-)r rvfilerrfrrrrs   zAugeas.transformcCs,|jr |jtjkr dSt|jd|_dS)z Close this Augeas instance and free any storage associated with it. After this call, this Augeas instance is invalid and can not be used for any more operations. N)rFrrAr aug_closerQrrrrOs  z Augeas.close)T)Nr)F)4r(r)r*__doc__NONE SAVE_BACKUP SAVE_NEWFILE TYPE_CHECK NO_STDINC SAVE_NOOPNO_LOADNO_MODL_AUTOLOAD ENABLE_SPAN AUG_NOERRORrG AUG_EINTERNAL AUG_EPATHX AUG_ENOMATCH AUG_EMMATCH AUG_ESYNTAX AUG_ENOLENS AUG_EMXFM AUG_ENOSPAN AUG_EMVDESC AUG_ECMDRUN AUG_EBADARG AUG_ELABEL AUG_ECPDESCrDrNrrgrjrmrsrxr|rrrrrrrrrrrrrrrOrrrrr/_sd' ,&#   r/cs eZdZdZfddZZS)augeaszN Compat class, obsolete. Use class Augeas directly. :deprecated: cs2ddl}|jdtddtt|j|i|dS)Nrzuse Augeas instead of augeasr1r)rrrrrr)r pkrr$rrrs zaugeas.__init__)r(r)r*rrr+rrr$rrsrN)rsysr_pyver augeas.ffirr __author__ __credits__PY3r rorT basestringrrIOErrorrrYr- ValueErrorr.objectr/r__all__rrrrs,    w