iY|UdZddlmZddlZddlZddlZddlmZddlmZm Z ddl m Z m Z m Z mZmZmZmZmZmZmZmZmZmZmZddlmZmZmZer$dd lmZdd lm Z dd l!m"Z"dd l#m$Z$dd l%m&Z&ddl'm(Z(dZ)ede de fZ*ej+j,Z,de-d<ej.e/Z0Gdde1Z2ddZ3Gdde2Z4Gdde4Z5dS) a: The MIT License (MIT) Copyright (c) 2015-present Rapptz 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. ) annotationsN) app_commands)maybe_coroutine_to_kebab_case)AnyCallableClassVar CoroutineDict GeneratorIterableListOptional TYPE_CHECKINGSequenceTupleTypeVarUnion) _BaseCommandBotT MaybeCoro)Self) Snowflake)ClientT)BotBase)Context)Command)CogMetaCogGroupCogFuncT.)boundrMISSINGceZdZUdZded<ded<ded<ded<ded <ded <d ed <d ed<ded<ded<ded<dfd Zdfd ZeddZxZ S) ra A metaclass for defining a cog. Note that you should probably not use this directly. It is exposed purely for documentation purposes along with making custom metaclasses to intermix with other metaclasses such as the :class:`abc.ABCMeta` metaclass. For example, to create an abstract cog mixin class, the following would be done. .. code-block:: python3 import abc class CogABCMeta(commands.CogMeta, abc.ABCMeta): pass class SomeMixin(metaclass=abc.ABCMeta): pass class SomeCogMixin(SomeMixin, commands.Cog, metaclass=CogABCMeta): pass .. note:: When passing an attribute of a metaclass that is documented below, note that you must pass it as a keyword-only argument to the class creation like the following example: .. code-block:: python3 class MyCog(commands.Cog, name='My Cog'): pass Attributes ----------- name: :class:`str` The cog name. By default, it is the name of the class with no modification. description: :class:`str` The cog description. By default, it is the cleaned docstring of the class. .. versionadded:: 1.6 command_attrs: :class:`dict` A list of attributes to apply to every command inside this cog. The dictionary is passed into the :class:`Command` options at ``__init__``. If you specify attributes inside the command attribute in the class, it will override the one specified inside this attribute. For example: .. code-block:: python3 class MyCog(commands.Cog, command_attrs=dict(hidden=True)): @commands.command() async def foo(self, ctx): pass # hidden -> True @commands.command(hidden=False) async def bar(self, ctx): pass # hidden -> False group_name: Union[:class:`str`, :class:`~discord.app_commands.locale_str`] The group name of a cog. This is only applicable for :class:`GroupCog` instances. By default, it's the same value as :attr:`name`. .. versionadded:: 2.0 group_description: Union[:class:`str`, :class:`~discord.app_commands.locale_str`] The group description of a cog. This is only applicable for :class:`GroupCog` instances. By default, it's the same value as :attr:`description`. .. versionadded:: 2.0 group_nsfw: :class:`bool` Whether the application command group is NSFW. This is only applicable for :class:`GroupCog` instances. By default, it's ``False``. .. versionadded:: 2.0 group_auto_locale_strings: :class:`bool` If this is set to ``True``, then all translatable strings will implicitly be wrapped into :class:`~discord.app_commands.locale_str` rather than :class:`str`. Defaults to ``True``. .. versionadded:: 2.0 group_extras: :class:`dict` A dictionary that can be used to store extraneous data. This is only applicable for :class:`GroupCog` instances. The library will not touch any values or keys within this dictionary. .. versionadded:: 2.1 str __cog_name____cog_description__#Union[str, app_commands.locale_str]__cog_group_name____cog_group_description__bool__cog_group_nsfw__!__cog_group_auto_locale_strings__zDict[Any, Any]__cog_group_extras__Dict[str, Any]__cog_settings__zList[Command[Any, ..., Any]]__cog_commands__zDList[Union[app_commands.Group, app_commands.Command[Any, ..., Any]]]__cog_app_commands__List[Tuple[str, str]]__cog_listeners__argsrkwargsreturnc |\}}}td|Drtd |d}|d|}nH#t$r;|} |d}n#t$rt |}YnwxYwYnwxYw|di|d<||d<||d<|d d |d <|d d |d<|di|d<|dd}|(t j|dd}||d<|d|pd|d<i} i} i} d} tj ||||fi|} t| j D]}|j D]\}}|| vr| |=|| vr| |=t|t}|r|j}t|t"rV|rtd|d|d|dr#t| |||| |<t|t(jt(jfr^|jW|rtd|d|d|dr#t| |||| |<!t j|ra t3|d|dr#t| |||| |<#t4$rYwxYwt7| | _t7| | _g}| D](}|jD]}| ||j!f)|| _"| S)Nc3JK|]}t|tjVdSN) issubclassrGroup).0bases Y/usr/local/lib/hermes-agent/venv/lib/python3.11/site-packages/discord/ext/commands/cog.py z"CogMeta.__new__..s/FFz$ 233FFFFFFzbCannot inherit from app_commands.Group with commands.Cog, consider using commands.GroupCog insteadname group_name command_attrsr1r'r* group_nsfwFr-group_auto_locale_stringsTr. group_extrasr/ description__doc__r(group_descriptionu…r+zSCommands or listeners must not start with cog_ or bot_ (in method {0.__name__}.{1})zCommand in method .z must not be staticmethod.)cog_bot___cog_listener__)#any TypeErrorpopKeyErrorrinspectcleandocgetsuper__new__reversed__mro____dict__items isinstance staticmethod__func__r startswithformatrr=rparentiscoroutinefunctiongetattrAttributeErrorlistvaluesr2r3__cog_listener_names__append__name__r5)clsr6r7rCbasesattrscog_namerDrIcommandscog_app_commands listeners no_bot_cognew_clsr?elemvalueis_static_methodlisteners_as_listlistener listener_name __class__s r@rYzCogMeta.__new__s!eU FFFFF F F t  <zz&))H L(;;JJ 2 2 2H 2#ZZ 55  2 2 2+D11  2  2%+JJ$C$C ! (n&0"#&,jju&E&E"#5;ZZ@[]a5b5b12(. >2(F(F$%jj55  !*599Y+C+CDDK'2#$-3ZZ8K[Md\d-e-e)* j !%''/#tUEDDVDDW_-- 0 0D#}2244 0 0 e8## 9$$!$#-e\#B#B #+!NEe\220'h'(fT(f(fD(f(f(fggg'788G' (9(9$(E(EFFF%*HTNN (:L$((9(9#:#: '+,<,C,C,E,E'F'F$!((** M MH!)!@ M M "((-9J)KLLLL M %6!sGA B"*B?B"BB"BB"!B">M  MMNonec4tj|dSr;)rX__init__)selfr6r7r{s r@r~zCogMeta.__init__s$rBc|jSr;r')rls r@qualified_namezCogMeta.qualified_names rB)r6rr7rr8r)r6rr7rr8r|r8r&) rk __module__ __qualname__rJ__annotations__rYr~ classmethodr __classcell__r{s@r@rrJsUUn;;;;BBBB++++(((($$$$2222^^^^,,,,SSSSSSj         [     rBrfuncr8cd|_|Sr;)__cog_special_method__)rs r@_cog_special_methodr s"&D KrBcneZdZUdZded<ded<ded<ded<ded <d ed <d ed <ded<dZded<ded<ded<dSfd ZdTdZdUdZe dVd Z e dVd!Z e j dWd$Z dXd&Z dYd(Ze dZd)Zd[d+Zed\d/Zeefd]d2Zd^d4Zd^d5Zed_d6Zed_d7Zed`d;Zed`d<Zed`d=Zedad@ZedbdCZedcdEZedddFZ edddGZ!dedOZ"dfdRZ#xZ$S)gr aWThe base class that all cogs must inherit from. A cog is a collection of commands, listeners, and optional state to help group commands together. More information on them can be found on the :ref:`ext_commands_cogs` page. When inheriting from this class, the options shown in :class:`CogMeta` are equally valid here. r&r'r(r)r*r+r0r1List[Command[Self, ..., Any]]r2zEList[Union[app_commands.Group, app_commands.Command[Self, ..., Any]]]r3r4r5FClassVar[bool]__cog_is_app_commands_group__Optional[app_commands.Group]__cog_app_commands_group__zbOptional[Callable[[discord.Interaction, app_commands.AppCommandError], Coroutine[Any, Any, None]]]&__discord_app_commands_error_handler__r6rr7r8rct|}|jtfd|jD|_d|jD}g}i}|jrt j|j|j |j |j dt|ddt|ddt|ddt|ddt|dd|j }nd}||_|jD]}t||jj||j} | || j} t)| d rFt)|d r6t|d d} ||j} | r | r| |_| |j| |t)|d r| t|d d} | r|j} | | | } | |_t7| t jrL| D]7}|||j<t)|d r|j|vr||j|_8|jr|| t> |j!|j!}nd}||_"|j#D]}||j| }|j$rt||j$|t7|t jrD||_"|j%&D]#}t7|t jr||_"$||||_#|jrK|j'|j_(d|D}tS|dkrtUd||j_%|S)Nc3BK|]}|VdSr;) _update_copy)r>c cmd_attrss r@rAzCog.__new__..2s/%^%^AannY&?&?%^%^%^%^%^%^rBci|] }|j| S)rr>cmds r@ zCog.__new__..4sKKKc#$cKKKrB'__discord_app_commands_default_guilds__#__discord_app_commands_guild_only__F!__discord_app_commands_contexts__+__discord_app_commands_installation_types__,__discord_app_commands_default_permissions__) rCrInsfwauto_locale_stringsrc guild_ids guild_onlyallowed_contextsallowed_installsdefault_permissionsextras__commands_is_hybrid__ app_command)rcbinding"__commands_is_hybrid_app_command__ci|] }|j| Sr)rCrs r@rzCog.__new__..s999sx999rBz7maximum number of application command children exceeded)+rXrYr1tupler2rrr=r*r+r-r.rer/rsetattrcallbackrkrcrhasattrrWrremove_commandrC add_command _copy_withr^ walk_commandswrappedrjr _get_overridden_methodcog_app_command_errorrr3_attr _childrenrhrmodulelenrR)rlr6r7rlookupchildrenapp_command_refsgroupcommandrccurrentupdatedr group_parentchild error_handlercopymappingrr{s @r@rYz Cog.__new__)sAwws##( !&%^%^%^%^I]%^%^%^ ^ ^KKT5JKKK[]gi  ,  &+9+$'$I!#'PRVWW"3(MuUU!(.QSW!X!X!(.[]a!b!b$+C1_ae$f$f/   EEE*/',' 5' 5G D'*3W = = =^F! 566#;<<6RjAkAk6ipjjG/2273IJJG676.5+%%gl333""7+++w 899 5fnip]Djj 5#'#BL"-"8"8 VZ"8"["[K*5G'"+|/ABBM%0%>%>%@%@MMEEJ,U-AB&u.RSSMX]XlpvXvXv06u7K0L 65  444  % %d&@ A A M 6MM M6C3/ " "G%%T-LVZ%[[Dz 0dj$///$ 233 W>K;#~4466WWG!'<+=>>WIVF OOD ! ! ! !$,!  * @58^D + 299999G7||b   YZZZ8?D + 5 rBc$d|jDS)a~Returns the commands that are defined inside this cog. This does *not* include :class:`discord.app_commands.Command` or :class:`discord.app_commands.Group` instances. Returns -------- List[:class:`.Command`] A :class:`list` of :class:`.Command`\s that are defined inside this cog, not including subcommands. c g|] }|j | Sr;rcr>rs r@ z$Cog.get_commands..sEEEaAH4D4D4D4DrB)r2rs r@ get_commandszCog.get_commandssFE40EEEErBEList[Union[app_commands.Command[Self, ..., Any], app_commands.Group]]c$d|jDS)aReturns the app commands that are defined inside this cog. Returns -------- List[Union[:class:`discord.app_commands.Command`, :class:`discord.app_commands.Group`]] A :class:`list` of :class:`discord.app_commands.Command`\s and :class:`discord.app_commands.Group`\s that are defined inside this cog, not including subcommands. c g|] }|j | Sr;rrs r@rz(Cog.get_app_commands..sIIIa8H8H8H8HrB)r3rs r@get_app_commandszCog.get_app_commandssJI44IIIIrBc|jS)zC:class:`str`: Returns the cog's specified name, not the class name.rrs r@rzCog.qualified_names   rBc|jS)zM:class:`str`: Returns the cog's description, typically the cleaned docstring.r(rs r@rIzCog.descriptions ''rBrIr|c||_dSr;r)rrIs r@rIzCog.descriptions#.   rB.Generator[Command[Self, ..., Any], None, None]c#Kddlm}|jD]7}|j.|Vt ||r|Ed{V8dS)zAn iterator that recursively walks through this cog's commands and subcommands. Yields ------ Union[:class:`.Command`, :class:`.Group`] A command or group from the cog. r) GroupMixinN)corerr2rcr^r)rrrs r@rzCog.walk_commandss~ %$$$$$, 7 7G~% gz227&44666666666  7 7rBVGenerator[Union[app_commands.Command[Self, ..., Any], app_commands.Group], None, None]c#K|jD]:}|Vt|tjr|Ed{V;dS)aAn iterator that recursively walks through this cog's app commands and subcommands. Yields ------ Union[:class:`discord.app_commands.Command`, :class:`discord.app_commands.Group`] An app command or group from the cog. N)r3r^rr=r)rrs r@walk_app_commandszCog.walk_app_commandssg0 3 3GMMM'<#566 3"00222222222 3 3rBc|jS)zOptional[:class:`discord.app_commands.Group`]: Returns the associated group with this cog. This is only available if inheriting from :class:`GroupCog`. )rrs r@rzCog.app_commands ..rB$List[Tuple[str, Callable[..., Any]]]c*fdjDS)zReturns a :class:`list` of (name, function) listener pairs that are defined in this cog. Returns -------- List[Tuple[:class:`str`, :ref:`coroutine `]] The listeners defined in this cog. c:g|]\}}|t|fSr)re)r>rC method_namers r@rz%Cog.get_listeners..s-ccc7Ht[wt[112cccrB)r5rs`r@ get_listenerszCog.get_listenerss#dcccDLbccccrBmethodr"Optional[FuncT]c.t|jd|S)zUReturn None if the method is not overridden. Otherwise returns the overridden method.r)rer`)rlrs r@rzCog._get_overridden_methodsv(@&IIIrBrCCallable[[FuncT], FuncT]ctur2ttstdjjddfd }|S)aA decorator that marks a function as a listener. This is the cog equivalent of :meth:`.Bot.listen`. Parameters ------------ name: :class:`str` The name of the event being listened to. If not provided, it defaults to the function's name. Raises -------- TypeError The function is not a coroutine function or a string was not passed as the name. z'Cog.listener expected str but received z instead.rr"r8c|}t|tr|j}tj|st dd|_p|j} |j |n#t$r |g|_YnwxYw|S)Nz/Listener function must be a coroutine function.T) r^r_r`rUrdrRrPrkrirjrf)ractual to_assignrCs r@ decoratorzCog.listener..decorator sF&,// ).v66 S QRRR&*F #/I <-44Y????! < < <1: --- < KsA//BBrr"r8r")r$r^r&rRr{rk)rlrCrs ` r@ryz Cog.listenersd& w  z$'<'< hdnF]hhhii i      $rBr,c8t|jjd S)zc:class:`bool`: Checks whether the cog has an error handler. .. versionadded:: 1.7 r)rcog_command_errorr`rs r@has_error_handlerzCog.has_error_handlers 41:@XYYYYrBc KdS)a|maybecoro| A special method that is called when the cog gets loaded. Subclasses must replace this if they want special asynchronous loading behaviour. Note that the ``__init__`` special method does not allow asynchronous code to run inside it, thus this is helpful for setting up code that needs to be asynchronous. .. versionadded:: 2.0 Nrrs r@cog_loadz Cog.cog_load+s  rBc KdS)aT|maybecoro| A special method that is called when the cog gets removed. Subclasses must replace this if they want special unloading behaviour. Exceptions raised in this method are ignored during extension unloading. .. versionchanged:: 2.0 This method can now be a :term:`coroutine`. Nrrs r@ cog_unloadzCog.cog_unload9s  rBctx Context[BotT]MaybeCoro[bool]cdS)zA special method that registers as a :meth:`.Bot.check_once` check. This function **can** be a coroutine and must take a sole parameter, ``ctx``, to represent the :class:`.Context`. Trrrs r@bot_check_oncezCog.bot_check_onceI trBcdS)zA special method that registers as a :meth:`.Bot.check` check. This function **can** be a coroutine and must take a sole parameter, ``ctx``, to represent the :class:`.Context`. Trrs r@ bot_checkz Cog.bot_checkSrrBcdS)a A special method that registers as a :func:`~discord.ext.commands.check` for every command and subcommand in this cog. This function **can** be a coroutine and must take a sole parameter, ``ctx``, to represent the :class:`.Context`. Trrs r@ cog_checkz Cog.cog_check]rrB interactiondiscord.Interaction[ClientT]cdS)a@A special method that registers as a :func:`discord.app_commands.check` for every app command and subcommand in this cog. This function **can** be a coroutine and must take a sole parameter, ``interaction``, to represent the :class:`~discord.Interaction`. .. versionadded:: 2.0 Tr)rrs r@interaction_checkzCog.interaction_checkgs trBerror Exceptionc KdS)a|coro| A special method that is called whenever an error is dispatched inside this cog. This is similar to :func:`.on_command_error` except only applying to the commands inside this cog. This **must** be a coroutine. Parameters ----------- ctx: :class:`.Context` The invocation context where the error happened. error: :class:`CommandError` The error that happened. Nr)rrr s r@rzCog.cog_command_errorss & rBapp_commands.AppCommandErrorc KdS)aC|coro| A special method that is called whenever an error within an application command is dispatched inside this cog. This is similar to :func:`discord.app_commands.CommandTree.on_error` except only applying to the application commands inside this cog. This **must** be a coroutine. Parameters ----------- interaction: :class:`~discord.Interaction` The interaction that is being handled. error: :exc:`~discord.app_commands.AppCommandError` The exception that was raised. Nr)rrr s r@rzCog.cog_app_command_errors * rBc KdS)a!|coro| A special method that acts as a cog local pre-invoke hook. This is similar to :meth:`.Command.before_invoke`. This **must** be a coroutine. Parameters ----------- ctx: :class:`.Context` The invocation context. Nrrs r@cog_before_invokezCog.cog_before_invoke  rBc KdS)a!|coro| A special method that acts as a cog local post-invoke hook. This is similar to :meth:`.Command.after_invoke`. This **must** be a coroutine. Parameters ----------- ctx: :class:`.Context` The invocation context. Nrrs r@cog_after_invokezCog.cog_after_invokerrBbotroverrideguildOptional[Snowflake]guildsSequence[Snowflake]cK|j}t|jd{Vt|jD]\}}||_|j ||*#t$r[}|jd|D]#} | j| | j $ t|j d{V|#|xYwd}~wwxYw|j tj ur||j |jtjur||jd|jD])\} } |t%|| | *|js(|jD] }|j||||!|S)NT call_once)rrr)r{rr enumerater2cogrcrr rrCrrr add_checkrr5 add_listenerrerr3tree) rrrrrrlindexreto_undorCrs r@_injectz Cog._injectsndm,,,,,,,,, ((=>> NE7GK~%  OOG,,,,    #'#8%#@==">1..w|<<< -do>>>>>>>>>a & = - - MM$. ) ) )  S%7 7 7 MM$-M > > > "&!7 ? ? D+   WT;77 > > > >. ]4 ] ]$$WxuU[$\\\\ s0 A"" C,3C B<:C<B??CCrOptional[Iterable[int]]cK|j} |jD]#}|j||j$|jsn|jD]f}|p|j}| |j|j-|D]6}|j|jtj |7g|j D])\}}| t|||*|jtjur||j|jtjur||jd t%|jd{VdS#t($r%t*d||jYdSwxYw# t%|jd{Vw#t($r$t*d||jYwwxYwxYw)N)id)rTrz0Ignoring exception in cog unload for Cog %r (%r))r{r2rcrrCrr3 _guild_idsr"discordObjectr5remove_listenerrerr remove_checkrrrr _log exceptionr)rrrrlrguild_idrCrs r@_ejectz Cog._ejectsIn m0 5 5>)&&w|4442 e#8eeG ) ?W-?I (// ====(1eeHH33GLZbHcHcHc3dddde&*%; F F!k##GD+$>$>EEEE}CM11  000!);;;  !4 EEE m%do66666666666 m m mQSVX\Xkllllll m m%do6666666666 m m mQSVX\Xklllll msBD-F9E+FFG F$#G$+GGGG)r6rr7rr8r)r8r)r8rr)rIr&r8r|)r8r)r8r)r8r)r8r)rr"r8r)rCr&r8r)r8r,)r8r|)rrr8r)rrr8r)rrr r r8r|)rrr rr8r|)rrr8r|) rrrr,rrrrr8r)rrrr'r8r|)%rkrrrJrrrYrrpropertyrrIsetterrrrrrrr$ryrrrrrrrrr rrrrr&r2rrs@r@r r s;;;;BBBB$$$$3333____,,,,49!9999<<<<mmmmmm^ F F F F J J J J!!!X!(((X(////7777 3 3 3 3///X/ddddJJJ[J")''''['RVVVVZZZZ                    (    ,        ....`mmmmmmmmrBr ) metaclassc"eZdZUdZdZded<dS)r!aRepresents a cog that also doubles as a parent :class:`discord.app_commands.Group` for the application commands defined within it. This inherits from :class:`Cog` and the options in :class:`CogMeta` also apply to this. See the :class:`Cog` documentation for methods. Decorators such as :func:`~discord.app_commands.guild_only`, :func:`~discord.app_commands.guilds`, and :func:`~discord.app_commands.default_permissions` will apply to the group if used on top of the cog. Hybrid commands will also be added to the Group, giving the ability to categorize slash commands into groups, while keeping the prefix-style command as a root-level command. For example: .. code-block:: python3 from discord import app_commands from discord.ext import commands @app_commands.guild_only() class MyCog(commands.GroupCog, group_name='my-cog'): pass .. versionadded:: 2.0 TrrN)rkrrrJrrrrBr@r!r!s0659!888888rBr!r)6rJ __future__rrUr+loggingr discord.utilsrrtypingrrr r r r r rrrrrrr_typesrrrtyping_extensionsr discord.abcrdiscord._typesrrrcontextrrr__all__r"utilsr$r getLoggerrkr/typerrr r!rrBr@rDs0#""""" 99999999"2111111111&&&&&&%%%%%%&&&&&&        xS1222}$$$$$w""~ ~ ~ ~ ~ d~ ~ ~ B ~m~m~m~m~mG~m~m~m~mB99999s99999rB