hikari.impl.bot
Basic implementation the components for a single-process bot.
View Source
# -*- coding: utf-8 -*- # cython: language_level=3 # Copyright (c) 2020 Nekokatt # Copyright (c) 2021-present davfsa # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in all # copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. """Basic implementation the components for a single-process bot.""" from __future__ import annotations __all__: typing.Sequence[str] = ("GatewayBot",) import asyncio import datetime import logging import math import signal import sys import threading import traceback import types import typing import warnings from hikari import applications from hikari import errors from hikari import intents as intents_ from hikari import presences from hikari import snowflakes from hikari import traits from hikari import undefined from hikari.impl import cache as cache_impl from hikari.impl import config as config_impl from hikari.impl import entity_factory as entity_factory_impl from hikari.impl import event_factory as event_factory_impl from hikari.impl import event_manager as event_manager_impl from hikari.impl import rest as rest_impl from hikari.impl import shard as shard_impl from hikari.impl import voice as voice_impl from hikari.internal import aio from hikari.internal import time from hikari.internal import ux if typing.TYPE_CHECKING: import concurrent.futures from hikari import channels from hikari import guilds from hikari import users as users_ from hikari.api import cache as cache_ from hikari.api import entity_factory as entity_factory_ from hikari.api import event_factory as event_factory_ from hikari.api import event_manager as event_manager_ from hikari.api import rest as rest_ from hikari.api import shard as gateway_shard from hikari.api import voice as voice_ from hikari.events import base_events _LOGGER: typing.Final[logging.Logger] = logging.getLogger("hikari.bot") async def _gather(coros: typing.Iterator[typing.Awaitable[typing.Any]]) -> None: # Calling asyncio.gather outside of a running event loop isn't safe and # will lead to RuntimeErrors in later versions of python, so this call is # kept within a coroutine function. await asyncio.gather(*coros) def _destroy_loop(loop: asyncio.AbstractEventLoop) -> None: async def murder(future: asyncio.Future[typing.Any]) -> None: # These include _GatheringFuture which must be awaited if the children # throw an asyncio.CancelledError, otherwise it will spam logs with warnings # about exceptions not being retrieved before GC. try: _LOGGER.log(ux.TRACE, "killing %s", future) future.cancel() await future except asyncio.CancelledError: pass except Exception as ex: loop.call_exception_handler( { "message": "Future raised unexpected exception after requesting cancellation", "exception": ex, "future": future, } ) remaining_tasks = [t for t in asyncio.all_tasks(loop) if not t.done()] if remaining_tasks: _LOGGER.debug("terminating %s remaining tasks forcefully", len(remaining_tasks)) loop.run_until_complete(_gather((murder(task) for task in remaining_tasks))) else: _LOGGER.debug("No remaining tasks exist, good job!") if sys.version_info >= (3, 9): _LOGGER.debug("shutting down default executor") try: # This seems to raise a NotImplementedError when running with uvloop. loop.run_until_complete(loop.shutdown_default_executor()) except NotImplementedError: pass _LOGGER.debug("shutting down asyncgens") loop.run_until_complete(loop.shutdown_asyncgens()) _LOGGER.debug("closing event loop") loop.close() # Closed loops cannot be re-used so it should also be un-set. asyncio.set_event_loop(None) def _validate_activity(activity: undefined.UndefinedNoneOr[presences.Activity]) -> None: # This seems to cause confusion for a lot of people, so lets add some warnings into the mix. if activity is undefined.UNDEFINED or activity is None: return # If you ever change where this is called from, make sure to check the stacklevels are correct # or the code preview in the warning will be wrong... if activity.type is presences.ActivityType.CUSTOM: warnings.warn( "The CUSTOM activity type is not supported by bots at the time of writing, and may therefore not have " "any effect if used.", category=errors.HikariWarning, stacklevel=3, ) elif activity.type is presences.ActivityType.STREAMING and activity.url is None: warnings.warn( "The STREAMING activity type requires a 'url' parameter pointing to a valid Twitch or YouTube video " "URL to be specified on the activity for the presence update to have any effect.", category=errors.HikariWarning, stacklevel=3, ) class GatewayBot(traits.GatewayBotAware): """Basic auto-sharding bot implementation. This is the class you will want to use to start, control, and build a bot with. .. note:: Settings that control the gateway session are provided to the `GatewayBot.run` and `GatewayBot.start` functions in this class. This is done to allow you to contextually customise details such as sharding configuration without having to re-initialize the entire application each time. Parameters ---------- token : str The bot token to sign in with. Other Parameters ---------------- allow_color : bool Defaulting to `True`, this will enable coloured console logs on any platform that is a TTY. Setting a `"CLICOLOR"` environment variable to any **non `0`** value will override this setting. Users should consider this an advice to the application on whether it is safe to show colours if possible or not. Since some terminals can be awkward or not support features in a standard way, the option to explicitly disable this is provided. See `force_color` for an alternative. banner : typing.Optional[str] The package to search for a `banner.txt` in. Defaults to `"hikari"` for the `"hikari/banner.txt"` banner. Setting this to `None` will disable the banner being shown. executor : typing.Optional[concurrent.futures.Executor] Defaults to `None`. If non-`None`, then this executor is used instead of the `concurrent.futures.ThreadPoolExecutor` attached to the `asyncio.AbstractEventLoop` that the bot will run on. This executor is used primarily for file-IO. While mainly supporting the `concurrent.futures.ThreadPoolExecutor` implementation in the standard lib, Hikari's file handling systems should also work with `concurrent.futures.ProcessPoolExecutor`, which relies on all objects used in IPC to be `pickle`able. Many third-party libraries will not support this fully though, so your mileage may vary on using ProcessPoolExecutor implementations with this parameter. force_color : bool Defaults to `False`. If `True`, then this application will __force__ colour to be used in console-based output. Specifying a `"CLICOLOR_FORCE"` environment variable with a non-`"0"` value will override this setting. This will take precedence over `allow_color` if both are specified. cache_settings : typing.Optional[hikari.impl.config.CacheSettings] Optional cache settings. If unspecified, will use the defaults. http_settings : typing.Optional[hikari.impl.config.HTTPSettings] Optional custom HTTP configuration settings to use. Allows you to customise functionality such as whether SSL-verification is enabled, what timeouts `aiohttp` should expect to use for requests, and behavior regarding HTTP-redirects. intents : hikari.intents.Intents Defaults to `hikari.intents.Intents.ALL_UNPRIVILEGED`. This allows you to change which intents your application will use on the gateway. This can be used to control and change the types of events you will receive. logs : typing.Union[None, LoggerLevel, typing.Dict[str, typing.Any]] Defaults to `"INFO"`. If `None`, then the Python logging system is left uninitialized on startup, and you will need to configure it manually to view most logs that are output by components of this library. If one of the valid values in a `LoggerLevel`, then this will match a call to `colorlog.basicConfig` (a facade for `logging.basicConfig` with additional conduit for enabling coloured logging levels) with the `level` kwarg matching this value. If a `typing.Dict[str, typing.Any]` equivalent, then this value is passed to `logging.config.dictConfig` to allow the user to provide a specialized logging configuration of their choice. If any handlers are defined in the dict, default handlers will not be setup. As a side note, you can always opt to leave this on the default value and then use an incremental `logging.config.dictConfig` that applies any additional changes on top of the base configuration, if you prefer. An example of can be found in the `Example` section. Note that `"TRACE_HIKARI"` is a library-specific logging level which is expected to be more verbose than `"DEBUG"`. max_rate_limit : float The max number of seconds to backoff for when rate limited. Anything greater than this will instead raise an error. This defaults to five minutes if left to the default value. This is to stop potentially indefinitely waiting on an endpoint, which is almost never what you want to do if giving a response to a user. You can set this to `float("inf")` to disable this check entirely. Note that this only applies to the REST API component that communicates with Discord, and will not affect sharding or third party HTTP endpoints that may be in use. max_retries : typing.Optional[int] Maximum number of times a request will be retried if it fails with a `5xx` status. Defaults to 3 if set to `None`. proxy_settings : typing.Optional[hikari.impl.config.ProxySettings] Custom proxy settings to use with network-layer logic in your application to get through an HTTP-proxy. rest_url : typing.Optional[str] Defaults to the Discord REST API URL if `None`. Can be overridden if you are attempting to point to an unofficial endpoint, or if you are attempting to mock/stub the Discord API for any reason. Generally you do not want to change this. Example ------- Setting up logging using a dictionary configuration: ```py import os import hikari # We want to make gateway logs output as DEBUG, and TRACE for all ratelimit content. bot = hikari.GatewayBot( token=os.environ["BOT_TOKEN"], logs={ "version": 1, "incremental": True, "loggers": { "hikari.gateway": {"level": "DEBUG"}, "hikari.ratelimits": {"level": "TRACE_HIKARI"}, }, }, ) ``` """ shards: typing.Mapping[int, gateway_shard.GatewayShard] """Mapping of shards in this application instance. Each shard ID is mapped to the corresponding shard instance. If the application has not started, it is acceptable to assume the result of this call will be an empty mapping. """ # noqa: D401 - Imperative mood __slots__: typing.Sequence[str] = ( "_cache", "_closing_event", "_closed_event", "_entity_factory", "_event_manager", "_event_factory", "_executor", "_http_settings", "_intents", "_is_alive", "_proxy_settings", "_rest", "_shards", "_token", "_voice", "shards", ) def __init__( self, token: str, *, allow_color: bool = True, banner: typing.Optional[str] = "hikari", executor: typing.Optional[concurrent.futures.Executor] = None, force_color: bool = False, cache_settings: typing.Optional[config_impl.CacheSettings] = None, http_settings: typing.Optional[config_impl.HTTPSettings] = None, intents: intents_.Intents = intents_.Intents.ALL_UNPRIVILEGED, logs: typing.Union[None, int, str, typing.Dict[str, typing.Any]] = "INFO", max_rate_limit: float = 300, max_retries: int = 3, proxy_settings: typing.Optional[config_impl.ProxySettings] = None, rest_url: typing.Optional[str] = None, ) -> None: # Beautification and logging ux.init_logging(logs, allow_color, force_color) self.print_banner(banner, allow_color, force_color) # Settings and state self._closing_event: typing.Optional[asyncio.Event] = None self._closed_event: typing.Optional[asyncio.Event] = None self._is_alive = False self._executor = executor self._http_settings = http_settings if http_settings is not None else config_impl.HTTPSettings() self._intents = intents self._proxy_settings = proxy_settings if proxy_settings is not None else config_impl.ProxySettings() self._token = token.strip() # Caching cache_settings = cache_settings if cache_settings is not None else config_impl.CacheSettings() self._cache = cache_impl.CacheImpl(self, cache_settings) # Entity creation self._entity_factory = entity_factory_impl.EntityFactoryImpl(self) # Event creation self._event_factory = event_factory_impl.EventFactoryImpl(self) # Event handling self._event_manager = event_manager_impl.EventManagerImpl( self._entity_factory, self._event_factory, self._intents, cache=self._cache ) # Voice subsystem self._voice = voice_impl.VoiceComponentImpl(self) # RESTful API. self._rest = rest_impl.RESTClientImpl( cache=self._cache, entity_factory=self._entity_factory, executor=self._executor, http_settings=self._http_settings, max_rate_limit=max_rate_limit, proxy_settings=self._proxy_settings, rest_url=rest_url, max_retries=max_retries, token=token, token_type=applications.TokenType.BOT, ) # We populate these on startup instead, as we need to possibly make some # HTTP requests to determine what to put in this mapping. self._shards: typing.Dict[int, gateway_shard.GatewayShard] = {} self.shards = types.MappingProxyType(self._shards) @property def cache(self) -> cache_.Cache: return self._cache @property def event_manager(self) -> event_manager_.EventManager: return self._event_manager @property def entity_factory(self) -> entity_factory_.EntityFactory: return self._entity_factory @property def event_factory(self) -> event_factory_.EventFactory: return self._event_factory @property def executor(self) -> typing.Optional[concurrent.futures.Executor]: return self._executor @property def heartbeat_latencies(self) -> typing.Mapping[int, float]: return {s.id: s.heartbeat_latency for s in self._shards.values()} @property def heartbeat_latency(self) -> float: latencies = [s.heartbeat_latency for s in self._shards.values() if not math.isnan(s.heartbeat_latency)] return sum(latencies) / len(latencies) if latencies else float("nan") @property def http_settings(self) -> config_impl.HTTPSettings: return self._http_settings @property def intents(self) -> intents_.Intents: return self._intents @property def proxy_settings(self) -> config_impl.ProxySettings: return self._proxy_settings @property def shard_count(self) -> int: return next(iter(self._shards.values())).shard_count if self._shards else 0 @property def voice(self) -> voice_.VoiceComponent: return self._voice @property def rest(self) -> rest_.RESTClient: return self._rest @property def is_alive(self) -> bool: return self._is_alive def _check_if_alive(self) -> None: if not self._is_alive: raise errors.ComponentStateConflictError("bot is not running so it cannot be interacted with") def get_me(self) -> typing.Optional[users_.OwnUser]: return self._cache.get_me() async def close(self) -> None: self._check_if_alive() await self._close() async def _close(self) -> None: if self._closed_event: # Closing is in progress from another call, wait for that to complete. await self._closed_event.wait() return if self._closing_event is None: # If closing event is None then this is already closed. return _LOGGER.debug("bot requested to shutdown") self._closed_event = asyncio.Event() self._closing_event.set() self._closing_event = None dispatch_events = self._is_alive loop = asyncio.get_running_loop() async def handle(name: str, awaitable: typing.Awaitable[typing.Any]) -> None: future = asyncio.ensure_future(awaitable) try: await future except Exception as ex: loop.call_exception_handler( { "message": f"{name} raised an exception during shutdown", "future": future, "exception": ex, } ) if dispatch_events: await self._event_manager.dispatch(self._event_factory.deserialize_stopping_event()) _LOGGER.log(ux.TRACE, "StoppingEvent dispatch completed, now beginning termination") calls = [ ("rest", self._rest.close()), ("voice handler", self._voice.close()), *((f"shard {s.id}", s.close()) for s in self._shards.values()), ] for coro in asyncio.as_completed([handle(*pair) for pair in calls]): await coro # Clear out cache and shard map self._cache.clear() self._shards.clear() self._is_alive = False if dispatch_events: await self._event_manager.dispatch(self._event_factory.deserialize_stopped_event()) self._closed_event.set() self._closed_event = None def dispatch(self, event: base_events.Event) -> asyncio.Future[typing.Any]: """Dispatch an event. Parameters ---------- event : hikari.events.base_events.Event The event to dispatch. Example ------- We can dispatch custom events by first defining a class that derives from `hikari.events.base_events.Event`. ```py import attr from hikari.traits import RESTAware from hikari.events.base_events import Event from hikari.users import User from hikari.snowflakes import Snowflake @attr.define() class EveryoneMentionedEvent(Event): app: RESTAware = attr.field() author: User = attr.field() '''The user who mentioned everyone.''' content: str = attr.field() '''The message that was sent.''' message_id: Snowflake = attr.field() '''The message ID.''' channel_id: Snowflake = attr.field() '''The channel ID.''' ``` We can then dispatch our event as we see fit. ```py from hikari.events.messages import MessageCreateEvent @bot.listen(MessageCreateEvent) async def on_message(event): if "@everyone" in event.content or "@here" in event.content: event = EveryoneMentionedEvent( author=event.author, content=event.content, message_id=event.id, channel_id=event.channel_id, ) bot.dispatch(event) ``` This event can be listened to elsewhere by subscribing to it with `EventManager.subscribe`. ```py @bot.listen(EveryoneMentionedEvent) async def on_everyone_mentioned(event): print(event.user, "just pinged everyone in", event.channel_id) ``` Returns ------- asyncio.Future[typing.Any] A future that can be optionally awaited. If awaited, the future will complete once all corresponding event listeners have been invoked. If not awaited, this will schedule the dispatch of the events in the background for later. See Also -------- `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ return self._event_manager.dispatch(event) def get_listeners( self, event_type: typing.Type[base_events.EventT], /, *, polymorphic: bool = True ) -> typing.Collection[event_manager_.CallbackT[base_events.EventT]]: """Get the listeners for a given event type, if there are any. Parameters ---------- event_type : typing.Type[EventT] The event type to look for. `EventT` must be a subclass of `hikari.events.base_events.Event`. polymorphic : bool If `True`, this will also return the listeners of the subclasses of the given event type. If `False`, then only listeners for this class specifically are returned. The default is `True`. Returns ------- typing.Collection[typing.Callable[[EventT], typing.Coroutine[typing.Any, typing.Any, None]] A copy of the collection of listeners for the event. Will return an empty collection if nothing is registered. """ return self._event_manager.get_listeners(event_type, polymorphic=polymorphic) async def join(self, until_close: bool = True) -> None: self._check_if_alive() awaitables: typing.List[typing.Awaitable[typing.Any]] = [s.join() for s in self._shards.values()] if until_close and self._closing_event: # If closing event is None then this is already closing. awaitables.append(self._closing_event.wait()) await aio.first_completed(*awaitables) def listen( self, *event_types: typing.Type[base_events.EventT], ) -> typing.Callable[[event_manager_.CallbackT[base_events.EventT]], event_manager_.CallbackT[base_events.EventT]]: """Generate a decorator to subscribe a callback to an event type. This is a second-order decorator. Parameters ---------- *event_types : typing.Optional[typing.Type[EventT]] The event types to subscribe to. The implementation may allow this to be undefined. If this is the case, the event type will be inferred instead from the type hints on the function signature. `EventT` must be a subclass of `hikari.events.base_events.Event`. Returns ------- typing.Callable[[EventT], EventT] A decorator for a coroutine function that passes it to `EventManager.subscribe` before returning the function reference. See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ return self._event_manager.listen(*event_types) @staticmethod def print_banner( banner: typing.Optional[str], allow_color: bool, force_color: bool, extra_args: typing.Optional[typing.Dict[str, str]] = None, ) -> None: """Print the banner. This allows library vendors to override this behaviour, or choose to inject their own "branding" on top of what hikari provides by default. Normal users should not need to invoke this function, and can simply change the `banner` argument passed to the constructor to manipulate what is displayed. Parameters ---------- banner : typing.Optional[str] The package to find a `banner.txt` in. allow_color : bool A flag that allows advising whether to allow color if supported or not. Can be overridden by setting a `"CLICOLOR"` environment variable to a non-`"0"` string. force_color : bool A flag that allows forcing color to always be output, even if the terminal device may not support it. Setting the `"CLICOLOR_FORCE"` environment variable to a non-`"0"` string will override this. This will take precedence over `allow_color` if both are specified. extra_args : typing.Optional[typing.Dict[str, str]] If provided, extra $-substitutions to use when printing the banner. Default substitutions can not be overwritten. Raises ------ ValueError If `extra_args` contains a default $-substitution. """ ux.print_banner(banner, allow_color, force_color, extra_args=extra_args) def run( self, *, activity: typing.Optional[presences.Activity] = None, afk: bool = False, asyncio_debug: typing.Optional[bool] = None, check_for_updates: bool = True, close_passed_executor: bool = False, close_loop: bool = True, coroutine_tracking_depth: typing.Optional[int] = None, enable_signal_handlers: typing.Optional[bool] = None, idle_since: typing.Optional[datetime.datetime] = None, ignore_session_start_limit: bool = False, large_threshold: int = 250, propagate_interrupts: bool = False, status: presences.Status = presences.Status.ONLINE, shard_ids: typing.Optional[typing.AbstractSet[int]] = None, shard_count: typing.Optional[int] = None, ) -> None: """Start the bot, wait for all shards to become ready, and then return. Other Parameters ---------------- activity : typing.Optional[hikari.presences.Activity] The initial activity to display in the bot user presence, or `None` (default) to not show any. afk : bool The initial AFK state to display in the bot user presence, or `False` (default) to not show any. asyncio_debug : bool Defaults to `False`. If `True`, then debugging is enabled for the asyncio event loop in use. check_for_updates : bool Defaults to `True`. If `True`, will check for newer versions of `hikari` on PyPI and notify if available. close_passed_executor : bool Defaults to `False`. If `True`, any custom `concurrent.futures.Executor` passed to the constructor will be shut down when the application terminates. This does not affect the default executor associated with the event loop, and will not do anything if you do not provide a custom executor to the constructor. close_loop : bool Defaults to `True`. If `True`, then once the bot enters a state where all components have shut down permanently during application shutdown, then all asyncgens and background tasks will be destroyed, and the event loop will be shut down. This will wait until all `hikari`-owned `aiohttp` connectors have had time to attempt to shut down correctly (around 250ms), and on Python 3.9 and newer, will also shut down the default event loop executor too. coroutine_tracking_depth : typing.Optional[int] Defaults to `None`. If an integer value and supported by the interpreter, then this many nested coroutine calls will be tracked with their call origin state. This allows you to determine where non-awaited coroutines may originate from, but generally you do not want to leave this enabled for performance reasons. enable_signal_handlers : typing.Optional[bool] Defaults to `True` if this is started in the main thread. If on a __non-Windows__ OS with builtin support for kernel-level POSIX signals, then setting this to `True` will allow treating keyboard interrupts and other OS signals to safely shut down the application as calls to shut down the application properly rather than just killing the process in a dirty state immediately. You should leave this enabled unless you plan to implement your own signal handling yourself. idle_since : typing.Optional[datetime.datetime] The `datetime.datetime` the user should be marked as being idle since, or `None` (default) to not show this. ignore_session_start_limit : bool Defaults to `False`. If `False`, then attempting to start more sessions than you are allowed in a 24 hour window will throw a `hikari.errors.GatewayError` rather than going ahead and hitting the IDENTIFY limit, which may result in your token being reset. Setting to `True` disables this behavior. large_threshold : int Threshold for members in a guild before it is treated as being "large" and no longer sending member details in the `GUILD CREATE` event. Defaults to `250`. propagate_interrupts : bool Defaults to `False`. If set to `True`, then any internal `hikari.errors.HikariInterrupt` that is raises as a result of catching an OS level signal will result in the exception being rethrown once the application has closed. This can allow you to use hikari signal handlers and still be able to determine what kind of interrupt the application received after it closes. When `False`, nothing is raised and the call will terminate cleanly and silently where possible instead. shard_ids : typing.Optional[typing.AbstractSet[int]] The shard IDs to create shards for. If not `None`, then a non-`None` `shard_count` must ALSO be provided. Defaults to `None`, which means the Discord-recommended count is used for your application instead. shard_count : typing.Optional[int] The number of shards to use in the entire distributed application. Defaults to `None` which results in the count being determined dynamically on startup. status : hikari.presences.Status The initial status to show for the user presence on startup. Defaults to `hikari.presences.Status.ONLINE`. Raises ------ hikari.errors.ComponentStateConflictError If bot is already running. TypeError If `shard_ids` is passed without `shard_count`. """ if self._is_alive: raise errors.ComponentStateConflictError("bot is already running") if shard_ids is not None and shard_count is None: raise TypeError("'shard_ids' must be passed with 'shard_count'") loop = aio.get_or_make_loop() signals = ("SIGINT", "SIGTERM") if asyncio_debug: loop.set_debug(True) if coroutine_tracking_depth is not None: try: # Provisionally defined in CPython, may be removed without notice. sys.set_coroutine_origin_tracking_depth(coroutine_tracking_depth) except AttributeError: _LOGGER.log(ux.TRACE, "cannot set coroutine tracking depth for sys, no functionality exists for this") # Throwing this in the handler will lead to lots of fun OS specific shenanigans. So, lets just # cache it for later, I guess. interrupt: typing.Optional[errors.HikariInterrupt] = None loop_thread_id = threading.get_native_id() def handle_os_interrupt(signum: int, frame: typing.Optional[types.FrameType]) -> None: # If we use a POSIX system, then raising an exception in here works perfectly and shuts the loop down # with an exception, which is good. # Windows, however, is special on this front. On Windows, the exception is caught by whatever was # currently running on the event loop at the time, which is annoying for us, as this could be fired into # the task for an event dispatch, for example, which is a guarded call that is never waited for by design. # We can't always safely intercept this either, as Windows does not allow us to use asyncio loop # signal listeners (since Windows doesn't have kernel-level signals, only emulated system calls # for a remote few standard C signal types). Thus, the best solution here is to set the close bit # instead, which will let the bot start to clean itself up as if the user closed it manually via a call # to `bot.close()`. nonlocal interrupt signame = signal.strsignal(signum) assert signame is not None # Will always be True interrupt = errors.HikariInterrupt(signum, signame) # The loop may or may not be running, depending on the state of the application when this occurs. # Signals on POSIX only occur on the main thread usually, too, so we need to ensure this is # threadsafe if we want the user's application to still shut down if on a separate thread. # We log native thread IDs purely for debugging purposes. if _LOGGER.isEnabledFor(ux.TRACE): _LOGGER.log( ux.TRACE, "interrupt %s occurred on thread %s, bot on thread %s will be notified to shut down shortly\n" "Stacktrace for developer sanity:\n%s", signum, threading.get_native_id(), loop_thread_id, "".join(traceback.format_stack(frame)), ) asyncio.run_coroutine_threadsafe(self._set_close_flag(signame, signum), loop) if enable_signal_handlers is None: # Signal handlers can only be registered on the main thread so we # only default to True if this is the case. enable_signal_handlers = threading.current_thread() is threading.main_thread() if enable_signal_handlers: for sig in signals: try: signum = getattr(signal, sig) signal.signal(signum, handle_os_interrupt) except AttributeError: _LOGGER.log(ux.TRACE, "signal %s is not implemented on your platform", sig) try: loop.run_until_complete( self.start( activity=activity, afk=afk, check_for_updates=check_for_updates, idle_since=idle_since, ignore_session_start_limit=ignore_session_start_limit, large_threshold=large_threshold, shard_ids=shard_ids, shard_count=shard_count, status=status, ) ) loop.run_until_complete(self.join()) finally: try: loop.run_until_complete(self._close()) if close_passed_executor and self._executor is not None: _LOGGER.debug("shutting down executor %s", self._executor) self._executor.shutdown(wait=True) self._executor = None finally: if enable_signal_handlers: for sig in signals: try: signum = getattr(signal, sig) signal.signal(signum, signal.SIG_DFL) except AttributeError: # Signal not implemented probably. We should have logged this earlier. pass if close_loop: _destroy_loop(loop) _LOGGER.info("successfully terminated") if propagate_interrupts and interrupt is not None: raise interrupt async def start( self, *, activity: typing.Optional[presences.Activity] = None, afk: bool = False, check_for_updates: bool = True, idle_since: typing.Optional[datetime.datetime] = None, ignore_session_start_limit: bool = False, large_threshold: int = 250, shard_ids: typing.Optional[typing.AbstractSet[int]] = None, shard_count: typing.Optional[int] = None, status: presences.Status = presences.Status.ONLINE, ) -> None: """Start the bot, wait for all shards to become ready, and then return. Other Parameters ---------------- activity : typing.Optional[hikari.presences.Activity] The initial activity to display in the bot user presence, or `None` (default) to not show any. afk : bool The initial AFK state to display in the bot user presence, or `False` (default) to not show any. check_for_updates : bool Defaults to `True`. If `True`, will check for newer versions of `hikari` on PyPI and notify if available. idle_since : typing.Optional[datetime.datetime] The `datetime.datetime` the user should be marked as being idle since, or `None` (default) to not show this. ignore_session_start_limit : bool Defaults to `False`. If `False`, then attempting to start more sessions than you are allowed in a 24 hour window will throw a `hikari.errors.GatewayError` rather than going ahead and hitting the IDENTIFY limit, which may result in your token being reset. Setting to `True` disables this behavior. large_threshold : int Threshold for members in a guild before it is treated as being "large" and no longer sending member details in the `GUILD CREATE` event. Defaults to `250`. shard_ids : typing.Optional[typing.AbstractSet[int]] The shard IDs to create shards for. If not `None`, then a non-`None` `shard_count` must ALSO be provided. Defaults to `None`, which means the Discord-recommended count is used for your application instead. shard_count : typing.Optional[int] The number of shards to use in the entire distributed application. Defaults to `None` which results in the count being determined dynamically on startup. status : hikari.presences.Status The initial status to show for the user presence on startup. Defaults to `hikari.presences.Status.ONLINE`. Raises ------ TypeError If `shard_ids` is passed without `shard_count`. hikari.errors.ComponentStateConflictError If bot is already running. """ if self._is_alive: raise errors.ComponentStateConflictError("bot is already running") if shard_ids is not None and shard_count is None: raise TypeError("'shard_ids' must be passed with 'shard_count'") _validate_activity(activity) start_time = time.monotonic() self._rest.start() self._voice.start() self._closing_event = asyncio.Event() self._is_alive = True if check_for_updates: asyncio.create_task( ux.check_for_updates(self._http_settings, self._proxy_settings), name="check for package updates", ) requirements = await self._rest.fetch_gateway_bot_info() await self._event_manager.dispatch(self._event_factory.deserialize_starting_event()) if shard_count is None: shard_count = requirements.shard_count if shard_ids is None: shard_ids = set(range(shard_count)) if requirements.session_start_limit.remaining < len(shard_ids) and not ignore_session_start_limit: _LOGGER.critical( "would have started %s session%s, but you only have %s session%s remaining until %s. Starting more " "sessions than you are allowed to start may result in your token being reset. To skip this message, " "use bot.run(..., ignore_session_start_limit=True) or bot.start(..., ignore_session_start_limit=True)", len(shard_ids), "s" if len(shard_ids) != 1 else "", requirements.session_start_limit.remaining, "s" if requirements.session_start_limit.remaining != 1 else "", requirements.session_start_limit.reset_at, ) raise errors.GatewayError("Attempted to start more sessions than were allowed in the given time-window") _LOGGER.info( "you can start %s session%s before the next window which starts at %s; planning to start %s session%s... ", requirements.session_start_limit.remaining, "s" if requirements.session_start_limit.remaining != 1 else "", requirements.session_start_limit.reset_at, len(shard_ids), "s" if len(shard_ids) != 1 else "", ) for window_start in range(0, shard_count, requirements.session_start_limit.max_concurrency): window = [ candidate_shard_id for candidate_shard_id in range( window_start, window_start + requirements.session_start_limit.max_concurrency ) if candidate_shard_id in shard_ids ] if not window: continue if self._shards: close_waiter = asyncio.create_task(self._closing_event.wait()) shard_joiners = [s.join() for s in self._shards.values()] try: # Attempt to wait for all started shards, for 5 seconds, along with the close # waiter. # If the close flag is set (i.e. user invoked bot.close), or one or more shards # die in this time, we shut down immediately. # If we time out, the joining tasks get discarded and we spin up the next # block of shards, if applicable. _LOGGER.info("the next startup window is in 5 seconds, please wait...") await aio.first_completed(aio.all_of(*shard_joiners, timeout=5), close_waiter) if not close_waiter.cancelled(): _LOGGER.info("requested to shut down during startup of shards") else: _LOGGER.critical("one or more shards shut down unexpectedly during bot startup") return except asyncio.TimeoutError: # If any shards stopped silently, we should close. if any(not s.is_alive for s in self._shards.values()): _LOGGER.warning("one of the shards has been manually shut down (no error), will now shut down") await self._close() return # new window starts. except Exception as ex: _LOGGER.critical("an exception occurred in one of the started shards during bot startup: %r", ex) raise await aio.all_of( *( self._start_one_shard( activity=activity, afk=afk, idle_since=idle_since, status=status, large_threshold=large_threshold, shard_id=candidate_shard_id, shard_count=shard_count, url=requirements.url, closing_event=self._closing_event, ) for candidate_shard_id in window if candidate_shard_id in shard_ids ) ) await self._event_manager.dispatch(self._event_factory.deserialize_started_event()) _LOGGER.info("started successfully in approx %.2f seconds", time.monotonic() - start_time) def stream( self, event_type: typing.Type[base_events.EventT], /, timeout: typing.Union[float, int, None], limit: typing.Optional[int] = None, ) -> event_manager_.EventStream[base_events.EventT]: """Return a stream iterator for the given event and sub-events. .. warning:: If you use `stream.open()` to start the stream then you must also close it with `stream.close()` otherwise it may queue events in memory indefinitely. Parameters ---------- event_type : typing.Type[hikari.events.base_events.Event] The event type to listen for. This will listen for subclasses of this type additionally. timeout : typing.Optional[int, float] How long this streamer should wait for the next event before ending the iteration. If `None` then this will continue until explicitly broken from. limit : typing.Optional[int] The limit for how many events this should queue at one time before dropping extra incoming events, leave this as `None` for the cache size to be unlimited. Returns ------- EventStream[hikari.events.base_events.Event] The async iterator to handle streamed events. This must be started with `with stream:` or `stream.open()` before asynchronously iterating over it. Examples -------- ```py with bot.stream(events.ReactionAddEvent, timeout=30).filter(("message_id", message.id)) as stream: async for user_id in stream.map("user_id").limit(50): ... ``` or using `open()` and `close()` ```py stream = bot.stream(events.ReactionAddEvent, timeout=30).filter(("message_id", message.id)) stream.open() async for user_id in stream.map("user_id").limit(50) ... stream.close() ``` See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ self._check_if_alive() return self._event_manager.stream(event_type, timeout=timeout, limit=limit) # Yes, this is not generic. The reason for this is MyPy complains about # using ABCs that are not concrete in generic types passed to functions. # For the sake of UX, I will check this at runtime instead and let the # user use a static type checker. def subscribe(self, event_type: typing.Type[typing.Any], callback: event_manager_.CallbackT[typing.Any]) -> None: """Subscribe a given callback to a given event type. Parameters ---------- event_type : typing.Type[T] The event type to listen for. This will also listen for any subclasses of the given type. `T` must be a subclass of `hikari.events.base_events.Event`. callback Must be a coroutine function to invoke. This should consume an instance of the given event, or an instance of a valid subclass if one exists. Any result is discarded. Example ------- The following demonstrates subscribing a callback to message creation events. ```py from hikari.events.messages import MessageCreateEvent async def on_message(event): ... bot.subscribe(MessageCreateEvent, on_message) ``` See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ self._event_manager.subscribe(event_type, callback) # Yes, this is not generic. The reason for this is MyPy complains about # using ABCs that are not concrete in generic types passed to functions. # For the sake of UX, I will check this at runtime instead and let the # user use a static type checker. def unsubscribe(self, event_type: typing.Type[typing.Any], callback: event_manager_.CallbackT[typing.Any]) -> None: """Unsubscribe a given callback from a given event type, if present. Parameters ---------- event_type : typing.Type[T] The event type to unsubscribe from. This must be the same exact type as was originally subscribed with to be removed correctly. `T` must derive from `hikari.events.base_events.Event`. callback The callback to unsubscribe. Example ------- The following demonstrates unsubscribing a callback from a message creation event. ```py from hikari.events.messages import MessageCreateEvent async def on_message(event): ... bot.unsubscribe(MessageCreateEvent, on_message) ``` See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.wait_for` """ self._event_manager.unsubscribe(event_type, callback) async def wait_for( self, event_type: typing.Type[base_events.EventT], /, timeout: typing.Union[float, int, None], predicate: typing.Optional[event_manager_.PredicateT[base_events.EventT]] = None, ) -> base_events.EventT: """Wait for a given event to occur once, then return the event. .. warning:: Async predicates are not supported. Parameters ---------- event_type : typing.Type[hikari.events.base_events.Event] The event type to listen for. This will listen for subclasses of this type additionally. predicate A function taking the event as the single parameter. This should return `True` if the event is one you want to return, or `False` if the event should not be returned. If left as `None` (the default), then the first matching event type that the bot receives (or any subtype) will be the one returned. timeout : typing.Union[float, int, None] The amount of time to wait before raising an `asyncio.TimeoutError` and giving up instead. This is measured in seconds. If `None`, then no timeout will be waited for (no timeout can result in "leaking" of coroutines that never complete if called in an uncontrolled way, so is not recommended). Returns ------- hikari.events.base_events.Event The event that was provided. Raises ------ asyncio.TimeoutError If the timeout is not `None` and is reached before an event is received that the predicate returns `True` for. See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` """ self._check_if_alive() return await self._event_manager.wait_for(event_type, timeout=timeout, predicate=predicate) def _get_shard(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> gateway_shard.GatewayShard: guild = snowflakes.Snowflake(guild) if shard := self._shards.get(snowflakes.calculate_shard_id(self.shard_count, guild)): return shard raise RuntimeError(f"Guild {guild} isn't covered by any of the shards in this client") async def update_presence( self, *, status: undefined.UndefinedOr[presences.Status] = undefined.UNDEFINED, idle_since: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, activity: undefined.UndefinedNoneOr[presences.Activity] = undefined.UNDEFINED, afk: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> None: self._check_if_alive() _validate_activity(activity) coros = [ s.update_presence(status=status, activity=activity, idle_since=idle_since, afk=afk) for s in self._shards.values() ] await aio.all_of(*coros) async def update_voice_state( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: typing.Optional[snowflakes.SnowflakeishOr[channels.GuildVoiceChannel]], *, self_mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED, self_deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> None: self._check_if_alive() shard = self._get_shard(guild) await shard.update_voice_state(guild=guild, channel=channel, self_mute=self_mute, self_deaf=self_deaf) async def request_guild_members( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, include_presences: undefined.UndefinedOr[bool] = undefined.UNDEFINED, query: str = "", limit: int = 0, users: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[users_.User]] = undefined.UNDEFINED, nonce: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: self._check_if_alive() shard = self._get_shard(guild) await shard.request_guild_members( guild=guild, include_presences=include_presences, query=query, limit=limit, users=users, nonce=nonce ) async def _set_close_flag(self, signame: str, signum: int) -> None: # This needs to be a coroutine, as the closing event is not threadsafe, so we have no way to set this # from a Unix system call handler if we are running on a thread that isn't the main application thread # without getting undefined behaviour. We do however have `asyncio.run_coroutine_threadsafe` which can # run a coroutine function on the event loop from a completely different thread, so this is the safest # solution. _LOGGER.debug("received interrupt %s (%s), will start shutting down shortly", signame, signum) await self._close() async def _start_one_shard( self, activity: typing.Optional[presences.Activity], afk: bool, idle_since: typing.Optional[datetime.datetime], status: presences.Status, large_threshold: int, shard_id: int, shard_count: int, url: str, closing_event: asyncio.Event, ) -> shard_impl.GatewayShardImpl: new_shard = shard_impl.GatewayShardImpl( http_settings=self._http_settings, proxy_settings=self._proxy_settings, event_manager=self._event_manager, event_factory=self._event_factory, intents=self._intents, initial_activity=activity, initial_is_afk=afk, initial_idle_since=idle_since, initial_status=status, large_threshold=large_threshold, shard_id=shard_id, shard_count=shard_count, token=self._token, url=url, ) self._shards[shard_id] = new_shard start = time.monotonic() await aio.first_completed(new_shard.start(), closing_event.wait()) end = time.monotonic() if new_shard.is_alive: _LOGGER.debug("shard %s started successfully in %.1fms", shard_id, (end - start) * 1_000) return new_shard raise errors.GatewayError(f"shard {shard_id} shut down immediately when starting")
View Source
class GatewayBot(traits.GatewayBotAware): """Basic auto-sharding bot implementation. This is the class you will want to use to start, control, and build a bot with. .. note:: Settings that control the gateway session are provided to the `GatewayBot.run` and `GatewayBot.start` functions in this class. This is done to allow you to contextually customise details such as sharding configuration without having to re-initialize the entire application each time. Parameters ---------- token : str The bot token to sign in with. Other Parameters ---------------- allow_color : bool Defaulting to `True`, this will enable coloured console logs on any platform that is a TTY. Setting a `"CLICOLOR"` environment variable to any **non `0`** value will override this setting. Users should consider this an advice to the application on whether it is safe to show colours if possible or not. Since some terminals can be awkward or not support features in a standard way, the option to explicitly disable this is provided. See `force_color` for an alternative. banner : typing.Optional[str] The package to search for a `banner.txt` in. Defaults to `"hikari"` for the `"hikari/banner.txt"` banner. Setting this to `None` will disable the banner being shown. executor : typing.Optional[concurrent.futures.Executor] Defaults to `None`. If non-`None`, then this executor is used instead of the `concurrent.futures.ThreadPoolExecutor` attached to the `asyncio.AbstractEventLoop` that the bot will run on. This executor is used primarily for file-IO. While mainly supporting the `concurrent.futures.ThreadPoolExecutor` implementation in the standard lib, Hikari's file handling systems should also work with `concurrent.futures.ProcessPoolExecutor`, which relies on all objects used in IPC to be `pickle`able. Many third-party libraries will not support this fully though, so your mileage may vary on using ProcessPoolExecutor implementations with this parameter. force_color : bool Defaults to `False`. If `True`, then this application will __force__ colour to be used in console-based output. Specifying a `"CLICOLOR_FORCE"` environment variable with a non-`"0"` value will override this setting. This will take precedence over `allow_color` if both are specified. cache_settings : typing.Optional[hikari.impl.config.CacheSettings] Optional cache settings. If unspecified, will use the defaults. http_settings : typing.Optional[hikari.impl.config.HTTPSettings] Optional custom HTTP configuration settings to use. Allows you to customise functionality such as whether SSL-verification is enabled, what timeouts `aiohttp` should expect to use for requests, and behavior regarding HTTP-redirects. intents : hikari.intents.Intents Defaults to `hikari.intents.Intents.ALL_UNPRIVILEGED`. This allows you to change which intents your application will use on the gateway. This can be used to control and change the types of events you will receive. logs : typing.Union[None, LoggerLevel, typing.Dict[str, typing.Any]] Defaults to `"INFO"`. If `None`, then the Python logging system is left uninitialized on startup, and you will need to configure it manually to view most logs that are output by components of this library. If one of the valid values in a `LoggerLevel`, then this will match a call to `colorlog.basicConfig` (a facade for `logging.basicConfig` with additional conduit for enabling coloured logging levels) with the `level` kwarg matching this value. If a `typing.Dict[str, typing.Any]` equivalent, then this value is passed to `logging.config.dictConfig` to allow the user to provide a specialized logging configuration of their choice. If any handlers are defined in the dict, default handlers will not be setup. As a side note, you can always opt to leave this on the default value and then use an incremental `logging.config.dictConfig` that applies any additional changes on top of the base configuration, if you prefer. An example of can be found in the `Example` section. Note that `"TRACE_HIKARI"` is a library-specific logging level which is expected to be more verbose than `"DEBUG"`. max_rate_limit : float The max number of seconds to backoff for when rate limited. Anything greater than this will instead raise an error. This defaults to five minutes if left to the default value. This is to stop potentially indefinitely waiting on an endpoint, which is almost never what you want to do if giving a response to a user. You can set this to `float("inf")` to disable this check entirely. Note that this only applies to the REST API component that communicates with Discord, and will not affect sharding or third party HTTP endpoints that may be in use. max_retries : typing.Optional[int] Maximum number of times a request will be retried if it fails with a `5xx` status. Defaults to 3 if set to `None`. proxy_settings : typing.Optional[hikari.impl.config.ProxySettings] Custom proxy settings to use with network-layer logic in your application to get through an HTTP-proxy. rest_url : typing.Optional[str] Defaults to the Discord REST API URL if `None`. Can be overridden if you are attempting to point to an unofficial endpoint, or if you are attempting to mock/stub the Discord API for any reason. Generally you do not want to change this. Example ------- Setting up logging using a dictionary configuration: ```py import os import hikari # We want to make gateway logs output as DEBUG, and TRACE for all ratelimit content. bot = hikari.GatewayBot( token=os.environ["BOT_TOKEN"], logs={ "version": 1, "incremental": True, "loggers": { "hikari.gateway": {"level": "DEBUG"}, "hikari.ratelimits": {"level": "TRACE_HIKARI"}, }, }, ) ``` """ shards: typing.Mapping[int, gateway_shard.GatewayShard] """Mapping of shards in this application instance. Each shard ID is mapped to the corresponding shard instance. If the application has not started, it is acceptable to assume the result of this call will be an empty mapping. """ # noqa: D401 - Imperative mood __slots__: typing.Sequence[str] = ( "_cache", "_closing_event", "_closed_event", "_entity_factory", "_event_manager", "_event_factory", "_executor", "_http_settings", "_intents", "_is_alive", "_proxy_settings", "_rest", "_shards", "_token", "_voice", "shards", ) def __init__( self, token: str, *, allow_color: bool = True, banner: typing.Optional[str] = "hikari", executor: typing.Optional[concurrent.futures.Executor] = None, force_color: bool = False, cache_settings: typing.Optional[config_impl.CacheSettings] = None, http_settings: typing.Optional[config_impl.HTTPSettings] = None, intents: intents_.Intents = intents_.Intents.ALL_UNPRIVILEGED, logs: typing.Union[None, int, str, typing.Dict[str, typing.Any]] = "INFO", max_rate_limit: float = 300, max_retries: int = 3, proxy_settings: typing.Optional[config_impl.ProxySettings] = None, rest_url: typing.Optional[str] = None, ) -> None: # Beautification and logging ux.init_logging(logs, allow_color, force_color) self.print_banner(banner, allow_color, force_color) # Settings and state self._closing_event: typing.Optional[asyncio.Event] = None self._closed_event: typing.Optional[asyncio.Event] = None self._is_alive = False self._executor = executor self._http_settings = http_settings if http_settings is not None else config_impl.HTTPSettings() self._intents = intents self._proxy_settings = proxy_settings if proxy_settings is not None else config_impl.ProxySettings() self._token = token.strip() # Caching cache_settings = cache_settings if cache_settings is not None else config_impl.CacheSettings() self._cache = cache_impl.CacheImpl(self, cache_settings) # Entity creation self._entity_factory = entity_factory_impl.EntityFactoryImpl(self) # Event creation self._event_factory = event_factory_impl.EventFactoryImpl(self) # Event handling self._event_manager = event_manager_impl.EventManagerImpl( self._entity_factory, self._event_factory, self._intents, cache=self._cache ) # Voice subsystem self._voice = voice_impl.VoiceComponentImpl(self) # RESTful API. self._rest = rest_impl.RESTClientImpl( cache=self._cache, entity_factory=self._entity_factory, executor=self._executor, http_settings=self._http_settings, max_rate_limit=max_rate_limit, proxy_settings=self._proxy_settings, rest_url=rest_url, max_retries=max_retries, token=token, token_type=applications.TokenType.BOT, ) # We populate these on startup instead, as we need to possibly make some # HTTP requests to determine what to put in this mapping. self._shards: typing.Dict[int, gateway_shard.GatewayShard] = {} self.shards = types.MappingProxyType(self._shards) @property def cache(self) -> cache_.Cache: return self._cache @property def event_manager(self) -> event_manager_.EventManager: return self._event_manager @property def entity_factory(self) -> entity_factory_.EntityFactory: return self._entity_factory @property def event_factory(self) -> event_factory_.EventFactory: return self._event_factory @property def executor(self) -> typing.Optional[concurrent.futures.Executor]: return self._executor @property def heartbeat_latencies(self) -> typing.Mapping[int, float]: return {s.id: s.heartbeat_latency for s in self._shards.values()} @property def heartbeat_latency(self) -> float: latencies = [s.heartbeat_latency for s in self._shards.values() if not math.isnan(s.heartbeat_latency)] return sum(latencies) / len(latencies) if latencies else float("nan") @property def http_settings(self) -> config_impl.HTTPSettings: return self._http_settings @property def intents(self) -> intents_.Intents: return self._intents @property def proxy_settings(self) -> config_impl.ProxySettings: return self._proxy_settings @property def shard_count(self) -> int: return next(iter(self._shards.values())).shard_count if self._shards else 0 @property def voice(self) -> voice_.VoiceComponent: return self._voice @property def rest(self) -> rest_.RESTClient: return self._rest @property def is_alive(self) -> bool: return self._is_alive def _check_if_alive(self) -> None: if not self._is_alive: raise errors.ComponentStateConflictError("bot is not running so it cannot be interacted with") def get_me(self) -> typing.Optional[users_.OwnUser]: return self._cache.get_me() async def close(self) -> None: self._check_if_alive() await self._close() async def _close(self) -> None: if self._closed_event: # Closing is in progress from another call, wait for that to complete. await self._closed_event.wait() return if self._closing_event is None: # If closing event is None then this is already closed. return _LOGGER.debug("bot requested to shutdown") self._closed_event = asyncio.Event() self._closing_event.set() self._closing_event = None dispatch_events = self._is_alive loop = asyncio.get_running_loop() async def handle(name: str, awaitable: typing.Awaitable[typing.Any]) -> None: future = asyncio.ensure_future(awaitable) try: await future except Exception as ex: loop.call_exception_handler( { "message": f"{name} raised an exception during shutdown", "future": future, "exception": ex, } ) if dispatch_events: await self._event_manager.dispatch(self._event_factory.deserialize_stopping_event()) _LOGGER.log(ux.TRACE, "StoppingEvent dispatch completed, now beginning termination") calls = [ ("rest", self._rest.close()), ("voice handler", self._voice.close()), *((f"shard {s.id}", s.close()) for s in self._shards.values()), ] for coro in asyncio.as_completed([handle(*pair) for pair in calls]): await coro # Clear out cache and shard map self._cache.clear() self._shards.clear() self._is_alive = False if dispatch_events: await self._event_manager.dispatch(self._event_factory.deserialize_stopped_event()) self._closed_event.set() self._closed_event = None def dispatch(self, event: base_events.Event) -> asyncio.Future[typing.Any]: """Dispatch an event. Parameters ---------- event : hikari.events.base_events.Event The event to dispatch. Example ------- We can dispatch custom events by first defining a class that derives from `hikari.events.base_events.Event`. ```py import attr from hikari.traits import RESTAware from hikari.events.base_events import Event from hikari.users import User from hikari.snowflakes import Snowflake @attr.define() class EveryoneMentionedEvent(Event): app: RESTAware = attr.field() author: User = attr.field() '''The user who mentioned everyone.''' content: str = attr.field() '''The message that was sent.''' message_id: Snowflake = attr.field() '''The message ID.''' channel_id: Snowflake = attr.field() '''The channel ID.''' ``` We can then dispatch our event as we see fit. ```py from hikari.events.messages import MessageCreateEvent @bot.listen(MessageCreateEvent) async def on_message(event): if "@everyone" in event.content or "@here" in event.content: event = EveryoneMentionedEvent( author=event.author, content=event.content, message_id=event.id, channel_id=event.channel_id, ) bot.dispatch(event) ``` This event can be listened to elsewhere by subscribing to it with `EventManager.subscribe`. ```py @bot.listen(EveryoneMentionedEvent) async def on_everyone_mentioned(event): print(event.user, "just pinged everyone in", event.channel_id) ``` Returns ------- asyncio.Future[typing.Any] A future that can be optionally awaited. If awaited, the future will complete once all corresponding event listeners have been invoked. If not awaited, this will schedule the dispatch of the events in the background for later. See Also -------- `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ return self._event_manager.dispatch(event) def get_listeners( self, event_type: typing.Type[base_events.EventT], /, *, polymorphic: bool = True ) -> typing.Collection[event_manager_.CallbackT[base_events.EventT]]: """Get the listeners for a given event type, if there are any. Parameters ---------- event_type : typing.Type[EventT] The event type to look for. `EventT` must be a subclass of `hikari.events.base_events.Event`. polymorphic : bool If `True`, this will also return the listeners of the subclasses of the given event type. If `False`, then only listeners for this class specifically are returned. The default is `True`. Returns ------- typing.Collection[typing.Callable[[EventT], typing.Coroutine[typing.Any, typing.Any, None]] A copy of the collection of listeners for the event. Will return an empty collection if nothing is registered. """ return self._event_manager.get_listeners(event_type, polymorphic=polymorphic) async def join(self, until_close: bool = True) -> None: self._check_if_alive() awaitables: typing.List[typing.Awaitable[typing.Any]] = [s.join() for s in self._shards.values()] if until_close and self._closing_event: # If closing event is None then this is already closing. awaitables.append(self._closing_event.wait()) await aio.first_completed(*awaitables) def listen( self, *event_types: typing.Type[base_events.EventT], ) -> typing.Callable[[event_manager_.CallbackT[base_events.EventT]], event_manager_.CallbackT[base_events.EventT]]: """Generate a decorator to subscribe a callback to an event type. This is a second-order decorator. Parameters ---------- *event_types : typing.Optional[typing.Type[EventT]] The event types to subscribe to. The implementation may allow this to be undefined. If this is the case, the event type will be inferred instead from the type hints on the function signature. `EventT` must be a subclass of `hikari.events.base_events.Event`. Returns ------- typing.Callable[[EventT], EventT] A decorator for a coroutine function that passes it to `EventManager.subscribe` before returning the function reference. See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ return self._event_manager.listen(*event_types) @staticmethod def print_banner( banner: typing.Optional[str], allow_color: bool, force_color: bool, extra_args: typing.Optional[typing.Dict[str, str]] = None, ) -> None: """Print the banner. This allows library vendors to override this behaviour, or choose to inject their own "branding" on top of what hikari provides by default. Normal users should not need to invoke this function, and can simply change the `banner` argument passed to the constructor to manipulate what is displayed. Parameters ---------- banner : typing.Optional[str] The package to find a `banner.txt` in. allow_color : bool A flag that allows advising whether to allow color if supported or not. Can be overridden by setting a `"CLICOLOR"` environment variable to a non-`"0"` string. force_color : bool A flag that allows forcing color to always be output, even if the terminal device may not support it. Setting the `"CLICOLOR_FORCE"` environment variable to a non-`"0"` string will override this. This will take precedence over `allow_color` if both are specified. extra_args : typing.Optional[typing.Dict[str, str]] If provided, extra $-substitutions to use when printing the banner. Default substitutions can not be overwritten. Raises ------ ValueError If `extra_args` contains a default $-substitution. """ ux.print_banner(banner, allow_color, force_color, extra_args=extra_args) def run( self, *, activity: typing.Optional[presences.Activity] = None, afk: bool = False, asyncio_debug: typing.Optional[bool] = None, check_for_updates: bool = True, close_passed_executor: bool = False, close_loop: bool = True, coroutine_tracking_depth: typing.Optional[int] = None, enable_signal_handlers: typing.Optional[bool] = None, idle_since: typing.Optional[datetime.datetime] = None, ignore_session_start_limit: bool = False, large_threshold: int = 250, propagate_interrupts: bool = False, status: presences.Status = presences.Status.ONLINE, shard_ids: typing.Optional[typing.AbstractSet[int]] = None, shard_count: typing.Optional[int] = None, ) -> None: """Start the bot, wait for all shards to become ready, and then return. Other Parameters ---------------- activity : typing.Optional[hikari.presences.Activity] The initial activity to display in the bot user presence, or `None` (default) to not show any. afk : bool The initial AFK state to display in the bot user presence, or `False` (default) to not show any. asyncio_debug : bool Defaults to `False`. If `True`, then debugging is enabled for the asyncio event loop in use. check_for_updates : bool Defaults to `True`. If `True`, will check for newer versions of `hikari` on PyPI and notify if available. close_passed_executor : bool Defaults to `False`. If `True`, any custom `concurrent.futures.Executor` passed to the constructor will be shut down when the application terminates. This does not affect the default executor associated with the event loop, and will not do anything if you do not provide a custom executor to the constructor. close_loop : bool Defaults to `True`. If `True`, then once the bot enters a state where all components have shut down permanently during application shutdown, then all asyncgens and background tasks will be destroyed, and the event loop will be shut down. This will wait until all `hikari`-owned `aiohttp` connectors have had time to attempt to shut down correctly (around 250ms), and on Python 3.9 and newer, will also shut down the default event loop executor too. coroutine_tracking_depth : typing.Optional[int] Defaults to `None`. If an integer value and supported by the interpreter, then this many nested coroutine calls will be tracked with their call origin state. This allows you to determine where non-awaited coroutines may originate from, but generally you do not want to leave this enabled for performance reasons. enable_signal_handlers : typing.Optional[bool] Defaults to `True` if this is started in the main thread. If on a __non-Windows__ OS with builtin support for kernel-level POSIX signals, then setting this to `True` will allow treating keyboard interrupts and other OS signals to safely shut down the application as calls to shut down the application properly rather than just killing the process in a dirty state immediately. You should leave this enabled unless you plan to implement your own signal handling yourself. idle_since : typing.Optional[datetime.datetime] The `datetime.datetime` the user should be marked as being idle since, or `None` (default) to not show this. ignore_session_start_limit : bool Defaults to `False`. If `False`, then attempting to start more sessions than you are allowed in a 24 hour window will throw a `hikari.errors.GatewayError` rather than going ahead and hitting the IDENTIFY limit, which may result in your token being reset. Setting to `True` disables this behavior. large_threshold : int Threshold for members in a guild before it is treated as being "large" and no longer sending member details in the `GUILD CREATE` event. Defaults to `250`. propagate_interrupts : bool Defaults to `False`. If set to `True`, then any internal `hikari.errors.HikariInterrupt` that is raises as a result of catching an OS level signal will result in the exception being rethrown once the application has closed. This can allow you to use hikari signal handlers and still be able to determine what kind of interrupt the application received after it closes. When `False`, nothing is raised and the call will terminate cleanly and silently where possible instead. shard_ids : typing.Optional[typing.AbstractSet[int]] The shard IDs to create shards for. If not `None`, then a non-`None` `shard_count` must ALSO be provided. Defaults to `None`, which means the Discord-recommended count is used for your application instead. shard_count : typing.Optional[int] The number of shards to use in the entire distributed application. Defaults to `None` which results in the count being determined dynamically on startup. status : hikari.presences.Status The initial status to show for the user presence on startup. Defaults to `hikari.presences.Status.ONLINE`. Raises ------ hikari.errors.ComponentStateConflictError If bot is already running. TypeError If `shard_ids` is passed without `shard_count`. """ if self._is_alive: raise errors.ComponentStateConflictError("bot is already running") if shard_ids is not None and shard_count is None: raise TypeError("'shard_ids' must be passed with 'shard_count'") loop = aio.get_or_make_loop() signals = ("SIGINT", "SIGTERM") if asyncio_debug: loop.set_debug(True) if coroutine_tracking_depth is not None: try: # Provisionally defined in CPython, may be removed without notice. sys.set_coroutine_origin_tracking_depth(coroutine_tracking_depth) except AttributeError: _LOGGER.log(ux.TRACE, "cannot set coroutine tracking depth for sys, no functionality exists for this") # Throwing this in the handler will lead to lots of fun OS specific shenanigans. So, lets just # cache it for later, I guess. interrupt: typing.Optional[errors.HikariInterrupt] = None loop_thread_id = threading.get_native_id() def handle_os_interrupt(signum: int, frame: typing.Optional[types.FrameType]) -> None: # If we use a POSIX system, then raising an exception in here works perfectly and shuts the loop down # with an exception, which is good. # Windows, however, is special on this front. On Windows, the exception is caught by whatever was # currently running on the event loop at the time, which is annoying for us, as this could be fired into # the task for an event dispatch, for example, which is a guarded call that is never waited for by design. # We can't always safely intercept this either, as Windows does not allow us to use asyncio loop # signal listeners (since Windows doesn't have kernel-level signals, only emulated system calls # for a remote few standard C signal types). Thus, the best solution here is to set the close bit # instead, which will let the bot start to clean itself up as if the user closed it manually via a call # to `bot.close()`. nonlocal interrupt signame = signal.strsignal(signum) assert signame is not None # Will always be True interrupt = errors.HikariInterrupt(signum, signame) # The loop may or may not be running, depending on the state of the application when this occurs. # Signals on POSIX only occur on the main thread usually, too, so we need to ensure this is # threadsafe if we want the user's application to still shut down if on a separate thread. # We log native thread IDs purely for debugging purposes. if _LOGGER.isEnabledFor(ux.TRACE): _LOGGER.log( ux.TRACE, "interrupt %s occurred on thread %s, bot on thread %s will be notified to shut down shortly\n" "Stacktrace for developer sanity:\n%s", signum, threading.get_native_id(), loop_thread_id, "".join(traceback.format_stack(frame)), ) asyncio.run_coroutine_threadsafe(self._set_close_flag(signame, signum), loop) if enable_signal_handlers is None: # Signal handlers can only be registered on the main thread so we # only default to True if this is the case. enable_signal_handlers = threading.current_thread() is threading.main_thread() if enable_signal_handlers: for sig in signals: try: signum = getattr(signal, sig) signal.signal(signum, handle_os_interrupt) except AttributeError: _LOGGER.log(ux.TRACE, "signal %s is not implemented on your platform", sig) try: loop.run_until_complete( self.start( activity=activity, afk=afk, check_for_updates=check_for_updates, idle_since=idle_since, ignore_session_start_limit=ignore_session_start_limit, large_threshold=large_threshold, shard_ids=shard_ids, shard_count=shard_count, status=status, ) ) loop.run_until_complete(self.join()) finally: try: loop.run_until_complete(self._close()) if close_passed_executor and self._executor is not None: _LOGGER.debug("shutting down executor %s", self._executor) self._executor.shutdown(wait=True) self._executor = None finally: if enable_signal_handlers: for sig in signals: try: signum = getattr(signal, sig) signal.signal(signum, signal.SIG_DFL) except AttributeError: # Signal not implemented probably. We should have logged this earlier. pass if close_loop: _destroy_loop(loop) _LOGGER.info("successfully terminated") if propagate_interrupts and interrupt is not None: raise interrupt async def start( self, *, activity: typing.Optional[presences.Activity] = None, afk: bool = False, check_for_updates: bool = True, idle_since: typing.Optional[datetime.datetime] = None, ignore_session_start_limit: bool = False, large_threshold: int = 250, shard_ids: typing.Optional[typing.AbstractSet[int]] = None, shard_count: typing.Optional[int] = None, status: presences.Status = presences.Status.ONLINE, ) -> None: """Start the bot, wait for all shards to become ready, and then return. Other Parameters ---------------- activity : typing.Optional[hikari.presences.Activity] The initial activity to display in the bot user presence, or `None` (default) to not show any. afk : bool The initial AFK state to display in the bot user presence, or `False` (default) to not show any. check_for_updates : bool Defaults to `True`. If `True`, will check for newer versions of `hikari` on PyPI and notify if available. idle_since : typing.Optional[datetime.datetime] The `datetime.datetime` the user should be marked as being idle since, or `None` (default) to not show this. ignore_session_start_limit : bool Defaults to `False`. If `False`, then attempting to start more sessions than you are allowed in a 24 hour window will throw a `hikari.errors.GatewayError` rather than going ahead and hitting the IDENTIFY limit, which may result in your token being reset. Setting to `True` disables this behavior. large_threshold : int Threshold for members in a guild before it is treated as being "large" and no longer sending member details in the `GUILD CREATE` event. Defaults to `250`. shard_ids : typing.Optional[typing.AbstractSet[int]] The shard IDs to create shards for. If not `None`, then a non-`None` `shard_count` must ALSO be provided. Defaults to `None`, which means the Discord-recommended count is used for your application instead. shard_count : typing.Optional[int] The number of shards to use in the entire distributed application. Defaults to `None` which results in the count being determined dynamically on startup. status : hikari.presences.Status The initial status to show for the user presence on startup. Defaults to `hikari.presences.Status.ONLINE`. Raises ------ TypeError If `shard_ids` is passed without `shard_count`. hikari.errors.ComponentStateConflictError If bot is already running. """ if self._is_alive: raise errors.ComponentStateConflictError("bot is already running") if shard_ids is not None and shard_count is None: raise TypeError("'shard_ids' must be passed with 'shard_count'") _validate_activity(activity) start_time = time.monotonic() self._rest.start() self._voice.start() self._closing_event = asyncio.Event() self._is_alive = True if check_for_updates: asyncio.create_task( ux.check_for_updates(self._http_settings, self._proxy_settings), name="check for package updates", ) requirements = await self._rest.fetch_gateway_bot_info() await self._event_manager.dispatch(self._event_factory.deserialize_starting_event()) if shard_count is None: shard_count = requirements.shard_count if shard_ids is None: shard_ids = set(range(shard_count)) if requirements.session_start_limit.remaining < len(shard_ids) and not ignore_session_start_limit: _LOGGER.critical( "would have started %s session%s, but you only have %s session%s remaining until %s. Starting more " "sessions than you are allowed to start may result in your token being reset. To skip this message, " "use bot.run(..., ignore_session_start_limit=True) or bot.start(..., ignore_session_start_limit=True)", len(shard_ids), "s" if len(shard_ids) != 1 else "", requirements.session_start_limit.remaining, "s" if requirements.session_start_limit.remaining != 1 else "", requirements.session_start_limit.reset_at, ) raise errors.GatewayError("Attempted to start more sessions than were allowed in the given time-window") _LOGGER.info( "you can start %s session%s before the next window which starts at %s; planning to start %s session%s... ", requirements.session_start_limit.remaining, "s" if requirements.session_start_limit.remaining != 1 else "", requirements.session_start_limit.reset_at, len(shard_ids), "s" if len(shard_ids) != 1 else "", ) for window_start in range(0, shard_count, requirements.session_start_limit.max_concurrency): window = [ candidate_shard_id for candidate_shard_id in range( window_start, window_start + requirements.session_start_limit.max_concurrency ) if candidate_shard_id in shard_ids ] if not window: continue if self._shards: close_waiter = asyncio.create_task(self._closing_event.wait()) shard_joiners = [s.join() for s in self._shards.values()] try: # Attempt to wait for all started shards, for 5 seconds, along with the close # waiter. # If the close flag is set (i.e. user invoked bot.close), or one or more shards # die in this time, we shut down immediately. # If we time out, the joining tasks get discarded and we spin up the next # block of shards, if applicable. _LOGGER.info("the next startup window is in 5 seconds, please wait...") await aio.first_completed(aio.all_of(*shard_joiners, timeout=5), close_waiter) if not close_waiter.cancelled(): _LOGGER.info("requested to shut down during startup of shards") else: _LOGGER.critical("one or more shards shut down unexpectedly during bot startup") return except asyncio.TimeoutError: # If any shards stopped silently, we should close. if any(not s.is_alive for s in self._shards.values()): _LOGGER.warning("one of the shards has been manually shut down (no error), will now shut down") await self._close() return # new window starts. except Exception as ex: _LOGGER.critical("an exception occurred in one of the started shards during bot startup: %r", ex) raise await aio.all_of( *( self._start_one_shard( activity=activity, afk=afk, idle_since=idle_since, status=status, large_threshold=large_threshold, shard_id=candidate_shard_id, shard_count=shard_count, url=requirements.url, closing_event=self._closing_event, ) for candidate_shard_id in window if candidate_shard_id in shard_ids ) ) await self._event_manager.dispatch(self._event_factory.deserialize_started_event()) _LOGGER.info("started successfully in approx %.2f seconds", time.monotonic() - start_time) def stream( self, event_type: typing.Type[base_events.EventT], /, timeout: typing.Union[float, int, None], limit: typing.Optional[int] = None, ) -> event_manager_.EventStream[base_events.EventT]: """Return a stream iterator for the given event and sub-events. .. warning:: If you use `stream.open()` to start the stream then you must also close it with `stream.close()` otherwise it may queue events in memory indefinitely. Parameters ---------- event_type : typing.Type[hikari.events.base_events.Event] The event type to listen for. This will listen for subclasses of this type additionally. timeout : typing.Optional[int, float] How long this streamer should wait for the next event before ending the iteration. If `None` then this will continue until explicitly broken from. limit : typing.Optional[int] The limit for how many events this should queue at one time before dropping extra incoming events, leave this as `None` for the cache size to be unlimited. Returns ------- EventStream[hikari.events.base_events.Event] The async iterator to handle streamed events. This must be started with `with stream:` or `stream.open()` before asynchronously iterating over it. Examples -------- ```py with bot.stream(events.ReactionAddEvent, timeout=30).filter(("message_id", message.id)) as stream: async for user_id in stream.map("user_id").limit(50): ... ``` or using `open()` and `close()` ```py stream = bot.stream(events.ReactionAddEvent, timeout=30).filter(("message_id", message.id)) stream.open() async for user_id in stream.map("user_id").limit(50) ... stream.close() ``` See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ self._check_if_alive() return self._event_manager.stream(event_type, timeout=timeout, limit=limit) # Yes, this is not generic. The reason for this is MyPy complains about # using ABCs that are not concrete in generic types passed to functions. # For the sake of UX, I will check this at runtime instead and let the # user use a static type checker. def subscribe(self, event_type: typing.Type[typing.Any], callback: event_manager_.CallbackT[typing.Any]) -> None: """Subscribe a given callback to a given event type. Parameters ---------- event_type : typing.Type[T] The event type to listen for. This will also listen for any subclasses of the given type. `T` must be a subclass of `hikari.events.base_events.Event`. callback Must be a coroutine function to invoke. This should consume an instance of the given event, or an instance of a valid subclass if one exists. Any result is discarded. Example ------- The following demonstrates subscribing a callback to message creation events. ```py from hikari.events.messages import MessageCreateEvent async def on_message(event): ... bot.subscribe(MessageCreateEvent, on_message) ``` See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ self._event_manager.subscribe(event_type, callback) # Yes, this is not generic. The reason for this is MyPy complains about # using ABCs that are not concrete in generic types passed to functions. # For the sake of UX, I will check this at runtime instead and let the # user use a static type checker. def unsubscribe(self, event_type: typing.Type[typing.Any], callback: event_manager_.CallbackT[typing.Any]) -> None: """Unsubscribe a given callback from a given event type, if present. Parameters ---------- event_type : typing.Type[T] The event type to unsubscribe from. This must be the same exact type as was originally subscribed with to be removed correctly. `T` must derive from `hikari.events.base_events.Event`. callback The callback to unsubscribe. Example ------- The following demonstrates unsubscribing a callback from a message creation event. ```py from hikari.events.messages import MessageCreateEvent async def on_message(event): ... bot.unsubscribe(MessageCreateEvent, on_message) ``` See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.wait_for` """ self._event_manager.unsubscribe(event_type, callback) async def wait_for( self, event_type: typing.Type[base_events.EventT], /, timeout: typing.Union[float, int, None], predicate: typing.Optional[event_manager_.PredicateT[base_events.EventT]] = None, ) -> base_events.EventT: """Wait for a given event to occur once, then return the event. .. warning:: Async predicates are not supported. Parameters ---------- event_type : typing.Type[hikari.events.base_events.Event] The event type to listen for. This will listen for subclasses of this type additionally. predicate A function taking the event as the single parameter. This should return `True` if the event is one you want to return, or `False` if the event should not be returned. If left as `None` (the default), then the first matching event type that the bot receives (or any subtype) will be the one returned. timeout : typing.Union[float, int, None] The amount of time to wait before raising an `asyncio.TimeoutError` and giving up instead. This is measured in seconds. If `None`, then no timeout will be waited for (no timeout can result in "leaking" of coroutines that never complete if called in an uncontrolled way, so is not recommended). Returns ------- hikari.events.base_events.Event The event that was provided. Raises ------ asyncio.TimeoutError If the timeout is not `None` and is reached before an event is received that the predicate returns `True` for. See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` """ self._check_if_alive() return await self._event_manager.wait_for(event_type, timeout=timeout, predicate=predicate) def _get_shard(self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild]) -> gateway_shard.GatewayShard: guild = snowflakes.Snowflake(guild) if shard := self._shards.get(snowflakes.calculate_shard_id(self.shard_count, guild)): return shard raise RuntimeError(f"Guild {guild} isn't covered by any of the shards in this client") async def update_presence( self, *, status: undefined.UndefinedOr[presences.Status] = undefined.UNDEFINED, idle_since: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, activity: undefined.UndefinedNoneOr[presences.Activity] = undefined.UNDEFINED, afk: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> None: self._check_if_alive() _validate_activity(activity) coros = [ s.update_presence(status=status, activity=activity, idle_since=idle_since, afk=afk) for s in self._shards.values() ] await aio.all_of(*coros) async def update_voice_state( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: typing.Optional[snowflakes.SnowflakeishOr[channels.GuildVoiceChannel]], *, self_mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED, self_deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> None: self._check_if_alive() shard = self._get_shard(guild) await shard.update_voice_state(guild=guild, channel=channel, self_mute=self_mute, self_deaf=self_deaf) async def request_guild_members( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, include_presences: undefined.UndefinedOr[bool] = undefined.UNDEFINED, query: str = "", limit: int = 0, users: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[users_.User]] = undefined.UNDEFINED, nonce: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: self._check_if_alive() shard = self._get_shard(guild) await shard.request_guild_members( guild=guild, include_presences=include_presences, query=query, limit=limit, users=users, nonce=nonce ) async def _set_close_flag(self, signame: str, signum: int) -> None: # This needs to be a coroutine, as the closing event is not threadsafe, so we have no way to set this # from a Unix system call handler if we are running on a thread that isn't the main application thread # without getting undefined behaviour. We do however have `asyncio.run_coroutine_threadsafe` which can # run a coroutine function on the event loop from a completely different thread, so this is the safest # solution. _LOGGER.debug("received interrupt %s (%s), will start shutting down shortly", signame, signum) await self._close() async def _start_one_shard( self, activity: typing.Optional[presences.Activity], afk: bool, idle_since: typing.Optional[datetime.datetime], status: presences.Status, large_threshold: int, shard_id: int, shard_count: int, url: str, closing_event: asyncio.Event, ) -> shard_impl.GatewayShardImpl: new_shard = shard_impl.GatewayShardImpl( http_settings=self._http_settings, proxy_settings=self._proxy_settings, event_manager=self._event_manager, event_factory=self._event_factory, intents=self._intents, initial_activity=activity, initial_is_afk=afk, initial_idle_since=idle_since, initial_status=status, large_threshold=large_threshold, shard_id=shard_id, shard_count=shard_count, token=self._token, url=url, ) self._shards[shard_id] = new_shard start = time.monotonic() await aio.first_completed(new_shard.start(), closing_event.wait()) end = time.monotonic() if new_shard.is_alive: _LOGGER.debug("shard %s started successfully in %.1fms", shard_id, (end - start) * 1_000) return new_shard raise errors.GatewayError(f"shard {shard_id} shut down immediately when starting")
Basic auto-sharding bot implementation.
This is the class you will want to use to start, control, and build a bot with.
Note: Settings that control the gateway session are provided to the GatewayBot.run and GatewayBot.start functions in this class. This is done to allow you to contextually customise details such as sharding configuration without having to re-initialize the entire application each time.
Parameters
- token (str): The bot token to sign in with.
Other Parameters
allow_color (bool): Defaulting to
True, this will enable coloured console logs on any platform that is a TTY. Setting a"CLICOLOR"environment variable to any non0value will override this setting.Users should consider this an advice to the application on whether it is safe to show colours if possible or not. Since some terminals can be awkward or not support features in a standard way, the option to explicitly disable this is provided. See
force_colorfor an alternative.- banner (typing.Optional[str]): The package to search for a
banner.txtin. Defaults to"hikari"for the"hikari/banner.txt"banner. Setting this toNonewill disable the banner being shown. executor (typing.Optional[concurrent.futures.Executor]): Defaults to
None. If non-None, then this executor is used instead of theconcurrent.futures.ThreadPoolExecutorattached to theasyncio.AbstractEventLoopthat the bot will run on. This executor is used primarily for file-IO.While mainly supporting the
concurrent.futures.ThreadPoolExecutorimplementation in the standard lib, Hikari's file handling systems should also work withconcurrent.futures.ProcessPoolExecutor, which relies on all objects used in IPC to bepickleable. Many third-party libraries will not support this fully though, so your mileage may vary on using ProcessPoolExecutor implementations with this parameter.force_color (bool): Defaults to
False. IfTrue, then this application will __force__ colour to be used in console-based output. Specifying a"CLICOLOR_FORCE"environment variable with a non-"0"value will override this setting.This will take precedence over
allow_colorif both are specified.- cache_settings (typing.Optional[hikari.impl.config.CacheSettings]): Optional cache settings. If unspecified, will use the defaults.
- http_settings (typing.Optional[hikari.impl.config.HTTPSettings]): Optional custom HTTP configuration settings to use. Allows you to customise functionality such as whether SSL-verification is enabled, what timeouts
aiohttpshould expect to use for requests, and behavior regarding HTTP-redirects. - intents (hikari.intents.Intents): Defaults to
hikari.intents.Intents.ALL_UNPRIVILEGED. This allows you to change which intents your application will use on the gateway. This can be used to control and change the types of events you will receive. logs (typing.Union[None, LoggerLevel, typing.Dict[str, typing.Any]]): Defaults to
"INFO".If
None, then the Python logging system is left uninitialized on startup, and you will need to configure it manually to view most logs that are output by components of this library.If one of the valid values in a
LoggerLevel, then this will match a call tocolorlog.basicConfig(a facade forlogging.basicConfigwith additional conduit for enabling coloured logging levels) with thelevelkwarg matching this value.If a
typing.Dict[str, typing.Any]equivalent, then this value is passed tologging.config.dictConfigto allow the user to provide a specialized logging configuration of their choice. If any handlers are defined in the dict, default handlers will not be setup.As a side note, you can always opt to leave this on the default value and then use an incremental
logging.config.dictConfigthat applies any additional changes on top of the base configuration, if you prefer. An example of can be found in theExamplesection.Note that
"TRACE_HIKARI"is a library-specific logging level which is expected to be more verbose than"DEBUG".max_rate_limit (float): The max number of seconds to backoff for when rate limited. Anything greater than this will instead raise an error.
This defaults to five minutes if left to the default value. This is to stop potentially indefinitely waiting on an endpoint, which is almost never what you want to do if giving a response to a user.
You can set this to
float("inf")to disable this check entirely.Note that this only applies to the REST API component that communicates with Discord, and will not affect sharding or third party HTTP endpoints that may be in use.
- max_retries (typing.Optional[int]): Maximum number of times a request will be retried if it fails with a
5xxstatus. Defaults to 3 if set toNone. - proxy_settings (typing.Optional[hikari.impl.config.ProxySettings]): Custom proxy settings to use with network-layer logic in your application to get through an HTTP-proxy.
- rest_url (typing.Optional[str]): Defaults to the Discord REST API URL if
None. Can be overridden if you are attempting to point to an unofficial endpoint, or if you are attempting to mock/stub the Discord API for any reason. Generally you do not want to change this.
Example
Setting up logging using a dictionary configuration:
import os
import hikari
# We want to make gateway logs output as DEBUG, and TRACE for all ratelimit content.
bot = hikari.GatewayBot(
token=os.environ["BOT_TOKEN"],
logs={
"version": 1,
"incremental": True,
"loggers": {
"hikari.gateway": {"level": "DEBUG"},
"hikari.ratelimits": {"level": "TRACE_HIKARI"},
},
},
)
Variables and properties
Immutable cache implementation for this object.
Entity factory implementation for this object.
Event factory component.
Event manager for this object.
Executor to use for blocking operations.
This may return None if the default asyncio thread pool should be used instead.
Mapping of shard ID to heartbeat latency.
Any shards that are not yet started will be float('nan').
Average heartbeat latency of all started shards.
If no shards are started, this will return float('nan').
HTTP settings in use by this component.
Intents registered for the application.
Whether the application is running or not.
This is useful as some functions might raise hikari.errors.ComponentStateConflictError if this is False.
Proxy settings in use by this component.
REST client to use for HTTP requests.
Number of shards in the total application.
This may not be the same as the size of shards. If the application is auto-sharded, this may be 0 until the shards are started.
Mapping of shards in this application instance.
Each shard ID is mapped to the corresponding shard instance.
If the application has not started, it is acceptable to assume the result of this call will be an empty mapping.
Voice connection manager component for this application.
Methods
# def __init__(
self,
token: str,
*,
allow_color: bool = True,
banner: Optional[str] = 'hikari',
executor: Optional[concurrent.futures._base.Executor] = None,
force_color: bool = False,
cache_settings: Optional[hikari.impl.config.CacheSettings] = None,
http_settings: Optional[hikari.impl.config.HTTPSettings] = None,
intents: hikari.intents.Intents = <Intents.ALL_UNPRIVILEGED: 98045>,
logs: Union[NoneType, int, str, Dict[str, Any]] = 'INFO',
max_rate_limit: float = 300,
max_retries: int = 3,
proxy_settings: Optional[hikari.impl.config.ProxySettings] = None,
rest_url: Optional[str] = None
):
self,
token: str,
*,
allow_color: bool = True,
banner: Optional[str] = 'hikari',
executor: Optional[concurrent.futures._base.Executor] = None,
force_color: bool = False,
cache_settings: Optional[hikari.impl.config.CacheSettings] = None,
http_settings: Optional[hikari.impl.config.HTTPSettings] = None,
intents: hikari.intents.Intents = <Intents.ALL_UNPRIVILEGED: 98045>,
logs: Union[NoneType, int, str, Dict[str, Any]] = 'INFO',
max_rate_limit: float = 300,
max_retries: int = 3,
proxy_settings: Optional[hikari.impl.config.ProxySettings] = None,
rest_url: Optional[str] = None
):
View Source
def __init__( self, token: str, *, allow_color: bool = True, banner: typing.Optional[str] = "hikari", executor: typing.Optional[concurrent.futures.Executor] = None, force_color: bool = False, cache_settings: typing.Optional[config_impl.CacheSettings] = None, http_settings: typing.Optional[config_impl.HTTPSettings] = None, intents: intents_.Intents = intents_.Intents.ALL_UNPRIVILEGED, logs: typing.Union[None, int, str, typing.Dict[str, typing.Any]] = "INFO", max_rate_limit: float = 300, max_retries: int = 3, proxy_settings: typing.Optional[config_impl.ProxySettings] = None, rest_url: typing.Optional[str] = None, ) -> None: # Beautification and logging ux.init_logging(logs, allow_color, force_color) self.print_banner(banner, allow_color, force_color) # Settings and state self._closing_event: typing.Optional[asyncio.Event] = None self._closed_event: typing.Optional[asyncio.Event] = None self._is_alive = False self._executor = executor self._http_settings = http_settings if http_settings is not None else config_impl.HTTPSettings() self._intents = intents self._proxy_settings = proxy_settings if proxy_settings is not None else config_impl.ProxySettings() self._token = token.strip() # Caching cache_settings = cache_settings if cache_settings is not None else config_impl.CacheSettings() self._cache = cache_impl.CacheImpl(self, cache_settings) # Entity creation self._entity_factory = entity_factory_impl.EntityFactoryImpl(self) # Event creation self._event_factory = event_factory_impl.EventFactoryImpl(self) # Event handling self._event_manager = event_manager_impl.EventManagerImpl( self._entity_factory, self._event_factory, self._intents, cache=self._cache ) # Voice subsystem self._voice = voice_impl.VoiceComponentImpl(self) # RESTful API. self._rest = rest_impl.RESTClientImpl( cache=self._cache, entity_factory=self._entity_factory, executor=self._executor, http_settings=self._http_settings, max_rate_limit=max_rate_limit, proxy_settings=self._proxy_settings, rest_url=rest_url, max_retries=max_retries, token=token, token_type=applications.TokenType.BOT, ) # We populate these on startup instead, as we need to possibly make some # HTTP requests to determine what to put in this mapping. self._shards: typing.Dict[int, gateway_shard.GatewayShard] = {} self.shards = types.MappingProxyType(self._shards)
View Source
async def close(self) -> None: self._check_if_alive() await self._close()
Kill the application by shutting all components down.
View Source
def dispatch(self, event: base_events.Event) -> asyncio.Future[typing.Any]: """Dispatch an event. Parameters ---------- event : hikari.events.base_events.Event The event to dispatch. Example ------- We can dispatch custom events by first defining a class that derives from `hikari.events.base_events.Event`. ```py import attr from hikari.traits import RESTAware from hikari.events.base_events import Event from hikari.users import User from hikari.snowflakes import Snowflake @attr.define() class EveryoneMentionedEvent(Event): app: RESTAware = attr.field() author: User = attr.field() '''The user who mentioned everyone.''' content: str = attr.field() '''The message that was sent.''' message_id: Snowflake = attr.field() '''The message ID.''' channel_id: Snowflake = attr.field() '''The channel ID.''' ``` We can then dispatch our event as we see fit. ```py from hikari.events.messages import MessageCreateEvent @bot.listen(MessageCreateEvent) async def on_message(event): if "@everyone" in event.content or "@here" in event.content: event = EveryoneMentionedEvent( author=event.author, content=event.content, message_id=event.id, channel_id=event.channel_id, ) bot.dispatch(event) ``` This event can be listened to elsewhere by subscribing to it with `EventManager.subscribe`. ```py @bot.listen(EveryoneMentionedEvent) async def on_everyone_mentioned(event): print(event.user, "just pinged everyone in", event.channel_id) ``` Returns ------- asyncio.Future[typing.Any] A future that can be optionally awaited. If awaited, the future will complete once all corresponding event listeners have been invoked. If not awaited, this will schedule the dispatch of the events in the background for later. See Also -------- `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ return self._event_manager.dispatch(event)
Dispatch an event.
Parameters
- event (hikari.events.base_events.Event): The event to dispatch.
Example
We can dispatch custom events by first defining a class that derives from hikari.events.base_events.Event.
import attr
from hikari.traits import RESTAware
from hikari.events.base_events import Event
from hikari.users import User
from hikari.snowflakes import Snowflake
@attr.define()
class EveryoneMentionedEvent(Event):
app: RESTAware = attr.field()
author: User = attr.field()
'''The user who mentioned everyone.'''
content: str = attr.field()
'''The message that was sent.'''
message_id: Snowflake = attr.field()
'''The message ID.'''
channel_id: Snowflake = attr.field()
'''The channel ID.'''
We can then dispatch our event as we see fit.
from hikari.events.messages import MessageCreateEvent
@bot.listen(MessageCreateEvent)
async def on_message(event):
if "@everyone" in event.content or "@here" in event.content:
event = EveryoneMentionedEvent(
author=event.author,
content=event.content,
message_id=event.id,
channel_id=event.channel_id,
)
bot.dispatch(event)
This event can be listened to elsewhere by subscribing to it with EventManager.subscribe.
@bot.listen(EveryoneMentionedEvent)
async def on_everyone_mentioned(event):
print(event.user, "just pinged everyone in", event.channel_id)
Returns
- asyncio.Future[typing.Any]: A future that can be optionally awaited. If awaited, the future will complete once all corresponding event listeners have been invoked. If not awaited, this will schedule the dispatch of the events in the background for later.
See Also
hikari.impl.bot.GatewayBot.listen
hikari.impl.bot.GatewayBot.stream
hikari.impl.bot.GatewayBot.subscribe
hikari.impl.bot.GatewayBot.unsubscribe
hikari.impl.bot.GatewayBot.wait_for
# def get_listeners(
self,
event_type: Type[~EventT],
/,
*,
polymorphic: bool = True
) -> Collection[Callable[[~EventT], Coroutine[Any, Any, NoneType]]]:
self,
event_type: Type[~EventT],
/,
*,
polymorphic: bool = True
) -> Collection[Callable[[~EventT], Coroutine[Any, Any, NoneType]]]:
View Source
def get_listeners( self, event_type: typing.Type[base_events.EventT], /, *, polymorphic: bool = True ) -> typing.Collection[event_manager_.CallbackT[base_events.EventT]]: """Get the listeners for a given event type, if there are any. Parameters ---------- event_type : typing.Type[EventT] The event type to look for. `EventT` must be a subclass of `hikari.events.base_events.Event`. polymorphic : bool If `True`, this will also return the listeners of the subclasses of the given event type. If `False`, then only listeners for this class specifically are returned. The default is `True`. Returns ------- typing.Collection[typing.Callable[[EventT], typing.Coroutine[typing.Any, typing.Any, None]] A copy of the collection of listeners for the event. Will return an empty collection if nothing is registered. """ return self._event_manager.get_listeners(event_type, polymorphic=polymorphic)
Get the listeners for a given event type, if there are any.
Parameters
- event_type (typing.Type[EventT]): The event type to look for.
EventTmust be a subclass ofhikari.events.base_events.Event. - polymorphic (bool): If
True, this will also return the listeners of the subclasses of the given event type. IfFalse, then only listeners for this class specifically are returned. The default isTrue.
Returns
- typing.Collection[typing.Callable[[EventT], typing.Coroutine[typing.Any, typing.Any, None]]: A copy of the collection of listeners for the event. Will return an empty collection if nothing is registered.
View Source
def get_me(self) -> typing.Optional[users_.OwnUser]: return self._cache.get_me()
Return the bot user, if known.
This should be available as soon as the bot has fired the hikari.events.lifetime_events.StartingEvent.
Until then, this may or may not be None.
Returns
- typing.Optional[hikari.users.OwnUser]: The bot user, if known, otherwise
None.
View Source
async def join(self, until_close: bool = True) -> None: self._check_if_alive() awaitables: typing.List[typing.Awaitable[typing.Any]] = [s.join() for s in self._shards.values()] if until_close and self._closing_event: # If closing event is None then this is already closing. awaitables.append(self._closing_event.wait()) await aio.first_completed(*awaitables)
Wait indefinitely until the application closes.
This can be placed in a task and cancelled without affecting the application runtime itself. Any exceptions raised by shards will be propagated to here.
Other Parameters
until_close (bool): Defaults to
True. If set, the waiter will stop as soon as a request for shut down is processed. This can allow you to break and begin closing your own resources.If
False, then this will wait until all shards' tasks have died.
# def listen(
self,
*event_types: Type[~EventT]
) -> Callable[[Callable[[~EventT], Coroutine[Any, Any, NoneType]]], Callable[[~EventT], Coroutine[Any, Any, NoneType]]]:
self,
*event_types: Type[~EventT]
) -> Callable[[Callable[[~EventT], Coroutine[Any, Any, NoneType]]], Callable[[~EventT], Coroutine[Any, Any, NoneType]]]:
View Source
def listen( self, *event_types: typing.Type[base_events.EventT], ) -> typing.Callable[[event_manager_.CallbackT[base_events.EventT]], event_manager_.CallbackT[base_events.EventT]]: """Generate a decorator to subscribe a callback to an event type. This is a second-order decorator. Parameters ---------- *event_types : typing.Optional[typing.Type[EventT]] The event types to subscribe to. The implementation may allow this to be undefined. If this is the case, the event type will be inferred instead from the type hints on the function signature. `EventT` must be a subclass of `hikari.events.base_events.Event`. Returns ------- typing.Callable[[EventT], EventT] A decorator for a coroutine function that passes it to `EventManager.subscribe` before returning the function reference. See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ return self._event_manager.listen(*event_types)
Generate a decorator to subscribe a callback to an event type.
This is a second-order decorator.
Parameters
*event_types (typing.Optional[typing.Type[EventT]]): The event types to subscribe to. The implementation may allow this to be undefined. If this is the case, the event type will be inferred instead from the type hints on the function signature.
EventTmust be a subclass ofhikari.events.base_events.Event.
Returns
- typing.Callable[[EventT], EventT]: A decorator for a coroutine function that passes it to
EventManager.subscribebefore returning the function reference.
See Also
hikari.impl.bot.GatewayBot.dispatch
hikari.impl.bot.GatewayBot.stream
hikari.impl.bot.GatewayBot.subscribe
hikari.impl.bot.GatewayBot.unsubscribe
hikari.impl.bot.GatewayBot.wait_for
# async def request_guild_members(
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
*,
include_presences: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
query: str = '',
limit: int = 0,
users: Union[Sequence[Union[hikari.users.User, hikari.snowflakes.Snowflake, int]], hikari.undefined.UndefinedType] = UNDEFINED,
nonce: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
*,
include_presences: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
query: str = '',
limit: int = 0,
users: Union[Sequence[Union[hikari.users.User, hikari.snowflakes.Snowflake, int]], hikari.undefined.UndefinedType] = UNDEFINED,
nonce: Union[str, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def request_guild_members( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], *, include_presences: undefined.UndefinedOr[bool] = undefined.UNDEFINED, query: str = "", limit: int = 0, users: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[users_.User]] = undefined.UNDEFINED, nonce: undefined.UndefinedOr[str] = undefined.UNDEFINED, ) -> None: self._check_if_alive() shard = self._get_shard(guild) await shard.request_guild_members( guild=guild, include_presences=include_presences, query=query, limit=limit, users=users, nonce=nonce )
Request for a guild chunk.
Note: To request the full list of members, set query to "" (empty string) and limit to 0.
Parameters
- guild (hikari.guilds.Guild): The guild to request chunk for.
Other Parameters
- include_presences (hikari.undefined.UndefinedOr[bool]): If provided, whether to request presences.
- query (str): If not
"", request the members which username starts with the string. - limit (int): Maximum number of members to send matching the query.
- users (hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishSequence[hikari.users.User]]): If provided, the users to request for.
- nonce (hikari.undefined.UndefinedOr[str]): If provided, the nonce to be sent with guild chunks.
Raises
- ValueError: When trying to specify
userswithquery/limit, iflimitis not between 0 and 100, both inclusive or ifuserslength is over 100. - hikari.errors.MissingIntentError: When trying to request presences without the
GUILD_MEMBERSor when trying to request the full list of members withoutGUILD_PRESENCES. - RuntimeError: If the guild passed isn't covered by any of the shards in this sharded client.
# def run(
self,
*,
activity: Optional[hikari.presences.Activity] = None,
afk: bool = False,
asyncio_debug: Optional[bool] = None,
check_for_updates: bool = True,
close_passed_executor: bool = False,
close_loop: bool = True,
coroutine_tracking_depth: Optional[int] = None,
enable_signal_handlers: Optional[bool] = None,
idle_since: Optional[datetime.datetime] = None,
ignore_session_start_limit: bool = False,
large_threshold: int = 250,
propagate_interrupts: bool = False,
status: hikari.presences.Status = <Status.ONLINE: 'online'>,
shard_ids: Optional[AbstractSet[int]] = None,
shard_count: Optional[int] = None
) -> None:
self,
*,
activity: Optional[hikari.presences.Activity] = None,
afk: bool = False,
asyncio_debug: Optional[bool] = None,
check_for_updates: bool = True,
close_passed_executor: bool = False,
close_loop: bool = True,
coroutine_tracking_depth: Optional[int] = None,
enable_signal_handlers: Optional[bool] = None,
idle_since: Optional[datetime.datetime] = None,
ignore_session_start_limit: bool = False,
large_threshold: int = 250,
propagate_interrupts: bool = False,
status: hikari.presences.Status = <Status.ONLINE: 'online'>,
shard_ids: Optional[AbstractSet[int]] = None,
shard_count: Optional[int] = None
) -> None:
View Source
def run( self, *, activity: typing.Optional[presences.Activity] = None, afk: bool = False, asyncio_debug: typing.Optional[bool] = None, check_for_updates: bool = True, close_passed_executor: bool = False, close_loop: bool = True, coroutine_tracking_depth: typing.Optional[int] = None, enable_signal_handlers: typing.Optional[bool] = None, idle_since: typing.Optional[datetime.datetime] = None, ignore_session_start_limit: bool = False, large_threshold: int = 250, propagate_interrupts: bool = False, status: presences.Status = presences.Status.ONLINE, shard_ids: typing.Optional[typing.AbstractSet[int]] = None, shard_count: typing.Optional[int] = None, ) -> None: """Start the bot, wait for all shards to become ready, and then return. Other Parameters ---------------- activity : typing.Optional[hikari.presences.Activity] The initial activity to display in the bot user presence, or `None` (default) to not show any. afk : bool The initial AFK state to display in the bot user presence, or `False` (default) to not show any. asyncio_debug : bool Defaults to `False`. If `True`, then debugging is enabled for the asyncio event loop in use. check_for_updates : bool Defaults to `True`. If `True`, will check for newer versions of `hikari` on PyPI and notify if available. close_passed_executor : bool Defaults to `False`. If `True`, any custom `concurrent.futures.Executor` passed to the constructor will be shut down when the application terminates. This does not affect the default executor associated with the event loop, and will not do anything if you do not provide a custom executor to the constructor. close_loop : bool Defaults to `True`. If `True`, then once the bot enters a state where all components have shut down permanently during application shutdown, then all asyncgens and background tasks will be destroyed, and the event loop will be shut down. This will wait until all `hikari`-owned `aiohttp` connectors have had time to attempt to shut down correctly (around 250ms), and on Python 3.9 and newer, will also shut down the default event loop executor too. coroutine_tracking_depth : typing.Optional[int] Defaults to `None`. If an integer value and supported by the interpreter, then this many nested coroutine calls will be tracked with their call origin state. This allows you to determine where non-awaited coroutines may originate from, but generally you do not want to leave this enabled for performance reasons. enable_signal_handlers : typing.Optional[bool] Defaults to `True` if this is started in the main thread. If on a __non-Windows__ OS with builtin support for kernel-level POSIX signals, then setting this to `True` will allow treating keyboard interrupts and other OS signals to safely shut down the application as calls to shut down the application properly rather than just killing the process in a dirty state immediately. You should leave this enabled unless you plan to implement your own signal handling yourself. idle_since : typing.Optional[datetime.datetime] The `datetime.datetime` the user should be marked as being idle since, or `None` (default) to not show this. ignore_session_start_limit : bool Defaults to `False`. If `False`, then attempting to start more sessions than you are allowed in a 24 hour window will throw a `hikari.errors.GatewayError` rather than going ahead and hitting the IDENTIFY limit, which may result in your token being reset. Setting to `True` disables this behavior. large_threshold : int Threshold for members in a guild before it is treated as being "large" and no longer sending member details in the `GUILD CREATE` event. Defaults to `250`. propagate_interrupts : bool Defaults to `False`. If set to `True`, then any internal `hikari.errors.HikariInterrupt` that is raises as a result of catching an OS level signal will result in the exception being rethrown once the application has closed. This can allow you to use hikari signal handlers and still be able to determine what kind of interrupt the application received after it closes. When `False`, nothing is raised and the call will terminate cleanly and silently where possible instead. shard_ids : typing.Optional[typing.AbstractSet[int]] The shard IDs to create shards for. If not `None`, then a non-`None` `shard_count` must ALSO be provided. Defaults to `None`, which means the Discord-recommended count is used for your application instead. shard_count : typing.Optional[int] The number of shards to use in the entire distributed application. Defaults to `None` which results in the count being determined dynamically on startup. status : hikari.presences.Status The initial status to show for the user presence on startup. Defaults to `hikari.presences.Status.ONLINE`. Raises ------ hikari.errors.ComponentStateConflictError If bot is already running. TypeError If `shard_ids` is passed without `shard_count`. """ if self._is_alive: raise errors.ComponentStateConflictError("bot is already running") if shard_ids is not None and shard_count is None: raise TypeError("'shard_ids' must be passed with 'shard_count'") loop = aio.get_or_make_loop() signals = ("SIGINT", "SIGTERM") if asyncio_debug: loop.set_debug(True) if coroutine_tracking_depth is not None: try: # Provisionally defined in CPython, may be removed without notice. sys.set_coroutine_origin_tracking_depth(coroutine_tracking_depth) except AttributeError: _LOGGER.log(ux.TRACE, "cannot set coroutine tracking depth for sys, no functionality exists for this") # Throwing this in the handler will lead to lots of fun OS specific shenanigans. So, lets just # cache it for later, I guess. interrupt: typing.Optional[errors.HikariInterrupt] = None loop_thread_id = threading.get_native_id() def handle_os_interrupt(signum: int, frame: typing.Optional[types.FrameType]) -> None: # If we use a POSIX system, then raising an exception in here works perfectly and shuts the loop down # with an exception, which is good. # Windows, however, is special on this front. On Windows, the exception is caught by whatever was # currently running on the event loop at the time, which is annoying for us, as this could be fired into # the task for an event dispatch, for example, which is a guarded call that is never waited for by design. # We can't always safely intercept this either, as Windows does not allow us to use asyncio loop # signal listeners (since Windows doesn't have kernel-level signals, only emulated system calls # for a remote few standard C signal types). Thus, the best solution here is to set the close bit # instead, which will let the bot start to clean itself up as if the user closed it manually via a call # to `bot.close()`. nonlocal interrupt signame = signal.strsignal(signum) assert signame is not None # Will always be True interrupt = errors.HikariInterrupt(signum, signame) # The loop may or may not be running, depending on the state of the application when this occurs. # Signals on POSIX only occur on the main thread usually, too, so we need to ensure this is # threadsafe if we want the user's application to still shut down if on a separate thread. # We log native thread IDs purely for debugging purposes. if _LOGGER.isEnabledFor(ux.TRACE): _LOGGER.log( ux.TRACE, "interrupt %s occurred on thread %s, bot on thread %s will be notified to shut down shortly\n" "Stacktrace for developer sanity:\n%s", signum, threading.get_native_id(), loop_thread_id, "".join(traceback.format_stack(frame)), ) asyncio.run_coroutine_threadsafe(self._set_close_flag(signame, signum), loop) if enable_signal_handlers is None: # Signal handlers can only be registered on the main thread so we # only default to True if this is the case. enable_signal_handlers = threading.current_thread() is threading.main_thread() if enable_signal_handlers: for sig in signals: try: signum = getattr(signal, sig) signal.signal(signum, handle_os_interrupt) except AttributeError: _LOGGER.log(ux.TRACE, "signal %s is not implemented on your platform", sig) try: loop.run_until_complete( self.start( activity=activity, afk=afk, check_for_updates=check_for_updates, idle_since=idle_since, ignore_session_start_limit=ignore_session_start_limit, large_threshold=large_threshold, shard_ids=shard_ids, shard_count=shard_count, status=status, ) ) loop.run_until_complete(self.join()) finally: try: loop.run_until_complete(self._close()) if close_passed_executor and self._executor is not None: _LOGGER.debug("shutting down executor %s", self._executor) self._executor.shutdown(wait=True) self._executor = None finally: if enable_signal_handlers: for sig in signals: try: signum = getattr(signal, sig) signal.signal(signum, signal.SIG_DFL) except AttributeError: # Signal not implemented probably. We should have logged this earlier. pass if close_loop: _destroy_loop(loop) _LOGGER.info("successfully terminated") if propagate_interrupts and interrupt is not None: raise interrupt
Start the bot, wait for all shards to become ready, and then return.
Other Parameters
- activity (typing.Optional[hikari.presences.Activity]): The initial activity to display in the bot user presence, or
None(default) to not show any. - afk (bool): The initial AFK state to display in the bot user presence, or
False(default) to not show any. - asyncio_debug (bool): Defaults to
False. IfTrue, then debugging is enabled for the asyncio event loop in use. - check_for_updates (bool): Defaults to
True. IfTrue, will check for newer versions ofhikarion PyPI and notify if available. - close_passed_executor (bool): Defaults to
False. IfTrue, any customconcurrent.futures.Executorpassed to the constructor will be shut down when the application terminates. This does not affect the default executor associated with the event loop, and will not do anything if you do not provide a custom executor to the constructor. close_loop (bool): Defaults to
True. IfTrue, then once the bot enters a state where all components have shut down permanently during application shutdown, then all asyncgens and background tasks will be destroyed, and the event loop will be shut down.This will wait until all
hikari-ownedaiohttpconnectors have had time to attempt to shut down correctly (around 250ms), and on Python 3.9 and newer, will also shut down the default event loop executor too.- coroutine_tracking_depth (typing.Optional[int]): Defaults to
None. If an integer value and supported by the interpreter, then this many nested coroutine calls will be tracked with their call origin state. This allows you to determine where non-awaited coroutines may originate from, but generally you do not want to leave this enabled for performance reasons. enable_signal_handlers (typing.Optional[bool]): Defaults to
Trueif this is started in the main thread.If on a __non-Windows__ OS with builtin support for kernel-level POSIX signals, then setting this to
Truewill allow treating keyboard interrupts and other OS signals to safely shut down the application as calls to shut down the application properly rather than just killing the process in a dirty state immediately. You should leave this enabled unless you plan to implement your own signal handling yourself.- idle_since (typing.Optional[datetime.datetime]): The
datetime.datetimethe user should be marked as being idle since, orNone(default) to not show this. - ignore_session_start_limit (bool): Defaults to
False. IfFalse, then attempting to start more sessions than you are allowed in a 24 hour window will throw ahikari.errors.GatewayErrorrather than going ahead and hitting the IDENTIFY limit, which may result in your token being reset. Setting toTruedisables this behavior. - large_threshold (int): Threshold for members in a guild before it is treated as being "large" and no longer sending member details in the
GUILD CREATEevent. Defaults to250. - propagate_interrupts (bool): Defaults to
False. If set toTrue, then any internalhikari.errors.HikariInterruptthat is raises as a result of catching an OS level signal will result in the exception being rethrown once the application has closed. This can allow you to use hikari signal handlers and still be able to determine what kind of interrupt the application received after it closes. WhenFalse, nothing is raised and the call will terminate cleanly and silently where possible instead. - shard_ids (typing.Optional[typing.AbstractSet[int]]): The shard IDs to create shards for. If not
None, then a non-Noneshard_countmust ALSO be provided. Defaults toNone, which means the Discord-recommended count is used for your application instead. - shard_count (typing.Optional[int]): The number of shards to use in the entire distributed application. Defaults to
Nonewhich results in the count being determined dynamically on startup. - status (hikari.presences.Status): The initial status to show for the user presence on startup. Defaults to
hikari.presences.Status.ONLINE.
Raises
- hikari.errors.ComponentStateConflictError: If bot is already running.
- TypeError: If
shard_idsis passed withoutshard_count.
# async def start(
self,
*,
activity: Optional[hikari.presences.Activity] = None,
afk: bool = False,
check_for_updates: bool = True,
idle_since: Optional[datetime.datetime] = None,
ignore_session_start_limit: bool = False,
large_threshold: int = 250,
shard_ids: Optional[AbstractSet[int]] = None,
shard_count: Optional[int] = None,
status: hikari.presences.Status = <Status.ONLINE: 'online'>
) -> None:
self,
*,
activity: Optional[hikari.presences.Activity] = None,
afk: bool = False,
check_for_updates: bool = True,
idle_since: Optional[datetime.datetime] = None,
ignore_session_start_limit: bool = False,
large_threshold: int = 250,
shard_ids: Optional[AbstractSet[int]] = None,
shard_count: Optional[int] = None,
status: hikari.presences.Status = <Status.ONLINE: 'online'>
) -> None:
View Source
async def start( self, *, activity: typing.Optional[presences.Activity] = None, afk: bool = False, check_for_updates: bool = True, idle_since: typing.Optional[datetime.datetime] = None, ignore_session_start_limit: bool = False, large_threshold: int = 250, shard_ids: typing.Optional[typing.AbstractSet[int]] = None, shard_count: typing.Optional[int] = None, status: presences.Status = presences.Status.ONLINE, ) -> None: """Start the bot, wait for all shards to become ready, and then return. Other Parameters ---------------- activity : typing.Optional[hikari.presences.Activity] The initial activity to display in the bot user presence, or `None` (default) to not show any. afk : bool The initial AFK state to display in the bot user presence, or `False` (default) to not show any. check_for_updates : bool Defaults to `True`. If `True`, will check for newer versions of `hikari` on PyPI and notify if available. idle_since : typing.Optional[datetime.datetime] The `datetime.datetime` the user should be marked as being idle since, or `None` (default) to not show this. ignore_session_start_limit : bool Defaults to `False`. If `False`, then attempting to start more sessions than you are allowed in a 24 hour window will throw a `hikari.errors.GatewayError` rather than going ahead and hitting the IDENTIFY limit, which may result in your token being reset. Setting to `True` disables this behavior. large_threshold : int Threshold for members in a guild before it is treated as being "large" and no longer sending member details in the `GUILD CREATE` event. Defaults to `250`. shard_ids : typing.Optional[typing.AbstractSet[int]] The shard IDs to create shards for. If not `None`, then a non-`None` `shard_count` must ALSO be provided. Defaults to `None`, which means the Discord-recommended count is used for your application instead. shard_count : typing.Optional[int] The number of shards to use in the entire distributed application. Defaults to `None` which results in the count being determined dynamically on startup. status : hikari.presences.Status The initial status to show for the user presence on startup. Defaults to `hikari.presences.Status.ONLINE`. Raises ------ TypeError If `shard_ids` is passed without `shard_count`. hikari.errors.ComponentStateConflictError If bot is already running. """ if self._is_alive: raise errors.ComponentStateConflictError("bot is already running") if shard_ids is not None and shard_count is None: raise TypeError("'shard_ids' must be passed with 'shard_count'") _validate_activity(activity) start_time = time.monotonic() self._rest.start() self._voice.start() self._closing_event = asyncio.Event() self._is_alive = True if check_for_updates: asyncio.create_task( ux.check_for_updates(self._http_settings, self._proxy_settings), name="check for package updates", ) requirements = await self._rest.fetch_gateway_bot_info() await self._event_manager.dispatch(self._event_factory.deserialize_starting_event()) if shard_count is None: shard_count = requirements.shard_count if shard_ids is None: shard_ids = set(range(shard_count)) if requirements.session_start_limit.remaining < len(shard_ids) and not ignore_session_start_limit: _LOGGER.critical( "would have started %s session%s, but you only have %s session%s remaining until %s. Starting more " "sessions than you are allowed to start may result in your token being reset. To skip this message, " "use bot.run(..., ignore_session_start_limit=True) or bot.start(..., ignore_session_start_limit=True)", len(shard_ids), "s" if len(shard_ids) != 1 else "", requirements.session_start_limit.remaining, "s" if requirements.session_start_limit.remaining != 1 else "", requirements.session_start_limit.reset_at, ) raise errors.GatewayError("Attempted to start more sessions than were allowed in the given time-window") _LOGGER.info( "you can start %s session%s before the next window which starts at %s; planning to start %s session%s... ", requirements.session_start_limit.remaining, "s" if requirements.session_start_limit.remaining != 1 else "", requirements.session_start_limit.reset_at, len(shard_ids), "s" if len(shard_ids) != 1 else "", ) for window_start in range(0, shard_count, requirements.session_start_limit.max_concurrency): window = [ candidate_shard_id for candidate_shard_id in range( window_start, window_start + requirements.session_start_limit.max_concurrency ) if candidate_shard_id in shard_ids ] if not window: continue if self._shards: close_waiter = asyncio.create_task(self._closing_event.wait()) shard_joiners = [s.join() for s in self._shards.values()] try: # Attempt to wait for all started shards, for 5 seconds, along with the close # waiter. # If the close flag is set (i.e. user invoked bot.close), or one or more shards # die in this time, we shut down immediately. # If we time out, the joining tasks get discarded and we spin up the next # block of shards, if applicable. _LOGGER.info("the next startup window is in 5 seconds, please wait...") await aio.first_completed(aio.all_of(*shard_joiners, timeout=5), close_waiter) if not close_waiter.cancelled(): _LOGGER.info("requested to shut down during startup of shards") else: _LOGGER.critical("one or more shards shut down unexpectedly during bot startup") return except asyncio.TimeoutError: # If any shards stopped silently, we should close. if any(not s.is_alive for s in self._shards.values()): _LOGGER.warning("one of the shards has been manually shut down (no error), will now shut down") await self._close() return # new window starts. except Exception as ex: _LOGGER.critical("an exception occurred in one of the started shards during bot startup: %r", ex) raise await aio.all_of( *( self._start_one_shard( activity=activity, afk=afk, idle_since=idle_since, status=status, large_threshold=large_threshold, shard_id=candidate_shard_id, shard_count=shard_count, url=requirements.url, closing_event=self._closing_event, ) for candidate_shard_id in window if candidate_shard_id in shard_ids ) ) await self._event_manager.dispatch(self._event_factory.deserialize_started_event()) _LOGGER.info("started successfully in approx %.2f seconds", time.monotonic() - start_time)
Start the bot, wait for all shards to become ready, and then return.
Other Parameters
- activity (typing.Optional[hikari.presences.Activity]): The initial activity to display in the bot user presence, or
None(default) to not show any. - afk (bool): The initial AFK state to display in the bot user presence, or
False(default) to not show any. - check_for_updates (bool): Defaults to
True. IfTrue, will check for newer versions ofhikarion PyPI and notify if available. - idle_since (typing.Optional[datetime.datetime]): The
datetime.datetimethe user should be marked as being idle since, orNone(default) to not show this. - ignore_session_start_limit (bool): Defaults to
False. IfFalse, then attempting to start more sessions than you are allowed in a 24 hour window will throw ahikari.errors.GatewayErrorrather than going ahead and hitting the IDENTIFY limit, which may result in your token being reset. Setting toTruedisables this behavior. - large_threshold (int): Threshold for members in a guild before it is treated as being "large" and no longer sending member details in the
GUILD CREATEevent. Defaults to250. - shard_ids (typing.Optional[typing.AbstractSet[int]]): The shard IDs to create shards for. If not
None, then a non-Noneshard_countmust ALSO be provided. Defaults toNone, which means the Discord-recommended count is used for your application instead. - shard_count (typing.Optional[int]): The number of shards to use in the entire distributed application. Defaults to
Nonewhich results in the count being determined dynamically on startup. - status (hikari.presences.Status): The initial status to show for the user presence on startup. Defaults to
hikari.presences.Status.ONLINE.
Raises
- TypeError: If
shard_idsis passed withoutshard_count. - hikari.errors.ComponentStateConflictError: If bot is already running.
# def stream(
self,
event_type: Type[~EventT],
/,
timeout: Union[float, int, NoneType],
limit: Optional[int] = None
) -> hikari.api.event_manager.EventStream[~EventT]:
self,
event_type: Type[~EventT],
/,
timeout: Union[float, int, NoneType],
limit: Optional[int] = None
) -> hikari.api.event_manager.EventStream[~EventT]:
View Source
def stream( self, event_type: typing.Type[base_events.EventT], /, timeout: typing.Union[float, int, None], limit: typing.Optional[int] = None, ) -> event_manager_.EventStream[base_events.EventT]: """Return a stream iterator for the given event and sub-events. .. warning:: If you use `stream.open()` to start the stream then you must also close it with `stream.close()` otherwise it may queue events in memory indefinitely. Parameters ---------- event_type : typing.Type[hikari.events.base_events.Event] The event type to listen for. This will listen for subclasses of this type additionally. timeout : typing.Optional[int, float] How long this streamer should wait for the next event before ending the iteration. If `None` then this will continue until explicitly broken from. limit : typing.Optional[int] The limit for how many events this should queue at one time before dropping extra incoming events, leave this as `None` for the cache size to be unlimited. Returns ------- EventStream[hikari.events.base_events.Event] The async iterator to handle streamed events. This must be started with `with stream:` or `stream.open()` before asynchronously iterating over it. Examples -------- ```py with bot.stream(events.ReactionAddEvent, timeout=30).filter(("message_id", message.id)) as stream: async for user_id in stream.map("user_id").limit(50): ... ``` or using `open()` and `close()` ```py stream = bot.stream(events.ReactionAddEvent, timeout=30).filter(("message_id", message.id)) stream.open() async for user_id in stream.map("user_id").limit(50) ... stream.close() ``` See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ self._check_if_alive() return self._event_manager.stream(event_type, timeout=timeout, limit=limit)
Return a stream iterator for the given event and sub-events.
Warning: If you use stream.open() to start the stream then you must also close it with stream.close() otherwise it may queue events in memory indefinitely.
Parameters
- event_type (typing.Type[hikari.events.base_events.Event]): The event type to listen for. This will listen for subclasses of this type additionally.
- timeout (typing.Optional[int, float]): How long this streamer should wait for the next event before ending the iteration. If
Nonethen this will continue until explicitly broken from. - limit (typing.Optional[int]): The limit for how many events this should queue at one time before dropping extra incoming events, leave this as
Nonefor the cache size to be unlimited.
Returns
- EventStream[hikari.events.base_events.Event]: The async iterator to handle streamed events. This must be started with
with stream:orstream.open()before asynchronously iterating over it.
Examples
with bot.stream(events.ReactionAddEvent, timeout=30).filter(("message_id", message.id)) as stream:
async for user_id in stream.map("user_id").limit(50):
...
or using open() and close()
stream = bot.stream(events.ReactionAddEvent, timeout=30).filter(("message_id", message.id))
stream.open()
async for user_id in stream.map("user_id").limit(50)
...
stream.close()
See Also
hikari.impl.bot.GatewayBot.dispatch
hikari.impl.bot.GatewayBot.listen
hikari.impl.bot.GatewayBot.subscribe
hikari.impl.bot.GatewayBot.unsubscribe
hikari.impl.bot.GatewayBot.wait_for
# def subscribe(
self,
event_type: Type[Any],
callback: Callable[[Any], Coroutine[Any, Any, NoneType]]
) -> None:
self,
event_type: Type[Any],
callback: Callable[[Any], Coroutine[Any, Any, NoneType]]
) -> None:
View Source
def subscribe(self, event_type: typing.Type[typing.Any], callback: event_manager_.CallbackT[typing.Any]) -> None: """Subscribe a given callback to a given event type. Parameters ---------- event_type : typing.Type[T] The event type to listen for. This will also listen for any subclasses of the given type. `T` must be a subclass of `hikari.events.base_events.Event`. callback Must be a coroutine function to invoke. This should consume an instance of the given event, or an instance of a valid subclass if one exists. Any result is discarded. Example ------- The following demonstrates subscribing a callback to message creation events. ```py from hikari.events.messages import MessageCreateEvent async def on_message(event): ... bot.subscribe(MessageCreateEvent, on_message) ``` See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.unsubscribe` `hikari.impl.bot.GatewayBot.wait_for` """ self._event_manager.subscribe(event_type, callback)
Subscribe a given callback to a given event type.
Parameters
- event_type (typing.Type[T]): The event type to listen for. This will also listen for any subclasses of the given type.
Tmust be a subclass ofhikari.events.base_events.Event. - callback: Must be a coroutine function to invoke. This should consume an instance of the given event, or an instance of a valid subclass if one exists. Any result is discarded.
Example
The following demonstrates subscribing a callback to message creation events.
from hikari.events.messages import MessageCreateEvent
async def on_message(event):
...
bot.subscribe(MessageCreateEvent, on_message)
See Also
hikari.impl.bot.GatewayBot.dispatch
hikari.impl.bot.GatewayBot.listen
hikari.impl.bot.GatewayBot.stream
hikari.impl.bot.GatewayBot.unsubscribe
hikari.impl.bot.GatewayBot.wait_for
# def unsubscribe(
self,
event_type: Type[Any],
callback: Callable[[Any], Coroutine[Any, Any, NoneType]]
) -> None:
self,
event_type: Type[Any],
callback: Callable[[Any], Coroutine[Any, Any, NoneType]]
) -> None:
View Source
def unsubscribe(self, event_type: typing.Type[typing.Any], callback: event_manager_.CallbackT[typing.Any]) -> None: """Unsubscribe a given callback from a given event type, if present. Parameters ---------- event_type : typing.Type[T] The event type to unsubscribe from. This must be the same exact type as was originally subscribed with to be removed correctly. `T` must derive from `hikari.events.base_events.Event`. callback The callback to unsubscribe. Example ------- The following demonstrates unsubscribing a callback from a message creation event. ```py from hikari.events.messages import MessageCreateEvent async def on_message(event): ... bot.unsubscribe(MessageCreateEvent, on_message) ``` See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.wait_for` """ self._event_manager.unsubscribe(event_type, callback)
Unsubscribe a given callback from a given event type, if present.
Parameters
- event_type (typing.Type[T]): The event type to unsubscribe from. This must be the same exact type as was originally subscribed with to be removed correctly.
Tmust derive fromhikari.events.base_events.Event. - callback: The callback to unsubscribe.
Example
The following demonstrates unsubscribing a callback from a message creation event.
from hikari.events.messages import MessageCreateEvent
async def on_message(event):
...
bot.unsubscribe(MessageCreateEvent, on_message)
See Also
hikari.impl.bot.GatewayBot.dispatch
hikari.impl.bot.GatewayBot.listen
hikari.impl.bot.GatewayBot.stream
hikari.impl.bot.GatewayBot.subscribe
hikari.impl.bot.GatewayBot.wait_for
# async def update_presence(
self,
*,
status: Union[hikari.presences.Status, hikari.undefined.UndefinedType] = UNDEFINED,
idle_since: Union[datetime.datetime, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
activity: Union[hikari.presences.Activity, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
afk: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
self,
*,
status: Union[hikari.presences.Status, hikari.undefined.UndefinedType] = UNDEFINED,
idle_since: Union[datetime.datetime, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
activity: Union[hikari.presences.Activity, hikari.undefined.UndefinedType, NoneType] = UNDEFINED,
afk: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def update_presence( self, *, status: undefined.UndefinedOr[presences.Status] = undefined.UNDEFINED, idle_since: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED, activity: undefined.UndefinedNoneOr[presences.Activity] = undefined.UNDEFINED, afk: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> None: self._check_if_alive() _validate_activity(activity) coros = [ s.update_presence(status=status, activity=activity, idle_since=idle_since, afk=afk) for s in self._shards.values() ] await aio.all_of(*coros)
Update the presence on all shards.
This call will patch the presence on each shard. This means that unless you explicitly specify a parameter, the previous value will be retained. This means you do not have to track the global presence in your code.
Note: This will only send the update payloads to shards that are alive. Any shards that are not alive will cache the new presence for when they do start.
Note: If you want to set presences per shard, access the shard you wish to update (e.g. by using GatewayBot.shards), and call hikari.api.shard.GatewayShard.update_presence on that shard. This method is simply a facade to make performing this in bulk simpler.
Other Parameters
- idle_since (hikari.undefined.UndefinedNoneOr[datetime.datetime]): The datetime that the user started being idle. If undefined, this will not be changed.
- afk (hikari.undefined.UndefinedOr[bool]): If
True, the user is marked as AFK. IfFalse, the user is marked as being active. If undefined, this will not be changed. - activity (hikari.undefined.UndefinedNoneOr[hikari.presences.Activity]): The activity to appear to be playing. If undefined, this will not be changed.
- status (hikari.undefined.UndefinedOr[hikari.presences.Status]): The web status to show. If undefined, this will not be changed.
# async def update_voice_state(
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
channel: Union[hikari.channels.GuildVoiceChannel, hikari.snowflakes.Snowflake, int, NoneType],
*,
self_mute: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
self_deaf: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
self,
guild: Union[hikari.guilds.PartialGuild, hikari.snowflakes.Snowflake, int],
channel: Union[hikari.channels.GuildVoiceChannel, hikari.snowflakes.Snowflake, int, NoneType],
*,
self_mute: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED,
self_deaf: Union[bool, hikari.undefined.UndefinedType] = UNDEFINED
) -> None:
View Source
async def update_voice_state( self, guild: snowflakes.SnowflakeishOr[guilds.PartialGuild], channel: typing.Optional[snowflakes.SnowflakeishOr[channels.GuildVoiceChannel]], *, self_mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED, self_deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED, ) -> None: self._check_if_alive() shard = self._get_shard(guild) await shard.update_voice_state(guild=guild, channel=channel, self_mute=self_mute, self_deaf=self_deaf)
Update the voice state for this bot in a given guild.
Parameters
- guild (hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]): The guild or guild ID to update the voice state for.
- channel (typing.Optional[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildVoiceChannel]]): The channel or channel ID to update the voice state for. If
Nonethen the bot will leave the voice channel that it is in for the given guild. - self_mute (bool): If specified and
True, the bot will mute itself in that voice channel. IfFalse, then it will unmute itself. - self_deaf (bool): If specified and
True, the bot will deafen itself in that voice channel. IfFalse, then it will undeafen itself.
Raises
- RuntimeError: If the guild passed isn't covered by any of the shards in this sharded client.
# async def wait_for(
self,
event_type: Type[~EventT],
/,
timeout: Union[float, int, NoneType],
predicate: Optional[Callable[[~EventT], bool]] = None
) -> ~EventT:
self,
event_type: Type[~EventT],
/,
timeout: Union[float, int, NoneType],
predicate: Optional[Callable[[~EventT], bool]] = None
) -> ~EventT:
View Source
async def wait_for( self, event_type: typing.Type[base_events.EventT], /, timeout: typing.Union[float, int, None], predicate: typing.Optional[event_manager_.PredicateT[base_events.EventT]] = None, ) -> base_events.EventT: """Wait for a given event to occur once, then return the event. .. warning:: Async predicates are not supported. Parameters ---------- event_type : typing.Type[hikari.events.base_events.Event] The event type to listen for. This will listen for subclasses of this type additionally. predicate A function taking the event as the single parameter. This should return `True` if the event is one you want to return, or `False` if the event should not be returned. If left as `None` (the default), then the first matching event type that the bot receives (or any subtype) will be the one returned. timeout : typing.Union[float, int, None] The amount of time to wait before raising an `asyncio.TimeoutError` and giving up instead. This is measured in seconds. If `None`, then no timeout will be waited for (no timeout can result in "leaking" of coroutines that never complete if called in an uncontrolled way, so is not recommended). Returns ------- hikari.events.base_events.Event The event that was provided. Raises ------ asyncio.TimeoutError If the timeout is not `None` and is reached before an event is received that the predicate returns `True` for. See Also -------- `hikari.impl.bot.GatewayBot.dispatch` `hikari.impl.bot.GatewayBot.listen` `hikari.impl.bot.GatewayBot.stream` `hikari.impl.bot.GatewayBot.subscribe` `hikari.impl.bot.GatewayBot.unsubscribe` """ self._check_if_alive() return await self._event_manager.wait_for(event_type, timeout=timeout, predicate=predicate)
Wait for a given event to occur once, then return the event.
Warning: Async predicates are not supported.
Parameters
- event_type (typing.Type[hikari.events.base_events.Event]): The event type to listen for. This will listen for subclasses of this type additionally.
- predicate: A function taking the event as the single parameter. This should return
Trueif the event is one you want to return, orFalseif the event should not be returned. If left asNone(the default), then the first matching event type that the bot receives (or any subtype) will be the one returned. - timeout (typing.Union[float, int, None]): The amount of time to wait before raising an
asyncio.TimeoutErrorand giving up instead. This is measured in seconds. IfNone, then no timeout will be waited for (no timeout can result in "leaking" of coroutines that never complete if called in an uncontrolled way, so is not recommended).
Returns
- hikari.events.base_events.Event: The event that was provided.
Raises
- asyncio.TimeoutError: If the timeout is not
Noneand is reached before an event is received that the predicate returnsTruefor.
See Also
hikari.impl.bot.GatewayBot.dispatch
hikari.impl.bot.GatewayBot.listen
hikari.impl.bot.GatewayBot.stream
hikari.impl.bot.GatewayBot.subscribe
hikari.impl.bot.GatewayBot.unsubscribe