From 620687a07922f66e6e278b74050b5384e0131c36 Mon Sep 17 00:00:00 2001 From: Lorenz Diener Date: Mon, 4 Jun 2018 14:54:26 +0200 Subject: Add pinning/unpinning, media_update --- DEVELOPMENT.md | 2 -- docs/index.rst | 5 +++++ mastodon/Mastodon.py | 40 ++++++++++++++++++++++++++++++++++++++-- 3 files changed, 43 insertions(+), 4 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 6d9e10d..5644dea 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -4,8 +4,6 @@ Here's some general stuff to keep in mind, and some work that needs to be done use requests over urllib, et cetera. * Current TODOs (2.3 support): - * Add support for media updating - * Add support for focal points * Add support for idempotency keys * Document error handling better diff --git a/docs/index.rst b/docs/index.rst index 62f5842..4bcc70d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -256,6 +256,8 @@ Toot dicts 'language': # The language of the toot, if specified by the server. 'muted': # Boolean denoting whether the user has muted this status by # way of conversation muting + 'pinned': # Boolean denoting whether or not the status is currently pinned for the + # associated account. } Mention dicts @@ -662,6 +664,8 @@ interact with already posted statuses. .. automethod:: Mastodon.status_unfavourite .. automethod:: Mastodon.status_mute .. automethod:: Mastodon.status_unmute +.. automethod:: Mastodon.status_pin +.. automethod:: Mastodon.status_unpin .. automethod:: Mastodon.status_delete Writing data: Notifications @@ -714,6 +718,7 @@ to attach media to statuses. .. _media_post(): .. automethod:: Mastodon.media_post +.. automethod:: Mastodon.media_update Writing data: Reports --------------------- diff --git a/mastodon/Mastodon.py b/mastodon/Mastodon.py index e616aa3..b9e880d 100644 --- a/mastodon/Mastodon.py +++ b/mastodon/Mastodon.py @@ -111,7 +111,7 @@ class Mastodon: __DICT_VERSION_MENTION = "1.0.0" __DICT_VERSION_MEDIA = "2.3.0" __DICT_VERSION_ACCOUNT = "2.3.0" - __DICT_VERSION_STATUS = bigger_version(bigger_version(bigger_version(bigger_version("2.0.0", + __DICT_VERSION_STATUS = bigger_version(bigger_version(bigger_version(bigger_version("2.1.0", __DICT_VERSION_MEDIA), __DICT_VERSION_ACCOUNT), __DICT_VERSION_APPLICATION), __DICT_VERSION_MENTION) __DICT_VERSION_INSTANCE = bigger_version("2.3.0", __DICT_VERSION_ACCOUNT) __DICT_VERSION_HASHTAG = "1.0.0" @@ -761,7 +761,7 @@ class Mastodon: @api_version("2.1.0", "2.1.0", __DICT_VERSION_LIST) def account_lists(self, id): """ - Get all of the logged in users lists which the specified user is + Get all of the logged-in users lists which the specified user is a member of. Returns a list of `list dicts`_. @@ -1108,6 +1108,28 @@ class Mastodon: url = '/api/v1/statuses/{0}/unmute'.format(str(id)) return self.__api_request('POST', url) + @api_version("2.1.0", "2.1.0", __DICT_VERSION_STATUS) + def status_pin(self, id): + """ + Pin a status for the logged-in user. + + Returns a `toot dict`_ with the now pinned status + """ + id = self.__unpack_id(id) + url = '/api/v1/statuses/{0}/pin'.format(str(id)) + return self.__api_request('POST', url) + + @api_version("2.1.0", "2.1.0", __DICT_VERSION_STATUS) + def status_unpin(self, id): + """ + Unpin a pinned status for the logged-in user. + + Returns a `toot dict`_ with the status that used to be pinned. + """ + id = self.__unpack_id(id) + url = '/api/v1/statuses/{0}/unpin'.format(str(id)) + return self.__api_request('POST', url) + ### # Writing data: Notifications ### @@ -1402,7 +1424,21 @@ class Mastodon: return self.__api_request('POST', '/api/v1/media', files={'file': media_file_description}, params={'description': description, 'focus': focus}) + + @api_version("2.3.0", "2.3.0", __DICT_VERSION_MEDIA) + def media_update(self, id, description=None, focus=None): + """ + Update the metadata of the media file with the given `id`. `description` and + `focus` are as in `media_post()`_ . + """ + id = self.__unpack_id(id) + if focus != None: + focus = str(focus[0]) + "," + str(focus[1]) + + params = self.__generate_params(locals(), ['id']) + return self.__api_request('PUT', '/api/v1/media/{0}'.format(str(id)), params) + ### # Writing data: Domain blocks ### -- cgit v1.2.3