mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-10-24 10:02:56 +00:00
Code Issues Projects Releases Wiki Activity

Skip default parameter validation when using a transformer

Browse Source 
Fixes #8110
This commit is contained in:
Rapptz
2022-06-05 01:18:16 -04:00
parent 87edabc5b8
commit d1039e209e
1 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
discord/app_commands/transformers.py
View File

@@ -613,32 +613,34 @@ def get_supported_annotation(
*, *,
_none: type = NoneType, _none: type = NoneType,
_mapping: Dict[Any, Type[Transformer]] = BUILT_IN_TRANSFORMERS, _mapping: Dict[Any, Type[Transformer]] = BUILT_IN_TRANSFORMERS,
) -> Tuple[Any, Any]: ) -> Tuple[Any, Any, bool]:
"""Returns an appropriate, yet supported, annotation along with an optional default value. """Returns an appropriate, yet supported, annotation along with an optional default value.
The third boolean element of the tuple indicates if default values should be validated.
This differs from the built in mapping by supporting a few more things. This differs from the built in mapping by supporting a few more things.
Likewise, this returns a "transformed" annotation that is ready to use with CommandParameter.transform. Likewise, this returns a "transformed" annotation that is ready to use with CommandParameter.transform.
""" """
try: try:
return (_mapping[annotation], MISSING) return (_mapping[annotation], MISSING, True)
except KeyError: except KeyError:
pass pass
if hasattr(annotation, '__discord_app_commands_transform__'): if hasattr(annotation, '__discord_app_commands_transform__'):
return (annotation.metadata, MISSING) return (annotation.metadata, MISSING, False)
if hasattr(annotation, '__metadata__'): if hasattr(annotation, '__metadata__'):
return get_supported_annotation(annotation.__metadata__[0]) return get_supported_annotation(annotation.__metadata__[0])
if inspect.isclass(annotation): if inspect.isclass(annotation):
if issubclass(annotation, Transformer): if issubclass(annotation, Transformer):
return (annotation, MISSING) return (annotation, MISSING, False)
if issubclass(annotation, (Enum, InternalEnum)): if issubclass(annotation, (Enum, InternalEnum)):
if all(isinstance(v.value, (str, int, float)) for v in annotation): if all(isinstance(v.value, (str, int, float)) for v in annotation):
return (_make_enum_transformer(annotation), MISSING) return (_make_enum_transformer(annotation), MISSING, False)
else: else:
return (_make_complex_enum_transformer(annotation), MISSING) return (_make_complex_enum_transformer(annotation), MISSING, False)
if annotation is Choice: if annotation is Choice:
raise TypeError(f'Choice requires a type argument of int, str, or float') raise TypeError(f'Choice requires a type argument of int, str, or float')
@@ -646,11 +648,11 @@ def get_supported_annotation(
origin = getattr(annotation, '__origin__', None) origin = getattr(annotation, '__origin__', None)
if origin is Literal: if origin is Literal:
args = annotation.__args__ # type: ignore args = annotation.__args__ # type: ignore
return (_make_literal_transformer(args), MISSING) return (_make_literal_transformer(args), MISSING, True)
if origin is Choice: if origin is Choice:
arg = annotation.__args__[0] # type: ignore arg = annotation.__args__[0] # type: ignore
return (_make_choice_transformer(arg), MISSING) return (_make_choice_transformer(arg), MISSING, True)
if origin is not Union: if origin is not Union:
# Only Union/Optional is supported right now so bail early # Only Union/Optional is supported right now so bail early
@@ -661,10 +663,10 @@ def get_supported_annotation(
if args[-1] is _none: if args[-1] is _none:
if len(args) == 2: if len(args) == 2:
underlying = args[0] underlying = args[0]
inner, _ = get_supported_annotation(underlying) inner, _, validate_default = get_supported_annotation(underlying)
if inner is None: if inner is None:
raise TypeError(f'unsupported inner optional type {underlying!r}') raise TypeError(f'unsupported inner optional type {underlying!r}')
return (inner, None) return (inner, None, validate_default)
else: else:
args = args[:-1] args = args[:-1]
default = None default = None
@@ -672,7 +674,7 @@ def get_supported_annotation(
# Check for channel union types # Check for channel union types
if any(arg in CHANNEL_TO_TYPES for arg in args): if any(arg in CHANNEL_TO_TYPES for arg in args):
# If any channel type is given, then *all* must be channel types # If any channel type is given, then *all* must be channel types
return (channel_transformer(*args, raw=None), default) return (channel_transformer(*args, raw=None), default, True)
# The only valid transformations here are: # The only valid transformations here are:
# [Member, User] => user # [Member, User] => user
@@ -682,9 +684,9 @@ def get_supported_annotation(
if not all(arg in supported_types for arg in args): if not all(arg in supported_types for arg in args):
raise TypeError(f'unsupported types given inside {annotation!r}') raise TypeError(f'unsupported types given inside {annotation!r}')
if args == (User, Member) or args == (Member, User): if args == (User, Member) or args == (Member, User):
return (passthrough_transformer(AppCommandOptionType.user), default) return (passthrough_transformer(AppCommandOptionType.user), default, True)
return (passthrough_transformer(AppCommandOptionType.mentionable), default) return (passthrough_transformer(AppCommandOptionType.mentionable), default, True)
def annotation_to_parameter(annotation: Any, parameter: inspect.Parameter) -> CommandParameter: def annotation_to_parameter(annotation: Any, parameter: inspect.Parameter) -> CommandParameter:
@@ -695,7 +697,7 @@ def annotation_to_parameter(annotation: Any, parameter: inspect.Parameter) -> Co
of a command parameter. of a command parameter.
""" """
(inner, default) = get_supported_annotation(annotation) (inner, default, validate_default) = get_supported_annotation(annotation)
type = inner.type() type = inner.type()
if default is MISSING or default is None: if default is MISSING or default is None:
@@ -704,12 +706,10 @@ def annotation_to_parameter(annotation: Any, parameter: inspect.Parameter) -> Co
default = param_default default = param_default
# Verify validity of the default parameter # Verify validity of the default parameter
if default is not MISSING: if default is not MISSING and validate_default:
enum_type = getattr(inner, '__discord_app_commands_transformer_enum__', None) valid_types: Tuple[Any, ...] = ALLOWED_DEFAULTS.get(type, (NoneType,))
if default.__class__ is not enum_type: if not isinstance(default, valid_types):
valid_types: Tuple[Any, ...] = ALLOWED_DEFAULTS.get(type, (NoneType,)) raise TypeError(f'invalid default parameter type given ({default.__class__}), expected {valid_types}')
if not isinstance(default, valid_types):
raise TypeError(f'invalid default parameter type given ({default.__class__}), expected {valid_types}')
result = CommandParameter( result = CommandParameter(
type=type, type=type,