theunkn0wn1
commented
6 years ago Well, it already has a default value for the optional parameter. According to the decorators top-level docstring:
def require_rat(message=None):
"""Decorate a function to require the triggering user to be a FuelRats rat (as in, registered with the API and drilled).
If they are not, `message` will be said if given.""the default is no message, None and, if the message is not None it prints it if the user fails the auth check. Granted I could find no instances of @require_rat with no given param, it made sense to have the default be None. However, I do see the value in having to evaluate the string only once, and not at every instance of the decorator. I will implement the change, test it, and push to this repo in a few hours time
Marenthyu
Fixes MECHA-230 by replacing all instances of
'You need to be a registered and drilled Rat to execute this command!','Sorry, you need to be a registered and drilled Rat to use this command.'and'Sorry, but you need to be a registered and drilled Rat to use this command.'with the variableapi.names.msg_not_idented.api.names.msg_not_identedis defined as string"Sorry, but you need to be a registered and drilled Rat with an identified IRC nickname to use this command."The reason i redefined all the hardcoded strings to a variable is because it increases uniformity (we had 3 different messages stating the same thing!) and makes it more maintainable. If i went and search-replaced all the hardcoded string instances the next change would also have to be search-replace. Placing it as a single var means we just have to edit the string in one place rather than
ncasesUpdate:
Refactored each
@require_{role}decorator to have a default message, and changed all decorated instances to use the default, excluding those that specifically had no message.