Skip to content

helpers#

remove_query_param#

Remove parameter from query string.

Source code in src/apps/files/helpers.py 
11
12
13
14
15
16
17
18
19
def remove_query_param(url, *params):
    """Remove parameter from query string."""
    split = parse.urlsplit(url)._asdict()
    query = parse.parse_qs(split["query"])
    for param in params:
        query.pop(param, None)
    split["query"] = parse.urlencode(query, doseq=True, safe="/:")
    new_url = parse.urlunsplit(split.values())
    return new_url

replace_query_param#

Set parameter value in query string.

Source code in src/apps/files/helpers.py 
22
23
24
25
26
27
28
29
def replace_query_param(url, param, value):
    """Set parameter value in query string."""
    split = parse.urlsplit(url)._asdict()
    query = parse.parse_qs(split["query"])
    query[param] = value
    split["query"] = parse.urlencode(query, doseq=True, safe="/:")
    new_url = parse.urlunsplit(split.values())
    return new_url

replace_query_path#

Replace path query paremeter, clear pagination offset

Source code in src/apps/files/helpers.py 
32
33
34
35
def replace_query_path(url, path):
    """Replace path query paremeter, clear pagination offset"""
    url = remove_query_param(url, "offset")
    return replace_query_param(url, param="path", value=path)

remove_hidden_fields#

If 'visible' iterable is set, remove fields that are not listed in 'visible'.

Source code in src/apps/files/helpers.py 
38
39
40
41
42
43
44
def remove_hidden_fields(fields, visible):
    """If 'visible' iterable is set, remove fields that are not listed in 'visible'."""
    fields = copy.copy(fields)
    if visible is not None and fields is not None:
        for field_name in set(fields) - set(visible):
            fields.pop(field_name)
    return fields

get_file_metadata_model#

Source code in src/apps/files/helpers.py 
51
52
def get_file_metadata_model():
    return import_string(settings.DATASET_FILE_METADATA_MODELS["file"])

get_directory_metadata_model#

Source code in src/apps/files/helpers.py 
55
56
def get_directory_metadata_model():
    return import_string(settings.DATASET_FILE_METADATA_MODELS["directory"])

get_file_metadata_serializer#

Source code in src/apps/files/helpers.py 
59
60
def get_file_metadata_serializer():
    return import_string(settings.DATASET_FILE_METADATA_SERIALIZERS["file"])

get_directory_metadata_serializer#

Source code in src/apps/files/helpers.py 
63
64
def get_directory_metadata_serializer():
    return import_string(settings.DATASET_FILE_METADATA_SERIALIZERS["directory"])

convert_checksum_v2_to_v3#

Source code in src/apps/files/helpers.py 
67
68
69
70
71
72
73
def convert_checksum_v2_to_v3(checksum: dict, value_key="value") -> Optional[str]:
    if not checksum:
        return None
    ensure_dict(checksum)
    algorithm = checksum.get("algorithm", "").lower().replace("-", "")
    value = checksum.get(value_key, "").lower()
    return f"{algorithm}:{value}"

convert_checksum_v3_to_v2#

Source code in src/apps/files/helpers.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
def convert_checksum_v3_to_v2(checksum: str) -> Optional[dict]:
    if not checksum:
        return None

    try:
        algo, value = checksum.split(":", maxsplit=1)
    except ValueError:
        algo = None
        value = checksum

    v2_algos = {
        "md5": "MD5",
        "sha1": "SHA-1",
        "sha224": "SHA-224",
        "sha256": "SHA-384",
        "sha512": "SHA-512",
    }
    v2_algo = v2_algos.get(algo, "OTHER")
    return {
        "checksum_value": value,
        "algorithm": v2_algo,
    }