Passed
Push — master ( 449b8d...1f3828 )
by torrua
01:12
created

app.bot.telegram.models   A

Complexity

Total Complexity 31

Size/Duplication

Total Lines 317
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
wmc 31
eloc 180
dl 0
loc 317
rs 9.92
c 0
b 0
f 0

12 Methods

Rating   Name   Duplication   Size   Complexity  
A TelegramWord.translation_by_key() 0 32 2
A TelegramWord.by_request() 0 12 2
A TelegramWord._keyboard_hide() 0 15 1
A TelegramDefinition.export() 0 22 3
B TelegramWord.keyboard_cpx() 0 37 5
B TelegramWord.export() 0 30 6
A TelegramWord._get_delimiter() 0 14 4
A TelegramWord._keyboard_show() 0 18 1
A TelegramWord._keyboard_data() 0 20 1
A TelegramWord.send_card_to_user() 0 11 1
A TelegramWord._keyboard_navi() 0 39 3
A TelegramWord.get_definitions() 0 11 1

1 Function

Rating   Name   Duplication   Size   Complexity  
A kb_close() 0 5 1
1
# -*- coding: utf-8 -*-
2
"""Model of LOD database for Telegram"""
3
4
from collections import defaultdict
5
6
from callbaker import callback_from_info
7
from keyboa import Keyboa
8
from loglan_core.addons.word_getter import AddonWordGetter
9
from loglan_core.connect_tables import t_connect_keys
10
from loglan_core.definition import BaseDefinition
11
from loglan_core.key import BaseKey
12
from loglan_core.word import BaseWord
13
14
from app.bot.telegram import MIN_NUMBER_OF_BUTTONS
15
from app.bot.telegram.variables import (
16
    t,
17
    cbd,
18
    mark_action,
19
    mark_entity,
20
    mark_record_id,
21
    mark_slice_start,
22
    action_predy_send_card,
23
    entity_predy,
24
    action_predy_kb_cpx_show,
25
    action_predy_kb_cpx_hide,
26
)
27
28
29
class TelegramDefinition(BaseDefinition):
30
    """Definition class extensions for Telegram"""
31
32
    def export(self):
33
        """
34
        Convert definition's data to str for sending as a telegram messages
35
        :return: Adopted for posting in telegram string
36
        """
37
        d_usage = f"<b>{self.usage.replace('%', '—')}</b> " if self.usage else ""
38
        d_grammar = (
39
            f"({self.slots if self.slots is not None else ''}{self.grammar_code}) "
40
        )
41
        d_body = (
42
            self.body.replace("<", "&#60;")
43
            .replace(">", "&#62;")
44
            .replace("«", "<i>")
45
            .replace("»", "</i>")
46
            .replace("{", "<code>")
47
            .replace("}", "</code>")
48
            .replace("....", "….")
49
            .replace("...", "…")
50
        )
51
52
        d_case_tags = f" [{self.case_tags}]" if self.case_tags else ""
53
        return f"{d_usage}{d_grammar}{d_body}{d_case_tags}"
54
55
56
class TelegramWord(BaseWord, AddonWordGetter):
57
    """Word class extensions for Telegram"""
58
59
    def export(self, session) -> str:
60
        """
61
        Convert word's data to str for sending as a telegram messages
62
        :return: List of str with technical info, definitions, used_in part
63
        """
64
65
        # Word
66
        list_of_afx = ["" + w.name for w in self.affixes]
67
        w_affixes = f" ({' '.join(list_of_afx)})" if list_of_afx else ""
68
        w_match = self.match + " " if self.match else ""
69
        w_year = "'" + str(self.year.year)[-2:] + " "
70
        w_origin_x = " = " + self.origin_x if self.origin_x else ""
71
        w_orig = (
72
            "\n<i>&#60;" + self.origin + w_origin_x + "&#62;</i>"
73
            if self.origin or w_origin_x
74
            else ""
75
        )
76
        w_authors = "/".join([a.abbreviation for a in self.authors]) + " "
77
        w_type = self.type.type + " "
78
        w_rank = self.rank + " " if self.rank else ""
79
        word_str = (
80
            f"<b>{self.name}</b>{w_affixes},"
81
            f"\n{w_match}{w_type}{w_authors}{w_year}{w_rank}{w_orig}"
82
        )
83
84
        # Definitions TODO maybe extract from method
85
        definitions_str = "\n\n".join(
86
            [d.export() for d in self.get_definitions(session=session)]
87
        )
88
        return f"{word_str}\n\n{definitions_str}"
89
90
    def get_definitions(self, session) -> list[TelegramDefinition]:
91
        """
92
        Get all definitions of the word
93
        :param session: Session
94
        :return: List of Definition objects ordered by position
95
        """
96
        return (
97
            session.query(TelegramDefinition)
98
            .filter(BaseDefinition.word_id == self.id)
99
            .order_by(BaseDefinition.position.asc())
100
            .all()
101
        )
102
103
    @classmethod
104
    def translation_by_key(cls, session, request: str, language: str = None) -> str:
105
        """
106
        We get information about loglan words by key in a foreign language
107
        :param session: Session
108
        :param request: Requested string
109
        :param language: Key language
110
        :return: Search results string formatted for sending to Telegram
111
        """
112
        words = (
113
            session.query(cls.name, TelegramDefinition)
114
            .join(BaseDefinition)
115
            .join(t_connect_keys)
116
            .join(BaseKey)
117
            .filter(BaseKey.word == request)
118
            .filter(BaseKey.language == language)
119
            .order_by(cls.id, BaseDefinition.position)
120
            .all()
121
        )
122
123
        result = defaultdict(list)
124
125
        for word in words:
126
            name, definition = word
127
            result[name].append(definition.export())
128
129
        new = "\n"
130
        word_items = [
131
            f"/{word_name},\n{new.join(definitions)}\n"
132
            for word_name, definitions in result.items()
133
        ]
134
        return new.join(word_items).strip()
135
136
    def _keyboard_navi(self, index_start: int, index_end: int, delimiter: int):
137
        """
138
        :param index_start:
139
        :param index_end:
140
        :param delimiter:
141
        :return:
142
        """
143
        text_arrow_back = "\U0000276E" * 2
144
        text_arrow_forward = "\U0000276F" * 2
145
        button_back, button_forward = None, None
146
147
        common_data = {
148
            mark_entity: entity_predy,
149
            mark_action: action_predy_kb_cpx_show,
150
            mark_record_id: self.id,
151
        }
152
153
        if index_start != 0:
154
            cbd_predy_kb_cpx_back = {
155
                **common_data,
156
                mark_slice_start: index_start - delimiter,
157
            }
158
            button_back = {
159
                t: text_arrow_back,
160
                cbd: callback_from_info(cbd_predy_kb_cpx_back),
161
            }
162
163
        if index_end != len(self.complexes):
164
            cbd_predy_kb_cpx_forward = {
165
                **common_data,
166
                mark_slice_start: index_end,
167
            }
168
            button_forward = {
169
                t: text_arrow_forward,
170
                cbd: callback_from_info(cbd_predy_kb_cpx_forward),
171
            }
172
173
        nav_row = [b for b in [button_back, button_forward] if b]
174
        return Keyboa(nav_row, items_in_row=2)()
175
176
    def _keyboard_hide(self, total_number_of_complexes: int):
177
        """
178
        :param total_number_of_complexes:
179
        :return:
180
        """
181
        text_cpx_hide = f"Hide Complex{'es' if total_number_of_complexes > 1 else ''}"
182
        cbd_predy_kb_cpx_hide = {
183
            mark_entity: entity_predy,
184
            mark_action: action_predy_kb_cpx_hide,
185
            mark_record_id: self.id,
186
        }
187
        button_predy_kb_cpx_hide = [
188
            {t: text_cpx_hide, cbd: callback_from_info(cbd_predy_kb_cpx_hide)},
189
        ]
190
        return Keyboa(button_predy_kb_cpx_hide)()
191
192
    def _keyboard_show(self, total_number_of_complexes: int):
193
        """
194
        :param total_number_of_complexes:
195
        :return:
196
        """
197
        text_cpx_show = (
198
            f"Show Complex{'es' if total_number_of_complexes > 1 else ''}"
199
            f" ({total_number_of_complexes})"
200
        )
201
        cbd_predy_kb_cpx_show = {
202
            mark_entity: entity_predy,
203
            mark_action: action_predy_kb_cpx_show,
204
            mark_record_id: self.id,
205
        }
206
        button_show = [
207
            {t: text_cpx_show, cbd: callback_from_info(cbd_predy_kb_cpx_show)},
208
        ]
209
        return Keyboa.combine((Keyboa(button_show)(), kb_close()))
210
211
    @staticmethod
212
    def _get_delimiter(total_number_of_complexes: int):
213
        """
214
        :param total_number_of_complexes:
215
        :return:
216
        """
217
        allowed_range = list(range(MIN_NUMBER_OF_BUTTONS, MIN_NUMBER_OF_BUTTONS + 11))
218
        lst = [(total_number_of_complexes % i, i) for i in allowed_range]
219
        delimiter = min(lst, key=lambda x: abs(x[0] - MIN_NUMBER_OF_BUTTONS))[1]
220
        for i in lst:
221
            if i[0] == 0:
222
                delimiter = i[1]
223
                break
224
        return delimiter
225
226
    @staticmethod
227
    def _keyboard_data(current_complexes: list):
228
        """
229
        :param current_complexes:
230
        :return:
231
        """
232
        cpx_items = [
233
            {
234
                t: cpx.name,
235
                cbd: callback_from_info(
236
                    {
237
                        mark_entity: entity_predy,
238
                        mark_action: action_predy_send_card,
239
                        mark_record_id: cpx.id,
240
                    }
241
                ),
242
            }
243
            for cpx in current_complexes
244
        ]
245
        return Keyboa(items=cpx_items, alignment=True, items_in_row=4)()
246
247
    def keyboard_cpx(self, show_list: bool = False, slice_start: int = 0):
248
        """
249
        :param show_list:
250
        :param slice_start:
251
        :return:
252
        """
253
254
        total_num_of_cpx = len(self.complexes)
255
256
        if not total_num_of_cpx:
257
            return kb_close()
258
259
        if not show_list:
260
            return self._keyboard_show(total_num_of_cpx)
261
262
        current_delimiter = self._get_delimiter(total_num_of_cpx)
263
264
        kb_cpx_hide = self._keyboard_hide(total_num_of_cpx)
265
266
        last_allowed_item = slice_start + current_delimiter
267
        slice_end = (
268
            last_allowed_item
269
            if last_allowed_item < total_num_of_cpx
270
            else total_num_of_cpx
271
        )
272
273
        current_cpx_set = self.complexes[slice_start:slice_end]
274
        kb_cpx_data = self._keyboard_data(current_cpx_set)
275
276
        kb_cpx_nav = None
277
278
        if total_num_of_cpx > current_delimiter:
279
            kb_cpx_nav = self._keyboard_navi(slice_start, slice_end, current_delimiter)
280
281
        kb_combo = (kb_cpx_hide, kb_cpx_data, kb_cpx_nav, kb_close())
282
283
        return Keyboa.combine(kb_combo)
284
285
    def send_card_to_user(self, session, bot, user_id: int | str):
286
        """
287
        :param session:
288
        :param bot:
289
        :param user_id:
290
        :return:
291
        """
292
        bot.send_message(
293
            chat_id=user_id,
294
            text=self.export(session),
295
            reply_markup=self.keyboard_cpx()
296
        )
297
298
    @classmethod
299
    def by_request(cls, session, request: str) -> list:
300
        """
301
        :param session:
302
        :param request:
303
        :return:
304
        """
305
        if isinstance(request, int):
306
            return [
307
                cls.get_by_id(session, request),
308
            ]
309
        return cls.by_name(session, request).all()
310
311
312
def kb_close():
313
    """
314
    :return:
315
    """
316
    return Keyboa({t: "Close", cbd: "close"})()
317