Flask-RESTFul中authenticate转装饰器报错：缺少位置参数，如何解决？

Let's break down what's going wrong here and fix it step by step.

Why You're Getting the Error #

Your authenticate function isn't structured as a valid decorator. Decorators in Python need to accept the function they're decorating as an argument and return a wrapper function that handles logic before/after calling the original function.

When you tried to use @fc.authenticate on your get method, Python automatically passed the get method as the first argument to authenticate—but your original authenticate definition didn't have a parameter to receive this. That's why you saw the "Function 'authenticate' lacks a positional argument" error.

Additionally, you need to account for the fact that get is a @classmethod, so the wrapper function needs to handle the cls parameter that gets passed to class methods.

How to Fix the Decorator #

We'll rewrite authenticate to be a proper decorator:

1. It will accept the target function as its first parameter.
2. It will return a wrapper function that handles token validation.
3. If validation passes, the wrapper will call the original function; if it fails, it will return an error response directly (which works seamlessly with Flask-RESTful's Resource methods).

Updated Code for functions.py #

import flask
import hashlib
import logging

logger = logging.getLogger(__name__)

def authenticate(func):
    def wrapper(*args, **kwargs):
        headers = flask.request.headers
        bearer = headers.get('Authorization')
        
        try:
            # First, validate the Authorization header format
            if not bearer or not bearer.startswith('Bearer '):
                logger.error('Invalid Authorization header format. Expected "Bearer <token>"')
                return {'message': 'Invalid Authorization header. Use format: "Bearer <token>"'}, 400
            
            # Extract the token from the header
            token = bearer.split()[1]
            
            # Compare with the expected MD5-hashed token
            expected_token = hashlib.md5(b'Token_String').hexdigest()
            if token == expected_token:
                logger.info('Token authentication successful.')
                # Call the original function if auth passes
                return func(*args, **kwargs)
            else:
                logger.error('Token authorization failed. Invalid token supplied.')
                return {'message': 'Token authentication failed'}, 401
        
        except IndexError:
            # Handle cases where "Bearer" is present but no token follows
            logger.error('Missing token in Authorization header.')
            return {'message': 'Missing token. Supply a token with your API call.'}, 400
        
        except Exception as e:
            logger.error(f'Unexpected error during authentication: {str(e)}')
            return {'message': f'Error processing token: {str(e)}'}, 400
    
    return wrapper

Updated API Class Code #

Make sure to place @classmethod inside the @fc.authenticate decorator (decorators apply from bottom to top, so we first turn the method into a class method, then apply the auth decorator):

from flask_restful import Resource
from validations import functions as fc
import logging

logger = logging.getLogger(__name__)

class APIClass(Resource):
    @fc.authenticate
    @classmethod
    def get(cls):
        logger.info('Initiating get()')
        # Run your SQL statements here
        run_some_sql_statements = "Your SQL result data"
        # Return a valid response (required for Flask-RESTful Resource methods)
        return {'data': run_some_sql_statements}, 200

Key Notes to Remember #

1. Decorator Order: Always place @classmethod (or @staticmethod) closest to the method definition. The custom auth decorator goes on top.
2. Error Handling: We added specific checks for invalid header formats and missing tokens to avoid vague error messages.
3. Flask-RESTful Responses: All Resource methods must return a response (either a dictionary, tuple with data + status code, etc.)—we added a proper return statement to your get method since the original had pass which would cause issues.

内容的提问来源于stack exchange，提问作者Metadata