Skip to content

Commit 8d1d38c

Browse files
Eldinnietsnoam
Eldinnie
authored and
tsnoam
committed
send_* now accepts tg-objects (python-telegram-bot#742)
Fixes python-telegram-bot#731
1 parent 2d1028a commit 8d1d38c

File tree

14 files changed

+223
-60
lines changed

14 files changed

+223
-60
lines changed

‎CHANGES.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Changes
1313
- Remove deprecated ``Botan`` import from ``utils`` (``Botan`` is still available through ``contrib``).
1414
- Remove deprecated ``ReplyKeyboardHide``.
1515
- Remove deprecated ``edit_message`` argument of `bot.set_game_score``.
16+
- Add the possibility to add objects as arguments to send_* methods.
1617

1718
**2017-06-18**
1819

‎telegram/bot.py‎

Lines changed: 120 additions & 45 deletions
Large diffs are not rendered by default.

‎telegram/files/sticker.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ class MaskPosition(TelegramObject):
149149
size, from left to right.
150150
y_shift (:obj:`float`): Shift by Y-axis measured in heights of the mask scaled to the face
151151
size, from top to bottom.
152-
zoom (:obj:`float`): Mask scaling coefficient. For example, 2.0 means double size.
152+
scale (:obj:`float`): Mask scaling coefficient. For example, 2.0 means double size.
153153
154154
Notes:
155155
:attr:`type` should be one of the following: `forehead`, `eyes`, `mouth` or `chin`. You can
@@ -163,7 +163,7 @@ class MaskPosition(TelegramObject):
163163
y_shift (:obj:`float`): Shift by Y-axis measured in heights of the mask scaled to the face
164164
size, from top to bottom. For example, 1.0 will place the mask just below the default
165165
mask position.
166-
zoom (:obj:`float`): Mask scaling coefficient. For example, 2.0 means double size.
166+
scale (:obj:`float`): Mask scaling coefficient. For example, 2.0 means double size.
167167
"""
168168

169169
FOREHEAD = 'forehead'
@@ -175,11 +175,11 @@ class MaskPosition(TelegramObject):
175175
CHIN = 'chin'
176176
""":obj:`str`: 'chin'"""
177177

178-
def __init__(self, point, x_shift, y_shift, zoom, **kwargs):
178+
def __init__(self, point, x_shift, y_shift, scale, **kwargs):
179179
self.point = point
180180
self.x_shift = x_shift
181181
self.y_shift = y_shift
182-
self.zoom = zoom
182+
self.scale = scale
183183

184184
@classmethod
185185
def de_json(cls, data, bot):

‎tests/test_audio.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,14 @@ def test_send_audio_resend(self):
155155

156156
self.assertEqual(audio, self.audio)
157157

158+
@flaky(3, 1)
159+
@timeout(10)
160+
def test_send_audio_with_audio(self):
161+
message = self._bot.send_audio(audio=self.audio, chat_id=self._chat_id)
162+
audio = message.audio
163+
164+
self.assertEqual(audio, self.audio)
165+
158166
def test_audio_de_json(self):
159167
audio = telegram.Audio.de_json(self.json_dict, self._bot)
160168

‎tests/test_contact.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,13 @@ def test_contact_de_json(self):
5353
self.assertEqual(contact.last_name, self.last_name)
5454
self.assertEqual(contact.user_id, self.user_id)
5555

56+
def test_send_contact_with_contact(self):
57+
con = telegram.Contact.de_json(self.json_dict, self._bot)
58+
message = self._bot.send_contact(contact=con, chat_id=self._chat_id)
59+
contact = message.contact
60+
61+
self.assertEqual(contact, con)
62+
5663
def test_contact_to_json(self):
5764
contact = telegram.Contact.de_json(self.json_dict, self._bot)
5865

‎tests/test_document.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,15 @@ def test_send_document_resend(self):
132132

133133
self.assertEqual(document, self.document)
134134

135+
@flaky(3, 1)
136+
@timeout(10)
137+
def test_send_document_with_document(self):
138+
message = self._bot.send_document(document=self.document, chat_id=self._chat_id)
139+
document = message.document
140+
141+
self.assertEqual(document, self.document)
142+
143+
135144
def test_document_de_json(self):
136145
document = telegram.Document.de_json(self.json_dict, self._bot)
137146

‎tests/test_location.py‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,13 @@ def test_send_location_explicit_args(self):
5555
self.assertEqual(location.latitude, self.latitude)
5656
self.assertEqual(location.longitude, self.longitude)
5757

58+
def test_send_location_with_location(self):
59+
loc = telegram.Location(longitude=self.longitude, latitude=self.latitude)
60+
message = self._bot.send_location(location=loc, chat_id=self._chat_id)
61+
location = message.location
62+
63+
self.assertEqual(location, loc)
64+
5865
def test_location_de_json(self):
5966
location = telegram.Location.de_json(self.json_dict, self._bot)
6067

@@ -78,19 +85,17 @@ def test_error_send_location_empty_args(self):
7885
json_dict['latitude'] = ''
7986
json_dict['longitude'] = ''
8087

81-
self.assertRaises(telegram.TelegramError,
82-
lambda: self._bot.sendLocation(chat_id=self._chat_id,
83-
**json_dict))
88+
with self.assertRaises(TypeError):
89+
self._bot.sendLocation(chat_id=self._chat_id, **json_dict)
8490

8591
def test_error_location_without_required_args(self):
8692
json_dict = self.json_dict
8793

8894
del (json_dict['latitude'])
8995
del (json_dict['longitude'])
9096

91-
self.assertRaises(TypeError,
92-
lambda: self._bot.sendLocation(chat_id=self._chat_id,
93-
**json_dict))
97+
with self.assertRaises(ValueError):
98+
self._bot.sendLocation(chat_id=self._chat_id, **json_dict)
9499

95100
@flaky(3, 1)
96101
def test_reply_location(self):

‎tests/test_official.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ def check_method(h4):
6363
ignored |= {'filename'} # Undocumented
6464
elif name == 'setGameScore':
6565
ignored |= {'edit_message'} # TODO: Now deprecated, so no longer in telegrams docs
66+
elif name == 'sendContact':
67+
ignored |= {'contact'} # Added for ease of use
68+
elif name == 'sendLocation':
69+
ignored |= {'location'} # Added for ease of use
70+
elif name == 'sendVenue':
71+
ignored |= {'venue'} # Added for ease of use
6672

6773
logger.debug((sig.parameters.keys(), checked, ignored,
6874
sig.parameters.keys() - checked - ignored))

‎tests/test_photo.py‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,8 @@ def test_send_photo_bytesio_jpg_file(self):
181181
@flaky(3, 1)
182182
@timeout(10)
183183
def test_silent_send_photo(self):
184-
message = self._bot.sendPhoto(photo=self.photo_file, chat_id=self._chat_id, disable_notification=True)
184+
message = self._bot.sendPhoto(photo=self.photo_file, chat_id=self._chat_id,
185+
disable_notification=True)
185186
thumb, photo = message.photo
186187

187188
self.assertIsInstance(thumb, telegram.PhotoSize)
@@ -192,6 +193,15 @@ def test_silent_send_photo(self):
192193
self.assertIsInstance(photo.file_id, str)
193194
self.assertNotEqual(photo.file_id, '')
194195

196+
@flaky(3, 1)
197+
@timeout(10)
198+
def test_send_photo_with_photosize(self):
199+
message = self._bot.send_photo(photo=self.photo, chat_id=self._chat_id)
200+
thumb, photo = message.photo
201+
202+
self.assertEqual(photo, self.photo)
203+
self.assertEqual(thumb, self.thumb)
204+
195205
@flaky(3, 1)
196206
@timeout(10)
197207
def test_send_photo_resend(self):

‎tests/test_sticker.py‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,15 @@ def test_sticker_de_json(self):
152152
self.assertEqual(sticker.emoji, self.emoji)
153153
self.assertEqual(sticker.file_size, self.sticker.file_size)
154154

155+
@flaky(3, 1)
156+
@timeout(10)
157+
def test_send_sticker_with_sticker(self):
158+
message = self._bot.send_sticker(sticker=self.sticker, chat_id=self._chat_id)
159+
sticker = message.sticker
160+
161+
self.assertEqual(sticker, self.sticker)
162+
163+
155164
def test_sticker_to_json(self):
156165
self.assertTrue(self.is_json(self.sticker.to_json()))
157166

@@ -288,13 +297,13 @@ def setUp(self):
288297
self.point = telegram.MaskPosition.EYES
289298
self.x_shift = -1
290299
self.y_shift = 1
291-
self.zoom = 2
300+
self.scale = 2
292301

293302
self.json_dict = {
294303
'point': self.point,
295304
'x_shift': self.x_shift,
296305
'y_shift': self.y_shift,
297-
'zoom': self.zoom
306+
'scale': self.scale
298307
}
299308

300309
def test_mask_position_de_json(self):
@@ -303,7 +312,7 @@ def test_mask_position_de_json(self):
303312
self.assertEqual(mask_position.point, self.point)
304313
self.assertEqual(mask_position.x_shift, self.x_shift)
305314
self.assertEqual(mask_position.y_shift, self.y_shift)
306-
self.assertEqual(mask_position.zoom, self.zoom)
315+
self.assertEqual(mask_position.scale, self.scale)
307316

308317
def test_mask_positiont_to_json(self):
309318
mask_position = telegram.MaskPosition.de_json(self.json_dict, self._bot)

0 commit comments

Comments
 (0)