Skip to content

merge

Merge contributors from multiple .all-contributorsrc files into a single list.

merge_contributions(first, second)

Return a sorted list of the contribution types for two contributor entries

Source code in all_all_contributors/merge.py 
45
46
47
48
49
50
51
52
def merge_contributions(first: Contributor, second: Contributor) -> Contributor:
    """Return a sorted list of the contribution types for two contributor entries"""
    return sorted(
        or_set(
            first.get(_contributions),
            second.get(_contributions),
        )
    )

merge_contributors(contributors_list)

Merge multiple lists of contributor dictionaries into a single list.

This function takes a list of contributor dictionaries (typically from different .all-contributorsrc files) and merges them based on unique profile URLs. When multiple entries exist for the same contributor, their contributions are aggregated into a single entry.

Parameters:

Name Type Description Default
contributors_list list[Contributor]

A list of contributor dictionaries. Each contributor dict should have at least 'profile' and 'contributions' keys.

 required

Returns:

Type Description
list[Contributor]

list[dict[str, Any]]: A list of merged contributor dictionaries, where each contributor appears only once with their combined contributions.
Note

The function merges contributors based on merge._unique_key and aggregates contributions types.

Source code in all_all_contributors/merge.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def merge_contributors(contributors_list: list[Contributor]) -> list[Contributor]:
    """Merge multiple lists of contributor dictionaries into a single list.

    This function takes a list of contributor dictionaries (typically from
    different .all-contributorsrc files) and merges them based on unique
    profile URLs. When multiple entries exist for the same contributor, their
    contributions are aggregated into a single entry.

    Args:
        contributors_list: A list of contributor dictionaries. Each contributor
            dict should have at least 'profile' and 'contributions' keys.

    Returns:
        list[dict[str, Any]]: A list of merged contributor dictionaries, where
            each contributor appears only once with their combined contributions.

    Note:
        The function merges contributors based on merge._unique_key and
        aggregates contributions types.
    """

    all_contributors = {}

    for contributor in contributors_list:
        if (key := contributor.get(_unique_key)) in all_contributors.keys():
            all_contributors[key][_contributions] = merge_contributions(
                all_contributors[key], contributor
            )
        else:
            all_contributors[key] = contributor.copy()

    return list(all_contributors.values())

or_set(first, second)

Return list of values that appear in first or second

Source code in all_all_contributors/merge.py 
55
56
57
def or_set(first: list[Any], second: list[Any]) -> list[Any]:
    """Return list of values that appear in `first` or `second`"""
    return list(set(first + second))