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.3.0.tar.gz (14.1 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.3.0-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nonebot_plugin_permission-0.3.0.tar.gz
  • Upload date:
  • Size: 14.1 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.3.0.tar.gz
Algorithm Hash digest
SHA256 3f5e5aecc6d2421cc385886505e831be2fb904ec26d5af7dc23633335a657b7e
MD5 e3c15b57163d2d218491cbe31b52dfe2
BLAKE2b-256 09b5b39049c66ae36e9d1493af449fe03f54611f0c4a209cc01687e4797bdd7c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nonebot_plugin_permission-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5208fd2b79d6a660af98564bc0a68b563b1380b68c2559880d0ae8682073fc9a
MD5 da49b7430e1f8ad420e3f2e9a0cf759c
BLAKE2b-256 a0a46a09e24ba418a6e63378fca3862aadef81a74c587de7756f944c9d1de253

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