o
�jew � @ s� d gZ ddlmZ ddlZddlmZ ddlZddlZddlZddl m
Z
m Z ddl Z ddl
mZmZmZm
Z
mZ ddlZddlmZ ddlmZ dd lmZ dd
lmZmZm Z m Z d d l m Z d d
l m!Z! d dl"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z( ddl)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3 e j4dkr�ddl)m5Z5 nddl6m5Z5 ddl7m8Z8 e1r�ddl9m:Z: ddl;m<Z< e�=e>�Z?G dd � d e j@e$ee#�ZAdS )�Commit� )� defaultdictN)�BytesIO)�Popen�PIPE)�altzone�daylight� localtime�time�timezone)�IStream)�Git)�Diffable)�Actor�Stats�finalize_process�
hex_to_bin� )�base)�Tree)� Serializable�TraversableIterableObj�altz_to_utctz_str�from_timestamp�parse_actor_and_date�
parse_date)
�Any�Dict�IO�Iterator�List�Sequence�Tuple�
TYPE_CHECKING�Union�cast)� � )�Literal)�PathLike)�SymbolicReference)�Repoc s� e Zd ZU dZdZdZdZdZdZe d e
d< dZ d Z e
d e
d
< dRd d
dedeed f deed f deed f ded ef deed f deed f ded ef deeed f d
ee
d d f deed f deed f dd f � fdd�
Zedd ded fd d ��Zed d
dd defd d ��Zd!edd fd"d#�Zd$edd f� fd%d&� Z e de j fd'd(��Z e de j fd)d*��Z e deeef fd+d,��Z!dSd.ee"e
e" f d!edefd/d0�Z#e defd1d2��Z$e -dSd d
d3eed d4f d.ee"e
e" f d!ede%d f
d5d6��Z&dSd.ee"e
e" f d!ede%d fd7d8�Z'e de(fd9d:��Z)e de*eef fd;d<��Z+e de,eeef fd=d>��Z-e de*ee,e f fd?d@��Z.ed d
dAee/e0f de%d fdBdC��Z1e D dTd d
deeef dedEed e,d f dFe2ded ef ded ef dGed ee j f dHed ee j f dd fdIdJ��Z3dKe4dd fdLdM�Z5dKe4dd fdNdO�Z6e de,e fdPdQ��Z7� Z8S )Ur a1 Wraps a git commit object.
See :manpage:`gitglossary(7)` on "commit object":
https://git-scm.com/docs/gitglossary#def_commit_object
:note:
This class will act lazily on some of its attributes and will query the value on
demand only if it involves calling the git binary.
ZGIT_AUTHOR_DATEZGIT_COMMITTER_DATEzi18n.commitencodingzUTF-8�commit�type) �tree�author�
authored_date�author_tz_offset� committer�committed_date�committer_tz_offset�message�parents�encoding�gpgsig�hexshar6 N�repor+ �binshar. r/ r0 r1 r2 r3 r4 r5 r7 r8 �returnc s� t � �||� || _|durt|t�sJ dt|� ��|dur"|| _|dur)|| _|dur0|| _|dur7|| _ |dur>|| _
|durE|| _ | durL| | _ |
durS|
| _
| durZ| | _| dura| | _|
durj|
| _dS dS )a Instantiate a new :class:`Commit`. All keyword arguments taking ``None`` as
default will be implicitly set on first query.
:param binsha:
20 byte sha1.
:param tree:
A :class:`~git.objects.tree.Tree` object.
:param author:
The author :class:`~git.util.Actor` object.
:param authored_date: int_seconds_since_epoch
The authored DateTime - use :func:`time.gmtime` to convert it into a
different format.
:param author_tz_offset: int_seconds_west_of_utc
The timezone that the `authored_date` is in.
:param committer:
The committer string, as an :class:`~git.util.Actor` object.
:param committed_date: int_seconds_since_epoch
The committed DateTime - use :func:`time.gmtime` to convert it into a
different format.
:param committer_tz_offset: int_seconds_west_of_utc
The timezone that the `committed_date` is in.
:param message: string
The commit message.
:param encoding: string
Encoding of the message, defaults to UTF-8.
:param parents:
List or tuple of :class:`Commit` objects which are our parent(s) in the
commit dependency graph.
:return:
:class:`Commit`
:note:
Timezone information is in the same format and in the same sign as what
:func:`time.altzone` returns. The sign is inverted compared to git's UTC
timezone.
Nz(Tree needs to be a Tree instance, was %s)�super�__init__r; �
isinstancer r- r. r/ r0 r1 r2 r3 r4 r5 r6 r7 r8 )�selfr: r; r. r/ r0 r1 r2 r3 r4 r5 r6 r7 r8 �� __class__� �F/opt/saltstack/salt/lib/python3.10/site-packages/git/objects/commit.pyr> m s6 ?
�zCommit.__init__)r .c C s
t |j�S �N)�tupler6 )�clsr, rC rC rD �_get_intermediate_items� s
z Commit._get_intermediate_itemsc C s> t � }|�|� |�� }|�d� |j�t| j||��}|jS )z�Calculate the sha of a commit.
:param repo:
:class:`~git.repo.base.Repo` object the commit should be part of.
:param commit:
:class:`Commit` object for which to generate the sha.
r ) r �
_serialize�tell�seek�odb�storer r- r; )rG r: r, �streamZ streamlen�istreamrC rC rD �_calculate_sha_� s
zCommit._calculate_sha_�kwargsc sf � fdd�� j D �}|D ] }|� j vrtd��q |�|� � j� j� jfi |��}� �� j|�|_|S )z�Create new commit object from an existing commit object.
Any values provided as keyword arguments will replace the corresponding
attribute in the new object.
c s i | ]}|t � |��qS rC )�getattr)�.0�k�r@ rC rD �
<dictcomp>� s z"Commit.replace.<locals>.<dictcomp>zinvalid attribute name)� __slots__�
ValueError�updaterB r: � NULL_BIN_SHArP r; )r@ rQ �attrs�attrname�
new_commitrC rU rD �replace� s
�
zCommit.replace�attrc sJ |t jv r | jj�| j�\}}| _}| �t|� � �� d S t
� � |� d S rE ) r rW r: rL rN r; �size� _deserializer �readr= � _set_cache_)r@ r_ Z_binshaZ _typenamerN rA rC rD rc � s
zCommit._set_cache_c C � t | j| j�S rE )r r0 r1 rU rC rC rD �authored_datetime� � zCommit.authored_datetimec C rd rE )r r3 r4 rU rC rC rD �committed_datetime� rf zCommit.committed_datetimec C s0 t | jt�r| j�dd�d S | j�dd�d S )z):return: First line of the commit message�
r r �
)r? r5 �str�splitrU rC rC rD �summary s zCommit.summary� �pathsc K sH |rt | jjj| jd|fi |���� �S t | jjj| jfi |���� �S )a Count the number of commits reachable from this commit.
:param paths:
An optional path or a list of paths restricting the return value to commits
actually containing the paths.
:param kwargs:
Additional options to be passed to :manpage:`git-rev-list(1)`. They must not
alter the output style of the command, or parsing will yield incorrect
results.
:return:
An int defining the number of reachable commits
�--)�lenr: �git�rev_listr9 �
splitlines)r@ rn rQ rC rC rD �count
s $ z Commit.countc C s | j j�| �S )z�
:return:
String describing the commits hex sha based on the closest
:class:`~git.refs.reference.Reference`.
:note:
Mostly useful for UI purposes.
)r: rq �name_revrU rC rC rD ru s
zCommit.name_rev�revr* c K sj d|v rt d��dg}|r"t|ttjf�r|f}nt|�}|�|� |jj||fddi|��}| � ||�S )a Find all commits matching the given criteria.
:param repo:
The :class:`~git.repo.base.Repo`.
:param rev:
Revision specifier. See :manpage:`git-rev-parse(1)` for viable options.
:param paths:
An optional path or list of paths. If set only :class:`Commit`\s that
include the path or paths will be considered.
:param kwargs:
Optional keyword arguments to :manpage:`git-rev-list(1)` where:
* ``max_count`` is the maximum number of commits to fetch.
* ``skip`` is the number of commits to skip.
* ``since`` selects all commits since some date, e.g. ``"1970-01-01"``.
:return:
Iterator yielding :class:`Commit` items.
Zprettyz<--pretty cannot be used as parsing expects single sha's onlyro �
as_processT)
rX r? rj �osr) rF �extendrq rr � _iter_from_process_or_stream)rG r: rv rn rQ Z args_listZ paths_tup�procrC rC rD �
iter_items+ s
zCommit.iter_itemsc K s8 |� dd�}|dkr d}||d< | j| j| |fi |��S )a� Iterate *all* parents of this commit.
:param paths:
Optional path or list of paths limiting the :class:`Commit`\s to those that
contain at least one of the paths.
:param kwargs:
All arguments allowed by :manpage:`git-rev-list(1)`.
:return:
Iterator yielding :class:`Commit` objects which are parents of ``self``
�skipr r )�getr| r: )r@ rn rQ r} rC rC rD � iter_parents_ s
zCommit.iter_parentsc C s� dt t dtfdd�}| js'| jjj| jdddddd��� dd � }||�}n| jjj| jd
j| jddddd ��� }||�}t �
| j|�S ) z�Create a git stat from changes between this commit and its first parent
or from all changes done if this is the very first commit.
:return:
:class:`Stats`
�linesr< c S sb d}t | | t| �d d � �D ] \}}|�d�d d }|�d�\}}}|d||||f 7 }q|S )Nrm � � r ���z %s %s %s %s
)�ziprp rk )r� �text� file_info�lineZ change_typeZ
insertionsZ deletions�filenamerC rC rD �
process_lines} s "z#Commit.stats.<locals>.process_linesro T)�numstat�
no_renames�root�rawr Nr )r� r� r� ) r rj r6 r: rq Z diff_treer9 rs �diffr Z_list_from_string)r@ r� r� r� rC rC rD �statst s �
�
��z Commit.statsc C s$ t jdtdd� dd� | j�� D �S )al Deprecated. Get the trailers of the message as a dictionary.
:note:
This property is deprecated, please use either :attr:`trailers_list` or
:attr:`trailers_dict`.
:return:
Dictionary containing whitespace stripped trailer information.
Only contains the latest instance of each trailer key.
zWCommit.trailers is deprecated, use Commit.trailers_list or Commit.trailers_dict insteadr� )�
stacklevelc S s i | ] \}}||d �qS )r rC )rS rT �vrC rC rD rV � s z#Commit.trailers.<locals>.<dictcomp>)�warnings�warn�DeprecationWarning�
trailers_dict�itemsrU rC rC rD �trailers� s �zCommit.trailersc C s� g d�}| j jj|dtd�}|�t| j��� �d �d�}|� � }|s%g S g }|�
d�D ]}|�
dd�\}}|� |� � |� � f� q,|S ) a� Get the trailers of the message as a list.
Git messages can contain trailer information that are similar to :rfc:`822`
e-mail headers. See :manpage:`git-interpret-trailers(1)`.
This function calls ``git interpret-trailers --parse`` onto the message to
extract the trailer information, returns the raw trailer data as a list.
Valid message with trailer::
Subject line
some body information
another information
key1: value1.1
key1: value1.2
key2 : value 2 with inner spaces
Returned list will look like this::
[
("key1", "value1.1"),
("key1", "value1.2"),
("key2", "value 2 with inner spaces"),
]
:return:
List containing key-value tuples of whitespace stripped trailer information.
)rq zinterpret-trailersz--parseT)rw rO r �utf8rh �:r ) r: rq Zexecuter � communicaterj r5 �encode�decode�striprk �append)r@ �cmdr{ ZtrailerZ trailer_list�t�key�valrC rC rD �
trailers_list� s !� zCommit.trailers_listc C s. t t�}| jD ] \}}|| �|� qt|�S )a Get the trailers of the message as a dictionary.
Git messages can contain trailer information that are similar to :rfc:`822`
e-mail headers. See :manpage:`git-interpret-trailers(1)`.
This function calls ``git interpret-trailers --parse`` onto the message to
extract the trailer information. The key value pairs are stripped of leading and
trailing whitespaces before they get saved into a dictionary.
Valid message with trailer::
Subject line
some body information
another information
key1: value1.1
key1: value1.2
key2 : value 2 with inner spaces
Returned dictionary will look like this::
{
"key1": ["value1.1", "value1.2"],
"key2": ["value 2 with inner spaces"],
}
:return:
Dictionary containing whitespace stripped trailer information, mapping
trailer keys to a list of their corresponding values.
)r �listr� r� �dict)r@ �dr� r� rC rC rD r� � s #zCommit.trailers_dict�proc_or_streamc c s� � t |d�rtt|�}|jdur|j}n t |d�r tt|�}|}|j} |� }|s*n'|�� }t|�dkr<|�dd�\}}t|�dksHJ d| ��| |t |��V q$t |d�ratt|�}t
|� dS dS )a� Parse out commit information into a list of :class:`Commit` objects.
We expect one line per commit, and parse the actual commit information directly
from our lighting fast object database.
:param proc:
:manpage:`git-rev-list(1)` process instance - one sha per line.
:return:
Iterator supplying :class:`Commit` objects
�waitN�readlineT�( r zInvalid line: %s) �hasattrr% r �stdoutr r� r� rp rk r r )rG r: r� rN r� r� r9 �_rC rC rD rz s0 �
�
�
�z#Commit._iter_from_process_or_streamF�parent_commits�head� author_date� commit_datec
C s |du rz|j jg}W n ty g }Y nw |D ]}
t|
| �s*td|
�d| � ���q|�� } tj} |p8t�| �}|p?t� | �}t
t � �}
t oLt
� jdk}|rQtnt}| �| jd�}|rct|�\}}n|rlt|�\}}n|
|}}| �| jd�}| r�t| �\}}n|r�t|�\}}n|
|}}| j�d�\}}| �||| j�}t|t�s�td��t|t�r�|�|�}| || j ||||||||||� }| � ||�|_ |r�ddl }z |j j ||d� W |S ty� |j!j"j#||j j$|d | d�}|j j%|d
| d� Y |S w |S ) a Commit the given tree, creating a :class:`Commit` object.
:param repo:
:class:`~git.repo.base.Repo` object the commit should be part of.
:param tree:
:class:`~git.objects.tree.Tree` object or hex or bin sha.
The tree of the new commit.
:param message:
Commit message. It may be an empty string if no message is provided. It will
be converted to a string, in any case.
:param parent_commits:
Optional :class:`Commit` objects to use as parents for the new commit. If
empty list, the commit will have no parents at all and become a root commit.
If ``None``, the current head commit will be the parent of the new commit
object.
:param head:
If ``True``, the HEAD will be advanced to the new commit automatically.
Otherwise the HEAD will remain pointing on the previous commit. This could
lead to undesired results when diffing files.
:param author:
The name of the author, optional.
If unset, the repository configuration is used to obtain this value.
:param committer:
The name of the committer, optional.
If unset, the repository configuration is used to obtain this value.
:param author_date:
The timestamp for the author field.
:param commit_date:
The timestamp for the committer field.
:return:
:class:`Commit` object representing the new commit.
:note:
Additional information about the committer and author are taken from the
environment or from the git configuration. See :manpage:`git-commit-tree(1)`
for more information.
NzParent commit 'z' must be of type r rm �.z)conf_encoding could not be coerced to str)Zlogmsgzcommit (initial): %szcommit: Switching to %s)&r� r, rX r? Z
config_readerrx �environr r2 r/ �intr
r r �tm_isdstr r r~ �env_author_dater �env_committer_date�
conf_encodingrk � get_value�default_encodingrj � TypeErrorr. rZ rP r; �git.refsZ
set_commitZrefsZHead�create�refZ
set_reference) rG r: r. r5 r� r� r/ r2 r� r� �pZcr�envZ unix_timeZis_dst�offsetZauthor_date_strZ author_timeZ
author_offsetZcommitter_date_strZcommitter_timeZcommitter_offsetZ enc_sectionZ
enc_optionr� r] rq ZmasterrC rC rD �create_from_tree1 s� ; �
�
� ���
zCommit.create_from_treerN c C sT |j }|d| j �d�� | jD ] }|d| �d�� q| j}|j}| j}d}||d||j| jt | j
�f �| j �� |j}||d||j| j t | j
�f �| j �� | j | jkrb|d| j �d�� z"| �d�r�|d � | j�d
��d
�D ]
}|d | d
�d�� quW n ty� Y nw |d � t| jt�r�|| j�| j �� | S || j� | S )
Nztree %s
�asciiz
parent %s
z%s %s <%s> %s %s
r/ r2 z encoding %s
r8 s gpgsigrh � ri )�writer. r� r6 r/ �namer2 �emailr0 r r1 r7 r3 r4 r� �__getattribute__r8 �rstriprk �AttributeErrorr? r5 rj ) r@ rN r� r� �aZaname�c�fmtZsiglinerC rC rD rI � s`
������
� �
�zCommit._serializec C s� |j }t| jt|� �� d �tjd> d�| _g | _d } |� }|�d�s'|}n| j� t
| �| jt|�� d � d���� q t | j�| _|}|� }|� }|�d�re|� }|�d �r`|� }|�d �sX|�d�sP| j
| _d| _|}|�� }|r�|d
d � d kr�||�d �d d � � | jd
�| _nD|d
d� dkr�||�d �d d � d } d}
|� } | s�n| d
d� d kr�| �� }d}
n | | dd � 7 } q�| �d�� | jd
�| _|
r�qr|� �� }|stzt|� | jd��\| _| _| _W n ty� tjd|| jdd� Y nw zt|� | jd��\| _| _| _ W n t�y# tjd|| jdd� Y nw |� � | _ z | j � | jd�| _ W | S t�yK tjd| j | jdd� Y | S w )Nr � rm Ts parentr� r� s mergetag � r �
s encoding �ignore� s gpgsig ri Fr^ z3Failed to decode author line '%s' using encoding %s)�exc_infoz6Failed to decode committer line '%s' using encoding %sz/Failed to decode message '%s' using encoding %s) r� r r: r rk Ztree_idr. r6 �
startswithr� r- r� rF r� r7 r8 r� �findr� r r/ r0 r1 �UnicodeDecodeError�_logger�errorr2 r3 r4 rb r5 ) r@ rN r� Z next_lineZ parent_lineZ author_lineZcommitter_line�enc�buf�sigZis_next_headerZsigbufrC rC rD ra s� &
*�
�
�$�
��
���
��
���zCommit._deserializec C s< g }| j r t�dt| j �tj�}|D ] }|�t|� � q|S )a Search the commit message for any co-authors of this commit.
Details on co-authors:
https://github.blog/2018-01-29-commit-together-with-co-authors/
:return:
List of co-authors for this commit (as :class:`~git.util.Actor` objects).
z ^Co-authored-by: (.*) <(.*?)>$)r5 �re�findallrj � MULTILINEr� r )r@ �
co_authors�resultsr/ rC rC rD r� x s
�zCommit.co_authors) NNNNNNNNNNN)rm )NFNNNN)9�__name__�
__module__� __qualname__�__doc__r� r� r� r� r- r( �__annotations__rW Z_id_attribute_r! �bytesr$ r r r� �floatrj r> � classmethodr" rH rP r r^ rc �property�datetimere rg rl r) rt ru r r| r r r� r r� r r� r� r r rz �boolr� r rI ra r� �
__classcell__rC rC rA rD r C s�
���
�
�
�
�
�
�
� � �
�
��Z $ �� ��� �(3 3 '$0��
����
�
� �
� � ";j )B�__all__� collectionsr r� �ior �loggingrx r� �
subprocessr r �sysr
r r r r r� Zgitdbr Zgit.cmdr
Zgit.diffr Zgit.utilr r r r rm r r. r �utilr r r r r r �typingr r r r r r! r" r# r$ r% � version_infor( Ztyping_extensionsZ git.typesr) r� r* Zgit.repor+ � getLoggerr� r� ZObjectr rC rC rC rD �<module> s8 0