Skip to main content

Permission Plugin based on Arclet Cithun

Project description

nonebot

nonebot-plugin-permission

Nonebot2 通用权限插件 ✨

license Python NoneBot pypi

本插件基于 arclet-cithun, 提供了一套通用的权限管理系统

安装

  • 使用 nb-cli
nb plugin install nonebot-plugin-permission
  • 使用 pip
pip install nonebot-plugin-permission

使用

设置 Matcher 级别的权限

from nonebot import on_command
from nonebot_plugin_permission import require_permission

matcher = on_command("test", rule=require_permission("command.test"))

设置 Handler 级别的权限

from nonebot import on_command
from nonebot_plugin_permission import depends_permission

matcher = on_command("test")

@matcher.handle(parameterless=depends_permission("command.test"))
async def handle():
    ...

依赖注入权限所有者模型

from nonebot import on_command
from nonebot_plugin_permission import UserOwner

matcher = on_command("test")

@matcher.handle()
async def handle(owner: UserOwner):
    # owner 表示当前用户所代表的权限所有者
    ...

查看具体权限

from nonebot import on_command
from nonebot_plugin_permission import UserOwner, Permission, system

matcher = on_command("test")

@matcher.handle()
async def handle(owner: UserOwner):
    state: Permission = await system.get(owner, "command.test")

通过指令设置权限

permission [@user] set <permission> <state>

通过代码设置权限

from nonebot_plugin_permission import Permission, system

@matcher.handle()
async def _():
    owner = await system.get_or_create_user("xxx")
    # 设置权限
    await system.suset(owner, "command.test", Permission("vma"))
    # 取消权限
    await system.suset(owner, "command.test", Permission("v--"))

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nonebot_plugin_permission-0.1.4.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nonebot_plugin_permission-0.1.4-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file nonebot_plugin_permission-0.1.4.tar.gz.

File metadata

  • Download URL: nonebot_plugin_permission-0.1.4.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.25.6 CPython/3.11.7 Windows/10

File hashes

Hashes for nonebot_plugin_permission-0.1.4.tar.gz
Algorithm Hash digest
SHA256 286d65c6dbddc5653351b58b4ba8cdcd49107c44ae61819ccaf1a3e3ad93dda4
MD5 2659985f83aa4057105a99310601b633
BLAKE2b-256 6b2d3e17452cdb601e28c6f032f4203d219f99cebd426f06138b5bc45950e364

See more details on using hashes here.

File details

Details for the file nonebot_plugin_permission-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_plugin_permission-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6e9a5f82ba7adaf6666fb1b51448790dc578c51ffc27cebae5d5f7bf767fefdb
MD5 bc9cd9d05be39b1b26905c1581c7073f
BLAKE2b-256 9c6d9d56f8822f99a2facb871490e76422c8e621ca62a15df2a260e7a0973d16

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page