1
2
3
4
5
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# admin.py - admin / moderation endpoints
import time
from mastodon.errors import MastodonVersionError, MastodonAPIError
from mastodon.utility import api_version
from mastodon.internals import Mastodon as Internals
from mastodon.return_types import MediaAttachment, PathOrFile, IdType
from typing import Optional, Union, Tuple, List, Dict, Any
class Mastodon(Internals):
###
# Reading data: Media
###
@api_version("3.1.4", "3.1.4")
def media(self, id: Union[MediaAttachment, IdType]) -> MediaAttachment:
"""
Get the updated JSON for one non-attached / in progress media upload belonging
to the logged-in user.
"""
id = self.__unpack_id(id)
return self.__api_request('GET', f'/api/v1/media/{id}')
###
# Writing data: Media
###
@api_version("1.0.0", "3.2.0")
def media_post(self, media_file: PathOrFile, mime_type: Optional[str] = None, description: Optional[str] = None,
focus: Optional[Tuple[float, float]] = None, file_name: Optional[str] = None,
thumbnail: Optional[PathOrFile] = None, thumbnail_mime_type: Optional[str] = None,
synchronous: bool = False) -> MediaAttachment:
"""
Post an image, video or audio file. `media_file` can either be data or
a file name. If data is passed directly, the mime type has to be specified
manually, otherwise, it is determined from the file name. `focus` should be a tuple
of floats between -1 and 1, giving the x and y coordinates of the images
focus point for cropping (with the origin being the images center).
Throws a `MastodonIllegalArgumentError` if the mime type of the
passed data or file can not be determined properly.
`file_name` can be specified to upload a file with the given name,
which is ignored by Mastodon, but some other Fediverse server software
will display it. If no name is specified, a random name will be generated.
The filename of a file specified in media_file will be ignored.
Starting with Mastodon 3.2.0, `thumbnail` can be specified in the same way as `media_file`
to upload a custom thumbnail image for audio and video files.
When using the v2 API (post Mastodon version 3.1.4), the `url` in the
returned dict will be `null`, since attachments are processed
asynchronously. You can fetch an updated dict using `media`. Pass
"synchronous" to emulate the old behaviour. Not recommended, inefficient
and deprecated, will eat your API quota, you know the deal.
The returned value (or its id) can be used in a status post as the `media_ids` parameter.
"""
files = {'file': self.__load_media_file(
media_file, mime_type, file_name)}
if focus is not None:
focus = f"{focus[0]},{focus[1]}"
if thumbnail is not None:
if not self.verify_minimum_version("3.2.0", cached=True):
raise MastodonVersionError('Thumbnail requires version > 3.2.0')
files["thumbnail"] = self.__load_media_file(thumbnail, thumbnail_mime_type)
# Disambiguate URL by version
if self.verify_minimum_version("3.1.4", cached=True):
ret_dict = self.__api_request(
'POST', '/api/v2/media', files=files, params={'description': description, 'focus': focus})
else:
ret_dict = self.__api_request(
'POST', '/api/v1/media', files=files, params={'description': description, 'focus': focus})
# Wait for processing?
if synchronous:
if self.verify_minimum_version("3.1.4"):
while not "url" in ret_dict or ret_dict.url is None:
try:
ret_dict = self.media(ret_dict)
time.sleep(5.0)
except:
raise MastodonAPIError("Attachment could not be processed")
else:
# Old version always waits
return ret_dict
return ret_dict
@api_version("2.3.0", "3.2.0")
def media_update(self, id: Union[MediaAttachment, IdType], description: Optional[str] = None,
focus: Optional[Tuple[float, float]] = None, thumbnail: Optional[PathOrFile] = None,
thumbnail_mime_type=None) -> MediaAttachment:
"""
Update the metadata of the media file with the given `id`. `description` and
`focus` and `thumbnail` are as in :ref:`media_post() <media_post()>` .
The returned dict reflects the updates to the media attachment.
Note: This is for updating the metadata of an *unattached* media attachment (i.e. one that has
not been used in a status yet). For editing media attachment metadata after posting, see `status_update` and
`generate_media_edit_attributes`.
"""
id = self.__unpack_id(id)
if focus is not None:
focus = f"{focus[0]},{focus[1]}"
params = self.__generate_params(
locals(), ['id', 'thumbnail', 'thumbnail_mime_type'])
if thumbnail is not None:
if not self.verify_minimum_version("3.2.0", cached=True):
raise MastodonVersionError('Thumbnail requires version > 3.2.0')
files = {"thumbnail": self.__load_media_file(
thumbnail, thumbnail_mime_type)}
return self.__api_request('PUT', f'/api/v1/media/{id}', params, files=files)
else:
return self.__api_request('PUT', f'/api/v1/media/{id}', params)
|
