utils.decorators

Method’s decorators

utils.decorators.add_default_group(sender, **kwargs)

# Function Name: add_default_group(request) # Inputs: sender, kwargs - # Outputs: - # Exceptions: None # Description: Assigns the user in the default group after its creation # We catch the post_save signal for the User model

Parameters:

• sender –
• kwargs –

Returns:

utils.decorators.api_permission_required(content_type, permission, raise_exception=False)

# Function Name: api_permission_required(request) # Inputs: - # Outputs: decorator # Exceptions: None # Description: Check if the user has the required permission given in parameter. # If the user is anonymous, check if the anonymous_group has the required permission # Used by the API

Parameters:

• content_type –
• permission –
• raise_exception –

Returns:

utils.decorators.api_staff_member_required()

# Function Name: api_staff_member_required(request) # Inputs: - # Outputs: decorator # Exceptions: None # Description: Check if the user is an admin user. Used by the API

Returns:

utils.decorators.login_or_anonymous_perm_required(anonymous_permission, function=None, redirect_field_name='next', login_url=None)

# Function Name: login_or_anonymous_perm_required(request) # Inputs: anonymous_permission, function=None, redirect_field_name=REDIRECT_FIELD_NAME, login_url=None - # Outputs: decorator # Exceptions: None # Description: Custom decorator for checking user authentication or anonymous user permission. # Manages the authorisation to execute a function decorated by this decorator. # Conditions: user connected or anonymous_group assigned with the anonymous_permission in parameter.

Parameters:

• anonymous_permission –
• function –
• redirect_field_name –
• login_url –

Returns:

utils.decorators.permission_required(content_type, permission, login_url=None, raise_exception=False, redirect_field_name='next')

# Function Name: permission_required(request) # Inputs: content_type, permission, login_url=None, raise_exception=False, # redirect_field_name=REDIRECT_FIELD_NAME - # Outputs: decorator # Exceptions: None # Description: Check if the user has the required permission given in parameter # If the user is anonymous, check if the anonymous_group has the required permission

Parameters:

• content_type –
• permission –
• login_url –
• raise_exception –
• redirect_field_name –

Returns: