-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Modeled slightly after Converters, allow specifying Converter-like class for context-based default parameters. e.g. ```py class Author(ParamDefault): async def default(self, ctx): return ctx.author async def my_command(ctx, user: discord.Member=Author): ... ``` Also adds a few common cases (Author, Channel, Guild) for current author, ...
- Loading branch information
Showing
4 changed files
with
161 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,3 +18,4 @@ | |
from .converter import * | ||
from .cooldowns import * | ||
from .cog import * | ||
from .default import CustomDefault |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
""" | ||
The MIT License (MIT) | ||
Copyright (c) 2015-2019 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. | ||
""" | ||
|
||
from .errors import MissingRequiredArgument | ||
|
||
__all__ = ( | ||
'CustomDefault', | ||
'Author', | ||
'Channel', | ||
'Guild', | ||
'Call', | ||
) | ||
|
||
class CustomDefault: | ||
"""The base class of custom defaults that require the :class:`.Context`. | ||
Classes that derive from this should override the :meth:`~.CustomDefault.default` | ||
method to do its conversion logic. This method must be a coroutine. | ||
""" | ||
|
||
async def default(self, ctx, param): | ||
"""|coro| | ||
The method to override to do conversion logic. | ||
If an error is found while converting, it is recommended to | ||
raise a :exc:`.CommandError` derived exception as it will | ||
properly propagate to the error handlers. | ||
Parameters | ||
----------- | ||
ctx: :class:`.Context` | ||
The invocation context that the argument is being used in. | ||
""" | ||
raise NotImplementedError('Derived classes need to implement this.') | ||
|
||
|
||
class Author(CustomDefault): | ||
"""Default parameter which returns the author for this context.""" | ||
|
||
async def default(self, ctx, param): | ||
return ctx.author | ||
|
||
class Channel(CustomDefault): | ||
"""Default parameter which returns the channel for this context.""" | ||
|
||
async def default(self, ctx, param): | ||
return ctx.channel | ||
|
||
class Guild(CustomDefault): | ||
"""Default parameter which returns the guild for this context.""" | ||
|
||
async def default(self, ctx, param): | ||
if ctx.guild: | ||
return ctx.guild | ||
raise MissingRequiredArgument(param) | ||
|
||
class Call(CustomDefault): | ||
"""Easy wrapper for lambdas/inline defaults.""" | ||
|
||
def __init__(self, callback): | ||
self._callback = callback | ||
|
||
async def default(self, ctx, param): | ||
return self._callback(ctx, param) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters