Skip to content

Value Checkers

is_nonempty_value

Check if a value is not None-like or that its string representation contains at least one of the following characters:

  • \p{S} = symbols and special characters
  • \p{P} = punctuation
  • \w = all Unicode letters, numbers, and _

Parameters:

Name Type Description Default
value Any

value of any type

 required

Returns:

Type Description
bool

True if the value is not None-like and contains at least one of the above-mentioned characters

Examples:

# True values:
assert xmllib.is_nonempty_value("word") == True
assert xmllib.is_nonempty_value("None") == True
assert xmllib.is_nonempty_value("-") == True
assert xmllib.is_nonempty_value(0) == True
assert xmllib.is_nonempty_value(1) == True
assert xmllib.is_nonempty_value("0") == True
assert xmllib.is_nonempty_value("1") == True
assert xmllib.is_nonempty_value(True) == True
assert xmllib.is_nonempty_value(False) == True
assert xmllib.is_nonempty_value("עִבְרִית") == True

# False values:
assert xmllib.is_nonempty_value(pd.NA) == False
assert xmllib.is_nonempty_value(None) == False
assert xmllib.is_nonempty_value("") == False
assert xmllib.is_nonempty_value(" ") == False
assert xmllib.is_nonempty_value("\n") == False
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.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
43
44
45
46
47
48
49
50
51
52
def is_nonempty_value(value: Any) -> bool:
    """
    Check if a value is not None-like
    or that its string representation contains at least one of the following characters:

    - ``\\p{S}`` = symbols and special characters
    - ``\\p{P}`` = punctuation
    - ``\\w`` = all Unicode letters, numbers, and _

    Args:
        value: value of any type

    Returns:
        True if the value is not None-like and contains at least one of the above-mentioned characters

    Examples:
        ```python
        # True values:
        assert xmllib.is_nonempty_value("word") == True
        assert xmllib.is_nonempty_value("None") == True
        assert xmllib.is_nonempty_value("-") == True
        assert xmllib.is_nonempty_value(0) == True
        assert xmllib.is_nonempty_value(1) == True
        assert xmllib.is_nonempty_value("0") == True
        assert xmllib.is_nonempty_value("1") == True
        assert xmllib.is_nonempty_value(True) == True
        assert xmllib.is_nonempty_value(False) == True
        assert xmllib.is_nonempty_value("עִבְרִית") == True

        # False values:
        assert xmllib.is_nonempty_value(pd.NA) == False
        assert xmllib.is_nonempty_value(None) == False
        assert xmllib.is_nonempty_value("") == False
        assert xmllib.is_nonempty_value(" ") == False
        assert xmllib.is_nonempty_value("\\n") == False
        ```
    """
    if pd.isna(value):
        return False
    if regex.search(r"[\p{S}\p{P}\w]", str(value), flags=regex.UNICODE):
        return True
    return False

is_bool_like

Checks if a value is a bool or can be converted into a bool. It is case-insensitive, meaning that the words can also be capitalised.

Accepted values
  • false, 0, 0.0, no, non, nein -> False
  • true, 1, 1.0, yes, oui, ja -> True

Parameters:

Name Type Description Default
value Any

value to check

 required

Returns:

Type Description
bool

True if it conforms

Examples:

result = xmllib.is_bool_like("yes")
# result == True

result = xmllib.is_bool_like("not like a bool")
# result == False
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def is_bool_like(value: Any) -> bool:
    """
    Checks if a value is a bool or can be converted into a bool.
    It is case-insensitive, meaning that the words can also be capitalised.

    Accepted values:
         - `false`, `0`, `0.0`, `no`, `non`, `nein` -> `False`
         - `true`, `1`, `1.0`, `yes`, `oui`, `ja` -> `True`

    Args:
        value: value to check

    Returns:
        True if it conforms

    Examples:
        ```python
        result = xmllib.is_bool_like("yes")
        # result == True
        ```

        ```python
        result = xmllib.is_bool_like("not like a bool")
        # result == False
        ```
    """
    value = str(value).lower().strip()
    if value in ("false", "0", "0.0", "no", "non", "nein"):
        return True
    elif value in ("true", "1", "1.0", "yes", "oui", "ja"):
        return True
    return False

is_color

Checks if a value is a color value.

Parameters:

Name Type Description Default
value Any

value to check

 required

Returns:

Type Description
bool

True if it conforms

Examples:

result = xmllib.is_color("#00ff66")
# result == True

result = xmllib.is_color("not a color")
# result == False
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def is_color(value: Any) -> bool:
    """
    Checks if a value is a color value.

    Args:
        value: value to check

    Returns:
        True if it conforms

    Examples:
        ```python
        result = xmllib.is_color("#00ff66")
        # result == True
        ```

        ```python
        result = xmllib.is_color("not a color")
        # result == False
        ```
    """
    return bool(regex.search(r"^#[0-9a-f]{6}$", str(value).strip(), flags=regex.IGNORECASE))

is_date

Checks if a value is a date value.

Parameters:

Name Type Description Default
value Any

value to check

 required

Returns:

Type Description
bool

True if it conforms

Examples:

result = xmllib.is_date("GREGORIAN:CE:2014-01-31:CE:2014-01-31")
# result == True

result = xmllib.is_date("not a date")
# result == False
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def is_date(value: Any) -> bool:
    """
    Checks if a value is a date value.

    Args:
        value: value to check

    Returns:
        True if it conforms

    Examples:
        ```python
        result = xmllib.is_date("GREGORIAN:CE:2014-01-31:CE:2014-01-31")
        # result == True
        ```

        ```python
        result = xmllib.is_date("not a date")
        # result == False
        ```
    """
    calendar_optional = r"(?:(GREGORIAN|JULIAN|ISLAMIC):)?"
    first_era_optional = r"(?:(CE|BCE|BC|AD):)?"
    second_area_optional = r"(?::(CE|BCE|BC|AD))?"
    date = r"\d{1,4}(?:-\d{1,2}){0,2}"
    date_mandatory = rf"({date})"
    date_optional = rf"(:{date})?"
    full_date_pattern = (
        rf"^{calendar_optional}{first_era_optional}{date_mandatory}{second_area_optional}{date_optional}$"
    )
    found = regex.search(full_date_pattern, str(value))
    if not found:
        return False
    if found.group(1) == "ISLAMIC" and (found.group(2) or found.group(4)):
        # eras are not supported yet for the islamic calendar
        return False
    return True

is_geoname

Checks if a value is a geoname value.

Parameters:

Name Type Description Default
value Any

value to check

 required

Returns:

Type Description
bool

True if it conforms

Examples:

result = xmllib.is_geoname("8879000")
# result == True

result = xmllib.is_geoname("not a geoname code")
# result == False
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
def is_geoname(value: Any) -> bool:
    """
    Checks if a value is a geoname value.

    Args:
        value: value to check

    Returns:
        True if it conforms

    Examples:
        ```python
        result = xmllib.is_geoname("8879000")
        # result == True
        ```

        ```python
        result = xmllib.is_geoname("not a geoname code")
        # result == False
        ```
    """
    return is_integer(value)

is_decimal

Checks if a value is a float, an integer, or a string which can be converted into a float.

Parameters:

Name Type Description Default
value Any

value to check

 required

Returns:

Type Description
bool

True if conforms to the above-mentioned criteria.

Examples:

result = xmllib.is_decimal("0.1")
# result == True

# because this is equivalent to 9.0 it is accepted

result = xmllib.is_decimal(9)
# result == True

result = xmllib.is_decimal("not a decimal")
# result == False
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
def is_decimal(value: Any) -> bool:
    """
    Checks if a value is a float, an integer, or a string which can be converted into a float.

    Args:
        value: value to check

    Returns:
        True if conforms to the above-mentioned criteria.

    Examples:
        ```python
        result = xmllib.is_decimal("0.1")
        # result == True
        ```

        ```python
        # because this is equivalent to 9.0 it is accepted

        result = xmllib.is_decimal(9)
        # result == True
        ```

        ```python
        result = xmllib.is_decimal("not a decimal")
        # result == False
        ```
    """
    if pd.isna(value):
        return False

    match value:
        case bool():
            return False
        case int() | float():
            return True
    try:
        float(value)
        return True
    except ValueError:
        return False

is_integer

Checks if a value is an integer or a string which can be converted into an integer.

Parameters:

Name Type Description Default
value Any

value to check

 required

Returns:

Type Description
bool

True if conforms to the above-mentioned criteria.

Examples:

result = xmllib.is_integer("1")
# result == True

result = xmllib.is_integer(9.1)
# result == False

result = xmllib.is_integer("not an integer")
# result == False
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
def is_integer(value: Any) -> bool:
    """
    Checks if a value is an integer or a string which can be converted into an integer.

    Args:
        value: value to check

    Returns:
        True if conforms to the above-mentioned criteria.

    Examples:
        ```python
        result = xmllib.is_integer("1")
        # result == True
        ```

        ```python
        result = xmllib.is_integer(9.1)
        # result == False
        ```

        ```python
        result = xmllib.is_integer("not an integer")
        # result == False
        ```
    """
    match value:
        case bool():
            return False
        case int():
            return True
        case str():
            return bool(regex.search(r"^\d+$", value))
        case _:
            return False

Check if a value is a valid internal ID of a resource (xsd:ID) or a valid internal DSP IRI. Both of these values are allowed in LinkValues.

Parameters:

Name Type Description Default
value Any

the target ID of a LinkValue

 required

Returns:

Type Description
bool

True if it is a permissible value.

Examples:

result = xmllib.is_link_value("1_must_not_start_with_number")
# result == False

result = xmllib.is_link_value("characters|not|allowed")
# result == False

result = xmllib.is_link_value("resource_id_1")
# result == True

result = xmllib.is_link_value("http://rdfh.ch/4123/54SYvWF0QUW6a")
# result == True
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
def is_link_value(value: Any) -> bool:
    """
    Check if a value is a valid internal ID of a resource (xsd:ID) or a valid internal DSP IRI.
    Both of these values are allowed in LinkValues.

    Args:
        value: the target ID of a LinkValue

    Returns:
        True if it is a permissible value.

    Examples:
        ```python
        result = xmllib.is_link_value("1_must_not_start_with_number")
        # result == False
        ```

        ```python
        result = xmllib.is_link_value("characters|not|allowed")
        # result == False
        ```

        ```python
        result = xmllib.is_link_value("resource_id_1")
        # result == True
        ```

        ```python
        result = xmllib.is_link_value("http://rdfh.ch/4123/54SYvWF0QUW6a")
        # result == True
        ```
    """
    if is_valid_resource_id(value):
        return True
    return is_dsp_iri(value)

is_valid_resource_id

Check if a value is a valid internal ID of a resource (xsd:ID).

Parameters:

Name Type Description Default
value Any

the ID of a Resource

 required

Returns:

Type Description
bool

True if it is a permissible value.

Examples:

result = xmllib.is_valid_resource_id("1_must_not_start_with_number")
# result == False

result = xmllib.is_valid_resource_id("characters|not|allowed")
# result == False

result = xmllib.is_valid_resource_id("resource_id_1")
# result == True
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
def is_valid_resource_id(value: Any) -> bool:
    """
    Check if a value is a valid internal ID of a resource (xsd:ID).

    Args:
        value: the ID of a Resource

    Returns:
        True if it is a permissible value.

    Examples:
        ```python
        result = xmllib.is_valid_resource_id("1_must_not_start_with_number")
        # result == False
        ```

        ```python
        result = xmllib.is_valid_resource_id("characters|not|allowed")
        # result == False
        ```

        ```python
        result = xmllib.is_valid_resource_id("resource_id_1")
        # result == True
        ```
    """
    if is_nonempty_value(value):
        # None, etc. would not be recognised as invalid since it is converted into a string.
        return bool(
            regex.search(r"^[a-zA-Zçéàèöäüòôûâêñ_][a-zA-Zçéàèöäüòôûâêñ_\d.\-]*$", str(value)),
        )
    return False

is_timestamp

Checks if a value is a valid timestamp.

Parameters:

Name Type Description Default
value Any

value to check

 required

Returns:

Type Description
bool

True if it conforms

Examples:

result = xmllib.is_timestamp("2019-10-23T13:45:12Z")
# result == True

result = xmllib.is_timestamp("not a time stamp")
# result == False
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
def is_timestamp(value: Any) -> bool:
    """
    Checks if a value is a valid timestamp.

    Args:
        value: value to check

    Returns:
        True if it conforms

    Examples:
        ```python
        result = xmllib.is_timestamp("2019-10-23T13:45:12Z")
        # result == True
        ```

        ```python
        result = xmllib.is_timestamp("not a time stamp")
        # result == False
        ```
    """
    validation_regex = r"^\d{4}-[0-1]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d(\.\d{1,12})?(Z|[+-][0-1]\d:[0-5]\d)$"
    return bool(regex.search(validation_regex, str(value)))

is_dsp_iri

Check if a value is a valid internal DSP IRI.

Parameters:

Name Type Description Default
value Any

IRI

 required

Returns:

Type Description
bool

True if it is valid, else false

Examples:

result = xmllib.is_dsp_iri("http://rdfh.ch/4123/54SYvWF0QUW6a")
# result == True

result = xmllib.is_dsp_iri("http://dbpedia.org/resource/Internationalized_Resource_Identifier")
# result == False
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
def is_dsp_iri(value: Any) -> bool:
    """
    Check if a value is a valid internal DSP IRI.

    Args:
        value: IRI

    Returns:
        True if it is valid, else false

    Examples:
        ```python
        result = xmllib.is_dsp_iri("http://rdfh.ch/4123/54SYvWF0QUW6a")
        # result == True
        ```

        ```python
        result = xmllib.is_dsp_iri("http://dbpedia.org/resource/Internationalized_Resource_Identifier")
        # result == False
        ```
    """
    return bool(regex.search(r"^http://rdfh\.ch/\d{4}/", str(value)))

is_dsp_ark

Checks if a value is a valid ARK.

Parameters:

Name Type Description Default
value Any

ARK

 required

Returns:

Type Description
bool

True if it is valid, else false

Examples:

result = xmllib.is_dsp_ark("ark:/72163/4123-31ec6eab334-a.2022829")
# result == True

result = xmllib.is_dsp_ark("http://rdfh.ch/4123/54SYvWF0QUW6a")
# result == False
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
def is_dsp_ark(value: Any) -> bool:
    """
    Checks if a value is a valid ARK.

    Args:
        value: ARK

    Returns:
        True if it is valid, else false

    Examples:
        ```python
        result = xmllib.is_dsp_ark("ark:/72163/4123-31ec6eab334-a.2022829")
        # result == True
        ```

        ```python
        result = xmllib.is_dsp_ark("http://rdfh.ch/4123/54SYvWF0QUW6a")
        # result == False
        ```
    """
    return bool(regex.search(r"^ark:/", str(value)))

check_richtext_syntax

DSP richtexts must be convertible into valid XML. This checker escapes the reserved characters <, > and &, but only if they are not part of a standard standoff tag or escape sequence. Then, it tries to parse the resulting XML.

Note: Only DSP standard standoff tags are allowed in richtexts. They are documented here.

Parameters:

Name Type Description Default
richtext str

richtext to check

 required

Warns:

Type Description
XmllibInputWarning

if the input contains XML syntax problems
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/value_checkers.py 
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
def check_richtext_syntax(richtext: str) -> None:
    """
    DSP richtexts must be convertible into valid XML.
    This checker escapes the reserved characters `<`, `>` and `&`,
    but only if they are not part of a standard standoff tag or escape sequence.
    Then, it tries to parse the resulting XML.

    Note: Only DSP standard standoff tags are allowed in richtexts. They are documented
    [here](https://docs.dasch.swiss/latest/DSP-API/03-endpoints/api-v2/text/standard-standoff/).

    Args:
        richtext: richtext to check

    Warns:
        XmllibInputWarning: if the input contains XML syntax problems
    """
    result = parse_richtext_as_xml(richtext)
    if isinstance(result, MessageInfo):
        emit_xmllib_input_warning(result)