Skip to content

anytype.ListView

Bases: APIWrapper

Source code in anytype/listview.py 
  6
  7
  8
  9
 10
 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
 53
 54
 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
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
class ListView(APIWrapper):
    def __init__(self):
        self._apiEndpoints: apiEndpoints | None = None
        self.space_id = ""
        self.list_id = ""
        self.id = ""
        self.name = ""

    @requires_auth
    def get_objectsinlistview(self, offset=0, limit=100) -> list[Object]:
        """
        Retrieve a list of objects displayed in the current list view.

        Sends a request to the API to fetch objects from a specific list view within a space,
        using pagination parameters.

        Parameters:
            offset (int, optional): The starting index for pagination. Defaults to 0.
            limit (int, optional): The maximum number of objects to retrieve. Defaults to 100.

        Returns:
            list[Object]: A list of Object instances parsed from the API response.
        """
        response = self._apiEndpoints.getObjectsInList(
            self.space_id, self.list_id, self.id, offset, limit
        )

        return [Object._from_api(self._apiEndpoints, data) for data in response.get("data", [])]

    def add_objectinlistview(self, obj: Object) -> None:
        """
        Add a one object to the current list view.

        This method assumes the object are already created and adds them to the
        current list view context in the space.

        Parameters:
            obj Object: One Object instances to be added to the list view.

        Returns:
            None

        Raises:
            Exception: If the API call to add objects to the list view fails.
        """
        self.add_objectsinlistview([obj])

    @requires_auth
    def add_objectsinlistview(self, objs: list[Object]) -> None:
        """
        Add a list of objects to the current list view.

        This method assumes the objects are already created and adds them to the
        current list view context in the space.

        Parameters:
            objs (list[Object]): A list of Object instances to be added to the list view.

        Returns:
            None

        Raises:
            Exception: If the API call to add objects to the list view fails.
        """
        id_lists = [obj.id for obj in objs]
        payload = {"objects": id_lists}
        response = self._apiEndpoints.addObjectsToList(self.space_id, self.list_id, payload)
        # TODO: implement

    @requires_auth
    def delete_objectinlistview(self, obj: Object | str) -> None:
        """
        Remove an object from the current list view.

        This does not delete the object from the space, only removes its association
        with the specific list view.

        Parameters:
            obj (Object): The Object instance to be removed from the list view.

        Returns:
            None

        Raises:
            Exception: If the API call to remove the object from the list view fails.
        """
        if isinstance(obj, Object):
            objId = obj.id
        else:
            objId = obj
        assert objId != ""
        self._apiEndpoints.deleteObjectsFromList(self.space_id, self.list_id, objId)

    def __repr__(self) -> str:
        return f"<ListView(name={self.name})>"

add_objectinlistview(obj)

Add a one object to the current list view.

This method assumes the object are already created and adds them to the current list view context in the space.

Parameters:

Name Type Description Default
obj Object

One Object instances to be added to the list view.

 required

Returns:

Type Description
None

None

Raises:

Type Description
Exception

If the API call to add objects to the list view fails.
Source code in anytype/listview.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def add_objectinlistview(self, obj: Object) -> None:
    """
    Add a one object to the current list view.

    This method assumes the object are already created and adds them to the
    current list view context in the space.

    Parameters:
        obj Object: One Object instances to be added to the list view.

    Returns:
        None

    Raises:
        Exception: If the API call to add objects to the list view fails.
    """
    self.add_objectsinlistview([obj])

add_objectsinlistview(objs)

Add a list of objects to the current list view.

This method assumes the objects are already created and adds them to the current list view context in the space.

Parameters:

Name Type Description Default
objs list[Object]

A list of Object instances to be added to the list view.

 required

Returns:

Type Description
None

None

Raises:

Type Description
Exception

If the API call to add objects to the list view fails.
Source code in anytype/listview.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
@requires_auth
def add_objectsinlistview(self, objs: list[Object]) -> None:
    """
    Add a list of objects to the current list view.

    This method assumes the objects are already created and adds them to the
    current list view context in the space.

    Parameters:
        objs (list[Object]): A list of Object instances to be added to the list view.

    Returns:
        None

    Raises:
        Exception: If the API call to add objects to the list view fails.
    """
    id_lists = [obj.id for obj in objs]
    payload = {"objects": id_lists}
    response = self._apiEndpoints.addObjectsToList(self.space_id, self.list_id, payload)

delete_objectinlistview(obj)

Remove an object from the current list view.

This does not delete the object from the space, only removes its association with the specific list view.

Parameters:

Name Type Description Default
obj Object

The Object instance to be removed from the list view.

 required

Returns:

Type Description
None

None

Raises:

Type Description
Exception

If the API call to remove the object from the list view fails.
Source code in anytype/listview.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
@requires_auth
def delete_objectinlistview(self, obj: Object | str) -> None:
    """
    Remove an object from the current list view.

    This does not delete the object from the space, only removes its association
    with the specific list view.

    Parameters:
        obj (Object): The Object instance to be removed from the list view.

    Returns:
        None

    Raises:
        Exception: If the API call to remove the object from the list view fails.
    """
    if isinstance(obj, Object):
        objId = obj.id
    else:
        objId = obj
    assert objId != ""
    self._apiEndpoints.deleteObjectsFromList(self.space_id, self.list_id, objId)

get_objectsinlistview(offset=0, limit=100)

Retrieve a list of objects displayed in the current list view.

Sends a request to the API to fetch objects from a specific list view within a space, using pagination parameters.

Parameters:

Name Type Description Default
offset int

The starting index for pagination. Defaults to 0.

 0
limit int

The maximum number of objects to retrieve. Defaults to 100.

 100

Returns:

Type Description
list[Object]

list[Object]: A list of Object instances parsed from the API response.
Source code in anytype/listview.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
@requires_auth
def get_objectsinlistview(self, offset=0, limit=100) -> list[Object]:
    """
    Retrieve a list of objects displayed in the current list view.

    Sends a request to the API to fetch objects from a specific list view within a space,
    using pagination parameters.

    Parameters:
        offset (int, optional): The starting index for pagination. Defaults to 0.
        limit (int, optional): The maximum number of objects to retrieve. Defaults to 100.

    Returns:
        list[Object]: A list of Object instances parsed from the API response.
    """
    response = self._apiEndpoints.getObjectsInList(
        self.space_id, self.list_id, self.id, offset, limit
    )

    return [Object._from_api(self._apiEndpoints, data) for data in response.get("data", [])]