keyboa.button.Button._raw_tuple_from_button_data() - Code Metrics - Inspection of "Add __call__ method for class Button" - torrua/keyboa - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#18)

unknown

created 2021-10-01 04:54 UTC

keyboa.button.Button._raw_tuple_from_button_data() A

↳ Parent: keyboa.button

Complexity

Conditions

Size

Total Lines	23
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	5

Importance

Changes

Metric	Value
cc	5
eloc	14
nop	1
dl	0
loc	23
ccs	11
cts	11
cp	1
crap	5
rs	9.2333
c	0
b	0
f	0

# -*- coding:utf-8 -*-
"""
This module contains all the necessary functions for
creating buttons for telegram inline keyboards.
"""
from dataclasses import dataclass
from typing import Optional
from telebot.types import InlineKeyboardButton
from keyboa.button_check import ButtonCheck
from keyboa.constants import (
    InlineButtonData,
    CallbackDataMarker,
    callback_data_types,
    button_text_types,
    ButtonText,
)


@dataclass
class Button(ButtonCheck):
    """Default Button class
    :button_data: InlineButtonData - an object from which the button will be created:
    • If string or an integer, it will be used for both text and callback.
    • If tuple, the zero element [0] will be the text, and the first [1] will be the callback.
    • If dictionary, there are two options:
        > if there is no "text" key in dictionary and only one key exists,
            the key will be the text, and the value will be the callback.
            In this case, no verification of the dictionary's contents is performed!
        > if "text" key exists, function passes the whole dictionary to InlineKeyboardButton,
            where dictionary's keys represent object's parameters
            and dictionary's values represent parameters' values accordingly.
        In all other cases ValueError will be called.

    :front_marker: CallbackDataMarker - a string to be added to the left side of callback.
        Optional. The default value is None.

    :back_marker: CallbackDataMarker - a string to be added to the right side of callback.
        Optional. The default value is None.

    :copy_text_to_callback: If enabled and button_data is a string or integer,
        function will copy button text to callback data (and add markers if they exist).
        Optional. The default value is False."""

    button_data: InlineButtonData = None
    front_marker: CallbackDataMarker = str()
    back_marker: CallbackDataMarker = str()
    copy_text_to_callback: Optional[bool] = None

    def __call__(self, *args, **kwargs):
        return self.generate()

    def generate(self) -> InlineKeyboardButton:
        """
        This function creates an InlineKeyboardButton object from various data types,
        such as str, int, tuple, dict.
        :return: InlineKeyboardButton

        Covered by tests.
        """

        if isinstance(self.button_data, InlineKeyboardButton):
            return self.button_data

        if isinstance(self.button_data, dict) and self.button_data.get("text"):
            return InlineKeyboardButton(**self.button_data)

        self.is_auto_copy_text_to_callback()

        button_tuple = self._verified_button_tuple
        text = self.get_text(button_tuple)
        raw_callback = self.get_callback(button_tuple)
        callback_data = self.get_callback_data(
            raw_callback, self.front_marker, self.back_marker
        )

        prepared_button = {"text": text, "callback_data": callback_data}

        return InlineKeyboardButton(**prepared_button)

    @property
    def button(self):
        return self.generate()

    def is_auto_copy_text_to_callback(self):
        """
        Enable copy_text_to_callback parameter if button_data is str or int
        :return:
        """
        if self.copy_text_to_callback is None and isinstance(
            self.button_data, (str, int)
        ):
            self.copy_text_to_callback = True

    @classmethod
    def get_callback(cls, button_data: tuple) -> str:
        """
        :param button_data:
        :return:
        """
        callback = button_data[1]
        cls.is_callback_proper_type(callback)
        return callback

    @classmethod
    def get_callback_data(
        cls,
        raw_callback: CallbackDataMarker,
        front_marker: CallbackDataMarker = str(),
        back_marker: CallbackDataMarker = str(),
    ) -> str:
        """
        :param raw_callback:
        :param front_marker:
        :param back_marker:
        :return:
        """

        front_marker = cls.get_checked_marker(front_marker)
        back_marker = cls.get_checked_marker(back_marker)

        callback_data = "%s%s%s" % (front_marker, raw_callback, back_marker)

        if not callback_data:
            raise ValueError("The callback data cannot be empty.")

        cls.is_callback_data_in_limits(callback_data)

        return callback_data

    @staticmethod
    def get_checked_marker(marker: CallbackDataMarker) -> CallbackDataMarker:
        """
        :param marker:
        :return:
        """
        if marker is None:
            marker = str()

        if not isinstance(marker, callback_data_types):
            type_error_message = "Marker could not have %s type. Only %s allowed." % (
                type(marker),
                CallbackDataMarker,
            )
            raise TypeError(type_error_message)

        return marker

    @staticmethod
    def get_text(button_data: tuple) -> str:
        """
        :param button_data:
        :return:
        """
        raw_text = button_data[0]
        if not isinstance(raw_text, button_text_types):
            type_error_message = "Button text cannot be %s. Only %s allowed." % (
                type(raw_text),
                ButtonText,
            )
            raise TypeError(type_error_message)
        text = str(raw_text)
        if not text:
            raise ValueError("Button text cannot be empty.")
        return text

    @property
    def _verified_button_tuple(self) -> tuple:
        """
        :return:
        """
        self.is_button_data_proper_type(self.button_data)

        btn_tuple = self._raw_tuple_from_button_data

        if len(btn_tuple) == 1 or btn_tuple[1] is None:
            btn_tuple = (
                btn_tuple[0],
                btn_tuple[0] if self.copy_text_to_callback else str(),
            )
        return btn_tuple

    @property
    def _raw_tuple_from_button_data(self) -> tuple:
        """
        :return:
        """
        if isinstance(self.button_data, (str, int)):
            btn_tuple = (
                self.button_data,
                self.button_data if self.copy_text_to_callback else str(),
            )

        elif isinstance(self.button_data, dict):
            if len(self.button_data.keys()) != 1:
                value_type_error = (
                    "Cannot convert dictionary to InlineButtonData object. "
                    "You passed more than one item, but did not add 'text' key."
                )
                raise ValueError(value_type_error)

            btn_tuple = next(iter(self.button_data.items()))
        else:
            btn_tuple = self.button_data
        return btn_tuple


1		# -- coding:utf-8 --
2	1	"""
3		This module contains all the necessary functions for
4		creating buttons for telegram inline keyboards.
5		"""
6	1	from dataclasses import dataclass
7	1	from typing import Optional
8	1	from telebot.types import InlineKeyboardButton
9	1	from keyboa.button_check import ButtonCheck
10	1	from keyboa.constants import (
11		InlineButtonData,
12		CallbackDataMarker,
13		callback_data_types,
14		button_text_types,
15		ButtonText,
16		)
17
18
19	1	@dataclass
20	1	class Button(ButtonCheck):
21		"""Default Button class
22		:button_data: InlineButtonData - an object from which the button will be created:
23		• If string or an integer, it will be used for both text and callback.
24		• If tuple, the zero element [0] will be the text, and the first [1] will be the callback.
25		• If dictionary, there are two options:
26		> if there is no "text" key in dictionary and only one key exists,
27		the key will be the text, and the value will be the callback.
28		In this case, no verification of the dictionary's contents is performed!
29		> if "text" key exists, function passes the whole dictionary to InlineKeyboardButton,
30		where dictionary's keys represent object's parameters
31		and dictionary's values represent parameters' values accordingly.
32		In all other cases ValueError will be called.
33
34		:front_marker: CallbackDataMarker - a string to be added to the left side of callback.
35		Optional. The default value is None.
36
37		:back_marker: CallbackDataMarker - a string to be added to the right side of callback.
38		Optional. The default value is None.
39
40		:copy_text_to_callback: If enabled and button_data is a string or integer,
41		function will copy button text to callback data (and add markers if they exist).
42		Optional. The default value is False."""
43
44	1	button_data: InlineButtonData = None
45	1	front_marker: CallbackDataMarker = str()
46	1	back_marker: CallbackDataMarker = str()
47	1	copy_text_to_callback: Optional[bool] = None
48
49	1	def __call__(self, args, *kwargs):
50	1	return self.generate()
51
52	1	def generate(self) -> InlineKeyboardButton:
53		"""
54		This function creates an InlineKeyboardButton object from various data types,
55		such as str, int, tuple, dict.
56		:return: InlineKeyboardButton
57
58		Covered by tests.
59		"""
60
61	1	if isinstance(self.button_data, InlineKeyboardButton):
62	1	return self.button_data
63
64	1	if isinstance(self.button_data, dict) and self.button_data.get("text"):
65	1	return InlineKeyboardButton(**self.button_data)
66
67	1	self.is_auto_copy_text_to_callback()
68
69	1	button_tuple = self._verified_button_tuple
70	1	text = self.get_text(button_tuple)
71	1	raw_callback = self.get_callback(button_tuple)
72	1	callback_data = self.get_callback_data(
73		raw_callback, self.front_marker, self.back_marker
74		)
75
76	1	prepared_button = {"text": text, "callback_data": callback_data}
77
78	1	return InlineKeyboardButton(**prepared_button)
79
80	1	@property
81		def button(self):
82	1	return self.generate()
83
84	1	def is_auto_copy_text_to_callback(self):
85		"""
86		Enable copy_text_to_callback parameter if button_data is str or int
87		:return:
88		"""
89	1	if self.copy_text_to_callback is None and isinstance(
90		self.button_data, (str, int)
91		):
92	1	self.copy_text_to_callback = True
93
94	1	@classmethod
95	1	def get_callback(cls, button_data: tuple) -> str:
96		"""
97		:param button_data:
98		:return:
99		"""
100	1	callback = button_data[1]
101	1	cls.is_callback_proper_type(callback)
102	1	return callback
103
104	1	@classmethod
105	1	def get_callback_data(
106		cls,
107		raw_callback: CallbackDataMarker,
108		front_marker: CallbackDataMarker = str(),
109		back_marker: CallbackDataMarker = str(),
110		) -> str:
111		"""
112		:param raw_callback:
113		:param front_marker:
114		:param back_marker:
115		:return:
116		"""
117
118	1	front_marker = cls.get_checked_marker(front_marker)
119	1	back_marker = cls.get_checked_marker(back_marker)
120
121	1	callback_data = "%s%s%s" % (front_marker, raw_callback, back_marker)
122
123	1	if not callback_data:
124	1	raise ValueError("The callback data cannot be empty.")
125
126	1	cls.is_callback_data_in_limits(callback_data)
127
128	1	return callback_data
129
130	1	@staticmethod
131	1	def get_checked_marker(marker: CallbackDataMarker) -> CallbackDataMarker:
132		"""
133		:param marker:
134		:return:
135		"""
136	1	if marker is None:
137	1	marker = str()
138
139	1	if not isinstance(marker, callback_data_types):
140	1	type_error_message = "Marker could not have %s type. Only %s allowed." % (
141		type(marker),
142		CallbackDataMarker,
143		)
144	1	raise TypeError(type_error_message)
145
146	1	return marker
147
148	1	@staticmethod
149	1	def get_text(button_data: tuple) -> str:
150		"""
151		:param button_data:
152		:return:
153		"""
154	1	raw_text = button_data[0]
155	1	if not isinstance(raw_text, button_text_types):
156	1	type_error_message = "Button text cannot be %s. Only %s allowed." % (
157		type(raw_text),
158		ButtonText,
159		)
160	1	raise TypeError(type_error_message)
161	1	text = str(raw_text)
162	1	if not text:
163	1	raise ValueError("Button text cannot be empty.")
164	1	return text
165
166	1	@property
167	1	def _verified_button_tuple(self) -> tuple:
168		"""
169		:return:
170		"""
171	1	self.is_button_data_proper_type(self.button_data)
172
173	1	btn_tuple = self._raw_tuple_from_button_data
174
175	1	if len(btn_tuple) == 1 or btn_tuple[1] is None:
176	1	btn_tuple = (
177		btn_tuple[0],
178		btn_tuple[0] if self.copy_text_to_callback else str(),
179		)
180	1	return btn_tuple
181
182	1	@property
183	1	def _raw_tuple_from_button_data(self) -> tuple:
184		"""
185		:return:
186		"""
187	1	if isinstance(self.button_data, (str, int)):
188	1	btn_tuple = (
189		self.button_data,
190		self.button_data if self.copy_text_to_callback else str(),
191		)
192
193	1	elif isinstance(self.button_data, dict):
194	1	if len(self.button_data.keys()) != 1:
195	1	value_type_error = (
196		"Cannot convert dictionary to InlineButtonData object. "
197		"You passed more than one item, but did not add 'text' key."
198		)
199	1	raise ValueError(value_type_error)
200
201	1	btn_tuple = next(iter(self.button_data.items()))
202		else:
203	1	btn_tuple = self.button_data
204		return btn_tuple
205

torrua / keyboa

Pull Request — master (#18)

keyboa.button.Button._raw_tuple_from_button_data() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like