Module aethersprite.filters.setting_filter
Setting filter base class
Classes
class SettingFilter (setting: str)
-
Expand source code
class SettingFilter(object): """A class with methods for filtering a setting's input and output""" setting: str """The name of the setting to filter""" def __init__(self, setting: str): self.setting = setting def in_(self, ctx: Context, value: str | None) -> Any | None: """ Must override; input filter method. Args: ctx: The current context value: The incoming value Returns: The raw setting value(s), for reference """ raise NotImplementedError() def out(self, ctx: Context, value: Any | None) -> Any | None: """ Must override; output filter method. Args: ctx: The current context value: The raw setting value Returns: The filtered setting value(s) """ raise NotImplementedError()
A class with methods for filtering a setting's input and output
Subclasses
Class variables
var setting : str
-
The name of the setting to filter
Methods
def in_(self, ctx: discord.ext.commands.context.Context, value: str | None) ‑> typing.Any | None
-
Expand source code
def in_(self, ctx: Context, value: str | None) -> Any | None: """ Must override; input filter method. Args: ctx: The current context value: The incoming value Returns: The raw setting value(s), for reference """ raise NotImplementedError()
Must override; input filter method.
Args
ctx
- The current context
value
- The incoming value
Returns
The raw setting value(s), for reference
def out(self, ctx: discord.ext.commands.context.Context, value: typing.Any | None) ‑> typing.Any | None
-
Expand source code
def out(self, ctx: Context, value: Any | None) -> Any | None: """ Must override; output filter method. Args: ctx: The current context value: The raw setting value Returns: The filtered setting value(s) """ raise NotImplementedError()
Must override; output filter method.
Args
ctx
- The current context
value
- The raw setting value
Returns
The filtered setting value(s)