-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
clients.py
3235 lines (2637 loc) · 124 KB
/
clients.py
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
# BSD 3-Clause License
#
# Copyright (c) 2020-2024, Faster Speeding
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""Standard Tanjun client."""
from __future__ import annotations
__all__: list[str] = [
"Client",
"ClientCallbackNames",
"InteractionAcceptsEnum",
"MessageAcceptsEnum",
"PrefixGetterSig",
"as_loader",
"as_unloader",
"on_parser_error",
]
import asyncio
import dataclasses
import enum
import functools
import importlib
import importlib.abc
import importlib.util
import inspect
import itertools
import logging
import pathlib
import typing
import warnings
from collections import abc as collections
import alluka
import hikari
import hikari.traits
import typing_extensions
from . import _internal
from . import abc as tanjun
from . import context
from . import dependencies
from . import errors
from . import hooks
from ._internal import localisation
if typing.TYPE_CHECKING:
import types
from typing_extensions import Self
_CheckSigT = typing.TypeVar("_CheckSigT", bound=tanjun.AnyCheckSig)
_AppCmdResponse = typing.Union[
hikari.api.InteractionMessageBuilder, hikari.api.InteractionDeferredBuilder, hikari.api.InteractionModalBuilder
]
_EventT = typing.TypeVar("_EventT", bound=hikari.Event)
_ListenerCallbackSigT = typing.TypeVar("_ListenerCallbackSigT", bound=tanjun.ListenerCallbackSig[typing.Any])
_MetaEventSigT = typing.TypeVar("_MetaEventSigT", bound=tanjun.MetaEventSig)
_PrefixGetterSigT = typing.TypeVar("_PrefixGetterSigT", bound="PrefixGetterSig")
_T = typing.TypeVar("_T")
_P = typing_extensions.ParamSpec("_P")
class _AutocompleteContextMakerProto(typing.Protocol):
def __call__(
self,
client: tanjun.Client,
interaction: hikari.AutocompleteInteraction,
*,
future: typing.Optional[asyncio.Future[hikari.api.InteractionAutocompleteBuilder]] = None,
) -> context.AutocompleteContext:
raise NotImplementedError
class _MenuContextMakerProto(typing.Protocol):
def __call__(
self,
client: tanjun.Client,
interaction: hikari.CommandInteraction,
register_task: collections.Callable[[asyncio.Task[typing.Any]], None],
*,
default_to_ephemeral: bool = False,
future: typing.Optional[asyncio.Future[_AppCmdResponse]] = None,
on_not_found: typing.Optional[
collections.Callable[[tanjun.MenuContext], collections.Awaitable[None]]
] = None,
) -> context.MenuContext:
raise NotImplementedError
class _MessageContextMakerProto(typing.Protocol):
def __call__(
self,
client: tanjun.Client,
content: str,
message: hikari.Message,
register_task: collections.Callable[[asyncio.Task[typing.Any]], None],
*,
triggering_name: str = "",
triggering_prefix: str = "",
) -> context.MessageContext:
raise NotImplementedError
class _SlashContextMakerProto(typing.Protocol):
def __call__(
self,
client: tanjun.Client,
interaction: hikari.CommandInteraction,
register_task: collections.Callable[[asyncio.Task[typing.Any]], None],
*,
default_to_ephemeral: bool = False,
future: typing.Optional[asyncio.Future[_AppCmdResponse]] = None,
on_not_found: typing.Optional[
collections.Callable[[tanjun.SlashContext], collections.Awaitable[None]]
] = None,
) -> context.SlashContext:
raise NotImplementedError
class _GatewayBotProto(hikari.EventManagerAware, hikari.RESTAware, hikari.ShardAware, typing.Protocol):
"""Protocol of a cacheless Hikari Gateway bot."""
# 3.9 and 3.10 just can't handle ending Concatenate with ... so we lie about this at runtime.
if typing.TYPE_CHECKING:
PrefixGetterSig = collections.Callable[
typing_extensions.Concatenate[tanjun.MessageContext, ...],
collections.Coroutine[typing.Any, typing.Any, collections.Iterable[str]],
]
"""Type hint of a callable used to get the prefix(es) for a specific guild.
This represents the callback `async def (tanjun.abc.MessageContext, ...) -> collections.Iterable[str]`
where dependency injection is supported.
"""
else:
PrefixGetterSig = collections.Callable[
..., collections.Coroutine[typing.Any, typing.Any, collections.Iterable[str]]
]
_LOGGER: typing.Final[logging.Logger] = logging.getLogger("hikari.tanjun.clients")
_MENU_TYPES = frozenset((hikari.CommandType.MESSAGE, hikari.CommandType.USER))
class _LoaderDescriptor(tanjun.ClientLoader): # Slots mess with functools.update_wrapper
def __init__(
self,
callback: typing.Union[collections.Callable[[Client], None], collections.Callable[[tanjun.Client], None]],
standard_impl: bool,
) -> None:
self._callback = callback
self._must_be_std = standard_impl
functools.update_wrapper(self, callback)
@property
def has_load(self) -> bool:
return True
@property
def has_unload(self) -> bool:
return False
def __call__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
self._callback(*args, **kwargs)
def load(self, client: tanjun.Client, /) -> bool:
if self._must_be_std:
if not isinstance(client, Client):
raise TypeError("This loader requires instances of the standard Client implementation")
self._callback(client)
else:
typing.cast("collections.Callable[[tanjun.Client], None]", self._callback)(client)
return True
def unload(self, _: tanjun.Client, /) -> bool:
return False
class _UnloaderDescriptor(tanjun.ClientLoader): # Slots mess with functools.update_wrapper
def __init__(
self,
callback: typing.Union[collections.Callable[[Client], None], collections.Callable[[tanjun.Client], None]],
standard_impl: bool,
) -> None:
self._callback = callback
self._must_be_std = standard_impl
functools.update_wrapper(self, callback)
@property
def has_load(self) -> bool:
return False
@property
def has_unload(self) -> bool:
return True
def __call__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
self._callback(*args, **kwargs)
def load(self, _: tanjun.Client, /) -> bool:
return False
def unload(self, client: tanjun.Client, /) -> bool:
if self._must_be_std:
if not isinstance(client, Client):
raise TypeError("This unloader requires instances of the standard Client implementation")
self._callback(client)
else:
typing.cast("collections.Callable[[tanjun.Client], None]", self._callback)(client)
return True
@typing.overload
def as_loader(
callback: collections.Callable[[Client], None], /, *, standard_impl: typing.Literal[True] = True
) -> collections.Callable[[Client], None]:
...
@typing.overload
def as_loader(
*, standard_impl: typing.Literal[True] = True
) -> collections.Callable[[collections.Callable[[Client], None]], collections.Callable[[Client], None]]:
...
@typing.overload
def as_loader(
callback: collections.Callable[[tanjun.Client], None], /, *, standard_impl: typing.Literal[False]
) -> collections.Callable[[tanjun.Client], None]:
...
@typing.overload
def as_loader(
*, standard_impl: typing.Literal[False]
) -> collections.Callable[[collections.Callable[[tanjun.Client], None]], collections.Callable[[tanjun.Client], None]]:
...
def as_loader(
callback: typing.Union[
collections.Callable[[tanjun.Client], None], collections.Callable[[Client], None], None
] = None,
/,
*,
standard_impl: bool = True,
) -> typing.Union[
collections.Callable[[tanjun.Client], None],
collections.Callable[[Client], None],
collections.Callable[[collections.Callable[[Client], None]], collections.Callable[[Client], None]],
collections.Callable[[collections.Callable[[tanjun.Client], None]], collections.Callable[[tanjun.Client], None]],
]:
"""Mark a callback as being used to load Tanjun components from a module.
!!! note
This is only necessary if you wish to use
[Client.load_modules][tanjun.abc.Client.load_modules].
Parameters
----------
callback
The callback used to load Tanjun components from a module.
This should take one argument of type [Client][tanjun.Client] (or
[tanjun.abc.Client][] if `standard_impl` is [False][]), return nothing
and will be expected to initiate and add utilities such as components
to the provided client.
standard_impl
Whether this loader should only allow instances of
[Client][tanjun.Client] as opposed to [tanjun.abc.Client][].
Returns
-------
collections.abc.Callable[[tanjun.abc.Client], None]]
The decorated load callback.
"""
if callback:
return _LoaderDescriptor(callback, standard_impl)
def decorator(
callback: collections.Callable[[tanjun.Client], None], /
) -> collections.Callable[[tanjun.Client], None]:
return _LoaderDescriptor(callback, standard_impl)
return decorator
@typing.overload
def as_unloader(
callback: collections.Callable[[Client], None], /, *, standard_impl: typing.Literal[True] = True
) -> collections.Callable[[Client], None]:
...
@typing.overload
def as_unloader(
*, standard_impl: typing.Literal[True] = True
) -> collections.Callable[[collections.Callable[[Client], None]], collections.Callable[[Client], None]]:
...
@typing.overload
def as_unloader(
callback: collections.Callable[[tanjun.Client], None], /, *, standard_impl: typing.Literal[False]
) -> collections.Callable[[tanjun.Client], None]:
...
@typing.overload
def as_unloader(
*, standard_impl: typing.Literal[False]
) -> collections.Callable[[collections.Callable[[tanjun.Client], None]], collections.Callable[[tanjun.Client], None]]:
...
def as_unloader(
callback: typing.Union[
collections.Callable[[Client], None], collections.Callable[[tanjun.Client], None], None
] = None,
/,
*,
standard_impl: bool = True,
) -> typing.Union[
collections.Callable[[Client], None],
collections.Callable[[tanjun.Client], None],
collections.Callable[[collections.Callable[[Client], None]], collections.Callable[[Client], None]],
collections.Callable[[collections.Callable[[tanjun.Client], None]], collections.Callable[[tanjun.Client], None]],
]:
"""Mark a callback as being used to unload a module's utilities from a client.
!!! note
This is the inverse of [as_loader][tanjun.as_loader] and is only
necessary if you wish to use the
[Client.unload_modules][tanjun.abc.Client.unload_modules]
or [Client.reload_modules][tanjun.abc.Client.reload_modules].
Parameters
----------
callback
The callback used to unload Tanjun components from a module.
This should take one argument of type [Client][tanjun.Client] (or
[tanjun.abc.Client][] if `standard_impl` is [False][]), return nothing
and will be expected to remove utilities such as components from the
provided client.
standard_impl
Whether this unloader should only allow instances of
[Client][tanjun.Client] as opposed to [tanjun.abc.Client][].
Returns
-------
collections.abc.Callable[[tanjun.abc.Client], None]]
The decorated unload callback.
"""
if callback:
return _UnloaderDescriptor(callback, standard_impl)
def decorator(
callback: collections.Callable[[tanjun.Client], None], /
) -> collections.Callable[[tanjun.Client], None]:
return _UnloaderDescriptor(callback, standard_impl)
return decorator
ClientCallbackNames = tanjun.ClientCallbackNames
"""Alias of [ClientCallbackNames][tanjun.abc.ClientCallbackNames]."""
class InteractionAcceptsEnum(enum.IntFlag):
"""The possible configurations for which interaction this client should execute."""
NONE = 0
"""Set the client to execute no interactions."""
AUTOCOMPLETE = enum.auto()
"""Execute autocomplete interactions."""
COMMANDS = enum.auto()
"""Execute command interactions.
This includes slash command and context menu calls.
"""
ALL = AUTOCOMPLETE | COMMANDS
"""Execute all the interaction types Tanjun supports."""
class MessageAcceptsEnum(str, enum.Enum):
"""The possible configurations for which events [Client][tanjun.Client] should execute commands based on."""
ALL = "ALL"
"""Set the client to execute commands based on both DM and guild message create events."""
DM_ONLY = "DM_ONLY"
"""Set the client to execute commands based only DM message create events."""
GUILD_ONLY = "GUILD_ONLY"
"""Set the client to execute commands based only guild message create events."""
NONE = "NONE"
"""Set the client to not execute commands based on message create events."""
def get_event_type(self) -> typing.Optional[type[hikari.MessageCreateEvent]]:
"""Get the base event type this mode listens to.
Returns
-------
type[hikari.events.message_events.MessageCreateEvent] | None
The type object of the MessageCreateEvent class this mode will
register a listener for.
This will be [None][] if this mode disables listening to
message create events.
"""
return _ACCEPTS_EVENT_TYPE_MAPPING[self]
_ACCEPTS_EVENT_TYPE_MAPPING: dict[MessageAcceptsEnum, typing.Optional[type[hikari.MessageCreateEvent]]] = {
MessageAcceptsEnum.ALL: hikari.MessageCreateEvent,
MessageAcceptsEnum.DM_ONLY: hikari.DMMessageCreateEvent,
MessageAcceptsEnum.GUILD_ONLY: hikari.GuildMessageCreateEvent,
MessageAcceptsEnum.NONE: None,
}
assert _ACCEPTS_EVENT_TYPE_MAPPING.keys() == set(MessageAcceptsEnum)
def _check_human(ctx: tanjun.Context, /) -> bool:
return ctx.is_human
async def _wrap_client_callback(client: Client, callback: tanjun.MetaEventSig, args: tuple[str, ...], /) -> None:
try:
await client.injector.call_with_async_di(callback, *args)
except Exception as exc:
_LOGGER.exception("Client callback raised exception", exc_info=exc)
async def on_parser_error(ctx: tanjun.Context, error: errors.ParserError, /) -> None:
"""Handle message parser errors.
This is the default message parser error hook included by [Client][tanjun.Client].
"""
await ctx.respond(error.message)
class _StartDeclarer:
__slots__ = ("client", "command_ids", "guild_id", "message_ids", "user_ids", "__weakref__")
def __init__(
self,
client: Client,
guild_id: hikari.UndefinedOr[hikari.SnowflakeishOr[hikari.PartialGuild]],
command_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]],
message_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]],
user_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]],
) -> None:
self.client = client
self.command_ids = command_ids
self.guild_id = guild_id
self.message_ids = message_ids
self.user_ids = user_ids
async def __call__(self) -> None:
self.client.remove_client_callback(ClientCallbackNames.STARTING, self)
await self.client.declare_global_commands(
self.command_ids, message_ids=self.message_ids, user_ids=self.user_ids, guild=self.guild_id, force=False
)
def _log_clients(
cache: typing.Optional[hikari.api.Cache],
events: typing.Optional[hikari.api.EventManager],
server: typing.Optional[hikari.api.InteractionServer],
rest: hikari.api.RESTClient,
shards: typing.Optional[hikari.ShardAware],
event_managed: bool,
/,
) -> None:
_LOGGER.info(
"%s initialised with the following components: %s",
"Event-managed client" if event_managed else "Client",
", ".join(
name
for name, value in [
("cache", cache),
("event manager", events),
("interaction server", server),
("rest", rest),
("shard manager", shards),
]
if value
),
)
class Client(tanjun.Client):
"""Tanjun's standard [tanjun.abc.Client][] implementation.
This implementation supports dependency injection for checks, command
callbacks, prefix getters and event listeners. For more information on how
this works see [alluka][].
When manually managing the lifetime of the client the linked rest app or
bot must always be started before the Tanjun client.
!!! note
By default this client includes a parser error handling hook which will
by overwritten if you call [Client.set_hooks][tanjun.Client.set_hooks].
"""
__slots__ = (
"_auto_defer_after",
"_cache",
"_cached_application_id",
"_checks",
"_client_callbacks",
"_components",
"_default_app_cmd_permissions",
"_defaults_to_ephemeral",
"_dms_enabled_for_app_cmds",
"_events",
"_grab_mention_prefix",
"_hooks",
"_interaction_accepts",
"_is_case_sensitive",
"_menu_hooks",
"_menu_not_found",
"_slash_hooks",
"_slash_not_found",
"_injector",
"_is_closing",
"_listeners",
"_loop",
"_make_autocomplete_context",
"_make_menu_context",
"_make_message_context",
"_make_slash_context",
"_message_accepts",
"_message_hooks",
"_metadata",
"_modules",
"_path_modules",
"_prefix_getter",
"_prefixes",
"_rest",
"_server",
"_shards",
"_tasks",
"_voice",
)
@typing.overload
def __init__(
self,
rest: hikari.api.RESTClient,
*,
cache: typing.Optional[hikari.api.Cache] = None,
events: typing.Optional[hikari.api.EventManager] = None,
server: typing.Optional[hikari.api.InteractionServer] = None,
shards: typing.Optional[hikari.ShardAware] = None,
voice: typing.Optional[hikari.api.VoiceComponent] = None,
event_managed: bool = False,
injector: typing.Optional[alluka.abc.Client] = None,
mention_prefix: bool = False,
declare_global_commands: typing.Union[
hikari.SnowflakeishSequence[hikari.PartialGuild], hikari.SnowflakeishOr[hikari.PartialGuild], bool
] = False,
command_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
message_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
user_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
) -> None:
...
@typing.overload
@typing_extensions.deprecated("Use the declare_global_commands arg instead")
def __init__(
self,
rest: hikari.api.RESTClient,
*,
cache: typing.Optional[hikari.api.Cache] = None,
events: typing.Optional[hikari.api.EventManager] = None,
server: typing.Optional[hikari.api.InteractionServer] = None,
shards: typing.Optional[hikari.ShardAware] = None,
voice: typing.Optional[hikari.api.VoiceComponent] = None,
event_managed: bool = False,
injector: typing.Optional[alluka.abc.Client] = None,
mention_prefix: bool = False,
set_global_commands: typing.Union[hikari.SnowflakeishOr[hikari.PartialGuild], bool] = False,
declare_global_commands: typing.Union[
hikari.SnowflakeishSequence[hikari.PartialGuild], hikari.SnowflakeishOr[hikari.PartialGuild], bool
] = False,
command_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
message_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
user_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
_stack_level: int = 0,
) -> None:
...
def __init__(
self,
rest: hikari.api.RESTClient,
*,
cache: typing.Optional[hikari.api.Cache] = None,
events: typing.Optional[hikari.api.EventManager] = None,
server: typing.Optional[hikari.api.InteractionServer] = None,
shards: typing.Optional[hikari.ShardAware] = None,
voice: typing.Optional[hikari.api.VoiceComponent] = None,
event_managed: bool = False,
injector: typing.Optional[alluka.abc.Client] = None,
mention_prefix: bool = False,
set_global_commands: typing.Union[hikari.SnowflakeishOr[hikari.PartialGuild], bool] = False,
declare_global_commands: typing.Union[
hikari.SnowflakeishSequence[hikari.PartialGuild], hikari.SnowflakeishOr[hikari.PartialGuild], bool
] = False,
command_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
message_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
user_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
_stack_level: int = 0,
) -> None:
"""Initialise a Tanjun client.
!!! note
For a quicker way to initiate this client around a standard bot aware
client, see [Client.from_gateway_bot][tanjun.Client.from_gateway_bot]
and [Client.from_rest_bot][tanjun.Client.from_rest_bot].
Parameters
----------
rest
The Hikari REST client this will use.
cache
The Hikari cache client this will use if applicable.
events
The Hikari event manager client this will use if applicable.
This is necessary for message command dispatch and will also
be necessary for interaction command dispatch if `server` isn't
provided.
server
The Hikari interaction server client this will use if applicable.
This is used for interaction command dispatch if interaction
events aren't being received from the event manager.
shards
The Hikari shard aware client this will use if applicable.
voice
The Hikari voice component this will use if applicable.
event_managed
Whether or not this client is managed by the event manager.
An event managed client will be automatically started and closed based
on Hikari's lifetime events.
This can only be passed as [True][] if `events` is also provided.
injector
The alluka client this should use for dependency injection.
If not provided then the client will initialise its own DI client.
mention_prefix
Whether or not mention prefixes should be automatically set when this
client is first started.
It should be noted that this only applies to message commands.
declare_global_commands
Whether or not to automatically set global slash commands when this
client is first started.
If one or more guild objects/IDs are passed here then the registered
global commands will be set on the specified guild(s) at startup rather
than globally.
The endpoint this uses has a strict ratelimit which, as of writing,
only allows for 2 requests per minute (with that ratelimit either
being per-guild if targeting a specific guild otherwise globally).
command_ids
If provided, a mapping of top level command names to IDs of the
existing commands to update.
This will be used for all application commands but in cases where
commands have overlapping names, `message_ids` and `user_ids` will
take priority over this for their relevant command type.
This field is complementary to `declare_global_commands` and, while it
isn't necessarily required, this will in some situations help avoid
permissions which were previously set for a command from being lost
after a rename.
This currently isn't supported when multiple guild IDs are passed for
`declare_global_commands`.
message_ids
If provided, a mapping of message context menu command names to the
IDs of existing commands to update.
user_ids
If provided, a mapping of user context menu command names to the IDs
of existing commands to update.
Raises
------
ValueError
Raises for the following reasons:
* If `event_managed` is `True` when `event_manager` is `None`.
* If `command_ids` is passed when multiple guild ids are provided for
`declare_global_commands`.
* If `command_ids` is passed when `declare_global_commands` is `False`.
"""
if _LOGGER.isEnabledFor(logging.INFO):
_log_clients(cache, events, server, rest, shards, event_managed)
if not events and not server:
_LOGGER.warning(
"Client initiaited without an event manager or interaction server, "
"automatic command dispatch will be unavailable."
)
self._auto_defer_after: typing.Optional[float] = 2.0
self._cache = cache
self._cached_application_id: typing.Optional[hikari.Snowflake] = None
self._checks: list[tanjun.AnyCheckSig] = []
self._client_callbacks: dict[str, list[tanjun.MetaEventSig]] = {}
self._components: dict[str, tanjun.Component] = {}
self._default_app_cmd_permissions = hikari.Permissions.NONE
self._defaults_to_ephemeral = False
self._dms_enabled_for_app_cmds = True
self._events = events
self._grab_mention_prefix = mention_prefix
self._hooks: typing.Optional[tanjun.AnyHooks] = hooks.AnyHooks().set_on_parser_error(on_parser_error)
self._interaction_accepts = InteractionAcceptsEnum.ALL
self._is_case_sensitive = True
self._menu_hooks: typing.Optional[tanjun.MenuHooks] = None
self._menu_not_found: typing.Optional[str] = "Command not found"
self._slash_hooks: typing.Optional[tanjun.SlashHooks] = None
self._slash_not_found: typing.Optional[str] = self._menu_not_found
# TODO: test coverage
self._injector = injector or alluka.Client()
self._is_closing = False
self._listeners: dict[
type[hikari.Event],
dict[
tanjun.ListenerCallbackSig[typing.Any],
alluka.abc.AsyncSelfInjecting[tanjun.ListenerCallbackSig[typing.Any]],
],
] = {}
self._loop: typing.Optional[asyncio.AbstractEventLoop] = None
self._make_autocomplete_context: _AutocompleteContextMakerProto = context.AutocompleteContext
self._make_menu_context: _MenuContextMakerProto = context.MenuContext
self._make_message_context: _MessageContextMakerProto = context.MessageContext
self._make_slash_context: _SlashContextMakerProto = context.SlashContext
self._message_accepts = MessageAcceptsEnum.ALL if events else MessageAcceptsEnum.NONE
self._message_hooks: typing.Optional[tanjun.MessageHooks] = None
self._metadata: dict[typing.Any, typing.Any] = {}
self._modules: dict[str, types.ModuleType] = {}
self._path_modules: dict[pathlib.Path, types.ModuleType] = {}
self._prefix_getter: typing.Optional[PrefixGetterSig] = None
self._prefixes: list[str] = []
self._rest = rest
self._server = server
self._shards = shards
self._tasks: list[asyncio.Task[typing.Any]] = []
self._voice = voice
if event_managed:
if not events:
raise ValueError("Client cannot be event managed without an event manager")
events.subscribe(hikari.StartingEvent, self._on_starting)
events.subscribe(hikari.StoppingEvent, self._on_stopping)
(
self.set_type_dependency(tanjun.Client, self)
.set_type_dependency(Client, self)
.set_type_dependency(type(self), self)
.set_type_dependency(hikari.api.RESTClient, rest)
.set_type_dependency(type(rest), rest)
._maybe_set_type_dep(hikari.api.Cache, cache)
._maybe_set_type_dep(type(cache), cache)
._maybe_set_type_dep(hikari.api.EventManager, events)
._maybe_set_type_dep(type(events), events)
._maybe_set_type_dep(hikari.api.InteractionServer, server)
._maybe_set_type_dep(type(server), server)
._maybe_set_type_dep(hikari.ShardAware, shards)
._maybe_set_type_dep(type(shards), shards)
._maybe_set_type_dep(hikari.api.VoiceComponent, voice)
._maybe_set_type_dep(type(voice), voice)
)
dependencies.set_standard_dependencies(self)
self._schedule_startup_registers(
set_global_commands,
declare_global_commands,
command_ids,
message_ids=message_ids,
user_ids=user_ids,
_stack_level=_stack_level,
)
def _maybe_set_type_dep(self, type_: type[_T], value: typing.Optional[_T], /) -> Self:
if value is not None:
self.set_type_dependency(type_, value)
return self
def _schedule_startup_registers(
self,
set_global_commands: typing.Union[hikari.SnowflakeishOr[hikari.PartialGuild], bool] = False,
declare_global_commands: typing.Union[
hikari.SnowflakeishSequence[hikari.PartialGuild], hikari.SnowflakeishOr[hikari.PartialGuild], bool
] = False,
command_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
message_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
user_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
_stack_level: int = 0,
) -> None:
if set_global_commands:
warnings.warn(
"The `set_global_commands` argument is deprecated since v2.1.1a1. "
"Use `declare_global_commands` instead.",
DeprecationWarning,
stacklevel=3 + _stack_level,
)
declare_global_commands = declare_global_commands or set_global_commands
if isinstance(declare_global_commands, collections.Sequence):
if command_ids and len(declare_global_commands) > 1:
raise ValueError(
"Cannot provide specific command_ids while automatically "
"declaring commands marked as 'global' in multiple-guilds on startup"
)
for guild in declare_global_commands:
_LOGGER.info("Registering startup command declarer for %s guild", guild)
self.add_client_callback(
ClientCallbackNames.STARTING,
_StartDeclarer(self, guild, command_ids=command_ids, message_ids=message_ids, user_ids=user_ids),
)
elif isinstance(declare_global_commands, bool):
if declare_global_commands:
_LOGGER.info("Registering startup command declarer for global commands")
if not command_ids and not message_ids and not user_ids:
_LOGGER.warning(
"No command IDs passed for startup command declarer, this could lead to previously set "
"command permissions being lost when commands are renamed."
)
self.add_client_callback(
ClientCallbackNames.STARTING,
_StartDeclarer(
self, hikari.UNDEFINED, command_ids=command_ids, message_ids=message_ids, user_ids=user_ids
),
)
elif command_ids:
raise ValueError("Cannot pass command IDs when not declaring global commands")
else:
self.add_client_callback(
ClientCallbackNames.STARTING,
_StartDeclarer(
self, declare_global_commands, command_ids=command_ids, message_ids=message_ids, user_ids=user_ids
),
)
def _remove_task(self, task: asyncio.Task[typing.Any], /) -> None:
self._tasks.remove(task)
def _add_task(self, task: asyncio.Task[typing.Any], /) -> None:
if not task.done():
self._tasks.append(task)
task.add_done_callback(self._remove_task)
@classmethod
@typing.overload
def from_gateway_bot(
cls,
bot: _GatewayBotProto,
/,
*,
event_managed: bool = True,
injector: typing.Optional[alluka.abc.Client] = None,
mention_prefix: bool = False,
declare_global_commands: typing.Union[
hikari.SnowflakeishSequence[hikari.PartialGuild], hikari.SnowflakeishOr[hikari.PartialGuild], bool
] = False,
command_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
message_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
user_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
) -> Client:
...
@classmethod
@typing.overload
@typing_extensions.deprecated("Use the declare_global_commands arg instead")
def from_gateway_bot(
cls,
bot: _GatewayBotProto,
/,
*,
event_managed: bool = True,
injector: typing.Optional[alluka.abc.Client] = None,
mention_prefix: bool = False,
declare_global_commands: typing.Union[
hikari.SnowflakeishSequence[hikari.PartialGuild], hikari.SnowflakeishOr[hikari.PartialGuild], bool
] = False,
set_global_commands: typing.Union[hikari.SnowflakeishOr[hikari.PartialGuild], bool] = False,
command_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
message_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
user_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
) -> Client:
...
@classmethod
def from_gateway_bot(
cls,
bot: _GatewayBotProto,
/,
*,
event_managed: bool = True,
injector: typing.Optional[alluka.abc.Client] = None,
mention_prefix: bool = False,
declare_global_commands: typing.Union[
hikari.SnowflakeishSequence[hikari.PartialGuild], hikari.SnowflakeishOr[hikari.PartialGuild], bool
] = False,
set_global_commands: typing.Union[hikari.SnowflakeishOr[hikari.PartialGuild], bool] = False,
command_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
message_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
user_ids: typing.Optional[collections.Mapping[str, hikari.SnowflakeishOr[hikari.PartialCommand]]] = None,
) -> Client:
"""Build a [Client][tanjun.Client] from a gateway bot.
!!! note
This defaults the client to human only mode and sets type
dependency injectors for the hikari traits present in `bot`.
Parameters
----------
bot : hikari.traits.ShardAware & hikari.traits.RESTAware & hikari.traits.EventManagerAware
The bot client to build from.
This will be used to infer the relevant Hikari clients to use.
event_managed
Whether or not this client is managed by the event manager.
An event managed client will be automatically started and closed
based on Hikari's lifetime events.
injector
The alluka client this should use for dependency injection.
If not provided then the client will initialise its own DI client.
mention_prefix
Whether or not mention prefixes should be automatically set when this
client is first started.
It should be noted that this only applies to message commands.
declare_global_commands
Whether or not to automatically set global slash commands when this
client is first started.
If one or more guild objects/IDs are passed here then the registered
global commands will be set on the specified guild(s) at startup rather
than globally.
The endpoint this uses has a strict ratelimit which, as of writing,
only allows for 2 requests per minute (with that ratelimit either
being per-guild if targeting a specific guild otherwise globally).
command_ids
If provided, a mapping of top level command names to IDs of the commands to update.
This field is complementary to `declare_global_commands` and, while it