)g:ySrSSKrSSKrSSKrSSKrSSKrSSKJrJrJ r J r J r J r J r JrJrJrJrJr SSKJrJrJrJrJr SSKJrJr SSKJr \Sr\SrS r \!"\ /5r"\RF"\$5r%"S S \&5r'"S S \'5r("SS\'\)5r*S\+S\,SS4Sjr-"SS5r.S\+S\+4Sjr/"SS5r0"SS5r1S\ \+S\ \+4Sjr2Sr3Sr4S\+S\ \+4Sjr5"S S!\Rl"S!S"55r7S#r8"S$S%\95r:"S&S'\:S(9r;"S)S*\;5r<"S+S,\;5r="S-S.\;5r>g!\a Nf=f)/a9Utilities for parsing and creating machine-readable debian/copyright files. The specification for the format (also known as DEP5) is available here: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Start from the Copyright docstring for usage information. Copyright Classes ----------------- N) Any FrozenSetIOIterableIteratorListOptionalPatternTextTupleUnioncast)parse_deb822_fileDeb822ParagraphElementDeb822FileElement'Deb822NoDuplicateFieldsParagraphElementSyntaxOrParseError)RestrictedFieldRestrictedFieldError)Deb822ValueType)FilesParagraphLicenseParagraph)HeaderrrzBhttps://www.debian.org/doc/packaging-manuals/copyright-format/1.0/c\rSrSrSrSrg)ErrorPz)Base class for exceptions in this module.N__name__ __module__ __qualname____firstlineno____doc____static_attributes__r2/usr/lib/python3/dist-packages/debian/copyright.pyrrPs3r%rc\rSrSrSrSrg)NotMachineReadableErrorTzFRaised when the input is not a machine-readable debian/copyright file.rNrrr%r&r(r(TsPr%r(c\rSrSrSrSrg)MachineReadableFormatErrorXzRaised when the input is not valid. This is both a `copyright.Error` and a `ValueError` to ease handling of errors coming from this module. rNrrr%r&r+r+Xsr%r+msgstrictreturncRU(a [U5e[RU5 gN)r+loggerwarning)r-r.s r& _complainr4`s (-- NN3r%c^\rSrSrSrSU4Sjjr\S5r\RS5rSr Sr Sr S r S r S rS rSS jrSrU=r$) Copyrightfa%Represents a debian/copyright file. A Copyright object contains a Header paragraph and a list of additional Files or License paragraphs. It provides methods to iterate over those paragraphs, in addition to adding new ones. It also provides a mechanism for finding the Files paragraph (if any) that matches a particular filename. Typical usage:: with io.open('debian/copyright', 'rt', encoding='utf-8') as f: c = copyright.Copyright(f) header = c.header # Header exposes standard fields, e.g. print('Upstream name: ', header.upstream_name) lic = header.license if lic: print('Overall license: ', lic.synopsis) # You can also retrieve and set custom fields. header['My-Special-Field'] = 'Very special' # Find the license for a given file. paragraph = c.find_files_paragraph('debian/rules') if paragraph: print('License for debian/rules: ', paragraph.license) # Dump the result, including changes, to another file. with io.open('debian/copyright.new', 'wt', encoding='utf-8') as f: c.dump(f=f) It is possible to build up a Copyright from scratch, by modifying the header and using add_files_paragraph and add_license_paragraph. See the associated method docstrings. c>[[U] 5 /UlUbSn[ XU(+S9UlUR HznUc [U5nMSU;a'[XcUS9nURRU5 M@SU;a([Xc5nURRU5 Mn[SU5 M| U(d [S5eX@lg[R "5Ul[5UlUR RURR"5 URRUR5 g![ an[[U55eSnAff=f)ayCreate a new copyright file in the current format. :param sequence: Sequence of lines, e.g. a list of strings or a file-like object. If not specified, a blank Copyright object is initialized. :param encoding: Encoding to use, in case input is raw byte strings. It is recommended to use unicode objects everywhere instead, e.g. by opening files in text mode. :param strict: Raise if format errors are detected in the data. Raises: :class:`NotMachineReadableError` if 'sequence' does not contain a machine-readable debian/copyright file. MachineReadableFormatError if 'sequence' is not a valid file. N)sequenceencoding#accept_files_with_duplicated_fieldsFiles)r.Licensez=Non-header paragraph has neither "Files" nor "License" fieldszno paragraphs in input)superr6__init___Copyright__paragraphsr_Copyright__filerr(strrrappendrr4_Copyright__headerrnew_empty_file_underlying_paragraph) selfr9r:r.headereppfpl __class__s r&r?Copyright.__init__s?" i')  F 6/!)@FJH [[>#AYF\'&AB%%,,R0!^)!4B%%,,R0128:!-.FGG"M,::+Copyright.all_paragraphs..s.L:KQq:Ks) itertoolschainrHr@rPs r&all_paragraphsCopyright.all_paragraphss' }.L$:K:K.LMMr%c"UR5$)zHIterate over all paragraphs see all_paragraphs() for more information )r^rPs r&__iter__Copyright.__iter__s""$$r%c(SUR5$)z>Returns an iterator over the contained FilesParagraph objects.c3T# UHn[U[5(dMUv M g7fr1)rSrrXs r&rZ1Copyright.all_files_paragraphs..sN,a 1n0M,( (r@rPs r&all_files_paragraphsCopyright.all_files_paragraphssO4,,NNr%clSnUR5HnURU5(dMUnM U$)zReturns the FilesParagraph for the given filename. In accordance with the spec, this method returns the last FilesParagraph that matches the filename. If no paragraphs matched, returns None. N)rhmatches)rGfilenameresultrJs r&find_files_paragraphCopyright.find_files_paragraphs7**,Ayy""- r%cF[U[5(d [S5eSn[UR5Hup4[U[5(dMUnM URR US-U5 UR R US-UR5 g)zAdds a FilesParagraph to this object. The paragraph is inserted directly after the last FilesParagraph (which might be before a standalone LicenseParagraph). z+paragraph must be a FilesParagraph instanceN)rSrrT enumerater@insertrArF)rG paragraphlast_iirJs r&add_files_paragraphCopyright.add_files_paragraphs)^44IJ Jd//0DA!^,,1   !Y7 6A:y'F'FGr%c(SUR5$)z=Returns an iterator over standalone LicenseParagraph objects.c3T# UHn[U[5(dMUv M g7fr1)rSrrXs r&rZ3Copyright.all_license_paragraphs..sP,a 1>N0O,rfrgrPs r&all_license_paragraphs Copyright.all_license_paragraphssQ4,,PPr%c[U[5(d [S5eURR U5 UR R UR 5 g)z_Adds a LicenceParagraph to this object. The paragraph is inserted after any other paragraphs. z-paragraph must be a LicenseParagraph instanceN)rSrrTr@rCrArF)rGrvs r&add_license_paragraphCopyright.add_license_paragraphsJ )%566KL L   + 9::;r%cdURR5nUbURU5 gU$)a9Dumps the contents of the copyright file. If f is None, returns a unicode object. Otherwise, writes the contents to f, which must be a file-like object that is opened in text mode (i.e. that accepts unicode objects directly). It is thus up to the caller to arrange for the file to do any appropriate encoding. N)rAdumpwrite)rGfss r&rCopyright.dumps. KK    = GGAJr%)__file__header __paragraphs)Nzutf-8Tr1)rr r!r"r#r?propertyrHsetterr^rarhrnryr~rrr$ __classcell__rMs@r&r6r6fsl"H14f  ]] N%O H"Q <r%r6rc(SU;a [S5eU$)zNReturns s if it is a single line; otherwise raises MachineReadableFormatError. zmust be single line)r+rs r& _single_liner#s qy()>?? Hr%c8\rSrSrSr\S5r\S5rSrg) _LineBasedi*z@Namespace for conversion methods for line-based lists as tuples.c~[SSU=(d SR5R5555$)z?Returns the lines in 's', with whitespace stripped, as a tuple.c38# UHnU(dM Uv M g7fr1rrYvs r&rZ&_LineBased.from_str..2sNQNs  c3@# UHoR5v M g7fr1)strip)rYlines r&rZr3sN/Mtjjll/Ms)tupler splitlinesrs r&from_str_LineBased.from_str.s7NR/@/K/K/MN r%c[U5nU(dgSn[U5S:Xa U"US5$S/nUHnURSU"U5-5 M SRU5$)zReturns the sequence as a string with each element on its own line. If 'seq' has one element, the result will be on a single line. Otherwise, the first line will be blank. NclUR5nU(d [S5eSU;a [S5eU$)Nvalues must not be emptyrz values must not contain newlines)rr+rs r&process_and_validate/_LineBased.to_str..process_and_validateBs8 A01KLLqy0688Hr%rrrr r)listlenrCjoin)seqlrtmprs r&to_str_LineBased.to_str6sj I  q6Q;'!- -dA JJs1!44 5yy~r%rN) rr r!r"r# staticmethodrrr$rr%r&rr*s-Jr%rc\\rSrSrSr\R "S5r\S5r \ S5r Sr g)_SpaceSeparatediUzENamespace for conversion methods for space-separated lists as tuples.z\scT[SU=(d SR555$)z>Returns the values in s as a tuple (empty if only whitespace).c36# UHo(dM Uv M g7fr1rrs r&rZ+_SpaceSeparated.from_str.._s7 11QQQ 1s  r)rsplitrs r&r_SpaceSeparated.from_str[s 7b 1777r%c[U5nU(dg/nUHanURRU5(a [S5eUR 5nU(d [S5eUR U5 Mc SR U5$)zAReturns the sequence as a space-separated string (None if empty).Nz"values must not contain whitespacerr)r _has_spacesearchr+rrCr)clsrrrrs r&r_SpaceSeparated.to_stras| IA~~$$Q''08:: A01KLL JJqMxx}r%rN) rr r!r"r#recompilerrr classmethodrr$rr%r&rrUs;OE"J88 r%rc<Ucg[UR55$)zFormats multiline text for insertion in a Deb822ParagraphElement field. Each line except for the first one is prefixed with a single space. Lines that are blank or only whitespace are replaced with ' .' N)format_multiline_linesrrs r&format_multilinervs  y !!,,. 11r%c/n[U5H8up#US:waUR5(dSnSU-nURU5 M: SRU5$)z?Same as format_multline, but taking input pre-split into lines.r.rr)rtrrCr)lines out_linesrxrs r&rrsYIU# 6::<<:D $ 99Y r%c>UcgSR[U55$)aOInverse of format_multiline. Technically it can't be a perfect inverse, since format_multline must replace all-whitespace lines with ' .'. Specifically, this function: - Does nothing to the first line - Removes first character (which must be ' ') from each proceeding line. - Replaces any line that is '.' with an empty line. Nr)rparse_multiline_as_linesrs r&parse_multiliners! y 99-a0 11r%cUR5n[U5H@up#US:XaM URS5(aUSSnO [S5eUS:XaSnX1U'MB U$)zhSame as parse_multiline, but returns a list of lines. (This is the inverse of format_multiline_lines.) rrrrNz"continued line must begin with " "rr)rrt startswithr+)rrrxrs r&rrsn LLNEU# 6  ??3  8D,46 6 3;Da$ Lr%cN^\rSrSrSrSU4Sjjr\S5rS\4Sjr Sr U=r $) r=iz7Represents the contents of a License field. Immutable.cN>[[U] U[U5U=(d SS9$)atCreates a new License object. :param synopsis: The short name of the license, or an expression giving alternatives. (The first line of a License field.) :param text: The full text of the license, if any (may be None). The lines should not be mangled for "deb822"-style wrapping - i.e. they should not have whitespace prefixes or single '.' for empty lines. r)synopsistext)r>r=__new__r)rrrrMs r&rLicense.__new__s0Wc* ,x0 +E Er%c Ucg[U5nU(dU"S5$U"USSR[R"USS55S9$)Nrrrrr)r)rrr\islice)rrrs r&rLicense.from_strsK 9(+r7N58$))I,<, ??r%c,^\rSrSrSrU4SjrSrU=r$)_ClassInitMetaiamMetaclass for classes that can be initialized at creation time. Implement the method:: @classmethod def _class_init(cls, new_attrs): pass on a class, and apply this metaclass to it. The _class_init method will be called right after the class is created. The 'new_attrs' param is a dict containing the attributes added in the definition of the class. cP>[[U] XU5 URU5 gr1)r>rr? _class_init)rnamebasesattrsrMs r&r?_ClassInitMeta.__init__s" nc+D? r%r)rr r!r"r#r?r$rrs@r&rrs r%rc^\rSrSrSr\"5r\S5r\S5r SU4Sjjr \ S5r Sr SrS rS rS \4S jrSS jrSrU=r$)_RestrictedWrapperiaBase class to wrap a Deb822 object, restricting write access to some keys. The underlying data is hidden internally. Subclasses may keep a reference to the data before giving it to this class's constructor, if necessary, but RestrictedField should cover most use-cases. The dump method from Deb822 is directly proxied. Typical usage:: class Foo: def __init__(self, ...): # ... @staticmethod def from_str(self, s): # Parse s... return Foo(...) def to_str(self): # Return in string format. return ... class MyClass(deb822._RestrictedWrapper): def __init__(self): data = Deb822ParagraphElement.new_empty_paragraph() data['Bar'] = 'baz' super(MyClass, self).__init__(data) foo = deb822.RestrictedField( 'Foo', from_str=Foo.from_str, to_str=Foo.to_str) bar = deb822.RestrictedField('Bar', allow_none=False) d = MyClass() d['Bar'] # returns 'baz' d['Bar'] = 'quux' # raises RestrictedFieldError d.bar = 'quux' d.bar # returns 'quux' d['Bar'] # returns 'quux' d.foo = Foo(...) d['Foo'] # returns string representation of foo c/nUR5HVup4[U[5(dMURURR 55 UR X45 MX [U5Ulgr1) itemsrSrrCrlower)_RestrictedWrapper__init_restricted_field frozenset%_RestrictedWrapper__restricted_fields)r new_attrsrestricted_fields attr_namevals r&r_RestrictedWrapper._class_initIs_'oo/NI#//!(()9:++I;0#,,=">r%c `^U4SjnU4Sjn[X[X4STR55 g)Nc>URRTR5nTRbTRU5$U$r1)_RestrictedWrapper__datagetrrrGrfields r&getter:_RestrictedWrapper.__init_restricted_field..getterTs7++//%**-C~~)~~c**Jr%c>UbTRbTRU5nUcOTR(a3TRUR;aURTR gg[ S5eXRTR'g)Nzvalue must not be None)r allow_nonerrrTrs r&r:_RestrictedWrapper.__init_restricted_field..setter[sp5<<#;ll3'{##zzT[[0 KK 31$$<==*- EJJ'r%)setattrrr)rrrrrs ` r&__init_restricted_field*_RestrictedWrapper.__init_restricted_fieldRs&  . uzz JKr%c>[[U] 5 U(a@[U[5(d+[ S[ URR5-5eXl g)zEInitializes the wrapper over 'data', a Deb822ParagraphElement object.z!Paragraph has duplicated fields: N) r>rr?rSr ValueErrorrBrMr!rrGdata_internal_validaterMs r&r?_RestrictedWrapper.__init__jsH  $02 j7^&_&_@3t~~GbGbCccd d r%cUR$r1rrPs r&rF(_RestrictedWrapper._underlying_paragraphrs{{r%c URU$r1rrGkeys r& __getitem___RestrictedWrapper.__getitem__ws{{3r%cxUR5UR;a[SU-5eX RU'gNz<%s may not be modified directly; use the associated propertyrrrr)rGrvalues r& __setitem___RestrictedWrapper.__setitem__{s> 99;$22 2&!"# #! Cr%cvUR5UR;a[SU-5eURU grrrs r& __delitem___RestrictedWrapper.__delitem__s> 99;$22 2&!"# # KK r%c(SUR5$)Nc38# UHn[U5v M g7fr1)rB)rYks r&rZ._RestrictedWrapper.__iter__..s, 1A srrPs r&ra_RestrictedWrapper.__iter__s, ,,r%r/c,[UR5$r1)rrrPs r&__len___RestrictedWrapper.__len__s4;;r%crUbUc-U(d&URR[SU55 gURR5nUb+[SU5RUR U55 gU(a[SU5RU5 gURR5$)zSCalls dump() on the underlying data object. See Deb822.dump for more information. Nz IO[bytes]zIO[str])rrrrencode)rGfdr: text_modeas_strs r&r_RestrictedWrapper.dumps >    k2!67[[%%'F#["%++FMM(,CDY#))&1{{!!r%)__dataT)NNF)rr r!r"r#rrrrrr?rrFrrr!raintr)rr$rrs@r&rrs*X$+??LL. !-  ""r%r) metaclassc^\rSrSrSr\R "S5rSU4Sjjr\ S5r Sr Sr \ "S\R\R S S 9r\ "S S S 9r\ "S \R\R S S 9r\ "S5rSrU=r$)rizRepresents a Files paragraph of a debian/copyright file. This kind of paragraph is used to specify the copyright and license for a particular set of files in the package. rc>[[U] X5 U(aRSU;a [S5eSU;a [ SU5 SU;a [ SU5 UR (d [ SU5 SUR 4Ulg) Nr<z"Files" field requiredr6z'Files paragraph missing Copyright fieldr=z%Files paragraph missing License fieldz%Files paragraph has empty Files fieldr)r>rr?r+r4files _default_re!_FilesParagraph__cached_files_pat)rGrrr.rMs r&r?FilesParagraph.__init__st nd,TF d"01IJJ$&CVL$A6J::A6J#%t'7'7"8r%c^U"[R"5SS9nXlX$lX4lU$)zCreate a new FilesParagraph from its required parts. :param files: The list of file globs. :param copyright: The copyright for the files (free-form text). :param license: The Licence for the files. Fr)rnew_empty_paragraphr7 copyrightlicense)rr7r>r?rJs r&createFilesParagraph.creates/ &::r=r?commentr$rrs@r&rrs **R.K9"( *3 /22%%% 9E >IG,,W^^Gi(Gr%rc^\rSrSrSrS U4Sjjr\S5r\"S\ R\ RSS9r \"S5r \"S 5rS rU=r$) riaRepresents a standalone license paragraph of a debian/copyright file. Minimally, this kind of paragraph requires a 'License' field and has no 'Files' field. It is used to give a short name to a license text, which can be referred to from the header or files paragraphs. c>[[U] X5 U(a#SU;a [S5eSU;a [S5egg)Nr=z"License" field requiredr<z%input appears to be a Files paragraph)r>rr?r+rs r&r?LicenseParagraph.__init__sK .tH $01KLL$0;== r%c[U[5(d [S5eU"[R"5SS9nXlU$)z2Returns a LicenseParagraph with the given license.z"license must be a License instanceFr<)rSr=rTrr=r?)rr?rvs r&r@LicenseParagraph.create s@ '7++@A A.BBDY^_ #r%r=FrJrKr<rr2)rr r!r"r#r?rr@rr=rrr?rM_LicenseParagraph__filesr$rrs@r&rrsY=G,,W^^Gi(Gg&Gr%rc^\rSrSrSrSU4SjjrS\4SjrS\4Sjr\ "S\ SS 9r \ "S \ S 9r \ "S \ R\ RS 9r\ "S5r\ "S5r\ "S5r\ "S\R\RS 9r\ "S5r\ "S\ R\ RS 9r\ "S\ R\ RS 9rSrU=r$)ri%zRepresents the header paragraph of a debian/copyright file. Property values are all immutable, such that in order to modify them you must explicitly set them (rather than modifying a returned reference). c>Uc[R"5n[US'SU;a [R S5 USUS'US [ [ U]U5 [5nURnU[:waaUb^URS5(dUS- nURS5(aSUSS-nU[;a[R S 5 X l Uc [S 5eU[;a[R S U5 gg) zyInitializer. :param data: A Deb822ParagraphElement object for underlying data. If None, a new one will be created. NFormatzFormat-SpecificationzEuse of deprecated "Format-Specification" field; rewriting as "Format"/zhttp:zhttps:%szFixing Format URLz0input is not a machine-readable debian/copyrightzformat not known: %r)rr=_CURRENT_FORMATr2r3r>rr?rBformatendswithr_KNOWN_FORMATSr()rGrfmtrMs r&r?Header.__init__,s <)==?D,DN !T ) NN4 5!"89DN+, fd$T*ekk / !co<<$$s ~~g&& 3qr7*n$23! ;)BD D n $ NN13 7 %r%r/c(UR[;$)z%Returns True iff the format is known.)rZr\rPs r& known_formatHeader.known_formatTs{{n,,r%c(UR[:H$)z2Returns True iff the format is the current format.)rZrYrPs r&current_formatHeader.current_formatXs{{o--r%rVF)rrz Upstream-Name)rzUpstream-Contact)rrSource DisclaimerrKr=r6zFiles-ExcludedzFiles-Included)rZr1)rr r!r"r#r?boolr`rcrrrZ upstream_namerrrupstream_contactsource disclaimerrMr=r?r>files_excludedfiles_includedr$rrs@r&rr%s &8P-d-.. %9F$ .M'Z%8%8  "X &F .Ji(GG,,W^^EG ,I$:#6#6  "N%:#6#6  "Nr%r)?r# collectionsr\loggingrrtypingrrrrrrr r r r r rdebian._deb822_reprorrrrr debian.deb822rrr ImportErrorParagraphTypesAllParagraphTypesrYrr\ getLoggerrr2 Exceptionrr(r r+rBrgr4r6rrrrrrr namedtupler=rtyperrrrrrr%r&rzs 8      @ - ;<HII   8 $4I4QeQ 3 zzz C C ((VB2 2(3-2   2 S (Pk$$Y@PD+@\T0M">M"`N)'N)b'')''TS" S"Q  s EE  E