python-telegram-bot/tests/_inline/test_inlinequeryresultvenue.py

#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2023
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser Public License for more details.
#
# You should have received a copy of the GNU Lesser Public License
# along with this program.  If not, see [http://www.gnu.org/licenses/].
import pytest

from telegram import (
    InlineKeyboardButton,
    InlineKeyboardMarkup,
    InlineQueryResultVenue,
    InlineQueryResultVoice,
    InputTextMessageContent,
)
from tests.auxil.deprecations import check_thumb_deprecation_warnings_for_args_and_attrs
from tests.auxil.slots import mro_slots


@pytest.fixture(scope="module")
def inline_query_result_venue():
    return InlineQueryResultVenue(
        TestInlineQueryResultVenueBase.id_,
        TestInlineQueryResultVenueBase.latitude,
        TestInlineQueryResultVenueBase.longitude,
        TestInlineQueryResultVenueBase.title,
        TestInlineQueryResultVenueBase.address,
        foursquare_id=TestInlineQueryResultVenueBase.foursquare_id,
        foursquare_type=TestInlineQueryResultVenueBase.foursquare_type,
        thumbnail_url=TestInlineQueryResultVenueBase.thumbnail_url,
        thumbnail_width=TestInlineQueryResultVenueBase.thumbnail_width,
        thumbnail_height=TestInlineQueryResultVenueBase.thumbnail_height,
        input_message_content=TestInlineQueryResultVenueBase.input_message_content,
        reply_markup=TestInlineQueryResultVenueBase.reply_markup,
        google_place_id=TestInlineQueryResultVenueBase.google_place_id,
        google_place_type=TestInlineQueryResultVenueBase.google_place_type,
    )


class TestInlineQueryResultVenueBase:
    id_ = "id"
    type_ = "venue"
    latitude = "latitude"
    longitude = "longitude"
    title = "title"
    address = "address"
    foursquare_id = "foursquare id"
    foursquare_type = "foursquare type"
    google_place_id = "google place id"
    google_place_type = "google place type"
    thumbnail_url = "thumb url"
    thumbnail_width = 10
    thumbnail_height = 15
    input_message_content = InputTextMessageContent("input_message_content")
    reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]])


class TestInlineQueryResultVenueWithoutRequest(TestInlineQueryResultVenueBase):
    def test_slot_behaviour(self, inline_query_result_venue):
        inst = inline_query_result_venue
        for attr in inst.__slots__:
            assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
        assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"

    def test_expected_values(self, inline_query_result_venue):
        assert inline_query_result_venue.id == self.id_
        assert inline_query_result_venue.type == self.type_
        assert inline_query_result_venue.latitude == self.latitude
        assert inline_query_result_venue.longitude == self.longitude
        assert inline_query_result_venue.title == self.title
        assert inline_query_result_venue.address == self.address
        assert inline_query_result_venue.foursquare_id == self.foursquare_id
        assert inline_query_result_venue.foursquare_type == self.foursquare_type
        assert inline_query_result_venue.google_place_id == self.google_place_id
        assert inline_query_result_venue.google_place_type == self.google_place_type
        assert inline_query_result_venue.thumbnail_url == self.thumbnail_url
        assert inline_query_result_venue.thumbnail_width == self.thumbnail_width
        assert inline_query_result_venue.thumbnail_height == self.thumbnail_height
        assert (
            inline_query_result_venue.input_message_content.to_dict()
            == self.input_message_content.to_dict()
        )
        assert inline_query_result_venue.reply_markup.to_dict() == self.reply_markup.to_dict()

    def test_thumb_url_property_deprecation_warning(self, recwarn):
        inline_query_result_venue = InlineQueryResultVenue(
            TestInlineQueryResultVenueBase.id_,
            TestInlineQueryResultVenueBase.latitude,
            TestInlineQueryResultVenueBase.longitude,
            TestInlineQueryResultVenueBase.title,
            TestInlineQueryResultVenueBase.address,
            foursquare_id=TestInlineQueryResultVenueBase.foursquare_id,
            foursquare_type=TestInlineQueryResultVenueBase.foursquare_type,
            input_message_content=TestInlineQueryResultVenueBase.input_message_content,
            reply_markup=TestInlineQueryResultVenueBase.reply_markup,
            google_place_id=TestInlineQueryResultVenueBase.google_place_id,
            google_place_type=TestInlineQueryResultVenueBase.google_place_type,
            thumb_url=TestInlineQueryResultVenueBase.thumbnail_url,  # deprecated arg
            thumbnail_height=TestInlineQueryResultVenueBase.thumbnail_height,
            thumbnail_width=TestInlineQueryResultVenueBase.thumbnail_width,
        )
        assert inline_query_result_venue.thumb_url == inline_query_result_venue.thumbnail_url
        check_thumb_deprecation_warnings_for_args_and_attrs(
            recwarn, __file__, deprecated_name="thumb_url", new_name="thumbnail_url"
        )

    def test_thumb_height_property_deprecation_warning(self, recwarn):
        inline_query_result_venue = InlineQueryResultVenue(
            TestInlineQueryResultVenueBase.id_,
            TestInlineQueryResultVenueBase.latitude,
            TestInlineQueryResultVenueBase.longitude,
            TestInlineQueryResultVenueBase.title,
            TestInlineQueryResultVenueBase.address,
            foursquare_id=TestInlineQueryResultVenueBase.foursquare_id,
            foursquare_type=TestInlineQueryResultVenueBase.foursquare_type,
            input_message_content=TestInlineQueryResultVenueBase.input_message_content,
            reply_markup=TestInlineQueryResultVenueBase.reply_markup,
            google_place_id=TestInlineQueryResultVenueBase.google_place_id,
            google_place_type=TestInlineQueryResultVenueBase.google_place_type,
            thumbnail_url=TestInlineQueryResultVenueBase.thumbnail_url,
            thumb_height=TestInlineQueryResultVenueBase.thumbnail_height,  # deprecated arg
            thumbnail_width=TestInlineQueryResultVenueBase.thumbnail_width,
        )
        assert inline_query_result_venue.thumb_height == inline_query_result_venue.thumbnail_height
        check_thumb_deprecation_warnings_for_args_and_attrs(
            recwarn, __file__, deprecated_name="thumb_height", new_name="thumbnail_height"
        )

    def test_thumb_width_property_deprecation_warning(self, recwarn):
        inline_query_result_venue = InlineQueryResultVenue(
            TestInlineQueryResultVenueBase.id_,
            TestInlineQueryResultVenueBase.latitude,
            TestInlineQueryResultVenueBase.longitude,
            TestInlineQueryResultVenueBase.title,
            TestInlineQueryResultVenueBase.address,
            foursquare_id=TestInlineQueryResultVenueBase.foursquare_id,
            foursquare_type=TestInlineQueryResultVenueBase.foursquare_type,
            input_message_content=TestInlineQueryResultVenueBase.input_message_content,
            reply_markup=TestInlineQueryResultVenueBase.reply_markup,
            google_place_id=TestInlineQueryResultVenueBase.google_place_id,
            google_place_type=TestInlineQueryResultVenueBase.google_place_type,
            thumbnail_url=TestInlineQueryResultVenueBase.thumbnail_url,
            thumbnail_height=TestInlineQueryResultVenueBase.thumbnail_height,
            thumb_width=TestInlineQueryResultVenueBase.thumbnail_width,  # deprecated arg
        )
        assert inline_query_result_venue.thumb_width == inline_query_result_venue.thumbnail_width
        check_thumb_deprecation_warnings_for_args_and_attrs(
            recwarn, __file__, deprecated_name="thumb_width", new_name="thumbnail_width"
        )

    def test_throws_value_error_with_different_deprecated_and_new_arg_thumb_url(self):
        with pytest.raises(
            ValueError, match="different entities as 'thumb_url' and 'thumbnail_url'"
        ):
            InlineQueryResultVenue(
                TestInlineQueryResultVenueBase.id_,
                TestInlineQueryResultVenueBase.latitude,
                TestInlineQueryResultVenueBase.longitude,
                TestInlineQueryResultVenueBase.title,
                TestInlineQueryResultVenueBase.address,
                foursquare_id=TestInlineQueryResultVenueBase.foursquare_id,
                foursquare_type=TestInlineQueryResultVenueBase.foursquare_type,
                input_message_content=TestInlineQueryResultVenueBase.input_message_content,
                reply_markup=TestInlineQueryResultVenueBase.reply_markup,
                google_place_id=TestInlineQueryResultVenueBase.google_place_id,
                google_place_type=TestInlineQueryResultVenueBase.google_place_type,
                thumbnail_url=TestInlineQueryResultVenueBase.thumbnail_url,
                thumb_url="some other url",
                thumbnail_height=TestInlineQueryResultVenueBase.thumbnail_height,
                thumbnail_width=TestInlineQueryResultVenueBase.thumbnail_width,
            )

    def test_throws_value_error_with_different_deprecated_and_new_arg_thumb_height(self):
        with pytest.raises(
            ValueError, match="different entities as 'thumb_height' and 'thumbnail_height'"
        ):
            InlineQueryResultVenue(
                TestInlineQueryResultVenueBase.id_,
                TestInlineQueryResultVenueBase.latitude,
                TestInlineQueryResultVenueBase.longitude,
                TestInlineQueryResultVenueBase.title,
                TestInlineQueryResultVenueBase.address,
                foursquare_id=TestInlineQueryResultVenueBase.foursquare_id,
                foursquare_type=TestInlineQueryResultVenueBase.foursquare_type,
                input_message_content=TestInlineQueryResultVenueBase.input_message_content,
                reply_markup=TestInlineQueryResultVenueBase.reply_markup,
                google_place_id=TestInlineQueryResultVenueBase.google_place_id,
                google_place_type=TestInlineQueryResultVenueBase.google_place_type,
                thumbnail_url=TestInlineQueryResultVenueBase.thumbnail_url,
                thumbnail_height=TestInlineQueryResultVenueBase.thumbnail_height,
                thumb_height=TestInlineQueryResultVenueBase.thumbnail_height + 1,
                thumbnail_width=TestInlineQueryResultVenueBase.thumbnail_width,
            )

    def test_throws_value_error_with_different_deprecated_and_new_arg_thumb_width(self):
        with pytest.raises(
            ValueError, match="different entities as 'thumb_width' and 'thumbnail_width'"
        ):
            InlineQueryResultVenue(
                TestInlineQueryResultVenueBase.id_,
                TestInlineQueryResultVenueBase.latitude,
                TestInlineQueryResultVenueBase.longitude,
                TestInlineQueryResultVenueBase.title,
                TestInlineQueryResultVenueBase.address,
                foursquare_id=TestInlineQueryResultVenueBase.foursquare_id,
                foursquare_type=TestInlineQueryResultVenueBase.foursquare_type,
                input_message_content=TestInlineQueryResultVenueBase.input_message_content,
                reply_markup=TestInlineQueryResultVenueBase.reply_markup,
                google_place_id=TestInlineQueryResultVenueBase.google_place_id,
                google_place_type=TestInlineQueryResultVenueBase.google_place_type,
                thumbnail_url=TestInlineQueryResultVenueBase.thumbnail_url,
                thumbnail_height=TestInlineQueryResultVenueBase.thumbnail_height,
                thumbnail_width=TestInlineQueryResultVenueBase.thumbnail_width,
                thumb_width=TestInlineQueryResultVenueBase.thumbnail_width + 1,
            )

    def test_to_dict(self, inline_query_result_venue):
        inline_query_result_venue_dict = inline_query_result_venue.to_dict()

        assert isinstance(inline_query_result_venue_dict, dict)
        assert inline_query_result_venue_dict["id"] == inline_query_result_venue.id
        assert inline_query_result_venue_dict["type"] == inline_query_result_venue.type
        assert inline_query_result_venue_dict["latitude"] == inline_query_result_venue.latitude
        assert inline_query_result_venue_dict["longitude"] == inline_query_result_venue.longitude
        assert inline_query_result_venue_dict["title"] == inline_query_result_venue.title
        assert inline_query_result_venue_dict["address"] == inline_query_result_venue.address
        assert (
            inline_query_result_venue_dict["foursquare_id"]
            == inline_query_result_venue.foursquare_id
        )
        assert (
            inline_query_result_venue_dict["foursquare_type"]
            == inline_query_result_venue.foursquare_type
        )
        assert (
            inline_query_result_venue_dict["google_place_id"]
            == inline_query_result_venue.google_place_id
        )
        assert (
            inline_query_result_venue_dict["google_place_type"]
            == inline_query_result_venue.google_place_type
        )
        assert (
            inline_query_result_venue_dict["thumbnail_url"]
            == inline_query_result_venue.thumbnail_url
        )
        assert (
            inline_query_result_venue_dict["thumbnail_width"]
            == inline_query_result_venue.thumbnail_width
        )
        assert (
            inline_query_result_venue_dict["thumbnail_height"]
            == inline_query_result_venue.thumbnail_height
        )
        assert (
            inline_query_result_venue_dict["input_message_content"]
            == inline_query_result_venue.input_message_content.to_dict()
        )
        assert (
            inline_query_result_venue_dict["reply_markup"]
            == inline_query_result_venue.reply_markup.to_dict()
        )

    def test_equality(self):
        a = InlineQueryResultVenue(
            self.id_, self.longitude, self.latitude, self.title, self.address
        )
        b = InlineQueryResultVenue(
            self.id_, self.longitude, self.latitude, self.title, self.address
        )
        c = InlineQueryResultVenue(self.id_, "", self.latitude, self.title, self.address)
        d = InlineQueryResultVenue("", self.longitude, self.latitude, self.title, self.address)
        e = InlineQueryResultVoice(self.id_, "", "")

        assert a == b
        assert hash(a) == hash(b)
        assert a is not b

        assert a == c
        assert hash(a) == hash(c)

        assert a != d
        assert hash(a) != hash(d)

        assert a != e
        assert hash(a) != hash(e)