Skip to content

muck_out.transform

default_public module-attribute 

default_public = (
    "https://www.w3.org/ns/activitystreams#Public"
)

Default URI to represent something is being addressed to the public.

normalize_public 

normalize_public(uri: str) -> str

Normalizes the representation of public, i.e.

>>> normalize_public("as:Public")
'https://www.w3.org/ns/activitystreams#Public'
Source code in muck_out/transform/__init__.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
def normalize_public(uri: str) -> str:
    """
    Normalizes the representation of public, i.e.

    ```python
    >>> normalize_public("as:Public")
    'https://www.w3.org/ns/activitystreams#Public'

    ```
    """
    if uri in uris_for_public:
        return default_public
    return uri

transform_to_list_of_uris 

transform_to_list_of_uris(data) -> list[str]

Transforms to a list of URIs. As this simplifies a complicated data structure, some information may be lost.

>>> transform_to_list_of_uris("http://remote.test/id")
['http://remote.test/id']

>>> transform_to_list_of_uris({"id": "http://remote.test/id"})
['http://remote.test/id']

>>> transform_to_list_of_uris({"ignored": True})
[]
Source code in muck_out/transform/__init__.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def transform_to_list_of_uris(data) -> list[str]:
    """Transforms to a list of URIs. As this simplifies a
    complicated data structure, some information may be lost.

    ``` python
    >>> transform_to_list_of_uris("http://remote.test/id")
    ['http://remote.test/id']

    >>> transform_to_list_of_uris({"id": "http://remote.test/id"})
    ['http://remote.test/id']

    >>> transform_to_list_of_uris({"ignored": True})
    []

    ```
    """
    to_list = transform_to_list(data)

    return [normalize_public(x) for x in (id_for_object(to) for to in to_list) if x]

transform_url 

transform_url(url) -> list[dict] | None

Transform to a list of links

>>> transform_url("http://remote.test/html")
[{'type': 'Link', 'href': 'http://remote.test/html'}]
Source code in muck_out/transform/__init__.py 
16
17
18
19
20
21
22
23
24
25
26
27
def transform_url(url) -> list[dict] | None:
    """Transform to a list of links

    ```python
    >>> transform_url("http://remote.test/html")
    [{'type': 'Link', 'href': 'http://remote.test/html'}]

    ```
    """
    url_list = transform_to_list(url)

    return [transform_url_part(url_part) for url_part in url_list]