Skip to content

Helpers

Compare by Similarity

The similarity calculation is customizable; visit the metrics section for more information.

JCompare.print_similar_files 

print_similar_files(folder1: Folder, folder2: Folder, threshold: float, same_parent_only: bool = False, comparer: Similarity = CompressionSimilarity('lzma2'), mode: int = ASYNC_AND_MULTIPROCESS) -> None

Prints the similar files between two folders based on a similarity threshold.

Parameters:

Name Type Description Default
folder1 Folder

The first folder object, which contains the files to be compared.

 required
folder2 Folder

The second folder object, which contains the files to be compared.

 required
threshold float

The similarity threshold. Only files with a similarity score above this threshold will be considered similar.

 required
same_parent_only bool

If set to True, only files with the same parent folder will be compared. Defaults to False.

 False
comparer Similarity

The similarity comparer to use. Defaults to CompressionSimilarity("lzma2").

 CompressionSimilarity('lzma2')
mode int

The mode to use for comparison. Defaults to ASYNC_AND_MULTIPROCESS.

 ASYNC_AND_MULTIPROCESS
Source code in JCompare/compare.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def print_similar_files(folder1: Folder, folder2: Folder, threshold: float, same_parent_only: bool = False, comparer: Similarity = CompressionSimilarity("lzma2"), mode: int = ASYNC_AND_MULTIPROCESS) -> None:
    """
    Prints the similar files between two folders based on a similarity threshold.

    Args:
        folder1 (Folder): The first folder object, which contains the files to be compared.
        folder2 (Folder): The second folder object, which contains the files to be compared.
        threshold (float): The similarity threshold. Only files with a similarity score above this threshold will be considered similar.
        same_parent_only (bool, optional): If set to True, only files with the same parent folder will be compared. Defaults to False.
        comparer (Similarity, optional): The similarity comparer to use. Defaults to CompressionSimilarity("lzma2").
        mode (int, optional): The mode to use for comparison. Defaults to ASYNC_AND_MULTIPROCESS.
    """

    result = find_similar_files_pairwise(
        folder1, folder2, threshold, same_parent_only, comparer, mode)

    for key, value in result.items():
        print(f"+ {key}")
        for i in value:
            print(f"  - {i[0]} {i[1]*100:.2f}%")

JCompare.print_dissimilar_files 

print_dissimilar_files(folder1: Folder, folder2: Folder, threshold: float, same_parent_only: bool = False, comparer: Similarity = CompressionSimilarity('lzma2'), mode: int = ASYNC_AND_MULTIPROCESS) -> None

Prints the dissimilar files between two folders based on a similarity threshold.

Parameters:

Name Type Description Default
folder1 Folder

The first folder object, which contains the files to be compared.

 required
folder2 Folder

The second folder object, which contains the files to be compared.

 required
threshold float

The similarity threshold. Only files with a similarity score below this threshold will be considered dissimilar.

 required
same_parent_only bool

If set to True, only files with the same parent folder will be compared. Defaults to False.

 False
comparer Similarity

The similarity comparer to use. Defaults to CompressionSimilarity("lzma2").

 CompressionSimilarity('lzma2')
mode int

The mode to use for comparison. Defaults to ASYNC_AND_MULTIPROCESS.

 ASYNC_AND_MULTIPROCESS
Source code in JCompare/compare.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def print_dissimilar_files(folder1: Folder, folder2: Folder, threshold: float, same_parent_only: bool = False, comparer: Similarity = CompressionSimilarity("lzma2"), mode: int = ASYNC_AND_MULTIPROCESS) -> None:
    """
    Prints the dissimilar files between two folders based on a similarity threshold.

    Args:
        folder1 (Folder): The first folder object, which contains the files to be compared.
        folder2 (Folder): The second folder object, which contains the files to be compared.
        threshold (float): The similarity threshold. Only files with a similarity score below this threshold will be considered dissimilar.
        same_parent_only (bool, optional): If set to True, only files with the same parent folder will be compared. Defaults to False.
        comparer (Similarity, optional): The similarity comparer to use. Defaults to CompressionSimilarity("lzma2").
        mode (int, optional): The mode to use for comparison. Defaults to ASYNC_AND_MULTIPROCESS.
    """

    result = find_dissimilar_files_pairwise(
        folder1, folder2, threshold, same_parent_only, comparer, mode)

    if result["is_similar"]:
        print("The folders are similar.")
    else:
        print("Dissimilar files found:")
        if result["folder1"]:
            print(f"Only in folder1:")
            for i in result['folder1']:
                print(f"+ {i}")
        if result["folder2"]:
            print(f"Only in folder2:")
            for i in result['folder2']:
                print(f"+ {i}")

Compare by Hash

JCompare.print_identical_files 

print_identical_files(folder1: Folder, folder2: Folder, same_parent_only: bool = False, hash_algorithm: tuple[str] = ('sha256')) -> None

Prints the identical files between two folders based on their hash values.

Parameters:

Name Type Description Default
folder1 Folder

The first folder object, which contains the files to be compared.

 required
folder2 Folder

The second folder object, which contains the files to be compared.

 required
same_parent_only bool

If set to True, only files with the same parent folder will be compared. Defaults to False.

 False
hash_algorithm tuple[str]

A tuple of strings specifying the names of the hash algorithms to use. Defaults to ("sha256",).

 ('sha256')
Source code in JCompare/compare.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
def print_identical_files(folder1: Folder, folder2: Folder, same_parent_only: bool = False, hash_algorithm: tuple[str] = ("sha256",)) -> None:
    """
    Prints the identical files between two folders based on their hash values.

    Args:
        folder1 (Folder): The first folder object, which contains the files to be compared.
        folder2 (Folder): The second folder object, which contains the files to be compared.
        same_parent_only (bool, optional): If set to True, only files with the same parent folder will be compared. Defaults to False.
        hash_algorithm (tuple[str], optional): A tuple of strings specifying the names of the hash algorithms to use. Defaults to ("sha256",).
    """

    result = find_identical_files(
        folder1, folder2, same_parent_only, hash_algorithm)

    for key, value in result.items():
        print(f"+ {key}")
        for i in value:
            print(f"  - {i}")

JCompare.print_different_files 

print_different_files(folder1: Folder, folder2: Folder, same_parent_only: bool = False, hash_algorithm: tuple[str] = ('sha256')) -> None

Prints the different files between two folders based on their hash values.

Parameters:

Name Type Description Default
folder1 Folder

The first folder object, which contains the files to be compared.

 required
folder2 Folder

The second folder object, which contains the files to be compared.

 required
same_parent_only bool

If set to True, only files with the same parent folder will be compared. Defaults to False.

 False
hash_algorithm tuple[str]

A tuple of strings specifying the names of the hash algorithms to use. Defaults to ("sha256",).

 ('sha256')
Source code in JCompare/compare.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def print_different_files(folder1: Folder, folder2: Folder, same_parent_only: bool = False, hash_algorithm: tuple[str] = ("sha256",)) -> None:
    """
    Prints the different files between two folders based on their hash values.

    Args:
        folder1 (Folder): The first folder object, which contains the files to be compared.
        folder2 (Folder): The second folder object, which contains the files to be compared.
        same_parent_only (bool, optional): If set to True, only files with the same parent folder will be compared. Defaults to False.
        hash_algorithm (tuple[str], optional): A tuple of strings specifying the names of the hash algorithms to use. Defaults to ("sha256",).
    """

    result = find_different_files(
        folder1, folder2, same_parent_only, hash_algorithm)

    if result["is_identical"]:
        print("The folders are identical.")
    else:
        print("Different files found:")
        if result['folder1']:
            print(f"Only in folder1:")
            for i in result['folder1']:
                print(f"+ {i}")
        if result['folder2']:
            print(f"Only in folder2:")
            for i in result['folder2']:
                print(f"+ {i}")

Compare by Directory Structure

JCompare.print_identical_files_by_mcs 

print_identical_files_by_mcs(folder1: Folder, folder2: Folder, ignore_directory_names: bool = False, path: None | tuple[tuple[str], tuple[str]] = None) -> None

Prints the identical files between two folders based on the maximum common subtree (MCS).

Parameters:

Name Type Description Default
folder1 Folder

The first folder object, which contains the files to be compared.

 required
folder2 Folder

The second folder object, which contains the files to be compared.

 required
ignore_directory_names bool

If set to True, directory names will be ignored when comparing the folder structures. Defaults to False.

 False
path None | tuple[tuple[str], tuple[str]]

A tuple of two tuples, each containing the path to a subtree in the corresponding folder. If provided, only the specified subtrees will be compared. Defaults to None.

 None
Source code in JCompare/compare.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def print_identical_files_by_mcs(folder1: Folder, folder2: Folder, ignore_directory_names: bool = False, path: None | tuple[tuple[str], tuple[str]] = None) -> None:
    """
    Prints the identical files between two folders based on the maximum common subtree (MCS).

    Args:
        folder1 (Folder): The first folder object, which contains the files to be compared.
        folder2 (Folder): The second folder object, which contains the files to be compared.
        ignore_directory_names (bool, optional): If set to True, directory names will be ignored when comparing the folder structures. Defaults to False.
        path (None | tuple[tuple[str], tuple[str]], optional): A tuple of two tuples, each containing the path to a subtree in the corresponding folder. If provided, only the specified subtrees will be compared. Defaults to None.
    """

    results = find_identical_files_by_mcs(
        folder1, folder2, ignore_directory_names, path)

    for result in results:
        for key, value in result.items():
            print(f"+ {key}")
            for i in value:
                print(f"  - {i}")

JCompare.print_different_files_by_mcs 

print_different_files_by_mcs(folder1: Folder, folder2: Folder, ignore_directory_names: bool = False, path: None | tuple[tuple[str], tuple[str]] = None) -> None

Prints the different files between two folders based on the maximum common subtree (MCS).

Parameters:

Name Type Description Default
folder1 Folder

The first folder object, which contains the files to be compared.

 required
folder2 Folder

The second folder object, which contains the files to be compared.

 required
ignore_directory_names bool

If set to True, directory names will be ignored when comparing the folder structures. Defaults to False.

 False
path None | tuple[tuple[str], tuple[str]]

A tuple of two tuples, each containing the path to a subtree in the corresponding folder. If provided, only the specified subtrees will be compared. Defaults to None.

 None
Source code in JCompare/compare.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def print_different_files_by_mcs(folder1: Folder, folder2: Folder, ignore_directory_names: bool = False, path: None | tuple[tuple[str], tuple[str]] = None) -> None:
    """
    Prints the different files between two folders based on the maximum common subtree (MCS).

    Args:
        folder1 (Folder): The first folder object, which contains the files to be compared.
        folder2 (Folder): The second folder object, which contains the files to be compared.
        ignore_directory_names (bool, optional): If set to True, directory names will be ignored when comparing the folder structures. Defaults to False.
        path (None | tuple[tuple[str], tuple[str]], optional): A tuple of two tuples, each containing the path to a subtree in the corresponding folder. If provided, only the specified subtrees will be compared. Defaults to None.
    """

    results = find_different_files_by_mcs(
        folder1, folder2, ignore_directory_names, path)

    for result in results:
        if result["is_identical"]:
            print("The folders are identical.")
        else:
            print("Different files found:")
            if result['folder1']:
                print(f"Only in folder1:")
                for i in result['folder1']:
                    print(f"+ {i}")
            if result['folder2']:
                print(f"Only in folder2:")
                for i in result['folder2']:
                    print(f"+ {i}")