# list.py - list endpoints
from mastodon.utility import api_version
from mastodon.internals import Mastodon as Internals
from mastodon.return_types import NonPaginatableList, UserList, IdType, PaginatableList, Account
from typing import List, Union, Optional
class Mastodon(Internals):
###
# Reading data: Lists
###
[docs]
@api_version("2.1.0", "2.1.0")
def lists(self) -> NonPaginatableList[UserList]:
"""
Fetch a list of all the Lists by the logged-in user.
"""
return self.__api_request('GET', '/api/v1/lists')
[docs]
@api_version("2.1.0", "2.1.0")
def list(self, id: Union[UserList, IdType]) -> UserList:
"""
Fetch info about a specific list.
"""
id = self.__unpack_id(id)
return self.__api_request('GET', f'/api/v1/lists/{id}')
[docs]
@api_version("2.1.0", "2.6.0")
def list_accounts(self, id: Union[UserList, IdType], max_id: Optional[Union[UserList, IdType]] = None,
min_id: Optional[Union[UserList, IdType]] = None, since_id: Optional[Union[UserList, IdType]] = None,
limit: Optional[int] = None) -> PaginatableList[Account]:
"""
Get the accounts that are on the given list.
"""
id = self.__unpack_id(id)
params = self.__generate_params(locals(), ['id'], dateconv=True)
return self.__api_request('GET', f'/api/v1/lists/{id}/accounts', params)
###
# Writing data: Lists
###
[docs]
@api_version("2.1.0", "4.2.0")
def list_create(self, title: str, replies_policy: str = "list", exclusive: bool = False) -> UserList:
"""
Create a new list with the given `title`.
`replies_policy` controls which replies are shown in the list. It can be one of "followed", "list" or "none".
`followed` means that only replies from accounts you follow will be shown, `list` means that only replies from
accounts on the list will be shown, and `none` means that no replies will be shown.
Set `exclusive` to True if you want the list to be an `exclusive` list, meaning that
accounts on the list will be excluded from the home timeline, appearing exclusively in the list timeline.
"""
params = self.__generate_params(locals())
return self.__api_request('POST', '/api/v1/lists', params)
[docs]
@api_version("2.1.0", "4.2.0")
def list_update(self, id: Union[UserList, IdType], title: str, replies_policy: str = "list", exclusive: bool = False) -> UserList:
"""
Update info about a list, where "info" is really the lists `title`.
`replies_policy` controls which replies are shown in the list. It can be one of "followed", "list" or "none".
`followed` means that only replies from accounts you follow will be shown, `list` means that only replies from
accounts on the list will be shown, and `none` means that no replies will be shown.
Set `exclusive` to True if you want the list to be an `exclusive` list, meaning that
accounts on the list will be excluded from the home timeline, appearing exclusively in the list timeline.
The returned object reflects the updated list.
"""
id = self.__unpack_id(id)
params = self.__generate_params(locals(), ['id'])
return self.__api_request('PUT', f'/api/v1/lists/{id}', params)
[docs]
@api_version("2.1.0", "2.1.0")
def list_delete(self, id: Union[UserList, IdType]):
"""
Delete a list.
"""
id = self.__unpack_id(id)
self.__api_request('DELETE', f'/api/v1/lists/{id}')
[docs]
@api_version("2.1.0", "2.1.0")
def list_accounts_add(self, id: Union[UserList, IdType], account_ids: List[Union[Account, IdType]]):
"""
Add the account(s) given in `account_ids` to the list.
"""
id = self.__unpack_id(id)
account_ids = self.__unpack_id(account_ids, listify = True)
params = self.__generate_params(locals(), ['id'])
self.__api_request('POST', f'/api/v1/lists/{id}/accounts', params)
[docs]
@api_version("2.1.0", "2.1.0")
def list_accounts_delete(self, id: Union[UserList, IdType], account_ids: List[Union[Account, IdType]]):
"""
Remove the account(s) given in `account_ids` from the list.
"""
id = self.__unpack_id(id)
account_ids = self.__unpack_id(account_ids, listify = True)
params = self.__generate_params(locals(), ['id'])
self.__api_request('DELETE', f'/api/v1/lists/{id}/accounts', params)