File: //usr/lib/python3/dist-packages/debian/__pycache__/copyright.cpython-310.pyc
o
���a�` � @ s� d Z ddlZddlZddlZddlZddlZz&ddlmZmZm Z m
Z
m Z m Z m
Z
mZmZmZmZmZ ed Zed ZW n eyG dZY nw ddlmZ dZeeg�Ze�e �Z G d d
� d
e �Z G d d � d e �Z G d
d� de e!�Z"dd� Z#G dd� de$�Z%dd� Z&G dd� de$�Z'G dd� de$�Z(dd� Z)dd � Z*d d � Z+d d � Z,G d!d"� d"e�-d"d#��Z.d$d%� Z/G d&d'� d'ej0�Z1G d(d)� d)ej0�Z2G d*d+� d+ej0�Z3dS ),a9 Utilities 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�Callable�IO�Iterable�Iterator�List�Optional�Pattern�Text�Tuple�Union�
TYPE_CHECKING)�FilesParagraph�LicenseParagraph)�Headerr r F)�deb822zBhttps://www.debian.org/doc/packaging-manuals/copyright-format/1.0/c @ � e Zd ZdZdS )�Errorz)Base class for exceptions in this module.N��__name__�
__module__� __qualname__�__doc__� r r �2/usr/lib/python3/dist-packages/debian/copyright.pyr G � r c @ r )�NotMachineReadableErrorzFRaised when the input is not a machine-readable debian/copyright file.Nr r r r r r K r r c @ r )�MachineReadableFormatErrorz�Raised when the input is not valid.
This is both a `copyright.Error` and a `ValueError` to ease handling of
errors coming from this module.
Nr r r r r r O r r c C s |rt | ��t�| � d S �N)r �logger�warning)�msg�strictr r r � _complainW s r# c s~ e Zd ZdZd� fdd� Zedd� �Zejd d� �Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zddd�Z� ZS ) � Copyrighta� 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.
N�utf-8Tc s� t t| ��� g | _|durZttjj||d��}|s td��t |d �| _
t dt |��D ]+}|| }d|v rBt
||�}| j�|� q,d|v rRt||�}| j�|� q,td|� q,dS t � | _
dS ) a� Create 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)�sequence�encodingzno paragraphs in inputr � �Files�Licensez=Non-header paragraph has neither "Files" nor "License" fields)�superr$ �__init__�_Copyright__paragraphs�listr �Deb822�iter_paragraphsr r �_Copyright__header�range�lenr �appendr r# ) �selfr& r' r" �
paragraphs�i�p�pf�pl�� __class__r r r, � s, �
��
zCopyright.__init__c C s | j S )zThe file header paragraph.)r1 �r5 r r r �header� s zCopyright.headerc C s t |t�s td��|| _d S )Nz value must be a Header object)�
isinstancer � TypeErrorr1 )r5 �hdrr r r r> � s
c C s t �| jgdd� | jD ��S )a Returns an iterator over all paragraphs (header, Files, License).
The header (returned first) will be returned as a Header object; file
paragraphs as FilesParagraph objects; license paragraphs as
LicenseParagraph objects.
c s s � | ]}|V qd S r r ��.0r8 r r r � <genexpr>� s � z+Copyright.all_paragraphs.<locals>.<genexpr>)� itertools�chainr> r- r= r r r �all_paragraphs� s zCopyright.all_paragraphsc C s | � � S )zXIterate over all paragraphs
see all_paragraphs() for more information
)rG r= r r r �__iter__� s zCopyright.__iter__c C � dd� | j D �S )z>Returns an iterator over the contained FilesParagraph objects.c s � � | ]
}t |t�r|V qd S r )r? r rB r r r rD � � � z1Copyright.all_files_paragraphs.<locals>.<genexpr>�r- r= r r r �all_files_paragraphs� � z Copyright.all_files_paragraphsc C s$ d}| � � D ] }|�|�r|}q|S )z�Returns 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)rM �matches)r5 �filename�resultr8 r r r �find_files_paragraph� s
�z Copyright.find_files_paragraphc C sN t |t�s td��d}t| j�D ] \}}t |t�r|}q| j�|d |� dS )z�Adds 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 instance���r( N)r? r r@ � enumerater- �insert)r5 � paragraph�last_ir7 r8 r r r �add_files_paragraph� s
�z Copyright.add_files_paragraphc C rI )z=Returns an iterator over standalone LicenseParagraph objects.c s rJ r )r? r rB r r r rD � rK z3Copyright.all_license_paragraphs.<locals>.<genexpr>rL r= r r r �all_license_paragraphs� rN z Copyright.all_license_paragraphsc C s" t |t�s td��| j�|� dS )zoAdds a LicenceParagraph to this object.
The paragraph is inserted after any other paragraphs.
z-paragraph must be a LicenseParagraph instanceN)r? r r@ r- r4 )r5 rV r r r �add_license_paragraph� s
z Copyright.add_license_paragraphc C s\ d}|du r d}t �� }| jj|dd� | jD ]}|�d� |j|dd� q|r,|�� S dS )aa Dumps 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.
FNT)� text_mode�
)�io�StringIOr> �dumpr- �write�getvalue)r5 �f�
return_stringr8 r r r r_ � s
zCopyright.dump)Nr% Tr )r r r r r, �propertyr> �setterrG rH rM rR rX rY rZ r_ �
__classcell__r r r; r r$ ^ s $*
r$ c C s d| v rt d��| S )zNReturns s if it is a single line; otherwise raises MachineReadableFormatError.r\ zmust be single line)r ��sr r r � _single_line s ri c @ s( e Zd ZdZedd� �Zedd� �ZdS )�
_LineBasedz@Namespace for conversion methods for line-based lists as tuples.c C s( t dd� dd� | p
d�� �� D �D ��S )z?Returns the lines in 's', with whitespace stripped, as a tuple.c s � � | ]}|r|V qd S r r �rC �vr r r rD $ s � �z&_LineBased.from_str.<locals>.<genexpr>c s s � | ]}|� � V qd S r )�strip)rC �liner r r rD % � � � )�tuplern �
splitlinesrg r r r �from_str s �z_LineBased.from_strc C s\ t | �}|sdS dd� }t|�dkr||d �S dg}|D ] }|�d||� � q d�|�S ) z�Returns 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.
Nc S s( | � � } | s
td��d| v rtd��| S )N�values must not be emptyr\ z values must not contain newlines)rn r rg r r r �process_and_validate4 s �z/_LineBased.to_str.<locals>.process_and_validater( r rq � r\ )r. r3 r4 �join)�seq�lrv �tmprh r r r �to_str( s
z_LineBased.to_strN)r r r r � staticmethodrt r| r r r r rj s
rj c @ s2 e Zd ZdZe�d�Zedd� �Ze dd� �Z
dS )�_SpaceSeparatedzENamespace for conversion methods for space-separated lists as tuples.z\sc C s t dd� | pd�� D ��S )z>Returns the values in s as a tuple (empty if only whitespace).c s rk r r rl r r r rD Q rp z+_SpaceSeparated.from_str.<locals>.<genexpr>rq )rr �splitrg r r r rt M s z_SpaceSeparated.from_strc C sZ t |�}|sdS g }|D ]}| j�|�rtd��|�� }|s"td��|�|� q d�|�S )zAReturns the sequence as a space-separated string (None if empty).Nz"values must not contain whitespaceru rw )r. �
_has_space�searchr rn r4 rx )�clsry rz r{ rh r r r r| S s �
z_SpaceSeparated.to_strN) r r r r �re�compiler� r} rt � classmethodr| r r r r r~ G s
r~ c C s | du rdS t | �� �S )z�Formats multiline text for insertion in a Deb822 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_linesrs rg r r r �format_multilineh s r� c C sF g }t | �D ]\}}|dkr|�� sd}d| }|�|� qd�|�S )z?Same as format_multline, but taking input pre-split into lines.r �.rw r\ )rT rn r4 rx )�lines� out_linesr7 ro r r r r� t s
r� c C s | du rdS d� t| ��S )ag Inverse 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\ )rx �parse_multiline_as_linesrg r r r �parse_multiline� s r� c C s\ | � � }t|�D ]#\}}|dkrq|�d�r |dd� }ntd��|dkr'd}|||< q|S )zpSame as parse_multiline, but returns a list of lines.
(This is the inverse of format_multiline_lines.)
r rw r( Nz"continued line must begin with " "r� rq )rs rT �
startswithr )rh r� r7 ro r r r r� � s
�
r� c s6 e Zd ZdZd � fdd� Zedd� �Zdd� Z� ZS )
r* z7Represents the contents of a License field. Immutable.rq c s t t| �j| t|�|p dd�S )a� Creates 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.
rq )�synopsis�text)r+ r* �__new__ri )r� r� r� r; r r r� � s
�zLicense.__new__c C s@ |d u rd S t |�}|s| d�S | |d d�t�|dd ��d�S )Nrq r r\ r( )r� )r� rx rE �islice)r� rh r� r r r rt � s zLicense.from_strc C s t | jg| j�� �S r )r� r� r� rs r= r r r r| � s zLicense.to_str)rq ) r r r r r� r� rt r| rf r r r; r r* � s
r* z
synopsis textc C s t �� }t| �D ]g\}}|dkr|�d� d}t|�}||k ro|| }|d7 }|dkr1|�d� n:|dkr;|�d� n0|dkrc||k rL|| }|d7 }ntd ��|d
v r]|�t�|�� ntd | ��|�t�|�� ||k s q|�d � t�|� � tj
tj B �S )
a^ Returns an re object for the given globs.
Only * and ? wildcards are supported. Literal * and ? may be matched via
\* and \?, respectively. A literal backslash is matched \\. Any other
character after a backslash is forbidden.
Empty globs match nothing.
Raises MachineReadableFormatError if any of the globs is illegal.
r �|r( �*z.*�?r� �\z#single backslash not allowed at endz\?*z invalid escape sequence: \%sz\Z) r] r^ rT r` r3 r r� �escaper� ra � MULTILINE�DOTALL)�globs�bufr7 �glob�n�cr r r � globs_to_re� s<
����
r� c s� e Zd ZdZe�d�Zd� fdd� Zedd� �Z dd � Z
d
d � Z e j
d ejejd
d�Ze j
dd
d�Ze j
dejejd
d�Ze �
d�Z� ZS )r z�Represents 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.
rq Tc sh t t| ��|� |r,d|vrtd��d|vrtd|� d|vr$td|� | js,td|� d| jf| _d S ) Nr) z"Files" field requiredr$ z'Files paragraph missing Copyright fieldr* z%Files paragraph missing License fieldz%Files paragraph has empty Files fieldrq )r+ r r, r r# �files� _default_re�!_FilesParagraph__cached_files_pat)r5 �data�_internal_validater" r; r r r, s
zFilesParagraph.__init__c C s& | t �� dd�}||_||_||_|S )z�Create 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.
F�r� )r r/ r� � copyright�license)r� r� r� r� r8 r r r �create s
zFilesParagraph.createc C s0 | d }| j d |kr|t| j�f| _ | j d S )z�Returns a regular expression equivalent to the Files globs.
Caches the result until files is set to a different value.
Raises ValueError if any of the globs are invalid.
r� r r( )r� r� r� )r5 � files_strr r r �
files_pattern& s
z FilesParagraph.files_patternc C s" | � � }|du r
dS |�|�duS )z8Returns True iff filename is matched by a glob in Files.NF)r� �match)r5 rP �patr r r rO 3 s zFilesParagraph.matchesr) F�rt r| �
allow_noner$ )r� r* �Comment)TT)r r r r r� r� r� r, r� r� r� rO r �RestrictedFieldr~ rt r| r� r� r* r� �commentrf r r r; r r � s$
�
�r c sX e Zd ZdZd � fdd� Zedd� �Zejde j
e j dd �Z e�d
�Z
e�d �Z� ZS )
r a Represents 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.
Tc s< t t| ��|� |rd|vrtd��d|v r td��d S d S )Nr* z"License" field requiredr) z%input appears to be a Files paragraph)r+ r r, r )r5 r� r� r; r r r, P s ��zLicenseParagraph.__init__c C s, t |t�s td��| t�� dd�}||_|S )z2Returns a LicenseParagraph with the given license.z"license must be a License instanceFr� )r? r* r@ r r/ r� )r� r� rV r r r r� Z s
zLicenseParagraph.creater* Fr� r� r) )T)r r r r r, r� r� r r� r* rt r| r� r� �_LicenseParagraph__filesrf r r r; r r H s
�
r c s� e Zd ZdZd� fdd� Zdd� Zdd� Zejd e d
d �Z
ejd e d
�Z ejde j
e jd�Ze�d�Ze�d�Ze�d�Zejdej
ejd�Ze�d�Zejde j
e jd�Zejde j
e jd�Z� ZS )r z�Represents 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).
Nc s� |du r t �� }t|d< d|v r t�d� |d |d< |d= tt| ��|� t� }| j }|tkrV|durV|�
d�s=|d7 }|� d�rJd|dd� }|t v rVt�d � || _ |du r^t
d
��|t vrjt�d |� dS dS ) z�Initializer.
:param data: A deb822.Deb822 object for underlying data. If None, a
new one will be created.
N�FormatzFormat-SpecificationzEuse of deprecated "Format-Specification" field; rewriting as "Format"�/zhttp:zhttps:%s� zFixing Format URLz0input is not a machine-readable debian/copyrightzformat not known: %r)r r/ �_CURRENT_FORMATr r r+ r r, �str�format�endswithr� �_KNOWN_FORMATSr )r5 r� �fmtr; r r r, y s2
��zHeader.__init__c C s
| j tv S )z%Returns True iff the format is known.)r� r� r= r r r � known_format� �
zHeader.known_formatc C s
| j tkS )z2Returns True iff the format is the current format.)r� r� r= r r r �current_format� r� zHeader.current_formatr� F)r| r� z
Upstream-Name)r| zUpstream-Contact)rt r| �Source�
Disclaimerr� r* r$ zFiles-ExcludedzFiles-Includedr )r r r r r, r� r� r r� ri r� �
upstream_namerj rt r| �upstream_contact�source�
disclaimerr� r* r� r� �files_excluded�files_includedrf r r r; r r r s< (���
�
��r )4r � collectionsrE �loggingr] r� �typingr r r r r r r r r
r r r
�ParagraphTypes�AllParagraphTypes� ImportError�debianr r� � frozensetr� � getLoggerr r � Exceptionr r �
ValueErrorr r# �objectr$ ri rj r~ r� r� r� r� �
namedtupler* r� �RestrictedWrapperr r r r r r r �<module> sL 8 � ��
7+!
#.Q*