kopia lustrzana https://github.com/halcy/Mastodon.py
105 wiersze
4.9 KiB
Python
105 wiersze
4.9 KiB
Python
# timeline.py - endpoints for reading various different timelines
|
|
|
|
from .versions import _DICT_VERSION_STATUS, _DICT_VERSION_CONVERSATION
|
|
from .errors import MastodonIllegalArgumentError, MastodonNotFoundError
|
|
from .utility import api_version
|
|
|
|
from .internals import Mastodon as Internals
|
|
|
|
class Mastodon(Internals):
|
|
###
|
|
# Reading data: Timelines
|
|
##
|
|
@api_version("1.0.0", "3.1.4", _DICT_VERSION_STATUS)
|
|
def timeline(self, timeline="home", max_id=None, min_id=None, since_id=None, limit=None, only_media=False, local=False, remote=False):
|
|
"""
|
|
Fetch statuses, most recent ones first. `timeline` can be 'home', 'local', 'public',
|
|
'tag/hashtag' or 'list/id'. See the following functions documentation for what those do.
|
|
|
|
The default timeline is the "home" timeline.
|
|
|
|
Specify `only_media` to only get posts with attached media. Specify `local` to only get local statuses,
|
|
and `remote` to only get remote statuses. Some options are mutually incompatible as dictated by logic.
|
|
|
|
May or may not require authentication depending on server settings and what is specifically requested.
|
|
|
|
Returns a list of :ref:`status dicts <status dicts>`.
|
|
"""
|
|
if max_id is not None:
|
|
max_id = self.__unpack_id(max_id, dateconv=True)
|
|
|
|
if min_id is not None:
|
|
min_id = self.__unpack_id(min_id, dateconv=True)
|
|
|
|
if since_id is not None:
|
|
since_id = self.__unpack_id(since_id, dateconv=True)
|
|
|
|
params_initial = locals()
|
|
|
|
if not local:
|
|
del params_initial['local']
|
|
|
|
if not remote:
|
|
del params_initial['remote']
|
|
|
|
if not only_media:
|
|
del params_initial['only_media']
|
|
|
|
if timeline == "local":
|
|
timeline = "public"
|
|
params_initial['local'] = True
|
|
|
|
params = self.__generate_params(params_initial, ['timeline'])
|
|
return self.__api_request('GET', f'/api/v1/timelines/{timeline}', params)
|
|
|
|
@api_version("1.0.0", "3.1.4", _DICT_VERSION_STATUS)
|
|
def timeline_home(self, max_id=None, min_id=None, since_id=None, limit=None, only_media=False, local=False, remote=False):
|
|
"""
|
|
Convenience method: Fetches the logged-in user's home timeline (i.e. followed users and self). Params as in `timeline()`.
|
|
|
|
Returns a list of :ref:`status dicts <status dicts>`.
|
|
"""
|
|
return self.timeline('home', max_id=max_id, min_id=min_id, since_id=since_id, limit=limit, only_media=only_media, local=local, remote=remote)
|
|
|
|
@api_version("1.0.0", "3.1.4", _DICT_VERSION_STATUS)
|
|
def timeline_local(self, max_id=None, min_id=None, since_id=None, limit=None, only_media=False):
|
|
"""
|
|
Convenience method: Fetches the local / instance-wide timeline, not including replies. Params as in `timeline()`.
|
|
|
|
Returns a list of :ref:`status dicts <status dicts>`.
|
|
"""
|
|
return self.timeline('local', max_id=max_id, min_id=min_id, since_id=since_id, limit=limit, only_media=only_media)
|
|
|
|
@api_version("1.0.0", "3.1.4", _DICT_VERSION_STATUS)
|
|
def timeline_public(self, max_id=None, min_id=None, since_id=None, limit=None, only_media=False, local=False, remote=False):
|
|
"""
|
|
Convenience method: Fetches the public / visible-network / federated timeline, not including replies. Params as in `timeline()`.
|
|
|
|
Returns a list of :ref:`status dicts <status dicts>`.
|
|
"""
|
|
return self.timeline('public', max_id=max_id, min_id=min_id, since_id=since_id, limit=limit, only_media=only_media, local=local, remote=remote)
|
|
|
|
@api_version("1.0.0", "3.1.4", _DICT_VERSION_STATUS)
|
|
def timeline_hashtag(self, hashtag, local=False, max_id=None, min_id=None, since_id=None, limit=None, only_media=False, remote=False):
|
|
"""
|
|
Convenience method: Fetch a timeline of toots with a given hashtag. The hashtag parameter
|
|
should not contain the leading #. Params as in `timeline()`.
|
|
|
|
Returns a list of :ref:`status dicts <status dicts>`.
|
|
"""
|
|
if hashtag.startswith("#"):
|
|
raise MastodonIllegalArgumentError(
|
|
"Hashtag parameter should omit leading #")
|
|
return self.timeline(f'tag/{hashtag}', max_id=max_id, min_id=min_id, since_id=since_id, limit=limit, only_media=only_media, local=local, remote=remote)
|
|
|
|
@api_version("2.1.0", "3.1.4", _DICT_VERSION_STATUS)
|
|
def timeline_list(self, id, max_id=None, min_id=None, since_id=None, limit=None, only_media=False, local=False, remote=False):
|
|
"""
|
|
Convenience method: Fetches a timeline containing all the toots by users in a given list. Params as in `timeline()`.
|
|
|
|
Returns a list of :ref:`status dicts <status dicts>`.
|
|
"""
|
|
id = self.__unpack_id(id)
|
|
return self.timeline(f'list/{id}', max_id=max_id, min_id=min_id, since_id=since_id, limit=limit, only_media=only_media, local=local, remote=remote)
|
|
|