Permissions
Represents an object that may become a server operator and can be assigned permissions.
property
¶
effective_permissions: set[PermissionAttachmentInfo]
Gets effective permissions.
add_attachment(
plugin: Plugin, name: str, value: bool
) -> PermissionAttachment
Adds a new PermissionAttachment.
add_attachment(plugin: Plugin) -> PermissionAttachment
Adds a new PermissionAttachment.
Checks if a permissions is available by name.
has_permission(perm: Permission) -> bool
Checks if a permissions is available by permission.
Checks if a permissions is set by name.
is_permission_set(perm: Permission) -> bool
Checks if a permissions is set by permission.
remove_attachment(attachment: PermissionAttachment) -> bool
Removes a given PermissionAttachment.
Permission(
name: str,
description: str | None = None,
default: PermissionDefault | None = None,
children: dict[str, bool] | None = None,
*args,
**kwargs
)
Represents a unique permission that may be attached to a Permissible
property
¶
permissibles: set[Permissible]
Gets a set containing every Permissible that has this permission.
add_parent(name: str, value: bool) -> Permission
Adds this permission to the specified parent permission.
add_parent(perm: Permission, value: bool) -> None
Adds this permission to the specified parent permission.
Recalculates all Permissibles that contain this permission.
PermissionAttachment(
plugin: Plugin, permissible: Permissible
)
Holds information about a permission attachment on a Permissible object
property
¶
Gets a copy of all set permissions and values contained within this attachment.
property
writable
¶
removal_callback: Callable[[PermissionAttachment], None]
The callback to be called when this attachment is removed.
Sets a permission to the given value, by its fully qualified name.
set_permission(perm: Permission, value: bool) -> None
Sets a permission to the given value.
unset_permission(name: str) -> None
Removes the specified permission from this attachment by name.
unset_permission(perm: Permission) -> None
Removes the specified permission from this attachment.
PermissionAttachmentInfo(
permissible: Permissible,
permission: str,
attachment: PermissionAttachment,
value: bool,
)
Holds information on a permission and which PermissionAttachment provides it
property
¶
attachment: PermissionAttachment
Gets the attachment providing this permission.