API Reference

Classes

class authorizeme.Authorization

Container of authorization rules and checker of permissions.

add_rule(rule_class, target_class=<class 'authorizeme._Nothing'>)

Adds an authorization rule.

Parameters:
  • rule_class – a class of authorization rule.
  • target_class – (optional) a class or an iterable with classes to associate the rule with.
allows(user, permission, obj=<authorizeme._Nothing object>)

Checks that a user has permission. Returns True or False.

Parameters:
  • user – a user.
  • permission – permission to check.
  • obj – (optional) an object to check permission for.
check(user, permission, obj=<authorizeme._Nothing object>)

Raises AuthorizationError when a user has no permission.

Parameters:
  • user – a user.
  • permission – permission to check.
  • obj – (optional) an object to check permission for.
get_permissions(user, obj=<authorizeme._Nothing object>)

Returns permissions of a user.

Parameters:
  • user – a user.
  • obj – (optional) an object to get permissions for.
rule(rule_class)

Decorates and adds an authorization rule.

rule_for(target_class)

Decorates and adds an authorization rule for a specified class(es) of objects.

Parameters:target_class – a class or an iterable with classes to associate the rule with.
class authorizeme.AuthorizationError

Raised when user has no permission.

class authorizeme.PermissionError

Raised when permission is invalid.

class authorizeme.RuleError

Raised when there is no authorization rule for class of given object.