)g:SrSSKrSSKrSSKrSSKrSSKrSSKJr SSKJ r SSK J r SSK J r SSKJrJrJrJrJrJrJrJrJr \(aSSKJr SS KJr \\\\\\\4r\R<"S 5r\R@"S 5r!"S S 5r"\RFS:d\(a "SS\RH\\ \\4\5r%O"SS\RL\\ \5r%"SS\%S5r'g!\a Nf=f)aFacilities for reading and writing Debian substvars files The aim of this module is to provide programmatic access to Debian substvars files to query and manipulate them. The format for the substvars files is defined in `deb-substvars(5) `_ Overview ======== The most common use-case for substvars is for package helpers to add or update a substvars (e.g., to add a dependency). This would look something like: >>> from debian.substvars import Substvars >>> from tempfile import TemporaryDirectory >>> import os >>> # Using a tmp dir for the sake of doctests >>> with TemporaryDirectory() as debian_dir: ... filename = os.path.join(debian_dir, "foo.substvars") ... with Substvars.load_from_path(filename, missing_ok=True) as svars: ... svars.add_dependency("misc:Depends", "bar (>= 1.0)") By default, the module creates new substvars as "mandatory" substvars (that triggers a warning by dpkg-gecontrol if not used. However, it does also support the "optional" substvars introduced in dpkg 1.21.8. See `Substvars.as_substvars` for an example of how to use the "optional" substvars. The :class:`Substvars` class is the key class within this module. Substvars Classes ----------------- N)ABC) OrderedDict)MutableMapping) TracebackType) DictSetOptionalUnionIteratorIOIterable TYPE_CHECKINGType)Self)PathLikeTzB^(?P\w[-:\dA-Za-z]*)(?P[?]?=)(?P.*)$c\rSrSrSS/rS Sjr\S\4Sj5r\RS5rSr S\4S jr S r S r g )Substvar?_assignment_operator_valuecXlX lgN)rassignment_operator)self initial_valuers 2/usr/lib/python3/dist-packages/debian/substvars.py__init__Substvar.__init__Cs$ #6 returncUR$r)rrs rrSubstvar.assignment_operatorTs(((r c8US;a[SU-5eXlg)N>=?=z-Operator must be one of: "=", or "?=" - got: ) ValueErrorr)r new_operators rrr$Xs# { *L|[\ \$0!r c0URS:Xa U1Ulg[UR[5(a>URRS5Vs1sHo"R 5iM snUlURR U5 gs snf)N,)r isinstancestrsplitstripadd)rdependency_clausevs radd_dependencySubstvar.add_dependency_sn ;;" ,-DK  dkk3 ' '.2kk.?.?.DE.D779.DEDK )*FsBc[UR[5(a$SR[ UR55$UR$)Nz, )r-rsetjoinsortedr#s rresolveSubstvar.resolveis5 dkk3 ' '99VDKK01 1{{r cUb[U[5(dgURUR:wagUR5UR5:H$NF)r-rrr:rothers r__eq__Substvar.__eq__nsD = 5( ; ;  # #u'@'@ @||~00r )rrrN)r+r&)__name__ __module__ __qualname____firstlineno__ __slots__rpropertyr.rsetterr4r:r@__static_attributes__r rrr?sb'2I%'%(7")S))1 1 + 1r r) c\rSrSrSrg)_Substvars_BasexrJN)rBrCrDrErIrJr rrNrNxs r rNc \rSrSrSrSrSrg)rNcU$rrJr#s r __enter___Substvars_Base.__enter__sKr cgrrJ)rexc_typeexc_valexc_tbs r__exit___Substvars_Base.__exit__sr rJN)rBrCrDrErSrYrIrJr rrNrNs   r c&^\rSrSrSrSS/rSSjr\SSj5r\ S5r \ RS 5r \ S 5r \ RS 5r S r U4S jrSrS\4SjrSrSrSrSr\ S5rSrS\4SjrSSjrSrSrSrU=r$) SubstvarsaOSubstvars is a dict-like object containing known substvars for a given package. >>> substvars = Substvars() >>> substvars['foo'] = 'bar, golf' >>> substvars['foo'] 'bar, golf' >>> substvars.add_dependency('foo', 'dpkg (>= 1.20.0)') >>> substvars['foo'] 'bar, dpkg (>= 1.20.0), golf' >>> 'foo' in substvars True >>> sorted(substvars) ['foo'] >>> del substvars['foo'] >>> substvars['foo'] Traceback (most recent call last): ... KeyError: 'foo' >>> substvars.get('foo') >>> # None >>> substvars['foo'] = "" >>> substvars['foo'] '' The Substvars object also provide methods for serializing and deserializing the substvars into and from the format used by dpkg-gencontrol. The Substvars object can be used as a context manager, which causes the substvars to be saved when the context manager exits successfully (i.e., no exceptions are raised). _vars_dict_substvars_pathr!c0[5UlSUlgr)rr^r_r#s rrSubstvars.__init__s%-#r cU"5n[USSS9nURU5 SSS5 XlU$!,(df  N=f![a0nUR[R:wdU(deSnANNSnAff=f)arShorthand for initializing a Substvars from a file The return substvars will have `substvars_path` set to the provided path enabling `save()` to work out of the box. This also makes it easy to combine this with the context manager interface to automatically save the file again. >>> import os >>> from tempfile import TemporaryDirectory >>> with TemporaryDirectory() as tmpdir: ... filename = os.path.join(tmpdir, "foo.substvars") ... # Obviously, this does not exist ... print("Exists before: " + str(os.path.exists(filename))) ... with Substvars.load_from_path(filename, missing_ok=True) as svars: ... svars.add_dependency("misc:Depends", "bar (>= 1.0)") ... print("Exists after: " + str(os.path.exists(filename))) Exists before: False Exists after: True :param substvars_path: The path to load from :param missing_ok: If True, then the path does not have to exist (i.e. FileNotFoundError causes an empty Substvars object to be returned). Combined with the context manager, this is useful for packaging helpers that want to append / update to the existing if it exists or create it if it does not exist. rutf-8encodingN)openread_substvarsOSErrorerrnoENOENTsubstvars_path)clsrl missing_ok substvarsfdes rload_from_pathSubstvars.load_from_pathsq6E  ncG<((,= $2  =< ww%,,&j/9 s1 A6A AAA B&A<<BcUR$rr^r#s r_varsSubstvars._varssr cXlgrru)r vars_dicts rrvrws $r cUR$rr_r#s rrlSubstvars.substvars_paths###r cXlgrr{)rnew_paths rrlr|s  (r cURUnURU5 g![a [5nX0RU'N6f=f)acAdd a dependency clause to a given substvar >>> substvars = Substvars() >>> # add_dependency automatically creates variables >>> 'misc:Recommends' not in substvars True >>> substvars.add_dependency('misc:Recommends', "foo (>= 1.0)") >>> substvars['misc:Recommends'] 'foo (>= 1.0)' >>> # It can be appended to other variables >>> substvars['foo'] = 'bar, golf' >>> substvars.add_dependency('foo', 'dpkg (>= 1.20.0)') >>> substvars['foo'] 'bar, dpkg (>= 1.20.0), golf' >>> # Exact duplicates are ignored >>> substvars.add_dependency('foo', 'dpkg (>= 1.20.0)') >>> substvars['foo'] 'bar, dpkg (>= 1.20.0), golf' N)rvKeyErrorrr4)rsubstvarr2variables rr4Substvars.add_dependencysJ, ,zz(+H  12 ,zH#+JJx  ,s#"AAcJ>UcUR5 [TU] XU5$r)savesuperrY)rrVrWrX __class__s rrYSubstvars.__exit__s&   IIKw6::r c,[UR5$r)iterrvr#s r__iter__Substvars.__iter__sDJJr c,[UR5$r)lenr^r#s r__len__Substvars.__len__s4??##r cXR;$rrv)ritems r __contains__Substvars.__contains__szz!!r c<URUR5$r)rvr:rkeys r __getitem__Substvars.__getitem__szz#&&((r cURU grrrs r __delitem__Substvars.__delitem__s JJsOr c4[U5URU'gr)rrv)rrvalues r __setitem__Substvars.__setitem__#s"5/ 3r cUR$)aProvides a mapping to the Substvars object for more advanced operations Treating a substvars file mostly as a "str -> str" mapping is sufficient for many cases. But when full control over the substvars (like fiddling with the assignment operator) is needed this attribute is useful. >>> content = ''' ... # Some comment (which is allowed but no one uses them - also, they are not preserved) ... shlib:Depends=foo (>= 1.0), libbar2 (>= 2.1-3~) ... random:substvar?=With the new assignment operator from dpkg 1.21.8 ... ''' >>> substvars = Substvars() >>> substvars.read_substvars(content.splitlines()) >>> substvars.as_substvar["shlib:Depends"].assignment_operator '=' >>> substvars.as_substvar["random:substvar"].assignment_operator '?=' >>> # Mutation is also possible >>> substvars.as_substvar["shlib:Depends"].assignment_operator = '?=' >>> print(substvars.dump(), end="") shlib:Depends?=foo (>= 1.0), libbar2 (>= 2.1-3~) random:substvar?=With the new assignment operator from dpkg 1.21.8 rr#s r as_substvarSubstvars.as_substvar's6zzr cfUb[U[5(dgURUR:H$r=)r-r\rvr>s rr@Substvars.__eq__Ds) = 5) < <zzU[[((r cbSRSURR555$)zDebug aid that generates a string representation of the content For persisting the contents, please consider `save()` or `write_substvars`. r+c3z# UH1upSRXRUR55v M3 g7fz{}{}{} Nformatrr:.0kr3s r !Substvars.dump..Os5#541"((,A,A199;OO#59;)r8rvitemsr#s rdumpSubstvars.dumpJs/ ww#'::#3#3#5 r cURc [S5e[URSSS9nURU5sSSS5 $!,(df  g=f)zSave the substvars file Replace the path denoted by the `substvars_path` attribute with the in-memory version of the substvars. Note that the `substvars_path` property must be not None for this method to work. NzcThe substvar does not have a substvars_path: Please set substvars_path first or use write_substvarswrdre)r_ TypeErrorrgwrite_substvars)rrps rrSubstvars.saveSsU    'OP P$&&g >"''+? > >s A  AcdURSURR555 g)zWrite a copy of the substvars to an open text file :param fileobj: The open file (should open in text mode using the UTF-8 encoding) c3z# UH1upSRXRUR55v M3 g7frrrs rr,Substvars.write_substvars..gs5'9tq&,,Q0E0Eqyy{SS'9rN) writelinesrvr)rfileobjs rrSubstvars.write_substvarsas, '+zz'7'7'9 r c [5nUHmnUR5S:Xd USS:XaM"[RUR S55nU(dMOUR 5upVn[ XvS9X%'Mo X lg)aRead substvars from an open text file in the format supported by dpkg-gencontrol On success, all existing variables will be discarded and only variables from the file will be present after this method completes. In case of any IO related errors, the object retains its state prior to the call of this method. >>> content = ''' ... # Some comment (which is allowed but no one uses them - also, they are not preserved) ... shlib:Depends=foo (>= 1.0), libbar2 (>= 2.1-3~) ... random:substvar?=With the new assignment operator from dpkg 1.21.8 ... ''' >>> substvars = Substvars() >>> substvars.read_substvars(content.splitlines()) >>> substvars["shlib:Depends"] 'foo (>= 1.0), libbar2 (>= 2.1-3~)' >>> substvars["random:substvar"] 'With the new assignment operator from dpkg 1.21.8' :param fileobj: An open file (in text mode using the UTF-8 encoding) or an iterable of str that provides line by line content. r+r#z )rN)rr0_SUBSTVAR_PATTERNmatchrstripgroupsrrv)rrrylinemvarnamerrs rrhSubstvars.read_substvarskss0 M Dzz|r!T!W^!'' F(;01I$""H  \\$$ $$((3:; $$")*8) c ,!!r r\)(r contextlibrjresystypingabcr collectionsrcollections.abcrtypesrrrr r r r r rrrosrr.bytesAnyPath ImportErrorTypeVarrcompilerr version_infoAbstractContextManagerrNGenericr\rJr rrs!H #*ZZZ  xUBC NN3JJI 5151pv *;;A>sTWx@XZ] &..+^SD ,Dg  s"C66C?>C?