Index of the users module
-
m
authkit.users
...
- Objects representing users, their passwords, roles and groups
-
C
Users
...
- Base class from which all other Users classes should be derived.
-
f
user_password
...
- Returns the password associated with the user or None if no password exists.
Raises an exception is the user doesn't exist.
-
f
user_group
...
- Returns the group associated with the user or None if no group is associated.
Raises an exception is the user doesn't exist.
-
f
user_add_role
...
- Sets the user's role to the lowercase of role. If the role doesn't exist and add_if_necessary is True the role will also be added. Otherwise an AuthKitNoSuchRoleError will be raised.
Raises an exception if the user doesn't exist.
-
f
__init__
...
-
f
user_set_username
...
- Sets the user's username to the lowercase of new_username.
Raises an exception if the user doesn't exist or if there is already a user with the username specified by new_username.
-
f
group_create
...
- Add a new group to the system
-
f
user_set_group
...
- Sets the user's group to the lowercase of group or None. If the group doesn't exist and add_if_necessary is True the group will also be added. Otherwise an AuthKitNoSuchGroupError will be raised.
Raises an exception if the user doesn't exist.
-
f
user_remove_role
...
- Removes the role from the user specified by username. Raises an exception if the user doesn't exist.
-
f
user_roles
...
- Returns a list of all the role names for the given username ordered alphabetically. Raises an exception if
the username doesn't exist.
-
f
user_remove_group
...
- Sets the group to None for the user specified by username. Raises an exception if the user doesn't exist.
-
f
role_delete_cascade
...
- Remove the role specified and remove the role from any users who used it
-
f
group_delete
...
- Remove the group specified. Rasies an exception if the group is still in use.
To delete the group and remove it from all existing users use group_delete_cascade()
-
f
list_roles
...
- Returns a lowercase list of all role names ordered alphabetically
-
f
group_delete_cascade
...
- Remove the group specified and remove the group from any users who used it
-
f
list_groups
...
- Returns a lowercase list of all groups ordered alphabetically
-
f
user
...
- Returns a dictionary in the following format:
-
f
user_exists
...
- Returns True if a user exists with the given username, False otherwise. Usernames are case insensitive.
-
f
user_create
...
- Create a new user with the username, password and group name specified.
-
f
role_exists
...
- Returns True if the role exists, False otherwise. Roles are case insensitive.
-
f
user_delete
...
- Remove the user with the specified username
-
f
group_exists
...
- Returns True if the group exists, False otherwise. Groups are case insensitive.
-
f
user_has_role
...
- Returns True if the user has the role specified, False otherwise. Raises an exception if the user doesn't exist.
-
f
list_users
...
- Returns a lowecase list of all usernames ordered alphabetically
-
f
role_delete
...
- Remove the role specified. Rasies an exception if the role is still in use.
To delete the role and remove it from all existing users use role_delete_cascade()
-
f
user_has_password
...
- Returns True if the user has the password specified, False otherwise. Passwords are case sensitive.
Raises an exception if the user doesn't exist.
-
f
user_has_group
...
- Returns True if the user has the group specified, False otherwise. The value for group can be None to test that the user doesn't belong to a group. Raises an exception if the user doesn't exist.
-
f
role_create
...
- Add a new role to the system
-
C
AuthKitNoSuchRoleError
...
-
C
UsersFromString
...
- A Users class which cbtains user information from a string with lines
formatted as` username1:password1:group role1, role2 etc where
group is optional and zero or more roles can exist.
-
f
user_password
...
- Returns the password associated with the user or None if no password exists.
Raises an exception is the user doesn't exist.
-
f
user_group
...
- Returns the group associated with the user or None if no group is associated.
Raises an exception is the user doesn't exist.
-
f
user_add_role
...
- Sets the user's role to the lowercase of role. If the role doesn't exist and add_if_necessary is True the role will also be added. Otherwise an AuthKitNoSuchRoleError will be raised.
Raises an exception if the user doesn't exist.
-
f
__init__
...
-
f
user_set_username
...
- Sets the user's username to the lowercase of new_username.
Raises an exception if the user doesn't exist or if there is already a user with the username specified by new_username.
-
f
group_create
...
- Add a new group to the system
-
f
user_set_group
...
- Sets the user's group to the lowercase of group or None. If the group doesn't exist and add_if_necessary is True the group will also be added. Otherwise an AuthKitNoSuchGroupError will be raised.
Raises an exception if the user doesn't exist.
-
f
user_remove_role
...
- Removes the role from the user specified by username. Raises an exception if the user doesn't exist.
-
f
user_roles
...
- Returns a list of all the role names for the given username ordered alphabetically. Raises an exception if
the username doesn't exist.
-
f
user_remove_group
...
- Sets the group to None for the user specified by username. Raises an exception if the user doesn't exist.
-
f
role_delete_cascade
...
- Remove the role specified and remove the role from any users who used it
-
f
group_delete
...
- Remove the group specified. Rasies an exception if the group is still in use.
To delete the group and remove it from all existing users use group_delete_cascade()
-
f
list_roles
...
- Returns a lowercase list of all role names ordered alphabetically
-
f
group_delete_cascade
...
- Remove the group specified and remove the group from any users who used it
-
f
list_groups
...
- Returns a lowercase list of all groups ordered alphabetically
-
f
user
...
- Returns a dictionary in the following format:
-
f
user_exists
...
- Returns True if a user exists with the given username, False otherwise. Usernames are case insensitive.
-
f
user_create
...
- Create a new user with the username, password and group name specified.
-
f
role_exists
...
- Returns True if the role exists, False otherwise. Roles are case insensitive.
-
f
user_delete
...
- Remove the user with the specified username
-
f
group_exists
...
- Returns True if the group exists, False otherwise. Groups are case insensitive.
-
f
user_has_role
...
- Returns True if the user has the role specified, False otherwise. Raises an exception if the user doesn't exist.
-
f
list_users
...
- Returns a lowecase list of all usernames ordered alphabetically
-
f
role_delete
...
- Remove the role specified. Rasies an exception if the role is still in use.
To delete the role and remove it from all existing users use role_delete_cascade()
-
f
user_has_password
...
- Passwords are case sensitive.
Returns True if the user has the password specified, False otherwise.
Raises an exception if the user doesn't exist.
-
f
user_has_group
...
- Returns True if the user has the group specified, False otherwise. Raises an exception if the user doesn't exist.
-
f
role_create
...
- Add a new role to the system
-
C
AuthKitError
...
-
C
UsersReadOnly
...
- Like the Users class except that user information is read only. All the information
is obtained from the attributes self.usernames, self.passwords, self.roles, self.groups
which are expected to be setup in __init__().
-
f
user_password
...
- Returns the password associated with the user or None if no password exists.
Raises an exception is the user doesn't exist.
-
f
user_group
...
- Returns the group associated with the user or None if no group is associated.
Raises an exception is the user doesn't exist.
-
f
user_add_role
...
- Sets the user's role to the lowercase of role. If the role doesn't exist and add_if_necessary is True the role will also be added. Otherwise an AuthKitNoSuchRoleError will be raised.
Raises an exception if the user doesn't exist.
-
f
__init__
...
-
f
user_set_username
...
- Sets the user's username to the lowercase of new_username.
Raises an exception if the user doesn't exist or if there is already a user with the username specified by new_username.
-
f
group_create
...
- Add a new group to the system
-
f
user_set_group
...
- Sets the user's group to the lowercase of group or None. If the group doesn't exist and add_if_necessary is True the group will also be added. Otherwise an AuthKitNoSuchGroupError will be raised.
Raises an exception if the user doesn't exist.
-
f
user_remove_role
...
- Removes the role from the user specified by username. Raises an exception if the user doesn't exist.
-
f
user_roles
...
- Returns a list of all the role names for the given username ordered alphabetically. Raises an exception if
the username doesn't exist.
-
f
user_remove_group
...
- Sets the group to None for the user specified by username. Raises an exception if the user doesn't exist.
-
f
role_delete_cascade
...
- Remove the role specified and remove the role from any users who used it
-
f
group_delete
...
- Remove the group specified. Rasies an exception if the group is still in use.
To delete the group and remove it from all existing users use group_delete_cascade()
-
f
list_roles
...
- Returns a lowercase list of all role names ordered alphabetically
-
f
group_delete_cascade
...
- Remove the group specified and remove the group from any users who used it
-
f
list_groups
...
- Returns a lowercase list of all groups ordered alphabetically
-
f
user
...
- Returns a dictionary in the following format:
-
f
user_exists
...
- Returns True if a user exists with the given username, False otherwise. Usernames are case insensitive.
-
f
user_create
...
- Create a new user with the username, password and group name specified.
-
f
role_exists
...
- Returns True if the role exists, False otherwise. Roles are case insensitive.
-
f
user_delete
...
- Remove the user with the specified username
-
f
group_exists
...
- Returns True if the group exists, False otherwise. Groups are case insensitive.
-
f
user_has_role
...
- Returns True if the user has the role specified, False otherwise. Raises an exception if the user doesn't exist.
-
f
list_users
...
- Returns a lowecase list of all usernames ordered alphabetically
-
f
role_delete
...
- Remove the role specified. Rasies an exception if the role is still in use.
To delete the role and remove it from all existing users use role_delete_cascade()
-
f
user_has_password
...
- Passwords are case sensitive.
Returns True if the user has the password specified, False otherwise.
Raises an exception if the user doesn't exist.
-
f
user_has_group
...
- Returns True if the user has the group specified, False otherwise. Raises an exception if the user doesn't exist.
-
f
role_create
...
- Add a new role to the system
-
C
AuthKitNotSupportedError
...
-
C
AuthKitNoSuchGroupError
...
-
C
AuthKitNoSuchUserError
...
-
C
UsersFromFile
...
- A Users class with the same implementation as UsersFromString except that
user information is obtained from a file. The file should contain user information
in the same format as the string accepted for UsersFromString.
-
f
user_password
...
- Returns the password associated with the user or None if no password exists.
Raises an exception is the user doesn't exist.
-
f
user_group
...
- Returns the group associated with the user or None if no group is associated.
Raises an exception is the user doesn't exist.
-
f
user_add_role
...
- Sets the user's role to the lowercase of role. If the role doesn't exist and add_if_necessary is True the role will also be added. Otherwise an AuthKitNoSuchRoleError will be raised.
Raises an exception if the user doesn't exist.
-
f
__init__
...
-
f
user_set_username
...
- Sets the user's username to the lowercase of new_username.
Raises an exception if the user doesn't exist or if there is already a user with the username specified by new_username.
-
f
group_create
...
- Add a new group to the system
-
f
user_set_group
...
- Sets the user's group to the lowercase of group or None. If the group doesn't exist and add_if_necessary is True the group will also be added. Otherwise an AuthKitNoSuchGroupError will be raised.
Raises an exception if the user doesn't exist.
-
f
user_remove_role
...
- Removes the role from the user specified by username. Raises an exception if the user doesn't exist.
-
f
user_roles
...
- Returns a list of all the role names for the given username ordered alphabetically. Raises an exception if
the username doesn't exist.
-
f
user_remove_group
...
- Sets the group to None for the user specified by username. Raises an exception if the user doesn't exist.
-
f
role_delete_cascade
...
- Remove the role specified and remove the role from any users who used it
-
f
group_delete
...
- Remove the group specified. Rasies an exception if the group is still in use.
To delete the group and remove it from all existing users use group_delete_cascade()
-
f
list_roles
...
- Returns a lowercase list of all role names ordered alphabetically
-
f
group_delete_cascade
...
- Remove the group specified and remove the group from any users who used it
-
f
list_groups
...
- Returns a lowercase list of all groups ordered alphabetically
-
f
user
...
- Returns a dictionary in the following format:
-
f
user_exists
...
- Returns True if a user exists with the given username, False otherwise. Usernames are case insensitive.
-
f
user_create
...
- Create a new user with the username, password and group name specified.
-
f
role_exists
...
- Returns True if the role exists, False otherwise. Roles are case insensitive.
-
f
user_delete
...
- Remove the user with the specified username
-
f
group_exists
...
- Returns True if the group exists, False otherwise. Groups are case insensitive.
-
f
user_has_role
...
- Returns True if the user has the role specified, False otherwise. Raises an exception if the user doesn't exist.
-
f
list_users
...
- Returns a lowecase list of all usernames ordered alphabetically
-
f
role_delete
...
- Remove the role specified. Rasies an exception if the role is still in use.
To delete the role and remove it from all existing users use role_delete_cascade()
-
f
user_has_password
...
- Passwords are case sensitive.
Returns True if the user has the password specified, False otherwise.
Raises an exception if the user doesn't exist.
-
f
user_has_group
...
- Returns True if the user has the group specified, False otherwise. Raises an exception if the user doesn't exist.
-
f
role_create
...
- Add a new role to the system
-
f
parse
...
- Parses the user data
-
f
md5
...
-
m
sqlalchemy_driver
...
-
a
NULLTYPE
...
-
a
default_metadata
...
-
a
EXT_PASS
...
-
C
UsersFromDatabase
...
- Database Version
-
f
user_password
...
- Returns the password associated with the user or None if no
password exists. Raises an exception is the user doesn't exist.
-
f
user_group
...
- Returns the group associated with the user or None if no group is
associated. Raises an exception is the user doesn't exist.
-
f
user_add_role
...
- Sets the user's role to the lowercase of role. If the role doesn't
exist and add_if_necessary is True the role will also be
added. Otherwise an AuthKitNoSuchRoleError will be raised. Raises
an exception if the user doesn't exist.
-
f
__init__
...
-
f
user_set_username
...
- Sets the user's username to the lowercase of new_username.
Raises an exception if the user doesn't exist or if there is already
a user with the username specified by new_username.
-
f
group_create
...
- Add a new group to the system
-
f
user_set_group
...
- Sets the user's group to the lowercase of group or None. If
the group doesn't exist and add_if_necessary is True the
group will also be added. Otherwise an AuthKitNoSuchGroupError
will be raised. Raises an exception if the user doesn't exist.
-
f
user_remove_role
...
- Removes the role from the user specified by username. Raises
an exception if the user doesn't exist.
-
f
user_roles
...
- Returns a list of all the role names for the given username ordered
alphabetically. Raises an exception if the username doesn't exist.
-
f
user_remove_group
...
- Sets the group to None for the user specified by username.
Raises an exception if the user doesn't exist.
-
f
group_delete
...
- Remove the group specified. Rasies an exception if the group is still in use.
To delete the group and remove it from all existing users use group_delete_cascade()
-
f
list_roles
...
- Returns a lowercase list of all roll names ordered alphabetically
-
f
list_groups
...
- Returns a lowercase list of all groups ordered alphabetically
-
f
user
...
- Returns a dictionary in the following format:
-
f
user_exists
...
- Returns True if a user exists with the given username, False
otherwise. Usernames are case insensitive.
-
f
user_create
...
- Create a new user with the username, password and group name specified.
-
f
role_exists
...
- Returns True if the role exists, False otherwise. Roles are
case insensitive.
-
f
user_delete
...
- Remove the user with the specified username
-
f
group_exists
...
- Returns True if the group exists, False otherwise. Groups
are case insensitive.
-
f
update_model
...
-
f
user_has_role
...
- Returns True if the user has the role specified, False
otherwise. Raises an exception if the user doesn't exist.
-
f
list_users
...
- Returns a lowecase list of all usernames ordered alphabetically
-
f
role_delete
...
- Remove the role specified. Rasies an exception if the role is still in use.
To delete the role and remove it from all existing users use
role_delete_cascade()
-
f
user_has_password
...
- Returns True if the user has the password specified, False
otherwise. Passwords are case sensitive. Raises an exception if the
user doesn't exist.
-
f
user_has_group
...
- Returns True if the user has the group specified, False
otherwise. The value for group can be None to test that
the user doesn't belong to a group. Raises an exception if the
user doesn't exist.
-
f
role_create
...
- Add a new role to the system
-
m
postgresql_driver
...
-
C
UsersDriver
...
- Raw SQL Version
-
f
user_password
...
- Returns the password associated with the user or None if no
password exists. Raises an exception is the user doesn't exist.
-
f
user_add_role
...
- Sets the user's role to the lowercase of role. If the role doesn't
exist and add_if_necessary is True the role will also be
added. Otherwise an AuthKitNoSuchRoleError will be raised. Raises
an exception if the user doesn't exist.
-
f
__init__
...
-
f
user_set_username
...
- Sets the user's username to the lowercase of new_username.
Raises an exception if the user doesn't exist or if there is already
a user with the username specified by new_username.
-
f
group_create
...
- Add a new group to the system
-
f
user_remove_role
...
- Removes the role from the user specified by username. Raises
an exception if the user doesn't exist.
-
f
user_roles
...
- Returns a list of all the role names for the given username ordered
alphabetically. Raises an exception if the username doesn't exist.
-
f
user_remove_group
...
- Sets the group to None for the user specified by username.
Raises an exception if the user doesn't exist.
-
f
group_delete
...
- Remove the group specified. Rasies an exception if the group is still in use.
To delete the group and remove it from all existing users use group_delete_cascade()
-
f
list_roles
...
- Returns a lowercase list of all roll names ordered alphabetically
-
f
list_groups
...
- Returns a lowercase list of all groups ordered alphabetically
-
f
user
...
- Returns a dictionary in the following format:
-
f
user_exists
...
- Returns True if a user exists with the given username, False
otherwise. Usernames are case insensitive.
-
f
user_create
...
- Create a new user with the username, password and group name specified.
-
f
role_exists
...
- Returns True if the role exists, False otherwise. Roles are
case insensitive.
-
f
group_exists
...
- Returns True if the group exists, False otherwise. Groups
are case insensitive.
-
f
user_has_role
...
- Returns True if the user has the role specified, False
otherwise. Raises an exception if the user doesn't exist.
-
f
list_users
...
- Returns a lowecase list of all usernames ordered alphabetically
-
f
role_delete
...
- Remove the role specified. Rasies an exception if the role is still in use.
To delete the role and remove it from all existing users use
role_delete_cascade()
-
f
user_has_password
...
- Returns True if the user has the password specified, False
otherwise. Passwords are case sensitive. Raises an exception if the
user doesn't exist.
-
f
role_create
...
- Add a new role to the system