Skip to content

helpers#

remove_query_param#

Remove parameter from query string.

Source code in src/apps/files/helpers.py 
 8
 9
10
11
12
13
14
15
16
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 
19
20
21
22
23
24
25
26
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 
29
30
31
32
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 
35
36
37
38
39
40
41
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 
48
49
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 
52
53
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 
56
57
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 
60
61
def get_directory_metadata_serializer():
    return import_string(settings.DATASET_FILE_METADATA_SERIALIZERS["directory"])