CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-07 11:48:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Commands] Added optional default_unit to the TimedeltaConverter (#2753)

Browse Source 
* Added default_unit to the TimedeltaConverter

* Fixed a possible converter crash

* Updated get_timedelta_converter to incorporate the new kwarg
This commit is contained in:
DevilXD 2019-06-03 13:46:55 +02:00 committed by Michael H
parent da40511306
commit 463d8d6306
1 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
redbot/core/commands/converter.py
View File

@ -94,13 +94,13 @@ def parse_timedelta(
if maximum and maximum < delta: if maximum and maximum < delta:
raise BadArgument( raise BadArgument(
_( _(
"This amount of time is too large for this command. (maximum: {maximum})" "This amount of time is too large for this command. (Maximum: {maximum})"
).format(maximum=humanize_timedelta(timedelta=maximum)) ).format(maximum=humanize_timedelta(timedelta=maximum))
) )
if minimum and delta < minimum: if minimum and delta < minimum:
raise BadArgument( raise BadArgument(
_( _(
"This amount of time is too small for this command. (minimum: {minimum})" "This amount of time is too small for this command. (Minimum: {minimum})"
).format(minimum=humanize_timedelta(timedelta=minimum)) ).format(minimum=humanize_timedelta(timedelta=minimum))
) )
return delta return delta
@ -224,17 +224,28 @@ class TimedeltaConverter(dpy_commands.Converter):
allowed_units : Optional[List[str]] allowed_units : Optional[List[str]]
If provided, you can constrain a user to expressing the amount of time If provided, you can constrain a user to expressing the amount of time
in specific units. The units you can chose to provide are the same as the in specific units. The units you can chose to provide are the same as the
parser understands. `weeks` `days` `hours` `minutes` `seconds` parser understands: `weeks` `days` `hours` `minutes` `seconds`
default_unit : Optional[str]
If provided, it will additionally try to match integer-only input into
a timedelta, using the unit specified. Same units as in `allowed_units`
apply.
""" """
def __init__(self, *, minimum=None, maximum=None, allowed_units=None): def __init__(self, *, minimum=None, maximum=None, allowed_units=None, default_unit=None):
self.allowed_units = allowed_units self.allowed_units = allowed_units
self.default_unit = default_unit
self.minimum = minimum self.minimum = minimum
self.maximum = maximum self.maximum = maximum
async def convert(self, ctx: "Context", argument: str) -> timedelta: async def convert(self, ctx: "Context", argument: str) -> timedelta:
if self.default_unit and argument.isdecimal():
delta = timedelta(**{self.default_unit: int(argument)})
else:
delta = parse_timedelta( delta = parse_timedelta(
argument, minimum=self.minimum, maximum=self.maximum, allowed_units=self.allowed_units argument,
minimum=self.minimum,
maximum=self.maximum,
allowed_units=self.allowed_units,
) )
if delta is not None: if delta is not None:
return delta return delta
@ -243,6 +254,7 @@ class TimedeltaConverter(dpy_commands.Converter):
def get_timedelta_converter( def get_timedelta_converter(
*, *,
default_unit: Optional[str] = None,
maximum: Optional[timedelta] = None, maximum: Optional[timedelta] = None,
minimum: Optional[timedelta] = None, minimum: Optional[timedelta] = None,
allowed_units: Optional[List[str]] = None, allowed_units: Optional[List[str]] = None,
@ -262,7 +274,11 @@ def get_timedelta_converter(
allowed_units : Optional[List[str]] allowed_units : Optional[List[str]]
If provided, you can constrain a user to expressing the amount of time If provided, you can constrain a user to expressing the amount of time
in specific units. The units you can chose to provide are the same as the in specific units. The units you can chose to provide are the same as the
parser understands. `weeks` `days` `hours` `minutes` `seconds` parser understands: `weeks` `days` `hours` `minutes` `seconds`
default_unit : Optional[str]
If provided, it will additionally try to match integer-only input into
a timedelta, using the unit specified. Same units as in `allowed_units`
apply.
Returns Returns
------- -------
@ -274,6 +290,7 @@ def get_timedelta_converter(
__call__ = functools.partialmethod( __call__ = functools.partialmethod(
type(DictConverter).__call__, type(DictConverter).__call__,
allowed_units=allowed_units, allowed_units=allowed_units,
default_unit=default_unit,
minimum=minimum, minimum=minimum,
maximum=maximum, maximum=maximum,
) )