File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/__pycache__/listdiffer.cpython-310.pyc
o
�N�g�+ � @ s* d Z ddlmZ dd� ZG dd� d�ZdS )a�
Compare lists of dictionaries by a specified key.
The following can be retrieved:
(1) List of added, removed, intersect elements
(2) List of diffs having the following format:
<key_val>: {<elem_key: {'old': <old_value>, 'new': <new_value>}}
A recursive diff is done between the values (dicts) with the same
key
(3) List with the new values for each key
(4) List with the old values for each key
(5) List of changed items in the format
('<key_val>.<elem_key>', {'old': <old_value>, 'new': <new_value>})
(5) String representations of the list diff
Note: All dictionaries keys are expected to be strings
� ��recursive_diffc C s t | ||�S �N)�ListDictDiffer)Zlist_aZlist_b�key� r �I/opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/listdiffer.py� list_diff s r c @ s� e Zd ZdZdd� Zdd� Zedd� �Zedd � �Zed
d � �Z d"dd�Z
edd� �Z edd� �Z ed#dd��Z
edd� �Zedd� �Zd$d d �Zed d � �Zed d!� �Zd S )%r z�
Calculates the differences between two lists of dictionaries.
It matches the items based on a given key and uses the recursive_diff to
diff the two values.
c C s� g | _ g | _g | _|| _|| _|| _|D ]C}||vr$td�||�� ���|D ]*}||vr6td�||�� ���|| || krP||| d|d|i}| j � |� nq&| j� |� q|D ]}|D ] }|| || krj nq^| j� |� qZd S )NzHThe supplied key '{}' does not exist in item, the available keys are: {}�old�new)
�
_intersect�_removed�_added�_new�_current�_key�
ValueError�format�keys�append)�self� current_listZ next_listr Z current_itemZ next_item�itemr r r �__init__" sB � � � �� ��zListDictDiffer.__init__c C s� |dkr dd� | j D �S |dkrdd� | jD �S |dkr$dd� | jD �S |dkrMg }|�d d� | j D �� |�d
d� | jD �� |�d d� | jD �� |S td ��)
z.Returns the recursive diff between dict values� intersectc S � g | ] }t |d |d ��qS �r
r r ��.0r r r r �
<listcomp>H s �z<ListDictDiffer._get_recursive_difference.<locals>.<listcomp>�addedc S � g | ]}t i |��qS r r r r r r r L � �removedc S � g | ] }t |i d d��qS �F)Zignore_missing_keysr r r r r r N � ���allc S r r r r r r r r U s c S r! r r r r r r r W r" c S r$ r% r r r r r r Y r& z<The given type for recursive list matching is not supported.)r r r
�extendr )r �typeZrecursive_listr r r �_get_recursive_differenceE s2 ������z(ListDictDiffer._get_recursive_differencec C � | j S )z3Returns the objects which are removed from the list)r
�r r r r r# d � zListDictDiffer.removedc C r+ )z/Returns the objects which are added to the list)r r, r r r r i r- zListDictDiffer.addedc C r+ )z Returns the intersect objects)r r, r r r r n r- zListDictDiffer.intersectNr c C s\ |dkr| j D ]}|d �|d� |d �|d� q|dkr*| jD ]
}|�|d� q!dS dS )z6Deletes an attribute from all of the intersect objectsr r
Nr r# )r �popr
)r Zdiff_keyZ diff_listr r r r � remove_diffs s
�zListDictDiffer.remove_diffc C s^ g }| j dd�D ]$}|jr,|jr |�|j| j |ji� q|jr,|�|j| j |ji� q|S )z�
Returns a list of dictionaries with key value pairs.
The values are the differences between the items identified by the key.
r' �r) )r* �diffs� past_dictr r � current_dict)r Z differencesr r r r r1 } s �zListDictDiffer.diffsc C s� d}| j dd�D ]}|jr#d�|d�| j|j| j |j�dd��g�}q| j dd�D ]}|jr?d�|d�| j|j| j �g�}q*| j d d�D ]}|jr[d�|d
�| j|j| j �g�}qF|S ) z'Returns a string describing the changes� r r0 z identified by {} {}:
{}
�
z
r# z' identified by {} {}:
will be removed
r z% identified by {} {}:
will be added
) r* r1 �joinr r r2 � changes_str�replacer3 )r �changesr r r r r7 � sD
����
���� ���� zListDictDiffer.changes_str� c C s� g }| j dd�D ] }|jr&|�dj| j|j| j |j�dd�|��|d�� q| j dd�D ]}|jrB|�dj| j|j| j |d�� q-| j d d�D ]}|jrb|�d
j| j|j| j t |j�|d�� qId�
|�S ) z�
Returns a string in a more compact format describing the changes.
The output better alligns with the one in recursive_diff.
r r0 z%{tab}{0}={1} (updated):
{tab}{tab}{2}r5 z
{0}{0})�tabr# z{tab}{0}={1} (removed)r z{tab}{0}={1} (added): {2}) r* r1 r r r r2 r7 r8 r3 �dictr6 )r Z
tab_stringr9 r r r r � changes_str2� s@
������
���
zListDictDiffer.changes_str2c �$ �fdd�� � fdd��� d�D �S )z$Returns the new values from the diffc sD | j }| jr|�� j| j� j i� |S |�� j| j� j i� |S r )�
new_valuesr2 �updater r3 �r �valuesr, r r �get_new_values_and_key� s �z9ListDictDiffer.new_values.<locals>.get_new_values_and_keyc � g | ] }|j r|jr� |��qS r )r1 r3 �r �el)rC r r r � � ���z-ListDictDiffer.new_values.<locals>.<listcomp>r' �r* r, r )rC r r r? � s
�zListDictDiffer.new_valuesc r> )z$Returns the old values from the diffc s" | j }|�� j| j� j i� |S r )�
old_valuesr@ r r2 rA r, r r �get_old_values_and_key� s z9ListDictDiffer.old_values.<locals>.get_old_values_and_keyc rD r )r1 r2 rE )rJ r r r � rG z-ListDictDiffer.old_values.<locals>.<listcomp>r' rH r, r )rJ r r rI � s
�zListDictDiffer.old_valuesr' c C s g }|dkrB| j dd�D ]3}d|_| j|jv r t|j| j �nt|j| j �}|�� D ]}|| jkr>|�d�| j||g�� q+q |S |dkr�| j dd�D ]3}d|_| j|jv r_t|j| j �nt|j| j �}|�� D ]}|| jkr~|�d�| j||g�� qkqL|S dS )aS
Returns the list of changed values.
The key is added to each item.
selection
Specifies the desired changes.
Supported values are
``all`` - all changed items are included in the output
``intersect`` - changed items present in both lists are included
r' r0 F�.r N) r* Zignore_unset_valuesr r2 �strr3 �changedr r6 )r Z selectionrM Zrecursive_itemZkey_valZchanger r r rM � s8 ��
�� ��
���zListDictDiffer.changedc C r+ r )r r, r r r r ' � zListDictDiffer.current_listc C r+ r )r r, r r r �new_list+ rN zListDictDiffer.new_list)Nr )r: )r' )�__name__�
__module__� __qualname__�__doc__r r* �propertyr# r r r/ r1 r7 r= r? rI rM r rO r r r r r s4 #
* $
)
r N)rS Zsalt.utils.dictdifferr r r r r r r �<module> s