🍻 publish plugin nonebot-plugin-memory (#3700)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.devcontainer/devcontainer.json

@@ -0,0 +1,54 @@
+{
+  "name": "Ubuntu",
+  "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+  "features": {
+    "ghcr.io/jsburckhardt/devcontainer-features/uv:1": {},
+    "ghcr.io/devcontainers/features/node:1": {},
+    "ghcr.io/meaningful-ooo/devcontainer-features/fish:2": {}
+  },
+  "postCreateCommand": "./scripts/setup-envs.sh",
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "python.analysis.diagnosticMode": "workspace",
+        "[python]": {
+          "editor.defaultFormatter": "charliermarsh.ruff",
+          "editor.codeActionsOnSave": {
+            "source.fixAll.ruff": "explicit",
+            "source.organizeImports": "explicit"
+          }
+        },
+        "[javascript]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "[html]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "[typescript]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "[javascriptreact]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "[typescriptreact]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "files.exclude": {
+          "**/__pycache__": true
+        },
+        "files.watcherExclude": {
+          "**/target/**": true,
+          "**/__pycache__": true
+        }
+      },
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "charliermarsh.ruff",
+        "EditorConfig.EditorConfig",
+        "esbenp.prettier-vscode",
+        "bradlc.vscode-tailwindcss"
+      ]
+    }
+  }
+}

.eslintignore

@@ -0,0 +1,6 @@
+dist
+node_modules
+.yarn
+.history
+build
+lib

.eslintrc.js

@@ -0,0 +1,403 @@
+const OFF = 0;
+const WARNING = 1;
+const ERROR = 2;
+
+// Prevent importing lodash, usually for browser bundle size reasons
+const LodashImportPatterns = ["lodash", "lodash.**", "lodash/**"];
+
+module.exports = {
+  root: true,
+  env: {
+    browser: true,
+    commonjs: true,
+    node: true,
+  },
+  parser: "@typescript-eslint/parser",
+  parserOptions: {},
+  globals: {
+    JSX: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:react-hooks/recommended",
+    "airbnb",
+    "plugin:@typescript-eslint/recommended",
+    // 'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    // 'plugin:@typescript-eslint/strict',
+    "plugin:regexp/recommended",
+    "prettier",
+    "plugin:@docusaurus/all",
+  ],
+  settings: {
+    "import/resolver": {
+      node: {
+        extensions: [".js", ".jsx", ".ts", ".tsx"],
+      },
+    },
+  },
+  reportUnusedDisableDirectives: true,
+  plugins: ["react-hooks", "@typescript-eslint", "regexp", "@docusaurus"],
+  rules: {
+    "react/jsx-uses-react": OFF, // JSX runtime: automatic
+    "react/react-in-jsx-scope": OFF, // JSX runtime: automatic
+    "array-callback-return": WARNING,
+    camelcase: WARNING,
+    "class-methods-use-this": OFF, // It's a way of allowing private variables.
+    curly: [WARNING, "all"],
+    "global-require": WARNING,
+    "lines-between-class-members": OFF,
+    "max-classes-per-file": OFF,
+    "max-len": [
+      WARNING,
+      {
+        code: Infinity, // Code width is already enforced by Prettier
+        tabWidth: 2,
+        comments: 80,
+        ignoreUrls: true,
+        ignorePattern: "(eslint-disable|@)",
+      },
+    ],
+    "arrow-body-style": OFF,
+    "no-await-in-loop": OFF,
+    "no-case-declarations": WARNING,
+    "no-console": OFF,
+    "no-constant-binary-expression": ERROR,
+    "no-continue": OFF,
+    "no-control-regex": WARNING,
+    "no-else-return": OFF,
+    "no-empty": [WARNING, { allowEmptyCatch: true }],
+    "no-lonely-if": WARNING,
+    "no-nested-ternary": WARNING,
+    "no-param-reassign": [WARNING, { props: false }],
+    "no-prototype-builtins": WARNING,
+    "no-restricted-exports": OFF,
+    "no-restricted-properties": [
+      ERROR,
+      .../** @type {[string, string][]} */ ([
+        // TODO: TS doesn't make Boolean a narrowing function yet,
+        // so filter(Boolean) is problematic type-wise
+        // ['compact', 'Array#filter(Boolean)'],
+        ["concat", "Array#concat"],
+        ["drop", "Array#slice(n)"],
+        ["dropRight", "Array#slice(0, -n)"],
+        ["fill", "Array#fill"],
+        ["filter", "Array#filter"],
+        ["find", "Array#find"],
+        ["findIndex", "Array#findIndex"],
+        ["first", "foo[0]"],
+        ["flatten", "Array#flat"],
+        ["flattenDeep", "Array#flat(Infinity)"],
+        ["flatMap", "Array#flatMap"],
+        ["fromPairs", "Object.fromEntries"],
+        ["head", "foo[0]"],
+        ["indexOf", "Array#indexOf"],
+        ["initial", "Array#slice(0, -1)"],
+        ["join", "Array#join"],
+        // Unfortunately there's no great alternative to _.last yet
+        // Candidates: foo.slice(-1)[0]; foo[foo.length - 1]
+        // Array#at is ES2022; could replace _.nth as well
+        // ['last'],
+        ["map", "Array#map"],
+        ["reduce", "Array#reduce"],
+        ["reverse", "Array#reverse"],
+        ["slice", "Array#slice"],
+        ["take", "Array#slice(0, n)"],
+        ["takeRight", "Array#slice(-n)"],
+        ["tail", "Array#slice(1)"],
+      ]).map(([property, alternative]) => ({
+        object: "_",
+        property,
+        message: `Use ${alternative} instead.`,
+      })),
+      ...[
+        "readdirSync",
+        "readFileSync",
+        "statSync",
+        "lstatSync",
+        "existsSync",
+        "pathExistsSync",
+        "realpathSync",
+        "mkdirSync",
+        "mkdirpSync",
+        "mkdirsSync",
+        "writeFileSync",
+        "writeJsonSync",
+        "outputFileSync",
+        "outputJsonSync",
+        "moveSync",
+        "copySync",
+        "copyFileSync",
+        "ensureFileSync",
+        "ensureDirSync",
+        "ensureLinkSync",
+        "ensureSymlinkSync",
+        "unlinkSync",
+        "removeSync",
+        "emptyDirSync",
+      ].map((property) => ({
+        object: "fs",
+        property,
+        message: "Do not use sync fs methods.",
+      })),
+    ],
+    "no-restricted-syntax": [
+      WARNING,
+      // Copied from airbnb, removed for...of statement, added export all
+      {
+        selector: "ForInStatement",
+        message:
+          "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.",
+      },
+      {
+        selector: "LabeledStatement",
+        message:
+          "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.",
+      },
+      {
+        selector: "WithStatement",
+        message:
+          "`with` is disallowed in strict mode because it makes code impossible to predict and optimize.",
+      },
+      {
+        selector: "ExportAllDeclaration",
+        message:
+          "Export all does't work well if imported in ESM due to how they are transpiled, and they can also lead to unexpected exposure of internal methods.",
+      },
+      // TODO make an internal plugin to ensure this
+      // {
+      //   selector:
+      // @   'ExportDefaultDeclaration > Identifier, ExportNamedDeclaration[source=null] > ExportSpecifier',
+      //   message: 'Export in one statement'
+      // },
+      ...["path", "fs-extra", "webpack", "lodash"].map((m) => ({
+        selector: `ImportDeclaration[importKind=value]:has(Literal[value=${m}]) > ImportSpecifier[importKind=value]`,
+        message:
+          "Default-import this, both for readability and interoperability with ESM",
+      })),
+    ],
+    "no-template-curly-in-string": WARNING,
+    "no-unused-expressions": [
+      WARNING,
+      { allowTaggedTemplates: true, allowShortCircuit: true },
+    ],
+    "no-useless-escape": WARNING,
+    "no-void": [ERROR, { allowAsStatement: true }],
+    "prefer-destructuring": WARNING,
+    "prefer-named-capture-group": WARNING,
+    "prefer-template": WARNING,
+    yoda: WARNING,
+
+    "import/extensions": OFF,
+    // This rule doesn't yet support resolving .js imports when the actual file
+    // is .ts. Plus it's not all that useful when our code is fully TS-covered.
+    "import/no-unresolved": [
+      OFF,
+      {
+        // Ignore certain webpack aliases because they can't be resolved
+        ignore: [
+          "^@theme",
+          "^@docusaurus",
+          "^@generated",
+          "^@site",
+          "^@testing-utils",
+        ],
+      },
+    ],
+    "import/order": [
+      WARNING,
+      {
+        groups: [
+          "builtin",
+          "external",
+          "internal",
+          ["parent", "sibling", "index"],
+          "type",
+        ],
+        "newlines-between": "always",
+        pathGroups: [
+          // always put css import to the last, ref:
+          // https://github.com/import-js/eslint-plugin-import/issues/1239
+          {
+            pattern: "*.+(css|sass|less|scss|pcss|styl)",
+            group: "unknown",
+            patternOptions: { matchBase: true },
+            position: "after",
+          },
+          { pattern: "react", group: "builtin", position: "before" },
+          { pattern: "react-dom", group: "builtin", position: "before" },
+          { pattern: "react-dom/**", group: "builtin", position: "before" },
+          { pattern: "stream", group: "builtin", position: "before" },
+          { pattern: "fs-extra", group: "builtin" },
+          { pattern: "lodash", group: "external", position: "before" },
+          { pattern: "clsx", group: "external", position: "before" },
+          // 'Bit weird to not use the `import/internal-regex` option, but this
+          // way, we can make `import type { Props } from "@theme/*"` appear
+          // before `import styles from "styles.module.css"`, which is what we
+          // always did. This should be removable once we stop using ambient
+          // module declarations for theme aliases.
+          { pattern: "@theme/**", group: "internal" },
+          { pattern: "@site/**", group: "internal" },
+          { pattern: "@theme-init/**", group: "internal" },
+          { pattern: "@theme-original/**", group: "internal" },
+          { pattern: "@/components/**", group: "internal" },
+          { pattern: "@/libs/**", group: "internal" },
+          { pattern: "@/types/**", group: "type" },
+        ],
+        pathGroupsExcludedImportTypes: [],
+        // example: let `import './nprogress.css';` after importing others
+        // in `packages/docusaurus-theme-classic/src/nprogress.ts`
+        // see more: https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md#warnonunassignedimports-truefalse
+        warnOnUnassignedImports: true,
+      },
+    ],
+    "import/prefer-default-export": OFF,
+
+    "jsx-a11y/click-events-have-key-events": WARNING,
+    "jsx-a11y/no-noninteractive-element-interactions": WARNING,
+    "jsx-a11y/html-has-lang": OFF,
+
+    "react-hooks/rules-of-hooks": ERROR,
+    "react-hooks/exhaustive-deps": ERROR,
+
+    // Sometimes we do need the props as a whole, e.g. when spreading
+    "react/destructuring-assignment": OFF,
+    "react/function-component-definition": [
+      WARNING,
+      {
+        namedComponents: "function-declaration",
+        unnamedComponents: "arrow-function",
+      },
+    ],
+    "react/jsx-filename-extension": OFF,
+    "react/jsx-key": [ERROR, { checkFragmentShorthand: true }],
+    "react/jsx-no-useless-fragment": [ERROR, { allowExpressions: true }],
+    "react/jsx-props-no-spreading": OFF,
+    "react/no-array-index-key": OFF, // We build a static site, and nearly all components don't change.
+    "react/no-unstable-nested-components": [WARNING, { allowAsProps: true }],
+    "react/prefer-stateless-function": WARNING,
+    "react/prop-types": OFF,
+    "react/require-default-props": [
+      ERROR,
+      { ignoreFunctionalComponents: true },
+    ],
+
+    "@typescript-eslint/consistent-type-definitions": OFF,
+    "@typescript-eslint/require-await": OFF,
+
+    "@typescript-eslint/ban-ts-comment": [
+      ERROR,
+      { "ts-expect-error": "allow-with-description" },
+    ],
+    "@typescript-eslint/consistent-indexed-object-style": OFF,
+    "@typescript-eslint/consistent-type-imports": [
+      WARNING,
+      { disallowTypeAnnotations: false },
+    ],
+    "@typescript-eslint/explicit-module-boundary-types": WARNING,
+    "@typescript-eslint/method-signature-style": ERROR,
+    "@typescript-eslint/no-empty-function": OFF,
+    "@typescript-eslint/no-empty-interface": [
+      ERROR,
+      {
+        allowSingleExtends: true,
+      },
+    ],
+    "@typescript-eslint/no-inferrable-types": OFF,
+    "@typescript-eslint/no-namespace": [WARNING, { allowDeclarations: true }],
+    "no-use-before-define": OFF,
+    "@typescript-eslint/no-use-before-define": [
+      ERROR,
+      { functions: false, classes: false, variables: true },
+    ],
+    "@typescript-eslint/no-non-null-assertion": OFF,
+    "no-redeclare": OFF,
+    "@typescript-eslint/no-redeclare": ERROR,
+    "no-shadow": OFF,
+    "@typescript-eslint/no-shadow": ERROR,
+    "no-unused-vars": OFF,
+    // We don't provide any escape hatches for this rule. Rest siblings and
+    // function placeholder params are always ignored, and any other unused
+    // locals must be justified with a disable comment.
+    "@typescript-eslint/no-unused-vars": [ERROR, { ignoreRestSiblings: true }],
+    "@typescript-eslint/prefer-optional-chain": ERROR,
+    "@docusaurus/no-html-links": ERROR,
+    "@docusaurus/prefer-docusaurus-heading": ERROR,
+    "@docusaurus/no-untranslated-text": [
+      WARNING,
+      {
+        ignoredStrings: [
+          "·",
+          "-",
+          "—",
+          "×",
+          "​", // zwj: ​
+          "@",
+          "WebContainers",
+          "Twitter",
+          "GitHub",
+          "Dev.to",
+          "1.x",
+        ],
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: ["packages/*/src/theme/**/*.{js,ts,tsx}"],
+      excludedFiles: "*.test.{js,ts,tsx}",
+      rules: {
+        "no-restricted-imports": [
+          "error",
+          {
+            patterns: LodashImportPatterns.concat(
+              // Prevents relative imports between React theme components
+              [
+                "../**",
+                "./**",
+                // Allows relative styles module import with consistent filename
+                "!./styles.module.css",
+                // Allows relative tailwind css import with consistent filename
+                "!./styles.css",
+              ]
+            ),
+          },
+        ],
+      },
+    },
+    {
+      files: ["packages/*/src/theme/**/*.{js,ts,tsx}"],
+      rules: {
+        "import/no-named-export": ERROR,
+      },
+    },
+    {
+      files: ["*.d.ts"],
+      rules: {
+        "import/no-duplicates": OFF,
+      },
+    },
+    {
+      files: ["*.{ts,tsx}"],
+      rules: {
+        "no-undef": OFF,
+        "import/no-import-module-exports": OFF,
+      },
+    },
+    {
+      files: ["*.{js,mjs,cjs}"],
+      rules: {
+        // Make JS code directly runnable in Node.
+        "@typescript-eslint/no-var-requires": OFF,
+        "@typescript-eslint/explicit-module-boundary-types": OFF,
+      },
+    },
+    {
+      // Internal files where extraneous deps don't matter much at long as
+      // they run
+      files: ["website/**"],
+      rules: {
+        "import/no-extraneous-dependencies": OFF,
+      },
+    },
+  ],
+};

.gitattributes

@@ -0,0 +1 @@
+website/versioned_*/** linguist-documentation

.github/FUNDING.yml

@@ -1,2 +1,2 @@
 open_collective: nonebot
-custom: ["https://afdian.net/@nonebot"]
+custom: ["https://afdian.com/@nonebot"]

.github/ISSUE_TEMPLATE/adapter_publish.yml

@@ -0,0 +1,64 @@
+name: 发布适配器
+title: "Adapter: {name}"
+description: 发布适配器到 NoneBot 官方商店
+labels: ["Adapter", "Publish"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # 发布须知
+
+        非特殊情况下，请通过 [NoneBot 适配器商店](https://nonebot.dev/store/adapters) 的发布表单进行插件发布信息填写。
+
+  - type: input
+    id: name
+    attributes:
+      label: 适配器名称
+      description: 适配器名称
+    validations:
+      required: true
+
+  - type: input
+    id: description
+    attributes:
+      label: 适配器描述
+      description: 适配器描述
+    validations:
+      required: true
+
+  - type: input
+    id: pypi
+    attributes:
+      label: PyPI 项目名
+      description: PyPI 项目名
+      placeholder: e.g. nonebot-adapter-xxx
+    validations:
+      required: true
+
+  - type: input
+    id: module
+    attributes:
+      label: 适配器 import 包名
+      description: 适配器 import 包名
+      placeholder: e.g. nonebot_adapter_xxx
+    validations:
+      required: true
+
+  - type: input
+    id: homepage
+    attributes:
+      label: 适配器项目仓库/主页链接
+      description: 适配器项目仓库/主页链接
+      placeholder: e.g. https://github.com/xxx/xxx
+    validations:
+      required: true
+
+  - type: input
+    id: tags
+    attributes:
+      label: 标签
+      description: 标签
+      placeholder: 'e.g. [{"label": "标签名", "color": "#ea5252"}]'
+      value: "[]"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/bot_publish.yml

@@ -0,0 +1,44 @@
+name: 发布机器人
+title: "Bot: {name}"
+description: 发布机器人到 NoneBot 官方商店
+labels: ["Bot", "Publish"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # 发布须知
+
+        非特殊情况下，请通过 [NoneBot 机器人商店](https://nonebot.dev/store/bots) 的发布表单进行插件发布信息填写。
+
+  - type: input
+    id: name
+    attributes:
+      label: 机器人名称
+      description: 机器人名称
+    validations:
+      required: true
+
+  - type: input
+    id: description
+    attributes:
+      label: 机器人描述
+      description: 机器人描述
+    validations:
+      required: true
+
+  - type: input
+    id: homepage
+    attributes:
+      label: 机器人项目仓库/主页链接
+      description: 机器人项目仓库/主页链接
+      placeholder: e.g. https://github.com/xxx/xxx
+
+  - type: input
+    id: tags
+    attributes:
+      label: 标签
+      description: 标签
+      placeholder: 'e.g. [{"label": "标签名", "color": "#ea5252"}]'
+      value: "[]"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,33 +0,0 @@
----
-name: Bug report
-about: Create a bug report to help us improve
-title: 'Bug: Something went wrong'
-labels: bug
-assignees: ''
-
----
-
-**描述问题：**
-
-A clear and concise description of what the bug is.
-
-**如何复现？**
-
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**期望的结果**
-
-A clear and concise description of what you expected to happen.
-
-**环境信息：**
-
- - OS: [e.g. Linux]
- - Python Version: [e.g. 3.8]
- - Nonebot Version: [e.g. 2.0.0]
-
-**截图**
-
-If applicable, add screenshots to help explain your problem.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,85 @@
+name: Bug 反馈
+title: "Bug: 出现异常"
+description: 提交 Bug 反馈以帮助我们改进代码
+labels: ["bug"]
+body:
+  - type: dropdown
+    id: env-os
+    attributes:
+      label: 操作系统
+      description: 选择运行 NoneBot 的系统
+      options:
+        - Windows
+        - MacOS
+        - Linux
+        - Other
+    validations:
+      required: true
+
+  - type: input
+    id: env-python-ver
+    attributes:
+      label: Python 版本
+      description: 填写运行 NoneBot 的 Python 版本
+      placeholder: e.g. 3.11.0
+    validations:
+      required: true
+
+  - type: input
+    id: env-nb-ver
+    attributes:
+      label: NoneBot 版本
+      description: 填写 NoneBot 版本
+      placeholder: e.g. 2.0.0
+    validations:
+      required: true
+
+  - type: input
+    id: env-adapter
+    attributes:
+      label: 适配器
+      description: 填写使用的适配器以及版本
+      placeholder: e.g. OneBot v11 2.2.2
+    validations:
+      required: true
+
+  - type: input
+    id: env-protocol
+    attributes:
+      label: 协议端
+      description: 填写连接 NoneBot 的协议端及版本
+      placeholder: e.g. go-cqhttp 1.0.0
+    validations:
+      required: true
+
+  - type: textarea
+    id: describe
+    attributes:
+      label: 描述问题
+      description: 清晰简洁地说明问题是什么
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: 复现步骤
+      description: 提供能复现此问题的详细操作步骤
+      placeholder: |
+        1. 首先……
+        2. 然后……
+        3. 发生……
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: 期望的结果
+      description: 清晰简洁地描述你期望发生的事情
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: 截图或日志
+      description: 提供有助于诊断问题的任何日志和截图

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: NoneBot 论坛
+    url: https://discussions.nonebot.dev/
+    about: 前往 NoneBot 论坛提问

.github/ISSUE_TEMPLATE/document.yml

@@ -0,0 +1,18 @@
+name: 文档改进
+title: "Docs: 描述"
+description: 文档错误及改进意见反馈
+labels: ["documentation"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: 描述问题或主题
+    validations:
+      required: true
+
+  - type: textarea
+    id: improve
+    attributes:
+      label: 需做出的修改
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,16 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: 'Feature: Something you want'
-labels: enhancement
-assignees: ''
-
----
-
-**是否在使用中遇到某些问题而需要新的特性？请描述：**
-
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**描述你所需要的特性：**
-
-A clear and concise description of what you want to happen.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,20 @@
+name: 功能建议
+title: "Feature: 功能描述"
+description: 提出关于项目新功能的想法
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: 希望能解决的问题
+      description: 在使用中遇到什么问题而需要新的功能？
+    validations:
+      required: true
+
+  - type: textarea
+    id: feature
+    attributes:
+      label: 描述所需要的功能
+      description: 请说明需要的功能或解决方法
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/plugin-publish.md

@@ -1,36 +0,0 @@
----
-name: Plugin Publish
-about: Publish your plugin to nonebot homepage and nb-cli
-title: "Plugin: blabla 的插件"
-labels: Plugin
-assignees: ""
-
----
-
-**你的插件名称：**
-
-例：复读机
-
-**简短描述插件功能：**
-
-例：复读群友的消息
-
-**插件 import 使用的名称**
-
-例：nonebot_plugin_example
-
-**插件 install 使用的名称**
-
-例 1：nonebot-plugin-example
-
-通过 pypi 安装
-
-> 请事先发布插件到[pypi](https://pypi.org/)
-
-例 2：git+https://github.com/nonebot/nonebot-plugin-example
-
-从 github 仓库安装
-
-**插件项目仓库/主页链接**
-
-例：nonebot/nonebot2（默认 github ）或其他链接

.github/ISSUE_TEMPLATE/plugin_publish.yml

@@ -0,0 +1,51 @@
+name: 发布插件
+title: "Plugin: {name}"
+description: 发布插件到 NoneBot 官方商店
+labels: ["Plugin", "Publish"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # 发布须知
+
+        非特殊情况下，请通过 [NoneBot 插件商店](https://nonebot.dev/store/plugins) 的发布表单进行插件发布信息填写。
+        在发布前请阅读 [NoneBot 插件发布流程指导](https://nonebot.dev/docs/developer/plugin-publishing) 并确保满足其中所述条件。
+
+  - type: input
+    id: pypi
+    attributes:
+      label: PyPI 项目名
+      description: PyPI 项目名
+      placeholder: e.g. nonebot-plugin-xxx
+    validations:
+      required: true
+
+  - type: input
+    id: module
+    attributes:
+      label: 插件模块名
+      description: 加载插件时所使用的模块名称
+      placeholder: e.g. nonebot_plugin_apscheduler
+    validations:
+      required: true
+
+  - type: input
+    id: tags
+    attributes:
+      label: 标签
+      description: 标签
+      placeholder: 'e.g. [{"label": "标签名", "color": "#ea5252"}]'
+      value: "[]"
+    validations:
+      required: true
+
+  - type: textarea
+    id: config
+    attributes:
+      label: 插件配置项
+      description: 插件配置项
+      render: dotenv
+      placeholder: |
+        # e.g.
+        # KEY=VALUE
+        # KEY2=VALUE2

.github/actions/build-api-doc/action.yml

@@ -0,0 +1,9 @@
+name: Build API Doc
+description: Build API Doc
+
+runs:
+  using: "composite"
+  steps:
+    - run: |
+        uv run --no-sync bash ./scripts/build-api-docs.sh
+      shell: bash

.github/actions/setup-node/action.yml

@@ -0,0 +1,13 @@
+name: Setup Node
+description: Setup Node
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-node@v5
+      with:
+        node-version: lts/*
+        cache: yarn
+
+    - run: yarn install --frozen-lockfile
+      shell: bash

.github/actions/setup-python/action.yml

@@ -0,0 +1,24 @@
+name: Setup Python
+description: Setup Python
+
+inputs:
+  python-version:
+    description: Python version
+    required: false
+    default: "3.12"
+  env-group:
+    description: Environment group
+    required: false
+    default: "pydantic-v2"
+
+runs:
+  using: "composite"
+  steps:
+    - uses: astral-sh/setup-uv@v6
+      with:
+        python-version: ${{ inputs.python-version }}
+        cache-suffix: ${{ inputs.env-group }}
+
+    - run: |
+        uv sync --all-extras --locked --group ${{ inputs.env-group }}
+      shell: bash

.github/dependabot.yml

@@ -0,0 +1,46 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+    groups:
+      actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: github-actions
+    directory: "/.github/actions/build-api-doc"
+    schedule:
+      interval: daily
+    groups:
+      actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: github-actions
+    directory: "/.github/actions/setup-node"
+    schedule:
+      interval: daily
+    groups:
+      actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: github-actions
+    directory: "/.github/actions/setup-python"
+    schedule:
+      interval: daily
+    groups:
+      actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: devcontainers
+    directory: "/"
+    schedule:
+      interval: daily
+    groups:
+      devcontainers:
+        patterns:
+          - "*"

.github/release-drafter.yml

@@ -1,38 +1,43 @@
-name-template: 'v$RESOLVED_VERSION 🌈'
-tag-template: 'v$RESOLVED_VERSION'
+template: $CHANGES
+category-template: "### $TITLE"
+name-template: "Release v$RESOLVED_VERSION 🌈"
+tag-template: "v$RESOLVED_VERSION"
+change-template: "- $TITLE [@$AUTHOR](https://github.com/$AUTHOR) ([#$NUMBER]($URL))"
+change-title-escapes: '\<&'
+exclude-labels:
+  - "dependencies"
+  - "skip-changelog"
 categories:
-  - title: '💥 Breaking Changes'
+  - title: "💥 破坏性变更"
     labels:
-      - 'Breaking'
-  - title: '🚀 Features'
+      - "Breaking"
+  - title: "🚀 新功能"
     labels:
-      - 'feature'
-      - 'enhancement'
-  - title: '🐛 Bug Fixes'
+      - "feature"
+      - "enhancement"
+  - title: "🐛 Bug 修复"
     labels:
-      - 'fix'
-      - 'bugfix'
-      - 'bug'
-  - title: '🍻 Plugin Publish'
-    label: 'Plugin'
-change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
-change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+      - "fix"
+      - "bugfix"
+      - "bug"
+  - title: "📝 文档"
+    labels:
+      - "documentation"
+  - title: "💫 杂项"
+  - title: "🍻 插件发布"
+    label: "Plugin"
+  - title: "🍻 机器人发布"
+    label: "Bot"
+  - title: "🍻 适配器发布"
+    label: "Adapter"
 version-resolver:
   major:
     labels:
-      - 'major'
+      - "major"
   minor:
     labels:
-      - 'minor'
+      - "minor"
   patch:
     labels:
-      - 'patch'
+      - "patch"
   default: patch
-template: |
-  ## Documentation
-
-  See: https://v2.nonebot.dev
-
-  ## 💫 Changes
-
-  $CHANGES

.github/workflows/build_docs.yml

@@ -1,37 +0,0 @@
-name: Build API Doc
-
-on:
-  pull_request:
-    types: [ opened, synchronize, reopened ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.8
-          architecture: "x64"
-
-      - name: Install Dependences
-        run: |
-          python -m pip install --upgrade pip
-          pip install poetry
-          poetry install
-
-      - name: Build Doc
-        run: poetry run sphinx-build -M markdown ./docs_build ./build
-
-      - name: Copy Files
-        run: cp -r ./build/markdown/* ./docs/api/
-
-      - uses: actions/upload-artifact@v2
-        with:
-          name: docs
-          path: docs/

.github/workflows/codecov.yml

@@ -0,0 +1,66 @@
+name: Code Coverage
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    paths:
+      - "envs/**"
+      - "nonebot/**"
+      - "packages/**"
+      - "tests/**"
+      - ".github/actions/setup-python/**"
+      - ".github/workflows/codecov.yml"
+      - "pyproject.toml"
+      - "uv.lock"
+
+jobs:
+  test:
+    name: Test Coverage
+    runs-on: ${{ matrix.os }}
+    concurrency:
+      group: test-coverage-${{ github.ref }}-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.env }}
+      cancel-in-progress: true
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        env: [pydantic-v1, pydantic-v2]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON_VERSION: ${{ matrix.python-version }}
+      PYDANTIC_VERSION: ${{ matrix.env }}
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Python environment
+        uses: ./.github/actions/setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
+          env-group: ${{ matrix.env }}
+
+      - name: Run Pytest
+        run: |
+          uv run --no-sync bash ./scripts/run-tests.sh
+
+      - name: Upload test results
+        uses: codecov/test-results-action@v1
+        with:
+          env_vars: OS,PYTHON_VERSION,PYDANTIC_VERSION
+          files: ./tests/junit.xml
+          flags: unittests
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v5
+        with:
+          env_vars: OS,PYTHON_VERSION,PYDANTIC_VERSION
+          files: ./tests/coverage.xml
+          flags: unittests
+          fail_ci_if_error: true
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/nonebot_plugin_docs.yml

@@ -1,40 +0,0 @@
-name: Release Nonebot Plugin Docs
-
-on:
-  release:
-    types: [ published ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Setup Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '12'
-      - run: npm ci
-      - name: Build Docs
-        env:
-          VUEPRESS_BASE: '/docs/'
-        run: npx vuepress build docs --dest packages/nonebot-plugin-docs/nonebot_plugin_docs/dist
-
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.8
-          architecture: "x64"
-      - name: Install Poetry
-        run: |
-          python -m pip install --upgrade pip
-          pip install poetry
-
-      - name: Publish Package
-        run: |
-          export NONEBOT_VERSION=`poetry version -s`
-          cd packages/nonebot-plugin-docs/
-          poetry version $NONEBOT_VERSION
-          poetry build
-          poetry publish -u ${{secrets.PYPI_USERNAME}} -p ${{secrets.PYPI_PASSWORD}}

.github/workflows/noneflow.yml

@@ -0,0 +1,73 @@
+name: NoneFlow
+
+on:
+  issues:
+    types: [opened, reopened, edited]
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [closed]
+  pull_request_review:
+    types: [submitted]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.issue.number && format('publish/issue{0}', github.event.issue.number) || github.head_ref || github.run_id }}
+  cancel-in-progress: ${{ startsWith(github.head_ref, 'publish/issue')}}
+
+jobs:
+  noneflow:
+    runs-on: ubuntu-latest
+    name: noneflow
+    # do not run on forked PRs, do not run on not related issues, do not run on pr comments
+    if: |
+      !(
+        (
+          github.event.pull_request &&
+          (
+            github.event.pull_request.head.repo.fork ||
+            !(
+              contains(github.event.pull_request.labels.*.name, 'Plugin') ||
+              contains(github.event.pull_request.labels.*.name, 'Adapter') ||
+              contains(github.event.pull_request.labels.*.name, 'Bot')
+            )
+          )
+        ) ||
+        (
+          github.event_name == 'issue_comment' && github.event.issue.pull_request
+        )
+      )
+    steps:
+      - name: Generate token
+        id: generate-token
+        uses: tibdex/github-app-token@v2
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_KEY }}
+
+      - name: Checkout Code
+        uses: actions/checkout@v5
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+
+      - name: NoneFlow
+        uses: docker://ghcr.io/nonebot/noneflow:latest
+        with:
+          config: >
+            {
+              "base": "master",
+              "plugin_path": "assets/plugins.json5",
+              "bot_path": "assets/bots.json5",
+              "adapter_path": "assets/adapters.json5",
+              "registry_repository": "nonebot/registry",
+              "artifact_path": "artifact"
+            }
+        env:
+          APP_ID: ${{ secrets.APP_ID }}
+          PRIVATE_KEY: ${{ secrets.APP_KEY }}
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: noneflow
+          path: artifact/*
+          if-no-files-found: ignore

.github/workflows/plugin_issue.yml

@@ -1,25 +0,0 @@
-name: 'Plugin Issue Bot'
-
-on:
-  push:
-    branches:
-      - master
-  issues:
-    types: [opened, reopened, edited]
-  pull_request:
-    types: [closed]
-
-jobs:
-  issue_bot:
-    runs-on: ubuntu-latest
-    name: plugin issue bot
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: NoneBot2 Plugin Issue Bot
-        uses: he0119/nonebot2-plugin-issue-bot@v0.2
-        with:
-          token: ${{ secrets.GH_TOKEN }}
-          base: master
-          path: docs/.vuepress/public/plugins.json

.github/workflows/pyright.yml

@@ -0,0 +1,48 @@
+name: Pyright Lint
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    paths:
+      - "envs/**"
+      - "nonebot/**"
+      - "packages/**"
+      - "tests/**"
+      - ".github/actions/setup-python/**"
+      - ".github/workflows/pyright.yml"
+      - "pyproject.toml"
+      - "uv.lock"
+
+jobs:
+  pyright:
+    name: Pyright Lint
+    runs-on: ubuntu-latest
+    concurrency:
+      group: pyright-${{ github.ref }}-${{ matrix.env }}
+      cancel-in-progress: true
+    strategy:
+      matrix:
+        env: [pydantic-v1, pydantic-v2]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Python environment
+        uses: ./.github/actions/setup-python
+        with:
+          env-group: ${{ matrix.env }}
+
+      - run: |
+          echo "$(dirname $(uv python find))" >> $GITHUB_PATH
+          if [ "${{ matrix.env }}" = "pydantic-v1" ]; then
+            sed -i 's/PYDANTIC_V2 = true/PYDANTIC_V2 = false/g' ./pyproject.toml
+          fi
+        shell: bash
+
+      - name: Run Pyright
+        uses: jakebailey/pyright-action@v2
+        with:
+          pylance-version: latest-release

.github/workflows/release-draft.yml

@@ -1,14 +0,0 @@
-name: Release Drafter
-
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  update_release_draft:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: release-drafter/release-drafter@v5
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-drafter.yml

@@ -0,0 +1,127 @@
+name: Release Drafter
+
+on:
+  push:
+    tags:
+      - v*
+  pull_request_target:
+    branches:
+      - master
+    types:
+      - closed
+
+jobs:
+  update-release-draft:
+    if: github.event_name == 'pull_request_target'
+    runs-on: ubuntu-latest
+    concurrency:
+      group: pull-request-changelog
+      cancel-in-progress: true
+    steps:
+      - name: Generate token
+        id: generate-token
+        uses: tibdex/github-app-token@v2
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_KEY }}
+
+      - uses: actions/checkout@v5
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+
+      - name: Setup Node Environment
+        uses: ./.github/actions/setup-node
+
+      - uses: release-drafter/release-drafter@v6.0.0
+        id: release-drafter
+        env:
+          GITHUB_TOKEN: ${{ steps.generate-token.outputs.token }}
+
+      - name: Update Changelog
+        uses: docker://ghcr.io/nonebot/auto-changelog:master
+        with:
+          changelog_file: website/src/changelog/changelog.md
+          latest_changes_position: '# 更新日志\n\n'
+          latest_changes_title: "## 最近更新"
+          replace_regex: '(?<=## 最近更新\n)[\s\S]*?(?=\n## )'
+          changelog_body: ${{ steps.release-drafter.outputs.body }}
+          commit_and_push: false
+
+      - name: Commit and Push
+        run: |
+          yarn prettier
+          git config user.name noneflow[bot]
+          git config user.email 129742071+noneflow[bot]@users.noreply.github.com
+          git add .
+          git diff-index --quiet HEAD || git commit -m ":memo: Update changelog"
+          git push
+
+  release:
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: Generate token
+        id: generate-token
+        uses: tibdex/github-app-token@v2
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_KEY }}
+
+      - uses: actions/checkout@v5
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/setup-python
+
+      - name: Setup Node Environment
+        uses: ./.github/actions/setup-node
+
+      - name: Build API Doc
+        uses: ./.github/actions/build-api-doc
+
+      - name: Get Version
+        id: version
+        run: |
+          echo "VERSION=$(uv version --short)" >> $GITHUB_OUTPUT
+          echo "TAG_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+          echo "TAG_NAME=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+
+      - name: Check Version
+        if: steps.version.outputs.VERSION != steps.version.outputs.TAG_VERSION
+        run: exit 1
+
+      - uses: release-drafter/release-drafter@v6.0.0
+        with:
+          name: Release ${{ steps.version.outputs.TAG_NAME }} 🌈
+          tag: ${{ steps.version.outputs.TAG_NAME }}
+          publish: true
+        env:
+          GITHUB_TOKEN: ${{ steps.generate-token.outputs.token }}
+
+      - name: Build Package
+        run: |
+          uv build
+          uv publish
+
+      - name: Publish package to GitHub
+        run: |
+          gh release upload --clobber ${{ steps.version.outputs.TAG_NAME }} dist/*.tar.gz dist/*.whl
+        env:
+          GITHUB_TOKEN: ${{ steps.generate-token.outputs.token }}
+
+      - name: Build and Publish Doc Package
+        run: |
+          yarn build:plugin --out-dir ../packages/nonebot-plugin-docs/nonebot_plugin_docs/dist
+          cd packages/nonebot-plugin-docs/
+          uv version ${{ steps.version.outputs.VERSION }}
+          uv build
+          uv publish
+
+      - name: Publish Doc Package to GitHub
+        run: |
+          cd packages/nonebot-plugin-docs/
+          gh release upload --clobber ${{ steps.version.outputs.TAG_NAME }} dist/*.tar.gz dist/*.whl
+        env:
+          GITHUB_TOKEN: ${{ steps.generate-token.outputs.token }}

.github/workflows/release.yml

@@ -0,0 +1,52 @@
+name: Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Generate token
+        id: generate-token
+        uses: tibdex/github-app-token@v2
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_KEY }}
+
+      - uses: actions/checkout@v5
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/setup-python
+
+      - name: Setup Node Environment
+        uses: ./.github/actions/setup-node
+
+      - name: Build API Doc
+        uses: ./.github/actions/build-api-doc
+
+      - run: echo "TAG_NAME=v$(uv version --short)" >> $GITHUB_ENV
+
+      - name: Archive Changelog
+        uses: docker://ghcr.io/nonebot/auto-changelog:master
+        with:
+          changelog_file: website/src/changelog/changelog.md
+          archive_regex: '(?<=## )最近更新(?=\n)'
+          archive_title: ${{ env.TAG_NAME }}
+          commit_and_push: false
+
+      - name: Archive Files
+        run: |
+          yarn archive $(uv version --short)
+          yarn prettier
+
+      - name: Push Tag
+        run: |
+          git config user.name noneflow[bot]
+          git config user.email 129742071+noneflow[bot]@users.noreply.github.com
+          git add .
+          git commit -m ":bookmark: Release $(uv version --short)"
+          git tag ${{ env.TAG_NAME }}
+          git push && git push --tags

.github/workflows/ruff.yml

@@ -0,0 +1,30 @@
+name: Ruff Lint
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    paths:
+      - "envs/**"
+      - "nonebot/**"
+      - "packages/**"
+      - "tests/**"
+      - ".github/actions/setup-python/**"
+      - ".github/workflows/ruff.yml"
+      - "pyproject.toml"
+      - "uv.lock"
+
+jobs:
+  ruff:
+    name: Ruff Lint
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ruff-${{ github.ref }}
+      cancel-in-progress: true
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Run Ruff Lint
+        uses: astral-sh/ruff-action@v3

.github/workflows/upload_docs.yml

@@ -1,35 +0,0 @@
-name: Upload API Doc
-
-on:
-  workflow_run:
-    workflows: ["Build API Doc"]
-    types:
-      - completed
-
-jobs:
-  upload:
-    runs-on: ubuntu-latest
-    if: ${{ github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' }}
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          ref: ${{ github.event.workflow_run.head_sha }}
-          token: ${{ secrets.GH_TOKEN }}
-
-      - uses: dawidd6/action-download-artifact@v2
-        with:
-          workflow: ${{ github.event.workflow_run.workflow_id }}
-          name: docs
-          path: docs/
-
-      - env:
-          REF: ${{ github.event.workflow_run.head_branch }}
-          PR_REPO: ${{ github.event.workflow_run.head_repository.full_name }}
-          PR_USER: ${{ github.event.workflow_run.head_repository.owner.login }}
-        run: |
-            git config user.name $PR_USER
-            git config user.email $PR_USER@users.noreply.github.com
-            git add .
-            git diff-index --quiet HEAD || git commit -m ":memo: update api docs"
-            git remote add target https://github.com/$PR_REPO.git
-            git push target HEAD:$REF

.github/workflows/website-deploy.yml

@@ -0,0 +1,46 @@
+name: Site Deploy
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: website-deploy-${{ github.ref }}
+      cancel-in-progress: true
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/setup-python
+
+      - name: Setup Node Environment
+        uses: ./.github/actions/setup-node
+
+      - name: Build API Doc
+        uses: ./.github/actions/build-api-doc
+
+      - name: Build Doc
+        run: yarn build
+
+      - name: Get Branch Name
+        run: echo "BRANCH_NAME=$(echo ${GITHUB_REF#refs/heads/})" >> $GITHUB_ENV
+
+      - name: Deploy to Netlify
+        uses: nwtgck/actions-netlify@v3
+        with:
+          publish-dir: "./website/build"
+          production-deploy: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          deploy-message: "Deploy ${{ env.BRANCH_NAME }}@${{ github.sha }}"
+          enable-commit-comment: false
+          alias: ${{ env.BRANCH_NAME }}
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.SITE_ID }}

.github/workflows/website-preview-cd.yml

@@ -0,0 +1,104 @@
+name: Site Deploy (Preview CD)
+
+on:
+  workflow_run:
+    workflows: ["Site Deploy (Preview CI)"]
+    types:
+      - completed
+
+jobs:
+  preview-cd:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: pull-request-preview-${{ github.event.workflow_run.head_repository.full_name }}-${{ github.event.workflow_run.head_branch }}
+      cancel-in-progress: true
+
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+
+    environment: pull request
+
+    permissions:
+      actions: read
+      statuses: write
+      pull-requests: write
+
+    steps:
+      - name: Set Commit Status
+        uses: actions/github-script@v8
+        with:
+          script: |
+            github.rest.repos.createCommitStatus({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              sha: context.payload.workflow_run.head_sha,
+              context: 'Website Preview',
+              description: 'Deploying...',
+              state: 'pending',
+            })
+
+      - name: Download Artifact
+        uses: actions/download-artifact@v5
+        with:
+          name: website-preview
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          run-id: ${{ github.event.workflow_run.id }}
+
+      - name: Restore Context
+        run: |
+          PR_NUMBER=$(cat ./pr-number)
+          if ! [[ "${PR_NUMBER}" =~ ^[0-9]+$ ]]; then
+            echo "Invalid PR number: ${PR_NUMBER}"
+            exit 1
+          fi
+          echo "PR_NUMBER=${PR_NUMBER}" >> "${GITHUB_ENV}"
+
+      - name: Set Deploy Name
+        run: |
+          echo "DEPLOY_NAME=deploy-preview-${PR_NUMBER}" >> "${GITHUB_ENV}"
+
+      - name: Deploy to Netlify
+        id: deploy
+        uses: nwtgck/actions-netlify@v3
+        with:
+          publish-dir: ./website/build
+          production-deploy: false
+          deploy-message: "Deploy ${{ env.DEPLOY_NAME }}@${{ github.event.workflow_run.head_sha }}"
+          alias: ${{ env.DEPLOY_NAME }}
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.SITE_ID }}
+
+      # action netlify has no pull request context, so we need to comment by ourselves
+      - name: Comment on Pull Request
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: website
+          number: ${{ env.PR_NUMBER }}
+          message: |
+            :rocket: Deployed to ${{ steps.deploy.outputs.deploy-url }}
+
+      - name: Set Commit Status
+        uses: actions/github-script@v8
+        if: always()
+        with:
+          script: |
+            if (`${{ job.status }}` === 'success') {
+              github.rest.repos.createCommitStatus({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                sha: context.payload.workflow_run.head_sha,
+                context: 'Website Preview',
+                description: `Deployed to ${{ steps.deploy.outputs.deploy-url }}`,
+                state: 'success',
+                target_url: `${{ steps.deploy.outputs.deploy-url }}`,
+              })
+            } else {
+              github.rest.repos.createCommitStatus({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                sha: context.payload.workflow_run.head_sha,
+                context: 'Website Preview',
+                description: `Deploy ${{ job.status }}`,
+                state: 'failure',
+              })
+            }

.github/workflows/website-preview-ci.yml

@@ -0,0 +1,42 @@
+name: Site Deploy (Preview CI)
+
+on:
+  pull_request:
+
+jobs:
+  preview-ci:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: pull-request-preview-${{ github.event.number }}
+      cancel-in-progress: true
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/setup-python
+
+      - name: Setup Node Environment
+        uses: ./.github/actions/setup-node
+
+      - name: Build API Doc
+        uses: ./.github/actions/build-api-doc
+
+      - name: Build Doc
+        run: yarn build
+
+      - name: Export Context
+        run: |
+          echo "${{ github.event.pull_request.number }}" > ./pr-number
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: website-preview
+          path: |
+            ./website/build
+            ./pr-number
+          retention-days: 1

.gitignore

@@ -1,5 +1,297 @@
-# ----- Python -----
+# ----- Project -----
 
+.idea
+.vscode
+dev
+docs_build/_build
+!tests/.env
+.docusaurus
+website/docs/api/**/*.md
+website/src/pages/changelog/**/*
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,node,visualstudiocode,jetbrains,macos,windows,linux
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,node,visualstudiocode,jetbrains,macos,windows,linux
+
+### JetBrains ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### JetBrains Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+# Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+.env.production
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+.stylelintcache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+### Python ###
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -22,6 +314,7 @@ parts/
 sdist/
 var/
 wheels/
+share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -40,23 +333,25 @@ pip-delete-this-directory.txt
 # Unit test / coverage reports
 htmlcov/
 .tox/
+.nox/
 .coverage
 .coverage.*
-.cache
 nosetests.xml
 coverage.xml
 *.cover
+*.py,cover
 .hypothesis/
 .pytest_cache/
+cover/
 
 # Translations
 *.mo
 *.pot
 
 # Django stuff:
-*.log
 local_settings.py
 db.sqlite3
+db.sqlite3-journal
 
 # Flask stuff:
 instance/
@@ -69,22 +364,39 @@ instance/
 docs/_build/
 
 # PyBuilder
+.pybuilder/
 target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# pyenv
-.python-version
+# IPython
+profile_default/
+ipython_config.py
 
-# celery beat schedule file
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
 celerybeat-schedule
+celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
 
 # Environments
-.env
 .venv
 env/
 venv/
@@ -104,87 +416,61 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+.dmypy.json
+dmypy.json
 
-# ----- Node -----
+# Pyre type checker
+.pyre/
 
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+# pytype static type analyzer
+.pytype/
 
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
+# Cython debug symbols
+cython_debug/
 
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
 
-# Coverage directory used by tools like istanbul
-coverage
+# Local History for Visual Studio Code
+.history/
 
-# nyc test coverage
-.nyc_output
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
 
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
+# Support for Project snippet scope
+!.vscode/*.code-snippets
 
-# Bower dependency directory (https://bower.io/)
-bower_components
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
 
-# node-waf configuration
-.lock-wscript
+# Dump file
+*.stackdump
 
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
+# Folder config file
+[Dd]esktop.ini
 
-# Dependency directories
-node_modules/
-jspm_packages/
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
 
-# TypeScript v1 declaration files
-typings/
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
 
-# Optional npm cache directory
-.npm
+# Windows shortcuts
+*.lnk
 
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# next.js build output
-.next
-
-# nuxt.js build output
-.nuxt
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless
-
-# ----- Project -----
-
-.idea
-.vscode
-dev
-docs_build/_build
-!tests/.env
+# End of https://www.toptal.com/developers/gitignore/api/python,node,visualstudiocode,jetbrains,macos,windows,linux

.markdownlint.yaml

@@ -0,0 +1,4 @@
+MD013: false
+MD024: # 重复标题
+  siblings_only: true
+MD033: false # 允许 html

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+default_install_hook_types: [pre-commit, prepare-commit-msg]
+ci:
+  autofix_commit_msg: ":rotating_light: auto fix by pre-commit hooks"
+  autofix_prs: true
+  autoupdate_branch: master
+  autoupdate_schedule: monthly
+  autoupdate_commit_msg: ":arrow_up: auto update by pre-commit hooks"
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.11
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+        stages: [pre-commit]
+      - id: ruff-format
+        stages: [pre-commit]
+
+  - repo: https://github.com/nonebot/nonemoji
+    rev: v0.1.4
+    hooks:
+      - id: nonemoji
+        stages: [prepare-commit-msg]

.prettierignore

@@ -1 +1,2 @@
 .github/**/*.md
+website/docs/tutorial/application.mdx

.prettierrc

@@ -0,0 +1,21 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "endOfLine": "lf",
+  "arrowParens": "always",
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "semi": true,
+  "overrides": [
+    {
+      "files": [
+        "**/devcontainer.json",
+        "**/tsconfig.json",
+        "**/tsconfig.*.json"
+      ],
+      "options": {
+        "parser": "json"
+      }
+    }
+  ]
+}

.style.yapf

@@ -1,2 +0,0 @@
-[style]
-based_on_style = google

.stylelintrc.js

@@ -0,0 +1,31 @@
+module.exports = {
+  extends: ["stylelint-config-standard", "stylelint-prettier/recommended"],
+  overrides: [
+    {
+      files: ["*.css"],
+      rules: {
+        "function-no-unknown": [true, { ignoreFunctions: ["theme"] }],
+        "selector-class-pattern": [
+          "^([a-z][a-z0-9]*)(-[a-z0-9]+)*$",
+          {
+            resolveNestedSelectors: true,
+            message: (selector) =>
+              `Expected class selector "${selector}" to be kebab-case`,
+          },
+        ],
+      },
+    },
+    {
+      files: ["*.module.css"],
+      rules: {
+        "selector-class-pattern": [
+          "^[a-z][a-zA-Z0-9]+$",
+          {
+            message: (selector) =>
+              `Expected class selector "${selector}" to be lowerCamelCase`,
+          },
+        ],
+      },
+    },
+  ],
+};

.yarnrc

@@ -0,0 +1 @@
+registry "https://registry.npmjs.org/"

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+See [changelog.md](./website/src/changelog/changelog.md) or <https://nonebot.dev/changelog>

CITATION.cff

@@ -0,0 +1,26 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: NoneBot
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Yongyu
+    family-names: Yan
+    email: yyy@nonebot.dev
+  - name: NoneBot Team
+    email: contact@nonebot.dev
+    website: 'https://github.com/nonebot'
+repository-code: 'https://github.com/nonebot/nonebot2'
+url: 'https://nonebot.dev/'
+abstract: >-
+  NoneBot, an asynchronous multi-platform chatbot framework
+  written in Python
+keywords:
+  - nonebot
+  - chatbot
+  - pydantic
+license: MIT

CODE_OF_CONDUCT.md

@@ -0,0 +1,86 @@
+# NoneBot2 贡献者公约
+
+## 我们的承诺
+
+身为项目成员、贡献者、负责人，我们保证参与此社区的每个人都不受骚扰，不论其年龄、体型、身体条件、民族、性征、性别认同与表现、经验水平、教育程度、社会地位、国籍、相貌、种族、宗教信仰及性取向如何。
+
+我们承诺致力于建设开放、友善、多元、包容、健康的社区环境。
+
+## 我们的准则
+
+有助于促进本社区积极环境的行为包括但不限于：
+
+- 与人为善、推己及人
+- 尊重不同的主张、观点和经历
+- 积极提出、耐心接受有益批评
+- 面对过失，承担责任、认真道歉、从中学习
+- 关注社区共同诉求，而非一己私利
+
+不当行为包括但不限于：
+
+- 发布与性有关的言论或图像，以及任何形式的献殷勤或勾引
+- 挑衅行为、侮辱或贬损的言论、人身及政治攻击
+- 公开或私下骚扰
+- 未获明确授权擅自发布他人的资料，如地址、电子邮箱等
+- 其他有理由认定为违反职业操守的不当行为
+
+## 落实之义务
+
+社区负责人有责任诠释什么是“妥当行为”，并据此准则，妥善公正地认定与处置不当、威胁、冒犯及有害的行为。
+
+社区负责人有权利和义务删除、编辑、拒绝违背本公约的评论（comment）、提交（commit）、代码、维基（wiki）编辑、问题（issue）等贡献。如有必要，需告知采取措施的理由。
+
+## 适用范围
+
+此行为标准适用于本社区全部场合，以及在其他场合代表本社区的个人。
+
+代表本社区的情形包括但不限于：使用官方电子邮件与社交平台、作为指定代表参与在线或线下活动。
+
+## 贯彻落实
+
+如遇滥用、骚扰等不当行为，请通过 contact@nonebot.dev 向我们举报。我们将迅速审议并调查全部投诉。
+
+社区全体负责人有义务保密举报者信息。
+
+## 指导方针
+
+社区负责人将依据下列方案判断并处置违纪行为：
+
+### 一、督促
+
+**社区影响**：用语不当、举止不符合道德或不受社区欢迎。
+
+**处理意见**：由社区负责人予以非公开的书面警告，阐明违纪事由、解释举止如何不妥。或要求公开道歉。
+
+### 二、警告
+
+**社区影响**：一起或多起事件中的违纪行为。
+
+**处理意见**：警告继续违纪的后果、违纪者在特定时间内禁止与当事人往来、不得擅自与社区执法者往来，禁令涵盖社区内外、社交网络在内的一切联络。如有违反，可致封禁乃至开除。
+
+### 三、封禁
+
+**社区影响**：严重违纪行为，包括屡教不改。
+
+**处理意见**：违纪者在特定时间内禁止与社区的任何往来或公开联络，禁止任何与当事人公开或私下往来，不得擅自与社区管理者往来。如有违反，可导致开除。
+
+### 四、开除
+
+**社区影响**：典型违纪行为，例如屡教不改、骚扰某个人、敌对或贬低某个群体。
+
+**处理意见**：无限期禁止违纪者与项目社区的一切公开往来。
+
+## 来源
+
+本行为标准改编自[参与者公约][homepage]2.0 版，可在此查阅：[https://www.contributor-covenant.org/zh-cn/version/2/0/code_of_conduct.html][v2.0]
+
+指导方针借鉴自[Mozilla 纪检分级][mozilla coc]。
+
+此行为标准常见问题请洽：[https://www.contributor-covenant.org/faq][faq]。
+另有诸译本：[https://www.contributor-covenant.org/translations][translations]。
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# NoneBot2 贡献指南
+
+首先，感谢你愿意为 NoneBot2 贡献自己的一份力量！
+
+本指南旨在引导你更规范地向 NoneBot2 提交贡献，请务必认真阅读。
+
+## 提交 Issue
+
+在提交 Issue 前，我们建议你先查看 [FAQ](https://github.com/nonebot/discussions/discussions/13) 与 [已有的 Issues](https://github.com/nonebot/nonebot2/issues)，以防重复提交。
+
+### 报告问题、故障与漏洞
+
+如果你在使用过程中发现问题并确信是由 NoneBot2 引起的，欢迎提交 Issue。
+
+### 建议功能
+
+为了让开发者更好地理解你的意图，请认真描述你所需要的特性，可能的话可以提出你认为可行的解决方案。
+
+## Pull Request
+
+NoneBot 使用 [uv](https://docs.astral.sh/uv/) 管理项目依赖，由于 pre-commit 也经其管理，所以在此一并说明。
+
+下面的命令能在已安装 uv 和 yarn 的情况下帮你快速配置开发环境。
+
+```bash
+# 安装 python 依赖
+uv sync --all-extras
+# 安装 pre-commit git hook
+uv run pre-commit install
+```
+
+### 使用 GitHub Codespaces（Dev Container）
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=289605524)
+
+### Commit 规范
+
+请确保你的每一个 commit 都能清晰地描述其意图，一个 commit 尽量只有一个意图。
+
+NoneBot 的 commit message 格式遵循 [gitmoji](https://gitmoji.dev/) 规范，在创建 commit 时请牢记这一点。
+
+或者使用 [nonemoji](https://github.com/nonebot/nonemoji) 代替 git 进行 commit，nonemoji 已默认作为项目开发依赖安装。
+
+```bash
+nonemoji commit [-e EMOJI] [-m MESSAGE] [-- ...]
+```
+
+### 工作流概述
+
+`master` 分支为 NoneBot 的开发分支，在任何情况下都请不要直接修改 `master` 分支，而是创建一个目标分支为 `nonebot:master` 的 Pull Request 来提交修改。Pull Request 标题请尽量更改成中文，以便自动生成更新日志。
+
+如果你不是 NoneBot 团队的成员，可在 fork 本仓库后，向本仓库的 `master` 分支发起 Pull Request，注意遵循先前提到的 commit message 规范创建 commit。我们将在 code review 通过后通过 squash merge 方式将您的贡献合并到主分支。
+
+### 撰写文档
+
+NoneBot2 的文档使用 [docusaurus](https://docusaurus.io/)，它有一些 [Markdown 特性](https://docusaurus.io/zh-CN/docs/markdown-features) 可能会帮助到你。
+
+如果你需要在本地预览修改后的文档，可以使用 yarn 安装文档依赖后启动 dev server，如下所示：
+
+```bash
+yarn install
+yarn start
+```
+
+NoneBot2 文档并没有具体的行文风格规范，但我们建议你尽量写得简单易懂。
+
+以下是比较重要的编写与排版规范。目前 NoneBot2 文档中仍有部分文档不完全遵守此规范，如果在阅读时发现欢迎提交 PR。
+
+1. 中文与英文、数字、半角符号之间需要有空格。例：`NoneBot2 是一个可扩展的 Python 异步机器人框架。`
+2. 若非英文整句，使用全角标点符号。例：`现在你可以看到机器人回复你：“Hello, World !”。`
+3. 直引号`「」`和弯引号`“”`都可接受，但同一份文件里应使用同种引号。
+4. **不要使用斜体**，你不需要一种与粗体不同的强调。除此之外，你也可以考虑使用 docusaurus 提供的[告示](https://docusaurus.io/zh-CN/docs/markdown-features/admonitions)功能。
+5. 文档中应以“我们”指代机器人开发者，以“机器人用户”指代机器人的使用者。
+
+以上由[社区创始人 richardchien 的中文排版规范](https://stdrc.cc/style-guides/chinese)补充修改得到。
+
+如果你需要编辑器检查 Markdown 规范，可以在 VSCode 中安装 markdownlint 扩展。
+
+### 参与开发
+
+NoneBot2 的代码风格遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/) 与 [PEP 484](https://www.python.org/dev/peps/pep-0484/) 规范，请确保你的代码风格和项目已有的代码保持一致，变量命名清晰，有适当的注释与测试代码。
+
+## 为社区做贡献
+
+你可以在 NoneBot 商店上架自己的适配器、插件、机器人，具体步骤可参考 [发布插件](https://nonebot.dev/docs/developer/plugin-publishing) 一节。
+
+我们仅对插件的兼容性进行简单测试，并会在下一个版本发布前对与该版本不兼容的插件作出处理。
+
+虽然对插件的内容没有严格限制，但我们还是建议在上架插件之前先查看商店有无功能一致的插件。如果你想要上架商店的插件功能与现有插件不完全重合，请在插件说明中补充其与现有插件的区别。
+
+同时，如果你参考或基于他人发行的代码进行开发，请注意遵守各代码所使用的开源许可协议。

README.md

@@ -1,12 +1,16 @@
+<!-- markdownlint-disable MD033 MD041 -->
 <p align="center">
-  <a href="https://v2.nonebot.dev/"><img src="https://raw.githubusercontent.com/nonebot/nonebot2/master/docs/.vuepress/public/logo.png" width="200" height="200" alt="nonebot"></a>
+  <a href="https://nonebot.dev/"><img src="https://nonebot.dev/logo.png" width="200" height="200" alt="nonebot"></a>
 </p>
 
 <div align="center">
 
 # NoneBot
 
-_✨ Python 异步机器人框架 ✨_
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable-next-line MD036 -->
+_✨ 跨平台 Python 异步机器人框架 ✨_
+<!-- prettier-ignore-end -->
 
 </div>
 
@@ -15,76 +19,165 @@ _✨ Python 异步机器人框架 ✨_
     <img src="https://img.shields.io/github/license/nonebot/nonebot2" alt="license">
   </a>
   <a href="https://pypi.python.org/pypi/nonebot2">
-    <img src="https://img.shields.io/pypi/v/nonebot2" alt="pypi">
+    <img src="https://img.shields.io/pypi/v/nonebot2?logo=python&logoColor=edb641" alt="pypi">
   </a>
-  <img src="https://img.shields.io/badge/python-3.7+-blue" alt="python"><br />
-  <a href="https://github.com/howmanybots/onebot/blob/master/README.md">
-    <img src="https://img.shields.io/badge/OneBot-v11-black?style=social&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABABAMAAABYR2ztAAAAIVBMVEUAAAAAAAADAwMHBwceHh4UFBQNDQ0ZGRkoKCgvLy8iIiLWSdWYAAAAAXRSTlMAQObYZgAAAQVJREFUSMftlM0RgjAQhV+0ATYK6i1Xb+iMd0qgBEqgBEuwBOxU2QDKsjvojQPvkJ/ZL5sXkgWrFirK4MibYUdE3OR2nEpuKz1/q8CdNxNQgthZCXYVLjyoDQftaKuniHHWRnPh2GCUetR2/9HsMAXyUT4/3UHwtQT2AggSCGKeSAsFnxBIOuAggdh3AKTL7pDuCyABcMb0aQP7aM4AnAbc/wHwA5D2wDHTTe56gIIOUA/4YYV2e1sg713PXdZJAuncdZMAGkAukU9OAn40O849+0ornPwT93rphWF0mgAbauUrEOthlX8Zu7P5A6kZyKCJy75hhw1Mgr9RAUvX7A3csGqZegEdniCx30c3agAAAABJRU5ErkJggg==" alt="cqhttp">
+  <img src="https://img.shields.io/badge/python-3.9+-blue?logo=python&logoColor=edb641" alt="python">
+  <a href="https://github.com/psf/black">
+    <img src="https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=edb641" alt="black">
   </a>
-  <a href="https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p">
-    <img src="https://img.shields.io/badge/%E9%92%89%E9%92%89-Bot-lightgrey?style=social&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD4jUzeAAAAM3RSTlMAQKSRaA+/f0YyFevh29R3cyklIfrlyrGsn41tVUs48c/HqJm9uZdhX1otGwkF9IN8V1CX0Q+IAAABY0lEQVRYw+3V2W7CMBAF0JuNQAhhX9OEfYdu9///rUVWpagE27Ef2gfO+0zGozsKnv6bMGzAhkNytIe5gDdzrwtTCwrbI8x4/NF668NAxgI3Q3UtFi3TyPwNQtPLUUmDd8YfqGLNe4v22XwEYb5zoOuF5baHq2UHtsKe5ivWfGAwrWu2mC34QM0PoCAuqZdOmiwV+5BLyMRtZ7dTSEcs48rzWfzwptMLyzpApka1SJ5FtR4kfCqNIBPEVDmqoqgwUYY5plQOlf6UEjNoOPnuKB6wzDyCrks///TDza8+PnR109WQdxLo8RKWq0PPnuXG0OXKQ6wWLFnCg75uYYbhmMIVVdQ709q33aHbGIj6Duz+2k1HQFX9VwqmY8xYsEJll2ahvhWgsjYLHFRXvIi2Qb0jzMQCzC3FAoydxCma88UCzE3JCWwkjCNYyMUCzHX4DiuTMawEwwhW6hnshPhjZzzJfAH0YacpbmRd7QAAAABJRU5ErkJggg==" alt="ding">
+  <a href="https://github.com/Microsoft/pyright">
+    <img src="https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641" alt="pyright">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="ruff">
+  </a>
+  <br />
+  <a href="https://codecov.io/gh/nonebot/nonebot2">
+    <img src="https://codecov.io/gh/nonebot/nonebot2/branch/master/graph/badge.svg?token=2P0G0VS7N4" alt="codecov"/>
+  </a>
+  <a href="https://github.com/nonebot/nonebot2/actions/workflows/website-deploy.yml">
+    <img src="https://github.com/nonebot/nonebot2/actions/workflows/website-deploy.yml/badge.svg?branch=master&event=push" alt="site"/>
+  </a>
+  <a href="https://results.pre-commit.ci/latest/github/nonebot/nonebot2/master">
+    <img src="https://results.pre-commit.ci/badge/github/nonebot/nonebot2/master.svg" alt="pre-commit" />
+  </a>
+  <a href="https://github.com/nonebot/nonebot2/actions/workflows/pyright.yml">
+    <img src="https://github.com/nonebot/nonebot2/actions/workflows/pyright.yml/badge.svg?branch=master&event=push" alt="pyright">
+  </a>
+  <a href="https://github.com/nonebot/nonebot2/actions/workflows/ruff.yml">
+    <img src="https://github.com/nonebot/nonebot2/actions/workflows/ruff.yml/badge.svg?branch=master&event=push" alt="ruff">
+  </a>
+  <br />
+  <a href="https://onebot.dev/">
+    <img src="https://img.shields.io/badge/OneBot-v11-black?style=social&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABABAMAAABYR2ztAAAAIVBMVEUAAAAAAAADAwMHBwceHh4UFBQNDQ0ZGRkoKCgvLy8iIiLWSdWYAAAAAXRSTlMAQObYZgAAAQVJREFUSMftlM0RgjAQhV+0ATYK6i1Xb+iMd0qgBEqgBEuwBOxU2QDKsjvojQPvkJ/ZL5sXkgWrFirK4MibYUdE3OR2nEpuKz1/q8CdNxNQgthZCXYVLjyoDQftaKuniHHWRnPh2GCUetR2/9HsMAXyUT4/3UHwtQT2AggSCGKeSAsFnxBIOuAggdh3AKTL7pDuCyABcMb0aQP7aM4AnAbc/wHwA5D2wDHTTe56gIIOUA/4YYV2e1sg713PXdZJAuncdZMAGkAukU9OAn40O849+0ornPwT93rphWF0mgAbauUrEOthlX8Zu7P5A6kZyKCJy75hhw1Mgr9RAUvX7A3csGqZegEdniCx30c3agAAAABJRU5ErkJggg==" alt="onebot">
+  </a>
+  <a href="https://onebot.dev/">
+    <img src="https://img.shields.io/badge/OneBot-v12-black?style=social&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABABAMAAABYR2ztAAAAIVBMVEUAAAAAAAADAwMHBwceHh4UFBQNDQ0ZGRkoKCgvLy8iIiLWSdWYAAAAAXRSTlMAQObYZgAAAQVJREFUSMftlM0RgjAQhV+0ATYK6i1Xb+iMd0qgBEqgBEuwBOxU2QDKsjvojQPvkJ/ZL5sXkgWrFirK4MibYUdE3OR2nEpuKz1/q8CdNxNQgthZCXYVLjyoDQftaKuniHHWRnPh2GCUetR2/9HsMAXyUT4/3UHwtQT2AggSCGKeSAsFnxBIOuAggdh3AKTL7pDuCyABcMb0aQP7aM4AnAbc/wHwA5D2wDHTTe56gIIOUA/4YYV2e1sg713PXdZJAuncdZMAGkAukU9OAn40O849+0ornPwT93rphWF0mgAbauUrEOthlX8Zu7P5A6kZyKCJy75hhw1Mgr9RAUvX7A3csGqZegEdniCx30c3agAAAABJRU5ErkJggg==" alt="onebot">
+  </a>
+  <a href="https://bot.q.qq.com/wiki/">
+    <img src="https://img.shields.io/badge/QQ-Bot-lightgrey?style=social&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMTIuODIgMTMwLjg5Ij48ZyBkYXRhLW5hbWU9IuWbvuWxgiAyIj48ZyBkYXRhLW5hbWU9IuWbvuWxgiAxIj48cGF0aCBkPSJNNTUuNjMgMTMwLjhjLTcgMC0xMy45LjA4LTIwLjg2IDAtMTkuMTUtLjI1LTMxLjcxLTExLjQtMzQuMjItMzAuMy00LjA3LTMwLjY2IDE0LjkzLTU5LjIgNDQuODMtNjYuNjQgMi0uNTEgNS4yMS0uMzEgNS4yMS0xLjYzIDAtMi4xMy4xNC0yLjEzLjE0LTUuNTcgMC0uODktMS4zLTEuNDYtMi4yMi0yLjMxLTYuNzMtNi4yMy03LjY3LTEzLjQxLTEtMjAuMTggNS40LTUuNTIgMTEuODctNS40IDE3LjgtLjU5IDYuNDkgNS4yNiA2LjMxIDEzLjA4LS44NiAyMS0uNjguNzQtMS43OCAxLjYtMS43OCAyLjY3djQuMjFjMCAxLjM1IDIuMiAxLjYyIDQuNzkgMi4zNSAzMS4wOSA4LjY1IDQ4LjE3IDM0LjEzIDQ1IDY2LjM3LTEuNzYgMTguMTUtMTQuNTYgMzAuMjMtMzIuNyAzMC42My04LjAyLjE5LTE2LjA3LS4wMS0yNC4xMy0uMDF6IiBmaWxsPSIjMDI5OWZlIi8+PHBhdGggZD0iTTMxLjQ2IDExOC4zOGMtMTAuNS0uNjktMTYuOC02Ljg2LTE4LjM4LTE3LjI3LTMtMTkuNDIgMi43OC0zNS44NiAxOC40Ni00Ny44MyAxNC4xNi0xMC44IDI5Ljg3LTEyIDQ1LjM4LTMuMTkgMTcuMjUgOS44NCAyNC41OSAyNS44MSAyNCA0NS4yOS0uNDkgMTUuOS04LjQyIDIzLjE0LTI0LjM4IDIzLjUtNi41OS4xNC0xMy4xOSAwLTE5Ljc5IDAiIGZpbGw9IiNmZWZlZmUiLz48cGF0aCBkPSJNNDYuMDUgNzkuNThjLjA5IDUgLjIzIDkuODItNyA5Ljc3LTcuODItLjA2LTYuMS01LjY5LTYuMjQtMTAuMTktLjE1LTQuODItLjczLTEwIDYuNzMtOS44NHM2LjM3IDUuNTUgNi41MSAxMC4yNnoiIGZpbGw9IiMxMDlmZmUiLz48cGF0aCBkPSJNODAuMjcgNzkuMjdjLS41MyAzLjkxIDEuNzUgOS42NC01Ljg4IDEwLTcuNDcuMzctNi44MS00LjgyLTYuNjEtOS41LjItNC4zMi0xLjgzLTEwIDUuNzgtMTAuNDJzNi41OSA0Ljg5IDYuNzEgOS45MnoiIGZpbGw9IiMwODljZmUiLz48L2c+PC9nPjwvc3ZnPg==" alt="QQ">
   </a>
   <a href="https://core.telegram.org/bots/api">
-    <img src="https://img.shields.io/badge/telegram-Bot-lightgrey?style=social&logo=telegram">
+    <img src="https://img.shields.io/badge/telegram-Bot-lightgrey?style=social&logo=telegram" alt="telegram">
+  </a>
+  <a href="https://open.feishu.cn/document/home/index">
+    <img src="https://img.shields.io/badge/%E9%A3%9E%E4%B9%A6-Bot-lightgrey?style=social&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48c3ZnIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDQ4IDQ4IiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPjxwYXRoIGQ9Ik0xNyAyOUMyMSAyOSAyNSAyNi45MzM5IDI4IDIzLjQwNjVDMzYgMTQgNDEuNDI0MiAxNi44MTY2IDQ0IDE3Ljk5OThDMzguNSAyMC45OTk4IDQwLjUgMjkuNjIzMyAzMyAzNS45OTk4QzI4LjM4MiAzOS45MjU5IDIzLjQ5NDUgNDEuMDE0IDE5IDQxQzEyLjUyMzEgNDAuOTc5OSA2Ljg2MjI2IDM3Ljc2MzcgNCAzNS40MDYzVjE2Ljk5OTgiIHN0cm9rZT0iIzMzMyIgc3Ryb2tlLXdpZHRoPSI0IiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiLz48cGF0aCBkPSJNNS42NDgwOCAxNS44NjY5QzUuMDIyMzEgMTQuOTU2NyAzLjc3NzE1IDE0LjcyNjEgMi44NjY5NCAxNS4zNTE5QzEuOTU2NzMgMTUuOTc3NyAxLjcyNjE1IDE3LjIyMjggMi4zNTE5MiAxOC4xMzMxTDUuNjQ4MDggMTUuODY2OVpNMzYuMDAyMSAzNS43MzA5QzM2Ljk1OCAzNS4xNzc0IDM3LjI4NDMgMzMuOTUzOSAzNi43MzA5IDMyLjk5NzlDMzYuMTc3NCAzMi4wNDIgMzQuOTUzOSAzMS43MTU3IDMzLjk5NzkgMzIuMjY5MUwzNi4wMDIxIDM1LjczMDlaTTIuMzUxOTIgMTguMTMzMUM1LjI0MzUgMjIuMzM5IDEwLjc5OTIgMjguMTQ0IDE2Ljg4NjUgMzIuMjIzOUMxOS45MzQ1IDM0LjI2NjcgMjMuMjE3IDM1Ljk0NiAyNi40NDkgMzYuNzMyNEMyOS42OTQ2IDM3LjUyMiAzMy4wNDUxIDM3LjQ0MjggMzYuMDAyMSAzNS43MzA5TDMzLjk5NzkgMzIuMjY5MUMzMi4yMDQ5IDMzLjMwNzIgMjkuOTkyOSAzMy40NzggMjcuMzk0NyAzMi44NDU4QzI0Ljc4MyAzMi4yMTAzIDIxLjk0MDUgMzAuNzk1OCAxOS4xMTM1IDI4LjkwMTFDMTMuNDUwOCAyNS4xMDYgOC4yNTY1IDE5LjY2MSA1LjY0ODA4IDE1Ljg2NjlMMi4zNTE5MiAxOC4xMzMxWiIgZmlsbD0iIzMzMyIvPjxwYXRoIGQ9Ik0zMy41OTQ1IDE3QzMyLjgzOTggMTQuNzAyNyAzMC44NTQ5IDkuOTQwNTQgMjcuNTk0NSA3SDExLjU5NDVDMTUuMjE3MSAxMC42NzU3IDIzIDE2IDI3IDI0IiBzdHJva2U9IiMzMzMiIHN0cm9rZS13aWR0aD0iNCIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIi8+PC9zdmc+" alt="feishu">
+  </a>
+  <a href="https://docs.github.com/en/developers/apps">
+    <img src="https://img.shields.io/badge/GitHub-Bot-181717?style=social&logo=github" alt="github"/>
+  </a>
+  <!-- <a href="https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p">
+    <img src="https://img.shields.io/badge/%E9%92%89%E9%92%89-Bot-lightgrey?style=social&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD4jUzeAAAAM3RSTlMAQKSRaA+/f0YyFevh29R3cyklIfrlyrGsn41tVUs48c/HqJm9uZdhX1otGwkF9IN8V1CX0Q+IAAABY0lEQVRYw+3V2W7CMBAF0JuNQAhhX9OEfYdu9///rUVWpagE27Ef2gfO+0zGozsKnv6bMGzAhkNytIe5gDdzrwtTCwrbI8x4/NF668NAxgI3Q3UtFi3TyPwNQtPLUUmDd8YfqGLNe4v22XwEYb5zoOuF5baHq2UHtsKe5ivWfGAwrWu2mC34QM0PoCAuqZdOmiwV+5BLyMRtZ7dTSEcs48rzWfzwptMLyzpApka1SJ5FtR4kfCqNIBPEVDmqoqgwUYY5plQOlf6UEjNoOPnuKB6wzDyCrks///TDza8+PnR109WQdxLo8RKWq0PPnuXG0OXKQ6wWLFnCg75uYYbhmMIVVdQ709q33aHbGIj6Duz+2k1HQFX9VwqmY8xYsEJll2ahvhWgsjYLHFRXvIi2Qb0jzMQCzC3FAoydxCma88UCzE3JCWwkjCNYyMUCzHX4DiuTMawEwwhW6hnshPhjZzzJfAH0YacpbmRd7QAAAABJRU5ErkJggg==" alt="dingtalk"> -->
   </a>
   <br />
   <a href="https://jq.qq.com/?_wv=1027&k=5OFifDh">
-    <img src="https://img.shields.io/badge/qq%E7%BE%A4-768887710-orange?style=flat-square" alt="QQ Chat">
+    <img src="https://img.shields.io/badge/QQ%E7%BE%A4-768887710-orange?style=flat-square" alt="QQ Chat Group">
   </a>
-  <a href="https://t.me/cqhttp">
-    <img src="https://img.shields.io/badge/telegram-chat-blue?style=flat-square" alt="Telegram Chat">
+  <a href="https://qun.qq.com/qqweb/qunpro/share?_wv=3&_wwv=128&appChannel=share&inviteCode=7b4a3&appChannel=share&businessType=9&from=246610&biz=ka">
+    <img src="https://img.shields.io/badge/QQ%E9%A2%91%E9%81%93-NoneBot-5492ff?style=flat-square" alt="QQ Channel">
   </a>
-  <a href="https://jq.qq.com/?_wv=1027&k=5Nl0zhE">
-    <img src="https://img.shields.io/badge/%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E7%BE%A4-218529254-green?style=flat-square" alt="QQ Release">
+  <a href="https://t.me/botuniverse">
+    <img src="https://img.shields.io/badge/telegram-botuniverse-blue?style=flat-square" alt="Telegram Channel">
   </a>
-  <a href="https://t.me/cqhttp_release">
-    <img src="https://img.shields.io/badge/%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E9%A2%91%E9%81%93-join-green?style=flat-square" alt="Telegram Release">
+  <a href="https://discord.gg/VKtE6Gdc4h">
+    <img src="https://discordapp.com/api/guilds/847819937858584596/widget.png?style=shield" alt="Discord Server">
   </a>
 </p>
 
 <p align="center">
-  <a href="https://v2.nonebot.dev/">文档</a>
+  <a href="https://nonebot.dev/">文档</a>
   ·
-  <a href="https://v2.nonebot.dev/guide/installation.html">安装</a>
-  ·
-  <a href="https://v2.nonebot.dev/guide/getting-started.html">开始使用</a>
+  <a href="https://nonebot.dev/docs/quick-start">快速上手</a>
   ·
   <a href="#插件">文档打不开？</a>
 </p>
 
+<p align="center">
+  <a href="https://asciinema.org/a/569440">
+    <img src="https://nonebot.dev/img/setup.svg" alt="setup" >
+  </a>
+</p>
+
 ## 简介
 
-NoneBot2 是一个可扩展的 Python 异步机器人框架，它会对机器人收到的事件进行解析和处理，并以插件化的形式，按优先级分发给事件所对应的事件响应器，来完成具体的功能。
-
-除了起到解析事件的作用，NoneBot 还为插件提供了大量实用的预设操作和权限控制机制。对于命令处理，它更是提供了完善且易用的会话机制和内部调用机制，以分别适应命令的连续交互和插件内部功能复用等需求。
-
-得益于 Python 的 [asyncio](https://docs.python.org/3/library/asyncio.html) 机制，NoneBot 处理事件的吞吐量有了很大的保障，再配合 WebSocket 通信方式（也是最建议的通信方式），NoneBot 的性能可以达到 HTTP 通信方式的两倍以上，相较于传统同步 I/O 的 HTTP 通信，更是有质的飞跃。
+NoneBot2 是一个现代、跨平台、可扩展的 Python 聊天机器人框架，它基于 Python 的类型注解和异步特性，能够为你的需求实现提供便捷灵活的支持。
 
 ## 特色
 
-NoneBot2 的驱动框架 `Driver` 以及通信协议 `Adapter` 均可**自定义**，并且可以作为插件进行**替换/添加**！
+- 异步优先：基于 Python 的异步特性，即使是~~非常~~大量的消息，也能吞吐自如
+- 易于开发：配合 NB-CLI 脚手架，代码编写上手简单，没有过多的冗余代码，可以让开发者专注于业务逻辑
+- 生而可靠：100% 类型注解覆盖，配合编辑器的类型推导功能，能将绝大多数的 Bug 杜绝在编辑器中 ([编辑器支持](https://nonebot.dev/docs/editor-support))
+- 社区丰富：社区用户众多，直接和间接用户超过十万人，每天都有大量的活跃用户 ([社区资源](#社区资源))
+- 海纳百川：一个框架，支持多个聊天软件平台，可自定义通信协议
 
-目前 NoneBot2 内置的驱动框架：
+  |                                                       协议名称                                                        | 状态 |                                   注释                                    |
+  | :-------------------------------------------------------------------------------------------------------------------: | :--: | :-----------------------------------------------------------------------: |
+  |               OneBot（[仓库](https://github.com/nonebot/adapter-onebot)，[协议](https://onebot.dev/)）                |  ✅  | 支持 QQ、TG、微信公众号、KOOK 等[平台](https://onebot.dev/ecosystem.html) |
+  |      Telegram（[仓库](https://github.com/nonebot/adapter-telegram)，[协议](https://core.telegram.org/bots/api)）      |  ✅  |                                                                           |
+  |     飞书（[仓库](https://github.com/nonebot/adapter-feishu)，[协议](https://open.feishu.cn/document/home/index)）     |  ✅  |                                                                           |
+  |         GitHub（[仓库](https://github.com/nonebot/adapter-github)，[协议](https://docs.github.com/en/apps)）          |  ✅  |                          GitHub APP & OAuth APP                           |
+  |                QQ（[仓库](https://github.com/nonebot/adapter-qq)，[协议](https://bot.q.qq.com/wiki/)）                |  ✅  |                            QQ 官方接口调整较多                            |
+  |                             Console（[仓库](https://github.com/nonebot/adapter-console)）                             |  ✅  |                                控制台交互                                 |
+  |     Red（[仓库](https://github.com/nonebot/adapter-red)，[协议](https://chrononeko.github.io/QQNTRedProtocol/)）      |  ✅  |                                 QQNT 协议                                  |
+  |           Satori（[仓库](https://github.com/nonebot/adapter-satori)，[协议](https://satori.js.org/zh-CN)）            |  ✅  |               支持 Onebot、TG、飞书、微信公众号、Koishi 等                |
+  |   Discord（[仓库](https://github.com/nonebot/adapter-discord)，[协议](https://discord.com/developers/docs/intro)）    |  ✅  |                             Discord Bot 协议                              |
+  |               DoDo（[仓库](https://github.com/nonebot/adapter-dodo)，[协议](https://open.imdodo.com/)）               |  ✅  |                               DoDo Bot 协议                               |
+  |        Kritor（[仓库](https://github.com/nonebot/adapter-kritor)，[协议](https://github.com/KarinJS/kritor)）         |  ✅  |                Kritor (OnebotX) 协议，QQNT 机器人接口标准                  |
+  |    Mirai（[仓库](https://github.com/nonebot/adapter-mirai)，[协议](https://docs.mirai.mamoe.net/mirai-api-http/)）    |  ✅  |                                  QQ 协议                                  |
+  |    Milky（[仓库](https://github.com/nonebot/adapter-milky)，[协议](https://milky.ntqqrev.org/)）                      |  ✅  |                           QQNT 机器人应用接口标准                          |
+  |         钉钉（[仓库](https://github.com/nonebot/adapter-ding)，[协议](https://open.dingtalk.com/document/)）          |  🤗  |                        寻找 Maintainer（暂不可用）                        |
+  |     开黑啦（[仓库](https://github.com/Tian-que/nonebot-adapter-kaiheila)，[协议](https://developer.kookapp.cn/)）     |  ↗️  |                                由社区贡献                                 |
+  |                          Ntchat（[仓库](https://github.com/JustUndertaker/adapter-ntchat)）                           |  ↗️  |                           微信协议，由社区贡献                            |
+  |                      MineCraft（[仓库](https://github.com/17TheWord/nonebot-adapter-minecraft)）                      |  ↗️  |                                由社区贡献                                 |
+  |                       Walle-Q（[仓库](https://github.com/onebot-walle/nonebot_adapter_walleq)）                       |  ↗️  |                            QQ 协议，由社区贡献                            |
+  |                       Villa（[仓库](https://github.com/CMHopeSunshine/nonebot-adapter-villa)）                        |  ❌  |                     米游社大别野 Bot 协议，官方已下线                     |
+  | Rocket.Chat（[仓库](https://github.com/IUnlimit/nonebot-adapter-rocketchat)，[协议](https://developer.rocket.chat/)） |  ↗️  |                     Rocket.Chat Bot 协议，由社区贡献                      |
+  |     Tailchat（[仓库](https://github.com/eya46/nonebot-adapter-tailchat)，[协议](https://tailchat.msgbyte.com/)）      |  ↗️  |                  Tailchat 开放平台 Bot 协议，由社区贡献                   |
+  |                             Mail（[仓库](https://github.com/mobyw/nonebot-adapter-mail)）                             |  ↗️  |                         邮件收发协议，由社区贡献                          |
+  |     黑盒语音（[仓库](https://github.com/lclbm/adapter-heybox)，[协议](https://github.com/QingFengOpen/HeychatDoc)）     |  ↗️  |                       黑盒语音机器人协议，由社区贡献                             |
+  | 微信公众平台（[仓库](https://github.com/YangRucheng/nonebot-adapter-wxmp)，[协议](https://developers.weixin.qq.com/doc/)）|  ↗️  |                       微信公众平台协议，由社区贡献                             |
+  | Gewechat（[仓库](https://github.com/Shine-Light/nonebot-adapter-gewechat)，[协议](https://github.com/Devo919/Gewechat)）|  ❌  |                      Gewechat 微信协议，Gewechat不再维护及可用                            |
+  |  EFChat（[仓库](https://github.com/molanp/nonebot_adapter_efchat)，[协议](https://irinu-live.melon.fish/efc-help/)）   |  ↗️  |                            恒五聊平台协议，由社区贡献                          |
+  |  VoceChat （[仓库](https://github.com/5656565566/nonebot-adapter-vocechat)，[协议](https://doc.voce.chat/zh-cn/bot/bot-and-webhook)）   |  ↗️  |                            VoceChat 平台协议，由社区贡献                          |
+  |  B站直播间（[仓库](https://github.com/MingxuanGame/nonebot-adapter-bilibili-live)，[Web API 协议](https://github.com/SocialSisterYi/bilibili-API-collect/blob/master/docs/live)，[开放平台协议](https://open-live.bilibili.com/document)）   |  ↗️  |                            B站直播间（Web API/开放平台）协议，由社区贡献                          |
 
-- [FastAPI](https://fastapi.tiangolo.com/)
+- 坚实后盾：支持多种 web 框架，可自定义替换、组合
 
-目前 NoneBot2 内置的协议适配：
+  |                              驱动框架                               |  类型  |
+  | :-----------------------------------------------------------------: | :----: |
+  |              [FastAPI](https://fastapi.tiangolo.com/)               | 服务端 |
+  | [Quart](https://quart.palletsprojects.com/en/latest/)（异步 Flask） | 服务端 |
+  |           [aiohttp](https://docs.aiohttp.org/en/stable/)            | 客户端 |
+  |               [httpx](https://www.python-httpx.org/)                | 客户端 |
+  |     [websockets](https://websockets.readthedocs.io/en/stable/)      | 客户端 |
 
-- [OneBot(CQHTTP) 协议](https://github.com/howmanybots/onebot/blob/master/README.md) (QQ 等)
-- [钉钉](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p) _开发中_
-- [Telegram](https://core.telegram.org/bots/api) _计划中_
+更多：[概览](https://nonebot.dev/docs/)
+
+## 什么不是 NoneBot2
+
+NoneBot2 不是某个平台或者协议的具体实现，它只负责和已有协议适配器通信，并处理接收到的事件。所以，“NoneBot 有 blabla 平台的 blabla 功能吗？”这种问题是与 NoneBot2 无关的。请在相应平台的功能文档中确认，或与相应平台的协议适配开发者联系。
+
+NoneBot2 不是 NoneBot1 的替代品。事实上，它们都在被积极的维护着。但是，如果你想尝试一些新功能，或者想要支持更多的平台，可以考虑使用 NoneBot2。
+
+> ~~NoneBot2 和 NoneBot1 的区别，就像是 VisualStudio Code 和 VisualStudio 一样~~
 
 ## 即刻开始
 
-~~完整~~文档可以在 [这里](https://v2.nonebot.dev/) 查看。
+~~完整~~文档可以在 [这里](https://nonebot.dev/) 查看。
 
-懒得看文档？下面是快速安装指南：~~这是坏文明~~
+懒得看文档？下面是快速安装指南：
 
-1. (可选)使用你喜欢的 Python 环境管理工具创建新的虚拟环境。
-2. 使用 `pip` (或其他) 安装 NoneBot 脚手架。
+1. 安装 [pipx](https://pypa.github.io/pipx/)
 
    ```bash
-   pip install nb-cli
+   python -m pip install --user pipx
+   python -m pipx ensurepath
+   ```
+
+2. 安装脚手架
+
+   ```bash
+   pipx install nb-cli
    ```
 
 3. 使用脚手架创建项目
@@ -93,20 +186,114 @@ NoneBot2 的驱动框架 `Driver` 以及通信协议 `Adapter` 均可**自定义
    nb create
    ```
 
-## 插件
+4. 运行项目
+
+   ```bash
+   nb run
+   ```
+
+## 社区资源
+
+### 常见问题
+
+- [常见问题解答(FAQ)](https://faq.nonebot.dev/)
+- [论坛(Discussion)](https://discussions.nonebot.dev/)
+
+### 教程/实际项目/经验分享
+
+- [awesome-nonebot](https://github.com/nonebot/awesome-nonebot)
+
+### 插件
 
 此外，NoneBot2 还有丰富的官方以及第三方现成的插件供大家使用：
 
-- [NoneBot-Plugin-Docs](https://github.com/nonebot/nonebot2/tree/master/packages/nonebot-plugin-docs)：离线文档至本地使用(别再说文档打不开了！)
+- [NoneBot-Plugin-Docs](https://github.com/nonebot/nonebot2/tree/master/packages/nonebot-plugin-docs)：离线文档至本地项目使用 (别再说文档打不开了！)
+
+  在项目目录下执行：
 
   ```bash
   nb plugin install nonebot_plugin_docs
   ```
 
-- 其他插件请查看 [插件商店](https://v2.nonebot.dev/plugin-store.html)
+  或者尝试以下镜像：
+
+  - [文档镜像(中国境内)](https://nb2.baka.icu)
+
+- 其他插件请查看 [商店](https://nonebot.dev/store/plugins)
+
+## 许可证
+
+`NoneBot` 采用 `MIT` 许可证进行开源
+
+```text
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
 
 ## 贡献
 
-如果你在使用过程中发现任何问题，可以 [提交 issue](https://github.com/nonebot/nonebot2/issues/new) 或自行 fork 修改后提交 pull request。
+请参考 [贡献指南](./CONTRIBUTING.md)
 
-如果你要提交 pull request，请确保你的代码风格和项目已有的代码保持一致，遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/)，变量命名清晰，有适当的注释。
+## 鸣谢
+
+### 赞助者
+
+感谢以下产品对 NoneBot 项目提供的赞助：
+
+<p align="center">
+  <a href="https://github.com/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://assets.nonebot.dev/github-dark.png">
+      <img src="https://assets.nonebot.dev/github-light.png" height="50" alt="GitHub">
+    </picture>
+  </a>&nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://www.netlify.com/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://assets.nonebot.dev/netlify-dark.svg">
+      <img src="https://assets.nonebot.dev/netlify-light.svg" height="50" alt="netlify">
+    </picture>
+  </a>&nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://sentry.io/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://assets.nonebot.dev/sentry-dark.svg">
+      <img src="https://assets.nonebot.dev/sentry-light.svg" height="50" alt="sentry">
+    </picture>
+  </a>
+</p>
+<p align="center">
+  <a href="https://www.docker.com/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://assets.nonebot.dev/docker-dark.svg">
+      <img src="https://assets.nonebot.dev/docker-light.svg" height="50" alt="docker">
+    </picture>
+  </a>&nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://www.algolia.com/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://assets.nonebot.dev/algolia-dark.svg">
+      <img src="https://assets.nonebot.dev/algolia-light.svg" height="50" alt="algolia">
+    </picture>
+  </a>
+</p>
+<p align="center">
+  <a href="https://www.jetbrains.com/">
+    <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg" height="80" alt="JetBrains" >
+  </a>
+</p>
+
+感谢以下赞助者对 NoneBot 项目提供的资金支持：
+
+<a href="https://assets.nonebot.dev/sponsors.svg">
+  <img src="https://assets.nonebot.dev/sponsors.svg" alt="sponsors" />
+</a>
+
+### 开发者
+
+感谢以下开发者对 NoneBot2 作出的贡献：
+
+<a href="https://github.com/nonebot/nonebot2/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=nonebot/nonebot2&max=1000" alt="contributors" />
+</a>

archive/2.0.0a7/README.md

@@ -1,15 +0,0 @@
----
-home: true
-heroImage: /logo.png
-tagline: An asynchronous QQ bot framework.
-actionText: 开始使用
-actionLink: guide/
-features:
-  - title: 简洁
-    details: 提供极其简洁易懂的 API，使你可以毫无压力地开始验证你的绝佳创意，只需编写最少量的代码，即可实现丰富的功能。
-  - title: 易于扩展
-    details: 精心设计的消息处理流程使得你可以很方便地将原型扩充为具有大量实用功能的完整聊天机器人，并持续保证扩展性。
-  - title: 高性能
-    details: 采用异步 I/O，利用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多账号同时接入，减少业务宕机的可能。
-footer: MIT Licensed | Copyright © 2018 - 2020 NoneBot Team
----

archive/2.0.0a7/advanced/README.md

@@ -1,7 +0,0 @@
-# 深入
-
-## 它如何工作？
-
-<!-- TODO: how to work -->
-
-~~未填坑~~

archive/2.0.0a7/advanced/export-and-require.md

@@ -1 +0,0 @@
-# 跨插件访问

archive/2.0.0a7/advanced/permission.md

@@ -1 +0,0 @@
-# 权限控制

archive/2.0.0a7/advanced/publish-plugin.md

@@ -1 +0,0 @@
-# 发布插件

archive/2.0.0a7/advanced/runtime-hook.md

@@ -1 +0,0 @@
-# 运行时插槽

archive/2.0.0a7/advanced/scheduler.md

@@ -1 +0,0 @@
-# 定时任务

archive/2.0.0a7/api/README.md

@@ -1,52 +0,0 @@
-# NoneBot Api Reference
-
-
-* **模块索引**
-
-    
-    * [nonebot](nonebot.html)
-
-
-    * [nonebot.config](config.html)
-
-
-    * [nonebot.plugin](plugin.html)
-
-
-    * [nonebot.message](message.html)
-
-
-    * [nonebot.matcher](matcher.html)
-
-
-    * [nonebot.rule](rule.html)
-
-
-    * [nonebot.permission](permission.html)
-
-
-    * [nonebot.log](log.html)
-
-
-    * [nonebot.utils](utils.html)
-
-
-    * [nonebot.typing](typing.html)
-
-
-    * [nonebot.exception](exception.html)
-
-
-    * [nonebot.drivers](drivers/)
-
-
-    * [nonebot.drivers.fastapi](drivers/fastapi.html)
-
-
-    * [nonebot.adapters](adapters/)
-
-
-    * [nonebot.adapters.cqhttp](adapters/cqhttp.html)
-
-
-    * [nonebot.adapters.ding](adapters/ding.html)

archive/2.0.0a7/api/adapters/README.md

@@ -1,362 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.adapters 模块
-
-## 协议适配基类
-
-各协议请继承以下基类，并使用 `driver.register_adapter` 注册适配器
-
-
-## _class_ `BaseBot`
-
-基类：`abc.ABC`
-
-Bot 基类。用于处理上报消息，并提供 API 调用接口。
-
-
-### _abstract_ `__init__(driver, connection_type, config, self_id, *, websocket=None)`
-
-
-* **参数**
-
-    
-    * `driver: Driver`: Driver 对象
-
-
-    * `connection_type: str`: http 或者 websocket
-
-
-    * `config: Config`: Config 对象
-
-
-    * `self_id: str`: 机器人 ID
-
-
-    * `websocket: Optional[WebSocket]`: Websocket 连接对象
-
-
-
-### `driver`
-
-Driver 对象
-
-
-### `connection_type`
-
-连接类型
-
-
-### `config`
-
-Config 配置对象
-
-
-### `self_id`
-
-机器人 ID
-
-
-### `websocket`
-
-Websocket 连接对象
-
-
-### _abstract property_ `type`
-
-Adapter 类型
-
-
-### _abstract async classmethod_ `check_permission(driver, connection_type, headers, body)`
-
-
-* **说明**
-
-    检查连接请求是否合法的函数，如果合法则返回当前连接 `唯一标识符`，通常为机器人 ID；如果不合法则抛出 `RequestDenied` 异常。
-
-
-
-* **参数**
-
-    
-    * `driver: Driver`: Driver 对象
-
-
-    * `connection_type: str`: 连接类型
-
-
-    * `headers: dict`: 请求头
-
-
-    * `body: Optional[dict]`: 请求数据，WebSocket 连接该部分为空
-
-
-
-* **返回**
-
-    
-    * `str`: 连接唯一标识符
-
-
-
-* **异常**
-
-    
-    * `RequestDenied`: 请求非法
-
-
-
-### _abstract async_ `handle_message(message)`
-
-
-* **说明**
-
-    处理上报消息的函数，转换为 `Event` 事件后调用 `nonebot.message.handle_event` 进一步处理事件。
-
-
-
-* **参数**
-
-    
-    * `message: dict`: 收到的上报消息
-
-
-
-### _abstract async_ `call_api(api, **data)`
-
-
-* **说明**
-
-    调用机器人 API 接口，可以通过该函数或直接通过 bot 属性进行调用
-
-
-
-* **参数**
-
-    
-    * `api: str`: API 名称
-
-
-    * `**data`: API 数据
-
-
-
-* **示例**
-
-
-```python
-await bot.call_api("send_msg", message="hello world"})
-await bot.send_msg(message="hello world")
-```
-
-
-### _abstract async_ `send(event, message, **kwargs)`
-
-
-* **说明**
-
-    调用机器人基础发送消息接口
-
-
-
-* **参数**
-
-    
-    * `event: Event`: 上报事件
-
-
-    * `message: Union[str, Message, MessageSegment]`: 要发送的消息
-
-
-    * `**kwargs`
-
-
-
-## _class_ `BaseEvent`
-
-基类：`abc.ABC`, `typing.Generic`
-
-Event 基类。提供上报信息的关键信息，其余信息可从原始上报消息获取。
-
-
-### `__init__(raw_event)`
-
-
-* **参数**
-
-    
-    * `raw_event: Union[dict, T]`: 原始上报消息
-
-
-
-### _property_ `raw_event`
-
-原始上报消息
-
-
-### _abstract property_ `id`
-
-事件 ID
-
-
-### _abstract property_ `name`
-
-事件名称
-
-
-### _abstract property_ `self_id`
-
-机器人 ID
-
-
-### _abstract property_ `time`
-
-事件发生时间
-
-
-### _abstract property_ `type`
-
-事件主类型
-
-
-### _abstract property_ `detail_type`
-
-事件详细类型
-
-
-### _abstract property_ `sub_type`
-
-事件子类型
-
-
-### _abstract property_ `user_id`
-
-触发事件的主体 ID
-
-
-### _abstract property_ `group_id`
-
-触发事件的主体群 ID
-
-
-### _abstract property_ `to_me`
-
-事件是否为发送给机器人的消息
-
-
-### _abstract property_ `message`
-
-消息内容
-
-
-### _abstract property_ `reply`
-
-回复的消息
-
-
-### _abstract property_ `raw_message`
-
-原始消息
-
-
-### _abstract property_ `plain_text`
-
-纯文本消息
-
-
-### _abstract property_ `sender`
-
-消息发送者信息
-
-
-## _class_ `BaseMessageSegment`
-
-基类：`abc.ABC`
-
-消息段基类
-
-
-### `type`
-
-
-* 类型: `str`
-
-
-* 说明: 消息段类型
-
-
-### `data`
-
-
-* 类型: `Dict[str, Union[str, list]]`
-
-
-* 说明: 消息段数据
-
-
-## _class_ `BaseMessage`
-
-基类：`list`, `abc.ABC`
-
-消息数组
-
-
-### `__init__(message=None, *args, **kwargs)`
-
-
-* **参数**
-
-    
-    * `message: Union[str, dict, list, BaseModel, MessageSegment, Message]`: 消息内容
-
-
-
-### `append(obj)`
-
-
-* **说明**
-
-    添加一个消息段到消息数组末尾
-
-
-
-* **参数**
-
-    
-    * `obj: Union[str, MessageSegment]`: 要添加的消息段
-
-
-
-### `extend(obj)`
-
-
-* **说明**
-
-    拼接一个消息数组或多个消息段到消息数组末尾
-
-
-
-* **参数**
-
-    
-    * `obj: Union[Message, Iterable[MessageSegment]]`: 要添加的消息数组
-
-
-
-### `reduce()`
-
-
-* **说明**
-
-    缩减消息数组，即按 MessageSegment 的实现拼接相邻消息段
-
-
-
-### `extract_plain_text()`
-
-
-* **说明**
-
-    提取消息内纯文本消息

archive/2.0.0a7/api/adapters/cqhttp.md

@@ -1,442 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.adapters.cqhttp 模块
-
-
-## `escape(s, *, escape_comma=True)`
-
-
-* **说明**
-
-    对字符串进行 CQ 码转义。
-
-
-
-* **参数**
-
-    
-    * `s: str`: 需要转义的字符串
-
-
-    * `escape_comma: bool`: 是否转义逗号（`,`）。
-
-
-
-## `unescape(s)`
-
-
-* **说明**
-
-    对字符串进行 CQ 码去转义。
-
-
-
-* **参数**
-
-    
-    * `s: str`: 需要转义的字符串
-
-
-
-## _exception_ `CQHTTPAdapterException`
-
-基类：[`nonebot.exception.AdapterException`](../exception.md#nonebot.exception.AdapterException)
-
-
-## _exception_ `ActionFailed`
-
-基类：[`nonebot.exception.ActionFailed`](../exception.md#nonebot.exception.ActionFailed), `nonebot.adapters.cqhttp.exception.CQHTTPAdapterException`
-
-
-* **说明**
-
-    API 请求返回错误信息。
-
-
-
-* **参数**
-
-    
-    * `retcode: Optional[int]`: 错误码
-
-
-
-## _exception_ `NetworkError`
-
-基类：[`nonebot.exception.NetworkError`](../exception.md#nonebot.exception.NetworkError), `nonebot.adapters.cqhttp.exception.CQHTTPAdapterException`
-
-
-* **说明**
-
-    网络错误。
-
-
-
-* **参数**
-
-    
-    * `retcode: Optional[int]`: 错误码
-
-
-
-## _exception_ `ApiNotAvailable`
-
-基类：[`nonebot.exception.ApiNotAvailable`](../exception.md#nonebot.exception.ApiNotAvailable), `nonebot.adapters.cqhttp.exception.CQHTTPAdapterException`
-
-
-## _async_ `_check_reply(bot, event)`
-
-
-* **说明**
-
-    检查消息中存在的回复，去除并赋值 `event.reply`, `event.to_me`
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-
-## `_check_at_me(bot, event)`
-
-
-* **说明**
-
-    检查消息开头或结尾是否存在 @机器人，去除并赋值 `event.to_me`
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-
-## `_check_nickname(bot, event)`
-
-
-* **说明**
-
-    检查消息开头是否存在，去除并赋值 `event.to_me`
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-
-## `_handle_api_result(result)`
-
-
-* **说明**
-
-    处理 API 请求返回值。
-
-
-
-* **参数**
-
-    
-    * `result: Optional[Dict[str, Any]]`: API 返回数据
-
-
-
-* **返回**
-
-    
-    * `Any`: API 调用返回数据
-
-
-
-* **异常**
-
-    
-    * `ActionFailed`: API 调用失败
-
-
-
-## _class_ `Bot`
-
-基类：[`nonebot.adapters.BaseBot`](README.md#nonebot.adapters.BaseBot)
-
-CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
-
-
-### _property_ `type`
-
-
-* 返回: `"cqhttp"`
-
-
-### _async classmethod_ `check_permission(driver, connection_type, headers, body)`
-
-
-* **说明**
-
-    CQHTTP (OneBot) 协议鉴权。参考 [鉴权](https://github.com/howmanybots/onebot/blob/master/v11/specs/communication/authorization.md)
-
-
-
-### _async_ `handle_message(message)`
-
-
-* **说明**
-
-    调用 [_check_reply](#async-check-reply-bot-event), [_check_at_me](#check-at-me-bot-event), [_check_nickname](#check-nickname-bot-event) 处理事件并转换为 [Event](#class-event)
-
-
-
-### _async_ `call_api(api, **data)`
-
-
-* **说明**
-
-    调用 CQHTTP 协议 API
-
-
-
-* **参数**
-
-    
-    * `api: str`: API 名称
-
-
-    * `**data: Any`: API 参数
-
-
-
-* **返回**
-
-    
-    * `Any`: API 调用返回数据
-
-
-
-* **异常**
-
-    
-    * `NetworkError`: 网络错误
-
-
-    * `ActionFailed`: API 调用失败
-
-
-
-### _async_ `send(event, message, at_sender=False, **kwargs)`
-
-
-* **说明**
-
-    根据 `event`  向触发事件的主体发送消息。
-
-
-
-* **参数**
-
-    
-    * `event: Event`: Event 对象
-
-
-    * `message: Union[str, Message, MessageSegment]`: 要发送的消息
-
-
-    * `at_sender: bool`: 是否 @ 事件主体
-
-
-    * `**kwargs`: 覆盖默认参数
-
-
-
-* **返回**
-
-    
-    * `Any`: API 调用返回数据
-
-
-
-* **异常**
-
-    
-    * `ValueError`: 缺少 `user_id`, `group_id`
-
-
-    * `NetworkError`: 网络错误
-
-
-    * `ActionFailed`: API 调用失败
-
-
-
-## _class_ `Event`
-
-基类：[`nonebot.adapters.BaseEvent`](README.md#nonebot.adapters.BaseEvent)
-
-CQHTTP 协议 Event 适配。继承属性参考 [BaseEvent](./#class-baseevent) 。
-
-
-### _property_ `id`
-
-
-* 类型: `Optional[int]`
-
-
-* 说明: 事件/消息 ID
-
-
-### _property_ `name`
-
-
-* 类型: `str`
-
-
-* 说明: 事件名称，由类型与 `.` 组合而成
-
-
-### _property_ `self_id`
-
-
-* 类型: `str`
-
-
-* 说明: 机器人自身 ID
-
-
-### _property_ `time`
-
-
-* 类型: `int`
-
-
-* 说明: 事件发生时间
-
-
-### _property_ `type`
-
-
-* 类型: `str`
-
-
-* 说明: 事件类型
-
-
-### _property_ `detail_type`
-
-
-* 类型: `str`
-
-
-* 说明: 事件详细类型
-
-
-### _property_ `sub_type`
-
-
-* 类型: `Optional[str]`
-
-
-* 说明: 事件子类型
-
-
-### _property_ `user_id`
-
-
-* 类型: `Optional[int]`
-
-
-* 说明: 事件主体 ID
-
-
-### _property_ `group_id`
-
-
-* 类型: `Optional[int]`
-
-
-* 说明: 事件主体群 ID
-
-
-### _property_ `to_me`
-
-
-* 类型: `Optional[bool]`
-
-
-* 说明: 消息是否与机器人相关
-
-
-### _property_ `message`
-
-
-* 类型: `Optional[Message]`
-
-
-* 说明: 消息内容
-
-
-### _property_ `reply`
-
-
-* 类型: `Optional[dict]`
-
-
-* 说明: 回复消息详情
-
-
-### _property_ `raw_message`
-
-
-* 类型: `Optional[str]`
-
-
-* 说明: 原始消息
-
-
-### _property_ `plain_text`
-
-
-* 类型: `Optional[str]`
-
-
-* 说明: 纯文本消息内容
-
-
-### _property_ `sender`
-
-
-* 类型: `Optional[dict]`
-
-
-* 说明: 消息发送者信息
-
-
-## _class_ `MessageSegment`
-
-基类：[`nonebot.adapters.BaseMessageSegment`](README.md#nonebot.adapters.BaseMessageSegment)
-
-CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
-
-
-## _class_ `Message`
-
-基类：[`nonebot.adapters.BaseMessage`](README.md#nonebot.adapters.BaseMessage)
-
-CQHTTP 协议 Message 适配。

archive/2.0.0a7/api/adapters/ding.md

@@ -1,380 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.adapters.ding 模块
-
-
-## _exception_ `DingAdapterException`
-
-基类：[`nonebot.exception.AdapterException`](../exception.md#nonebot.exception.AdapterException)
-
-
-* **说明**
-
-    钉钉 Adapter 错误基类
-
-
-
-## _exception_ `ActionFailed`
-
-基类：[`nonebot.exception.ActionFailed`](../exception.md#nonebot.exception.ActionFailed), `nonebot.adapters.ding.exception.DingAdapterException`
-
-
-* **说明**
-
-    API 请求返回错误信息。
-
-
-
-* **参数**
-
-    
-    * `errcode: Optional[int]`: 错误码
-
-
-    * `errmsg: Optional[str]`: 错误信息
-
-
-
-## _exception_ `ApiNotAvailable`
-
-基类：[`nonebot.exception.ApiNotAvailable`](../exception.md#nonebot.exception.ApiNotAvailable), `nonebot.adapters.ding.exception.DingAdapterException`
-
-
-## _exception_ `NetworkError`
-
-基类：[`nonebot.exception.NetworkError`](../exception.md#nonebot.exception.NetworkError), `nonebot.adapters.ding.exception.DingAdapterException`
-
-
-* **说明**
-
-    网络错误。
-
-
-
-* **参数**
-
-    
-    * `retcode: Optional[int]`: 错误码
-
-
-
-## _exception_ `SessionExpired`
-
-基类：[`nonebot.exception.ApiNotAvailable`](../exception.md#nonebot.exception.ApiNotAvailable), `nonebot.adapters.ding.exception.DingAdapterException`
-
-
-* **说明**
-
-    发消息的 session 已经过期。
-
-
-
-## _class_ `Bot`
-
-基类：[`nonebot.adapters.BaseBot`](README.md#nonebot.adapters.BaseBot)
-
-钉钉 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
-
-
-### _property_ `type`
-
-
-* 返回: `"ding"`
-
-
-### _async classmethod_ `check_permission(driver, connection_type, headers, body)`
-
-
-* **说明**
-
-    钉钉协议鉴权。参考 [鉴权](https://ding-doc.dingtalk.com/doc#/serverapi2/elzz1p)
-
-
-
-### _async_ `handle_message(body)`
-
-
-* **说明**
-
-    处理上报消息的函数，转换为 `Event` 事件后调用 `nonebot.message.handle_event` 进一步处理事件。
-
-
-
-* **参数**
-
-    
-    * `message: dict`: 收到的上报消息
-
-
-
-### _async_ `call_api(api, event=None, **data)`
-
-
-* **说明**
-
-    调用 钉钉 协议 API
-
-
-
-* **参数**
-
-    
-    * `api: str`: API 名称
-
-
-    * `**data: Any`: API 参数
-
-
-
-* **返回**
-
-    
-    * `Any`: API 调用返回数据
-
-
-
-* **异常**
-
-    
-    * `NetworkError`: 网络错误
-
-
-    * `ActionFailed`: API 调用失败
-
-
-
-### _async_ `send(event, message, at_sender=False, **kwargs)`
-
-
-* **说明**
-
-    根据 `event`  向触发事件的主体发送消息。
-
-
-
-* **参数**
-
-    
-    * `event: Event`: Event 对象
-
-
-    * `message: Union[str, Message, MessageSegment]`: 要发送的消息
-
-
-    * `at_sender: bool`: 是否 @ 事件主体
-
-
-    * `**kwargs`: 覆盖默认参数
-
-
-
-* **返回**
-
-    
-    * `Any`: API 调用返回数据
-
-
-
-* **异常**
-
-    
-    * `ValueError`: 缺少 `user_id`, `group_id`
-
-
-    * `NetworkError`: 网络错误
-
-
-    * `ActionFailed`: API 调用失败
-
-
-
-## _class_ `Event`
-
-基类：[`nonebot.adapters.BaseEvent`](README.md#nonebot.adapters.BaseEvent)
-
-钉钉 协议 Event 适配。继承属性参考 [BaseEvent](./#class-baseevent) 。
-
-
-### _property_ `raw_event`
-
-原始上报消息
-
-
-### _property_ `id`
-
-
-* 类型: `Optional[str]`
-
-
-* 说明: 消息 ID
-
-
-### _property_ `name`
-
-
-* 类型: `str`
-
-
-* 说明: 事件名称，由 type.\`detail_type\` 组合而成
-
-
-### _property_ `self_id`
-
-
-* 类型: `str`
-
-
-* 说明: 机器人自身 ID
-
-
-### _property_ `time`
-
-
-* 类型: `int`
-
-
-* 说明: 消息的时间戳，单位 s
-
-
-### _property_ `type`
-
-
-* 类型: `str`
-
-
-* 说明: 事件类型
-
-
-### _property_ `detail_type`
-
-
-* 类型: `str`
-
-
-* 说明: 事件详细类型
-
-
-### _property_ `sub_type`
-
-
-* 类型: `None`
-
-
-* 说明: 钉钉适配器无事件子类型
-
-
-### _property_ `user_id`
-
-
-* 类型: `Optional[str]`
-
-
-* 说明: 发送者 ID
-
-
-### _property_ `group_id`
-
-
-* 类型: `Optional[str]`
-
-
-* 说明: 事件主体群 ID
-
-
-### _property_ `to_me`
-
-
-* 类型: `Optional[bool]`
-
-
-* 说明: 消息是否与机器人相关
-
-
-### _property_ `message`
-
-
-* 类型: `Optional[Message]`
-
-
-* 说明: 消息内容
-
-
-### _property_ `reply`
-
-
-* 类型: `None`
-
-
-* 说明: 回复消息详情
-
-
-### _property_ `raw_message`
-
-
-* 类型: `Optional[str]`
-
-
-* 说明: 原始消息
-
-
-### _property_ `plain_text`
-
-
-* 类型: `Optional[str]`
-
-
-* 说明: 纯文本消息内容
-
-
-### _property_ `sender`
-
-
-* 类型: `Optional[dict]`
-
-
-* 说明: 消息发送者信息
-
-
-## _class_ `MessageSegment`
-
-基类：[`nonebot.adapters.BaseMessageSegment`](README.md#nonebot.adapters.BaseMessageSegment)
-
-钉钉 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
-
-
-### _static_ `actionCardSingleMultiBtns(title, text, btns=[], hideAvatar=False, btnOrientation='1')`
-
-
-* **参数**
-
-    
-    * `btnOrientation`: 0：按钮竖直排列 1：按钮横向排列
-
-
-    * `btns`: [{ "title": title, "actionURL": actionURL }, ...]
-
-
-
-### _static_ `feedCard(links=[])`
-
-
-* **参数**
-
-    
-    * `links`: [{ "title": xxx, "messageURL": xxx, "picURL": xxx }, ...]
-
-
-
-### _static_ `empty()`
-
-不想回复消息到群里
-
-
-## _class_ `Message`
-
-基类：[`nonebot.adapters.BaseMessage`](README.md#nonebot.adapters.BaseMessage)
-
-钉钉 协议 Message 适配。

archive/2.0.0a7/api/config.md

@@ -1,285 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.config 模块
-
-## 配置
-
-NoneBot 使用 [pydantic](https://pydantic-docs.helpmanual.io/) 以及 [python-dotenv](https://saurabh-kumar.com/python-dotenv/) 来读取配置。
-
-配置项需符合特殊格式或 json 序列化格式。详情见 [pydantic Field Type](https://pydantic-docs.helpmanual.io/usage/types/) 文档。
-
-
-## _class_ `Env`
-
-基类：`pydantic.env_settings.BaseSettings`
-
-运行环境配置。大小写不敏感。
-
-将会从 `nonebot.init 参数` > `环境变量` > `.env 环境配置文件` 的优先级读取配置。
-
-
-### `environment`
-
-
-* **类型**: `str`
-
-
-* **默认值**: `"prod"`
-
-
-* **说明**
-
-    当前环境名。 NoneBot 将从 `.env.{environment}` 文件中加载配置。
-
-
-
-## _class_ `Config`
-
-基类：`nonebot.config.BaseConfig`
-
-NoneBot 主要配置。大小写不敏感。
-
-除了 NoneBot 的配置项外，还可以自行添加配置项到 `.env.{environment}` 文件中。
-这些配置将会在 json 反序列化后一起带入 `Config` 类中。
-
-
-### `driver`
-
-
-* **类型**: `str`
-
-
-* **默认值**: `"nonebot.drivers.fastapi"`
-
-
-* **说明**
-
-    NoneBot 运行所使用的 `Driver` 。继承自 `nonebot.driver.BaseDriver` 。
-
-
-
-### `host`
-
-
-* **类型**: `IPvAnyAddress`
-
-
-* **默认值**: `127.0.0.1`
-
-
-* **说明**
-
-    NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP/主机名。
-
-
-
-### `port`
-
-
-* **类型**: `int`
-
-
-* **默认值**: `8080`
-
-
-* **说明**
-
-    NoneBot 的 HTTP 和 WebSocket 服务端监听的端口。
-
-
-
-### `debug`
-
-
-* **类型**: `bool`
-
-
-* **默认值**: `False`
-
-
-* **说明**
-
-    是否以调试模式运行 NoneBot。
-
-
-
-### `api_root`
-
-
-* **类型**: `Dict[str, str]`
-
-
-* **默认值**: `{}`
-
-
-* **说明**
-
-    以机器人 ID 为键，上报地址为值的字典，环境变量或文件中应使用 json 序列化。
-
-
-
-* **示例**
-
-
-```default
-API_ROOT={"123456": "http://127.0.0.1:5700"}
-```
-
-
-### `api_timeout`
-
-
-* **类型**: `Optional[float]`
-
-
-* **默认值**: `30.`
-
-
-* **说明**
-
-    API 请求超时时间，单位: 秒。
-
-
-
-### `access_token`
-
-
-* **类型**: `Optional[str]`
-
-
-* **默认值**: `None`
-
-
-* **说明**
-
-    API 请求以及上报所需密钥，在请求头中携带。
-
-
-
-* **示例**
-
-
-```http
-POST /cqhttp/ HTTP/1.1
-Authorization: Bearer kSLuTF2GC2Q4q4ugm3
-```
-
-
-### `secret`
-
-
-* **类型**: `Optional[str]`
-
-
-* **默认值**: `None`
-
-
-* **说明**
-
-    HTTP POST 形式上报所需签名，在请求头中携带。
-
-
-
-* **示例**
-
-
-```http
-POST /cqhttp/ HTTP/1.1
-X-Signature: sha1=f9ddd4863ace61e64f462d41ca311e3d2c1176e2
-```
-
-
-### `superusers`
-
-
-* **类型**: `Set[int]`
-
-
-* **默认值**: `set()`
-
-
-* **说明**
-
-    机器人超级用户。
-
-
-
-* **示例**
-
-
-```default
-SUPER_USERS=[12345789]
-```
-
-
-### `nickname`
-
-
-* **类型**: `Set[str]`
-
-
-* **默认值**: `set()`
-
-
-* **说明**
-
-    机器人昵称。
-
-
-
-### `command_start`
-
-
-* **类型**: `Set[str]`
-
-
-* **默认值**: `{"/"}`
-
-
-* **说明**
-
-    命令的起始标记，用于判断一条消息是不是命令。
-
-
-
-### `command_sep`
-
-
-* **类型**: `Set[str]`
-
-
-* **默认值**: `{"."}`
-
-
-* **说明**
-
-    命令的分隔标记，用于将文本形式的命令切分为元组（实际的命令名）。
-
-
-
-### `session_expire_timeout`
-
-
-* **类型**: `timedelta`
-
-
-* **默认值**: `timedelta(minutes=2)`
-
-
-* **说明**
-
-    等待用户回复的超时时间。
-
-
-
-* **示例**
-
-
-```default
-SESSION_EXPIRE_TIMEOUT=120  # 单位: 秒
-SESSION_EXPIRE_TIMEOUT=[DD ][HH:MM]SS[.ffffff]
-SESSION_EXPIRE_TIMEOUT=P[DD]DT[HH]H[MM]M[SS]S  # ISO 8601
-```

archive/2.0.0a7/api/drivers/README.md

@@ -1,246 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.drivers 模块
-
-## 后端驱动适配基类
-
-各驱动请继承以下基类
-
-
-## _class_ `BaseDriver`
-
-基类：`abc.ABC`
-
-Driver 基类。将后端框架封装，以满足适配器使用。
-
-
-### `_adapters`
-
-
-* **类型**
-
-    `Dict[str, Type[Bot]]`
-
-
-
-* **说明**
-
-    已注册的适配器列表
-
-
-
-### _abstract_ `__init__(env, config)`
-
-
-* **参数**
-
-    
-    * `env: Env`: 包含环境信息的 Env 对象
-
-
-    * `config: Config`: 包含配置信息的 Config 对象
-
-
-
-### `env`
-
-
-* **类型**
-
-    `str`
-
-
-
-* **说明**
-
-    环境名称
-
-
-
-### `config`
-
-
-* **类型**
-
-    `Config`
-
-
-
-* **说明**
-
-    配置对象
-
-
-
-### `_clients`
-
-
-* **类型**
-
-    `Dict[str, Bot]`
-
-
-
-* **说明**
-
-    已连接的 Bot
-
-
-
-### _classmethod_ `register_adapter(name, adapter)`
-
-
-* **说明**
-
-    注册一个协议适配器
-
-
-
-* **参数**
-
-    
-    * `name: str`: 适配器名称，用于在连接时进行识别
-
-
-    * `adapter: Type[Bot]`: 适配器 Class
-
-
-
-### _abstract property_ `type`
-
-驱动类型名称
-
-
-### _abstract property_ `server_app`
-
-驱动 APP 对象
-
-
-### _abstract property_ `asgi`
-
-驱动 ASGI 对象
-
-
-### _abstract property_ `logger`
-
-驱动专属 logger 日志记录器
-
-
-### _property_ `bots`
-
-
-* **类型**
-
-    `Dict[str, Bot]`
-
-
-
-* **说明**
-
-    获取当前所有已连接的 Bot
-
-
-
-### _abstract_ `on_startup(func)`
-
-注册一个在驱动启动时运行的函数
-
-
-### _abstract_ `on_shutdown(func)`
-
-注册一个在驱动停止时运行的函数
-
-
-### _abstract_ `run(host=None, port=None, *args, **kwargs)`
-
-
-* **说明**
-
-    启动驱动框架
-
-
-
-* **参数**
-
-    
-    * `host: Optional[str]`: 驱动绑定 IP
-
-
-    * `post: Optional[int]`: 驱动绑定端口
-
-
-    * `*args`
-
-
-    * `**kwargs`
-
-
-
-### _abstract async_ `_handle_http()`
-
-用于处理 HTTP 类型请求的函数
-
-
-### _abstract async_ `_handle_ws_reverse()`
-
-用于处理 WebSocket 类型请求的函数
-
-
-## _class_ `BaseWebSocket`
-
-基类：`object`
-
-WebSocket 连接封装，统一接口方便外部调用。
-
-
-### _abstract_ `__init__(websocket)`
-
-
-* **参数**
-
-    
-    * `websocket: Any`: WebSocket 连接对象
-
-
-
-### _property_ `websocket`
-
-WebSocket 连接对象
-
-
-### _abstract property_ `closed`
-
-
-* **类型**
-
-    `bool`
-
-
-
-* **说明**
-
-    连接是否已经关闭
-
-
-
-### _abstract async_ `accept()`
-
-接受 WebSocket 连接请求
-
-
-### _abstract async_ `close(code)`
-
-关闭 WebSocket 连接请求
-
-
-### _abstract async_ `receive()`
-
-接收一条 WebSocket 信息
-
-
-### _abstract async_ `send(data)`
-
-发送一条 WebSocket 信息

archive/2.0.0a7/api/drivers/fastapi.md

@@ -1,118 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.drivers.fastapi 模块
-
-## FastAPI 驱动适配
-
-后端使用方法请参考: [FastAPI 文档](https://fastapi.tiangolo.com/)
-
-
-## _class_ `Driver`
-
-基类：[`nonebot.drivers.BaseDriver`](README.md#nonebot.drivers.BaseDriver)
-
-FastAPI 驱动框架
-
-
-* **上报地址**
-
-    
-    * `/{adapter name}/`: HTTP POST 上报
-
-
-    * `/{adapter name}/http/`: HTTP POST 上报
-
-
-    * `/{adapter name}/ws`: WebSocket 上报
-
-
-    * `/{adapter name}/ws/`: WebSocket 上报
-
-
-
-### _property_ `type`
-
-驱动名称: `fastapi`
-
-
-### _property_ `server_app`
-
-`FastAPI APP` 对象
-
-
-### _property_ `asgi`
-
-`FastAPI APP` 对象
-
-
-### _property_ `logger`
-
-fastapi 使用的 logger
-
-
-### `on_startup(func)`
-
-参考文档: [Events](https://fastapi.tiangolo.com/advanced/events/#startup-event)
-
-
-### `on_shutdown(func)`
-
-参考文档: [Events](https://fastapi.tiangolo.com/advanced/events/#startup-event)
-
-
-### `run(host=None, port=None, *, app=None, **kwargs)`
-
-使用 `uvicorn` 启动 FastAPI
-
-
-### _async_ `_handle_http(adapter, request, data=Body(Ellipsis))`
-
-用于处理 HTTP 类型请求的函数
-
-
-### _async_ `_handle_ws_reverse(adapter, websocket)`
-
-用于处理 WebSocket 类型请求的函数
-
-
-## _class_ `WebSocket`
-
-基类：[`nonebot.drivers.BaseWebSocket`](README.md#nonebot.drivers.BaseWebSocket)
-
-
-### _property_ `closed`
-
-
-* **类型**
-
-    `bool`
-
-
-
-* **说明**
-
-    连接是否已经关闭
-
-
-
-### _async_ `accept()`
-
-接受 WebSocket 连接请求
-
-
-### _async_ `close(code=1000)`
-
-关闭 WebSocket 连接请求
-
-
-### _async_ `receive()`
-
-接收一条 WebSocket 信息
-
-
-### _async_ `send(data)`
-
-发送一条 WebSocket 信息

archive/2.0.0a7/api/exception.md

@@ -1,182 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.exception 模块
-
-## 异常
-
-下列文档中的异常是所有 NoneBot 运行时可能会抛出的。
-这些异常并非所有需要用户处理，在 NoneBot 内部运行时被捕获，并进行对应操作。
-
-
-## _exception_ `NoneBotException`
-
-基类：`Exception`
-
-
-* **说明**
-
-    所有 NoneBot 发生的异常基类。
-
-
-
-## _exception_ `IgnoredException`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
-
-
-
-* **参数**
-
-    
-    * `reason`: 忽略事件的原因
-
-
-
-## _exception_ `PausedException`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    指示 NoneBot 结束当前 `Handler` 并等待下一条消息后继续下一个 `Handler`。
-    可用于用户输入新信息。
-
-
-
-* **用法**
-
-    可以在 `Handler` 中通过 `Matcher.pause()` 抛出。
-
-
-
-## _exception_ `RejectedException`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    指示 NoneBot 结束当前 `Handler` 并等待下一条消息后重新运行当前 `Handler`。
-    可用于用户重新输入。
-
-
-
-* **用法**
-
-    可以在 `Handler` 中通过 `Matcher.reject()` 抛出。
-
-
-
-## _exception_ `FinishedException`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    指示 NoneBot 结束当前 `Handler` 且后续 `Handler` 不再被运行。
-    可用于结束用户会话。
-
-
-
-* **用法**
-
-    可以在 `Handler` 中通过 `Matcher.finish()` 抛出。
-
-
-
-## _exception_ `StopPropagation`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    指示 NoneBot 终止事件向下层传播。
-
-
-
-* **用法**
-
-    在 `Matcher.block == True` 时抛出。
-
-
-
-## _exception_ `RequestDenied`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    Bot 连接请求不合法。
-
-
-
-* **参数**
-
-    
-    * `status_code: int`: HTTP 状态码
-
-
-    * `reason: str`: 拒绝原因
-
-
-
-## _exception_ `AdapterException`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    代表 `Adapter` 抛出的异常，所有的 `Adapter` 都要在内部继承自这个 `Exception`
-
-
-
-* **参数**
-
-    
-    * `adapter_name: str`: 标识 adapter
-
-
-
-## _exception_ `ApiNotAvailable`
-
-基类：`nonebot.exception.AdapterException`
-
-
-* **说明**
-
-    在 API 连接不可用时抛出。
-
-
-
-## _exception_ `NetworkError`
-
-基类：`nonebot.exception.AdapterException`
-
-
-* **说明**
-
-    在网络出现问题时抛出，如: API 请求地址不正确, API 请求无返回或返回状态非正常等。
-
-
-
-## _exception_ `ActionFailed`
-
-基类：`nonebot.exception.AdapterException`
-
-
-* **说明**
-
-    API 请求成功返回数据，但 API 操作失败。

archive/2.0.0a7/api/log.md

@@ -1,55 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.log 模块
-
-## 日志
-
-NoneBot 使用 [loguru](https://github.com/Delgan/loguru) 来记录日志信息。
-
-自定义 logger 请参考 [loguru](https://github.com/Delgan/loguru) 文档。
-
-
-## `logger`
-
-
-* **说明**
-
-    NoneBot 日志记录器对象。
-
-
-
-* **默认信息**
-
-    
-    * 格式: `[%(asctime)s %(name)s] %(levelname)s: %(message)s`
-
-
-    * 等级: `DEBUG` / `INFO` ，根据 config 配置改变
-
-
-    * 输出: 输出至 stdout
-
-
-
-* **用法**
-
-
-```python
-from nonebot.log import logger
-```
-
-
-## _class_ `LoguruHandler`
-
-基类：`logging.Handler`
-
-
-### `emit(record)`
-
-Do whatever it takes to actually log the specified logging record.
-
-This version is intended to be implemented by subclasses and so
-raises a NotImplementedError.

archive/2.0.0a7/api/matcher.md

@@ -1,452 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.matcher 模块
-
-## 事件响应器
-
-该模块实现事件响应器的创建与运行，并提供一些快捷方法来帮助用户更好的与机器人进行 对话 。
-
-
-## `matchers`
-
-
-* **类型**
-
-    `Dict[int, List[Type[Matcher]]]`
-
-
-
-* **说明**
-
-    用于存储当前所有的事件响应器
-
-
-
-## _class_ `Matcher`
-
-基类：`object`
-
-事件响应器类
-
-
-### `module`
-
-
-* **类型**
-
-    `Optional[str]`
-
-
-
-* **说明**
-
-    事件响应器所在模块名称
-
-
-
-### `type`
-
-
-* **类型**
-
-    `str`
-
-
-
-* **说明**
-
-    事件响应器类型
-
-
-
-### `rule`
-
-
-* **类型**
-
-    `Rule`
-
-
-
-* **说明**
-
-    事件响应器匹配规则
-
-
-
-### `permission`
-
-
-* **类型**
-
-    `Permission`
-
-
-
-* **说明**
-
-    事件响应器触发权限
-
-
-
-### `priority`
-
-
-* **类型**
-
-    `int`
-
-
-
-* **说明**
-
-    事件响应器优先级
-
-
-
-### `block`
-
-
-* **类型**
-
-    `bool`
-
-
-
-* **说明**
-
-    事件响应器是否阻止事件传播
-
-
-
-### `temp`
-
-
-* **类型**
-
-    `bool`
-
-
-
-* **说明**
-
-    事件响应器是否为临时
-
-
-
-### `expire_time`
-
-
-* **类型**
-
-    `Optional[datetime]`
-
-
-
-* **说明**
-
-    事件响应器过期时间点
-
-
-
-### `_default_state`
-
-
-* **类型**
-
-    `dict`
-
-
-
-* **说明**
-
-    事件响应器默认状态
-
-
-
-### `_default_parser`
-
-
-* **类型**
-
-    `Optional[ArgsParser]`
-
-
-
-* **说明**
-
-    事件响应器默认参数解析函数
-
-
-
-### `__init__()`
-
-实例化 Matcher 以便运行
-
-
-### `handlers`
-
-
-* **类型**
-
-    `List[Handler]`
-
-
-
-* **说明**
-
-    事件响应器拥有的事件处理函数列表
-
-
-
-### _classmethod_ `new(type_='', rule=None, permission=None, handlers=None, temp=False, priority=1, block=False, *, module=None, default_state=None, expire_time=None)`
-
-
-* **说明**
-
-    创建一个新的事件响应器，并存储至 [matchers](#matchers)
-
-
-
-* **参数**
-
-    
-    * `type_: str`: 事件响应器类型，与 `event.type` 一致时触发，空字符串表示任意
-
-
-    * `rule: Optional[Rule]`: 匹配规则
-
-
-    * `permission: Optional[Permission]`: 权限
-
-
-    * `handlers: Optional[List[Handler]]`: 事件处理函数列表
-
-
-    * `temp: bool`: 是否为临时事件响应器，即触发一次后删除
-
-
-    * `priority: int`: 响应优先级
-
-
-    * `block: bool`: 是否阻止事件向更低优先级的响应器传播
-
-
-    * `module: Optional[str]`: 事件响应器所在模块名称
-
-
-    * `default_state: Optional[dict]`: 默认状态 `state`
-
-
-    * `expire_time: Optional[datetime]`: 事件响应器最终有效时间点，过时即被删除
-
-
-
-* **返回**
-
-    
-    * `Type[Matcher]`: 新的事件响应器类
-
-
-
-### _async classmethod_ `check_perm(bot, event)`
-
-
-* **说明**
-
-    检查是否满足触发权限
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: 上报事件
-
-
-
-* **返回**
-
-    
-    * `bool`: 是否满足权限
-
-
-
-### _async classmethod_ `check_rule(bot, event, state)`
-
-
-* **说明**
-
-    检查是否满足匹配规则
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: 上报事件
-
-
-    * `state: dict`: 当前状态
-
-
-
-* **返回**
-
-    
-    * `bool`: 是否满足匹配规则
-
-
-
-### _classmethod_ `args_parser(func)`
-
-
-* **说明**
-
-    装饰一个函数来更改当前事件响应器的默认参数解析函数
-
-
-
-* **参数**
-
-    
-    * `func: ArgsParser`: 参数解析函数
-
-
-
-### _classmethod_ `handle()`
-
-
-* **说明**
-
-    装饰一个函数来向事件响应器直接添加一个处理函数
-
-
-
-* **参数**
-
-    
-    * 无
-
-
-
-### _classmethod_ `receive()`
-
-
-* **说明**
-
-    装饰一个函数来指示 NoneBot 在接收用户新的一条消息后继续运行该函数
-
-
-
-* **参数**
-
-    
-    * 无
-
-
-
-### _classmethod_ `got(key, prompt=None, args_parser=None)`
-
-
-* **说明**
-
-    装饰一个函数来指示 NoneBot 当要获取的 `key` 不存在时接收用户新的一条消息并经过 `ArgsParser` 处理后再运行该函数，如果 `key` 已存在则直接继续运行
-
-
-
-* **参数**
-
-    
-    * `key: str`: 参数名
-
-
-    * `prompt: Optional[Union[str, Message, MessageSegment]]`: 在参数不存在时向用户发送的消息
-
-
-    * `args_parser: Optional[ArgsParser]`: 可选参数解析函数，空则使用默认解析函数
-
-
-
-### _async classmethod_ `send(message, **kwargs)`
-
-
-* **说明**
-
-    发送一条消息给当前交互用户
-
-
-
-* **参数**
-
-    
-    * `message: Union[str, Message, MessageSegment]`: 消息内容
-
-
-    * `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
-
-
-
-### _async classmethod_ `finish(message=None, **kwargs)`
-
-
-* **说明**
-
-    发送一条消息给当前交互用户并结束当前事件响应器
-
-
-
-* **参数**
-
-    
-    * `message: Union[str, Message, MessageSegment]`: 消息内容
-
-
-    * `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
-
-
-
-### _async classmethod_ `pause(prompt=None, **kwargs)`
-
-
-* **说明**
-
-    发送一条消息给当前交互用户并暂停事件响应器，在接收用户新的一条消息后继续下一个处理函数
-
-
-
-* **参数**
-
-    
-    * `prompt: Union[str, Message, MessageSegment]`: 消息内容
-
-
-    * `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
-
-
-
-### _async classmethod_ `reject(prompt=None, **kwargs)`
-
-
-* **说明**
-
-    发送一条消息给当前交互用户并暂停事件响应器，在接收用户新的一条消息后重新运行当前处理函数
-
-
-
-* **参数**
-
-    
-    * `prompt: Union[str, Message, MessageSegment]`: 消息内容
-
-
-    * `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api

archive/2.0.0a7/api/message.md

@@ -1,143 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.message 模块
-
-## 事件处理
-
-NoneBot 内部处理并按优先级分发事件给所有事件响应器，提供了多个插槽以进行事件的预处理等。
-
-
-## `event_preprocessor(func)`
-
-
-* **说明**
-
-    事件预处理。装饰一个函数，使它在每次接收到事件并分发给各响应器之前执行。
-
-
-
-* **参数**
-
-    事件预处理函数接收三个参数。
-
-
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-    * `state: dict`: 当前 State
-
-
-
-## `event_postprocessor(func)`
-
-
-* **说明**
-
-    事件后处理。装饰一个函数，使它在每次接收到事件并分发给各响应器之后执行。
-
-
-
-* **参数**
-
-    事件后处理函数接收三个参数。
-
-
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-    * `state: dict`: 当前事件运行前 State
-
-
-
-## `run_preprocessor(func)`
-
-
-* **说明**
-
-    运行预处理。装饰一个函数，使它在每次事件响应器运行前执行。
-
-
-
-* **参数**
-
-    运行预处理函数接收四个参数。
-
-
-    * `matcher: Matcher`: 当前要运行的事件响应器
-
-
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-    * `state: dict`: 当前 State
-
-
-
-## `run_postprocessor(func)`
-
-
-* **说明**
-
-    运行后处理。装饰一个函数，使它在每次事件响应器运行后执行。
-
-
-
-* **参数**
-
-    运行后处理函数接收五个参数。
-
-
-    * `matcher: Matcher`: 运行完毕的事件响应器
-
-
-    * `exception: Optional[Exception]`: 事件响应器运行错误（如果存在）
-
-
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-    * `state: dict`: 当前 State
-
-
-
-## _async_ `handle_event(bot, event)`
-
-
-* **说明**
-
-    处理一个事件。调用该函数以实现分发事件。
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-
-* **示例**
-
-
-```python
-import asyncio
-asyncio.create_task(handle_event(bot, event))
-```

archive/2.0.0a7/api/nonebot.md

@@ -1,266 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot 模块
-
-## 快捷导入
-
-为方便使用，`nonebot` 模块从子模块导入了部分内容
-
-
-* `on_message` => `nonebot.plugin.on_message`
-
-
-* `on_notice` => `nonebot.plugin.on_notice`
-
-
-* `on_request` => `nonebot.plugin.on_request`
-
-
-* `on_metaevent` => `nonebot.plugin.on_metaevent`
-
-
-* `on_startswith` => `nonebot.plugin.on_startswith`
-
-
-* `on_endswith` => `nonebot.plugin.on_endswith`
-
-
-* `on_keyword` => `nonebot.plugin.on_keyword`
-
-
-* `on_command` => `nonebot.plugin.on_command`
-
-
-* `on_regex` => `nonebot.plugin.on_regex`
-
-
-* `CommandGroup` => `nonebot.plugin.CommandGroup`
-
-
-* `MatcherGroup` => `nonebot.plugin.MatcherGroup`
-
-
-* `load_plugin` => `nonebot.plugin.load_plugin`
-
-
-* `load_plugins` => `nonebot.plugin.load_plugins`
-
-
-* `load_builtin_plugins` => `nonebot.plugin.load_builtin_plugins`
-
-
-* `get_plugin` => `nonebot.plugin.get_plugin`
-
-
-* `get_loaded_plugins` => `nonebot.plugin.get_loaded_plugins`
-
-
-* `export` => `nonebot.plugin.export`
-
-
-* `require` => `nonebot.plugin.require`
-
-
-## `get_driver()`
-
-
-* **说明**
-
-    获取全局 Driver 对象。可用于在计划任务的回调中获取当前 Driver 对象。
-
-
-
-* **返回**
-
-    
-    * `Driver`: 全局 Driver 对象
-
-
-
-* **异常**
-
-    
-    * `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
-
-
-
-* **用法**
-
-
-```python
-driver = nonebot.get_driver()
-```
-
-
-## `get_app()`
-
-
-* **说明**
-
-    获取全局 Driver 对应 Server App 对象。
-
-
-
-* **返回**
-
-    
-    * `Any`: Server App 对象
-
-
-
-* **异常**
-
-    
-    * `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
-
-
-
-* **用法**
-
-
-```python
-app = nonebot.get_app()
-```
-
-
-## `get_asgi()`
-
-
-* **说明**
-
-    获取全局 Driver 对应 Asgi 对象。
-
-
-
-* **返回**
-
-    
-    * `Any`: Asgi 对象
-
-
-
-* **异常**
-
-    
-    * `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
-
-
-
-* **用法**
-
-
-```python
-asgi = nonebot.get_asgi()
-```
-
-
-## `get_bots()`
-
-
-* **说明**
-
-    获取所有通过 ws 连接 NoneBot 的 Bot 对象。
-
-
-
-* **返回**
-
-    
-    * `Dict[str, Bot]`: 一个以字符串 ID 为键，Bot 对象为值的字典
-
-
-
-* **异常**
-
-    
-    * `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
-
-
-
-* **用法**
-
-
-```python
-bots = nonebot.get_bots()
-```
-
-
-## `init(*, _env_file=None, **kwargs)`
-
-
-* **说明**
-
-    初始化 NoneBot 以及 全局 Driver 对象。
-
-    NoneBot 将会从 .env 文件中读取环境信息，并使用相应的 env 文件配置。
-
-    你也可以传入自定义的 _env_file 来指定 NoneBot 从该文件读取配置。
-
-
-
-* **参数**
-
-    
-    * `_env_file: Optional[str]`: 配置文件名，默认从 .env.{env_name} 中读取配置
-
-
-    * `**kwargs`: 任意变量，将会存储到 Config 对象里
-
-
-
-* **返回**
-
-    
-    * `None`
-
-
-
-* **用法**
-
-
-```python
-nonebot.init(database=Database(...))
-```
-
-
-## `run(host=None, port=None, *args, **kwargs)`
-
-
-* **说明**
-
-    启动 NoneBot，即运行全局 Driver 对象。
-
-
-
-* **参数**
-
-    
-    * `host: Optional[str]`: 主机名／IP，若不传入则使用配置文件中指定的值
-
-
-    * `port: Optional[int]`: 端口，若不传入则使用配置文件中指定的值
-
-
-    * `*args`: 传入 Driver.run 的位置参数
-
-
-    * `**kwargs`: 传入 Driver.run 的命名参数
-
-
-
-* **返回**
-
-    
-    * `None`
-
-
-
-* **用法**
-
-
-```python
-nonebot.run(host="127.0.0.1", port=8080)
-```

archive/2.0.0a7/api/permission.md

@@ -1,121 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.permission 模块
-
-## 权限
-
-每个 `Matcher` 拥有一个 `Permission` ，其中是 **异步** `PermissionChecker` 的集合，只要有一个 `PermissionChecker` 检查结果为 `True` 时就会继续运行。
-
-:::tip 提示
-`PermissionChecker` 既可以是 async function 也可以是 sync function
-:::
-
-
-## `MESSAGE`
-
-
-* **说明**: 匹配任意 `message` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 message type 的 Matcher。
-
-
-## `NOTICE`
-
-
-* **说明**: 匹配任意 `notice` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 notice type 的 Matcher。
-
-
-## `REQUEST`
-
-
-* **说明**: 匹配任意 `request` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 request type 的 Matcher。
-
-
-## `METAEVENT`
-
-
-* **说明**: 匹配任意 `meta_event` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 meta_event type 的 Matcher。
-
-
-## `USER(*user, perm=<nonebot.permission.Permission object>)`
-
-
-* **说明**
-
-    在白名单内且满足 perm
-
-
-
-* **参数**
-
-    
-    * `*user: int`: 白名单
-
-
-    * `perm: Permission`: 需要同时满足的权限
-
-
-
-## `PRIVATE`
-
-
-* **说明**: 匹配任意私聊消息类型事件
-
-
-## `PRIVATE_FRIEND`
-
-
-* **说明**: 匹配任意好友私聊消息类型事件
-
-
-## `PRIVATE_GROUP`
-
-
-* **说明**: 匹配任意群临时私聊消息类型事件
-
-
-## `PRIVATE_OTHER`
-
-
-* **说明**: 匹配任意其他私聊消息类型事件
-
-
-## `GROUP`
-
-
-* **说明**: 匹配任意群聊消息类型事件
-
-
-## `GROUP_MEMBER`
-
-
-* **说明**: 匹配任意群员群聊消息类型事件
-
-:::warning 警告
-该权限通过 event.sender 进行判断且不包含管理员以及群主！
-:::
-
-
-## `GROUP_ADMIN`
-
-
-* **说明**: 匹配任意群管理员群聊消息类型事件
-
-
-## `GROUP_OWNER`
-
-
-* **说明**: 匹配任意群主群聊消息类型事件
-
-
-## `SUPERUSER`
-
-
-* **说明**: 匹配任意超级用户消息类型事件
-
-
-## `EVERYBODY`
-
-
-* **说明**: 匹配任意消息类型事件

archive/2.0.0a7/api/rule.md

@@ -1,210 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.rule 模块
-
-## 规则
-
-每个事件响应器 `Matcher` 拥有一个匹配规则 `Rule` ，其中是 **异步** `RuleChecker` 的集合，只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行。
-
-:::tip 提示
-`RuleChecker` 既可以是 async function 也可以是 sync function，但在最终会被 `nonebot.utils.run_sync` 转换为 async function
-:::
-
-
-## _class_ `Rule`
-
-基类：`object`
-
-
-* **说明**
-
-    `Matcher` 规则类，当事件传递时，在 `Matcher` 运行前进行检查。
-
-
-
-* **示例**
-
-
-```python
-Rule(async_function) & sync_function
-# 等价于
-from nonebot.utils import run_sync
-Rule(async_function, run_sync(sync_function))
-```
-
-
-### `__init__(*checkers)`
-
-
-* **参数**
-
-    
-    * `*checkers: Callable[[Bot, Event, dict], Awaitable[bool]]`: **异步** RuleChecker
-
-
-
-### `checkers`
-
-
-* **说明**
-
-    存储 `RuleChecker`
-
-
-
-* **类型**
-
-    
-    * `Set[Callable[[Bot, Event, dict], Awaitable[bool]]]`
-
-
-
-### _async_ `__call__(bot, event, state)`
-
-
-* **说明**
-
-    检查是否符合所有规则
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-    * `state: dict`: 当前 State
-
-
-
-* **返回**
-
-    
-    * `bool`
-
-
-
-## `startswith(msg)`
-
-
-* **说明**
-
-    匹配消息开头
-
-
-
-* **参数**
-
-    
-    * `msg: str`: 消息开头字符串
-
-
-
-## `endswith(msg)`
-
-
-* **说明**
-
-    匹配消息结尾
-
-
-
-* **参数**
-
-    
-    * `msg: str`: 消息结尾字符串
-
-
-
-## `keyword(*keywords)`
-
-
-* **说明**
-
-    匹配消息关键词
-
-
-
-* **参数**
-
-    
-    * `*keywords: str`: 关键词
-
-
-
-## `command(*cmds)`
-
-
-* **说明**
-
-    命令形式匹配，根据配置里提供的 `command_start`, `command_sep` 判断消息是否为命令。
-
-    可以通过 `state["_prefix"]["command"]` 获取匹配成功的命令（例：`("test",)`），通过 `state["_prefix"]["raw_command"]` 获取匹配成功的原始命令文本（例：`"/test"`）。
-
-
-
-* **参数**
-
-    
-    * `*cmds: Union[str, Tuple[str, ...]]`: 命令内容
-
-
-
-* **示例**
-
-    使用默认 `command_start`, `command_sep` 配置
-
-    命令 `("test",)` 可以匹配：`/test` 开头的消息
-    命令 `("test", "sub")` 可以匹配”`/test.sub` 开头的消息
-
-
-:::tip 提示
-命令内容与后续消息间无需空格！
-:::
-
-
-## `regex(regex, flags=0)`
-
-
-* **说明**
-
-    根据正则表达式进行匹配。
-
-    可以通过 `state["_matched"]` 获取正则表达式匹配成功的文本。
-
-
-
-* **参数**
-
-    
-    * `regex: str`: 正则表达式
-
-
-    * `flags: Union[int, re.RegexFlag]`: 正则标志
-
-
-:::tip 提示
-正则表达式匹配使用 search 而非 match，如需从头匹配请使用 `r"^xxx"` 来确保匹配开头
-:::
-
-
-## `to_me()`
-
-
-* **说明**
-
-    通过 `event.to_me` 判断消息是否是发送给机器人
-
-
-
-* **参数**
-
-    
-    * 无

archive/2.0.0a7/api/typing.md

@@ -1,300 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.typing 模块
-
-## 类型
-
-下面的文档中，「类型」部分使用 Python 的 Type Hint 语法，见 [PEP 484](https://www.python.org/dev/peps/pep-0484/)、[PEP 526](https://www.python.org/dev/peps/pep-0526/) 和 [typing](https://docs.python.org/3/library/typing.html)。
-
-除了 Python 内置的类型，下面还出现了如下 NoneBot 自定类型，实际上它们是 Python 内置类型的别名。
-
-以下类型均可从 nonebot.typing 模块导入。
-
-
-## `Driver`
-
-
-* **类型**
-
-    `BaseDriver`
-
-
-
-* **说明**
-
-    所有 Driver 的基类。
-
-
-
-
-## `WebSocket`
-
-
-* **类型**
-
-    `BaseWebSocket`
-
-
-
-* **说明**
-
-    所有 WebSocket 的基类。
-
-
-
-
-## `Bot`
-
-
-* **类型**
-
-    `BaseBot`
-
-
-
-* **说明**
-
-    所有 Bot 的基类。
-
-
-
-
-## `Event`
-
-
-* **类型**
-
-    `BaseEvent`
-
-
-
-* **说明**
-
-    所有 Event 的基类。
-
-
-
-
-## `Message`
-
-
-* **类型**
-
-    `BaseMessage`
-
-
-
-* **说明**
-
-    所有 Message 的基类。
-
-
-
-
-## `MessageSegment`
-
-
-* **类型**
-
-    `BaseMessageSegment`
-
-
-
-* **说明**
-
-    所有 MessageSegment 的基类。
-
-
-
-
-## `EventPreProcessor`
-
-
-* **类型**
-
-    `Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
-
-
-
-* **说明**
-
-    事件预处理函数 EventPreProcessor 类型
-
-
-
-
-## `EventPostProcessor`
-
-
-* **类型**
-
-    `Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
-
-
-
-* **说明**
-
-    事件预处理函数 EventPostProcessor 类型
-
-
-
-
-## `RunPreProcessor`
-
-
-* **类型**
-
-    `Callable[[Matcher, Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
-
-
-
-* **说明**
-
-    事件响应器运行前预处理函数 RunPreProcessor 类型
-
-
-
-
-## `RunPostProcessor`
-
-
-* **类型**
-
-    `Callable[[Matcher, Optional[Exception], Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
-
-
-
-* **说明**
-
-    事件响应器运行前预处理函数 RunPostProcessor 类型，第二个参数为运行时产生的错误（如果存在）
-
-
-
-
-## `Matcher`
-
-
-* **类型**
-
-    `Matcher`
-
-
-
-* **说明**
-
-    Matcher 即响应事件的处理类。通过 Rule 判断是否响应事件，运行 Handler。
-
-
-
-
-## `MatcherGroup`
-
-
-* **类型**
-
-    `MatcherGroup`
-
-
-
-* **说明**
-
-    MatcherGroup 为 Matcher 的集合。可以共享 Handler。
-
-
-
-
-## `Rule`
-
-
-* **类型**
-
-    `Rule`
-
-
-
-* **说明**
-
-    Rule 即判断是否响应事件的处理类。内部存储 RuleChecker ，返回全为 True 则响应事件。
-
-
-
-
-## `RuleChecker`
-
-
-* **类型**
-
-    `Callable[[Bot, Event, dict], Union[bool, Awaitable[bool]]]`
-
-
-
-* **说明**
-
-    RuleChecker 即判断是否响应事件的处理函数。
-
-
-
-
-## `Permission`
-
-
-* **类型**
-
-    `Permission`
-
-
-
-* **说明**
-
-    Permission 即判断是否响应消息的处理类。内部存储 PermissionChecker ，返回只要有一个 True 则响应消息。
-
-
-
-
-## `PermissionChecker`
-
-
-* **类型**
-
-    `Callable[[Bot, Event], Union[bool, Awaitable[bool]]]`
-
-
-
-* **说明**
-
-    RuleChecker 即判断是否响应消息的处理函数。
-
-
-
-
-## `Handler`
-
-
-* **类型**
-
-    `Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
-
-
-
-* **说明**
-
-    Handler 即事件的处理函数。
-
-
-
-
-## `ArgsParser`
-
-
-* **类型**
-
-    `Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
-
-
-
-* **说明**
-
-    ArgsParser 即消息参数解析函数，在 Matcher.got 获取参数时被运行。

archive/2.0.0a7/api/utils.md

@@ -1,60 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.utils 模块
-
-
-## `escape_tag(s)`
-
-
-* **说明**
-
-    用于记录带颜色日志时转义 `<tag>` 类型特殊标签
-
-
-
-* **参数**
-
-    
-    * `s: str`: 需要转义的字符串
-
-
-
-* **返回**
-
-    
-    * `str`
-
-
-
-## `run_sync(func)`
-
-
-* **说明**
-
-    一个用于包装 sync function 为 async function 的装饰器
-
-
-
-* **参数**
-
-    
-    * `func: Callable[..., Any]`: 被装饰的同步函数
-
-
-
-* **返回**
-
-    
-    * `Callable[..., Awaitable[Any]]`
-
-
-
-## _class_ `DataclassEncoder`
-
-
-* **说明**
-
-    在JSON序列化 `Message` (List[Dataclass]) 时使用的 `JSONEncoder`

archive/2.0.0a7/guide/README.md

@@ -1,33 +0,0 @@
-# 概览
-
-<!-- :::tip 提示
-如果在阅读本文档时遇到难以理解的词汇，请随时查阅 [术语表](../glossary.md) 或使用 [Google 搜索](https://www.google.com/)。
-::: -->
-
-:::tip 提示
-初次使用时可能会觉得这里的概览过于枯燥，可以先简单略读之后直接前往 [安装](./installation.md) 查看安装方法，并进行后续的基础使用教程。
-:::
-
-## 简介
-
-NoneBot2 是一个可扩展的 Python 异步机器人框架，它会对机器人收到的事件进行解析和处理，并以插件化的形式，按优先级分发给事件所对应的事件响应器，来完成具体的功能。
-
-除了起到解析事件的作用，NoneBot 还为插件提供了大量实用的预设操作和权限控制机制。对于命令处理，它更是提供了完善且易用的会话机制和内部调用机制，以分别适应命令的连续交互和插件内部功能复用等需求。
-
-得益于 Python 的 [asyncio](https://docs.python.org/3/library/asyncio.html) 机制，NoneBot 处理事件的吞吐量有了很大的保障，再配合 WebSocket 通信方式（也是最建议的通信方式），NoneBot 的性能可以达到 HTTP 通信方式的两倍以上，相较于传统同步 I/O 的 HTTP 通信，更是有质的飞跃。
-
-需要注意的是，NoneBot 仅支持 **Python 3.7+**
-
-## 特色
-
-NoneBot2 的驱动框架 `Driver` 以及通信协议 `Adapter` 均可**自定义**，并且可以作为插件进行**替换/添加**！
-
-- 提供使用简易的脚手架
-- 提供丰富的官方插件
-- 提供可添加/替换的驱动以及协议选项
-- 基于异步 I/O
-- 同时支持 HTTP 和反向 WebSocket 通信方式
-- 支持多个机器人账号负载均衡
-- 提供直观的交互式会话接口
-- 提供可自定义的权限控制机制
-- 多种方式渲染要发送的消息内容，使对话足够自然

archive/2.0.0a7/guide/basic-configuration.md

@@ -1,68 +0,0 @@
-# 基本配置
-
-到目前为止我们还在使用 NoneBot 的默认行为，在开始编写自己的插件之前，我们先尝试在配置文件上动动手脚，让 NoneBot 表现出不同的行为。
-
-在上一章节中，我们创建了默认的项目结构，其中 `.env`, `.env.*` 均为项目的配置文件，下面将介绍几种 NoneBot 配置方式。
-
-:::danger 警告
-请勿将敏感信息写入配置文件并提交至开源仓库！
-:::
-
-## .env 文件
-
-NoneBot 在启动时将会从系统环境变量或者 `.env` 文件中寻找变量 `ENVIRONMENT` (大小写不敏感)，默认值为 `prod`。  
-这将引导 NoneBot 从系统环境变量或者 `.env.{ENVIRONMENT}` 文件中进一步加载具体配置。
-
-现在，我们在 `.env` 文件中写入当前环境信息
-
-```bash
-# .env
-ENVIRONMENT=dev
-```
-
-## .env.\* 文件
-
-详细配置文件，使用 [pydantic](https://pydantic-docs.helpmanual.io/) 加载配置。在 NoneBot 初始化时可以指定忽略 `.env` 中的环境信息转而加载某个配置文件: `nonebot.init(_env_file=".env.dev")`。
-
-:::warning 提示
-由于 `pydantic` 使用 JSON 加载配置项，请确保配置项值为 JSON 能够解析的数据。如果 JSON 解析失败将作为字符串处理。
-:::
-
-示例及说明：
-
-```bash
-HOST=0.0.0.0  # 配置 NoneBot 监听的 IP/主机名
-PORT=8080  # 配置 NoneBot 监听的端口
-DEBUG=true  # 开启 debug 模式 **请勿在生产环境开启**
-SUPERUSERS=["123456789", "987654321"]  # 配置 NoneBot 超级用户
-NICKNAME=["awesome", "bot"]  # 配置机器人的昵称
-COMMAND_START=["/", ""]  # 配置命令起始字符
-COMMAND_SEP=["."]  # 配置命令分割字符
-
-# Custom Configs
-CUSTOM_CONFIG1="config in env file"
-CUSTOM_CONFIG2=  # 留空则从系统环境变量读取，如不存在则为空字符串
-```
-
-详细的配置项参考 [Config Reference](../api/config.md) 。
-
-## bot.py 文件
-
-配置项也可以在 NoneBot 初始化时传入。此处可以传入任意合法 Python 变量。当然也可以在初始化完成后修改或新增。
-
-示例：
-
-```python
-# bot.py
-import nonebot
-
-nonebot.init(custom_config3="config on init")
-
-config = nonebot.get_driver().config
-config.custom_config3 = "changed after init"
-config.custom_config4 = "new config after init"
-```
-
-## 优先级
-
-`bot.py init` > `env file` > `system env`

archive/2.0.0a7/guide/creating-a-handler.md

@@ -1,159 +0,0 @@
-# 事件处理
-
-在上一章中，我们已经注册了事件响应器，现在我们可以正式编写事件处理逻辑了！
-
-## [事件处理函数](../api/typing.md#handler)
-
-```python{1,2,8,9}
-@weather.handle()
-async def handle_first_receive(bot: Bot, event: Event, state: dict):
-    args = str(event.message).strip()  # 首次发送命令时跟随的参数，例：/天气 上海，则args为上海
-    if args:
-        state["city"] = args  # 如果用户发送了参数则直接赋值
-
-
-@weather.got("city", prompt="你想查询哪个城市的天气呢？")
-async def handle_city(bot: Bot, event: Event, state: dict):
-    city = state["city"]
-    if city not in ["上海", "北京"]:
-        await weather.reject("你想查询的城市暂不支持，请重新输入！")
-    city_weather = await get_weather(city)
-    await weather.finish(city_weather)
-```
-
-在之前的样例中，我们定义了两个函数 `handle_first_receive`, `handle_city`，他们被事件响应器的装饰器装饰从而成为事件响应器的事件处理函数。
-
-:::tip 提示
-在事件响应器中，事件处理函数是**顺序**执行的！
-:::
-
-### 添加一个事件处理函数
-
-事件响应器提供了三种装饰事件处理函数的装饰器，分别是：
-
-1. [handle()](../api/matcher.md#classmethod-handle)
-2. [receive()](../api/matcher.md#classmethod-receive)
-3. [got(key, prompt, args_parser)](../api/matcher.md#classmethod-got-key-prompt-none-args-parser-none)
-
-#### handle()
-
-简单的为事件响应器添加一个事件处理函数，这个函数将会在上一个处理函数正常返回执行完毕后立即执行。
-
-#### receive()
-
-指示 NoneBot 接收一条新的用户消息后继续执行该处理函数。此时函数将会接收到新的消息而非前一条消息，之前相关信息可以存储在 state 中。
-
-特别的，当装饰的函数前没有其他事件处理函数，那么 `receive()` 不会接收一条新的消息而是直接使用第一条接收到的消息。
-
-#### got(key, prompt, args_parser)
-
-指示 NoneBot 当 `state` 中不存在 `key` 时向用户发送 `prompt` 等待用户回复并赋值给 `state[key]`。
-
-`prompt` 可以为 `str`, `Message`, `MessageSegment`，若为空则不会向用户发送，若不为空则会在 format 之后发送，即 `prompt.format(**state)`，注意对 `{}` 进行转义。示例：
-
-```python
-@matcher.receive()
-async def handle(bot: Bot, event: Event, state: dict):
-    state["key"] = "hello"
-
-
-@matcher.got("key2", prompt="{key}!")
-async def handle2(bot: Bot, event: Event, state: dict):
-    pass
-```
-
-`args_parser` 为参数处理函数，在这里传入一个新的函数以覆盖默认的参数处理。详情参照 [args_parser](#参数处理函数-args-parser)
-
-特别的，这些装饰器都可以套娃使用：
-
-```python
-@matcher.got("key1")
-@matcher.got("key2")
-async def handle(bot: Bot, event: Event, state: dict):
-    pass
-```
-
-### 事件处理函数参数
-
-事件处理函数类型为 `Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]` 。
-
-参数分别为：
-
-1. [nonebot.typing.Bot](../api/typing.md#bot): 即事件上报连接对应的 Bot 对象，为 BaseBot 的子类。特别注意，此处的类型注释可以替换为指定的 Bot 类型，例如：`nonebot.adapters.cqhttp.Bot`，只有在上报事件的 Bot 类型与类型注释相符时才会执行该处理函数！可用于多平台进行不同的处理。
-2. [nonebot.typing.Event](../api/typing.md#event): 即上报事件对象，可以获取到上报的所有信息。
-3. `state`: 状态字典，可以存储任意的信息，其中还包含一些特殊的值以获取 NoneBot 内部处理时的一些信息，如：
-
-- `state["_current_key"]`: 存储当前 `got` 获取的参数名
-- `state["_prefix"]`, `state["_suffix"]`: 存储当前 TRIE 匹配的前缀/后缀，可以通过该值获取用户命令的原始命令
-
-### 参数处理函数 args_parser
-
-在使用 `got` 获取用户输入参数时，需要对用户的消息进行处理以转换为我们所需要的信息。在默认情况下，NoneBot 会把用户的消息字符串原封不动的赋值给 `state[key]` 。可以通过以下两种方式修改默认处理逻辑：
-
-- `@matcher.args_parser` 装饰器：直接装饰一个函数作为参数处理器
-- `got(key, prompt, args_parser)`：直接把函数作为参数传入
-
-参数处理函数类型为：`Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`，即：
-
-```python
-async def parser(bot: Bot, event: Event, state: dict):
-    state[state["_current_key"]] = str(event.message)
-```
-
-特别的，`state["_current_key"]` 中存储了当前获取的参数名
-
-### 逻辑控制
-
-NoneBot 也为事件处理函数提供了一些便捷的逻辑控制函数：
-
-#### `matcher.send`
-
-这个函数用于发送一条消息给当前交互的用户。~~其实这并不是一个逻辑控制函数，只是不知道放在哪里……~~
-
-#### `matcher.pause`
-
-这个函数用于结束当前事件处理函数，强制接收一条新的消息再运行**下一个消息处理函数**。
-
-#### `matcher.reject`
-
-这个函数用于结束当前事件处理函数，强制接收一条新的消息再**再次运行当前消息处理函数**。常用于用户输入信息不符合预期。
-
-#### `matcher.finish`
-
-这个函数用于直接结束当前事件处理。
-
-以上三个函数都拥有一个参数 `message` / `prompt`，用于向用户发送一条消息。以及 `**kwargs` 直接传递给 `bot.send` 的额外参数。
-
-## 常用事件处理结构
-
-```python
-matcher = on_command("test")
-
-# 修改默认参数处理
-@matcher.args_parser
-async def parse(bot: Bot, event: Event, state: dict):
-    print(state["_current_key"], ":", str(event.message))
-    state[state["_current_key"]] = str(event.message)
-
-@matcher.handle()
-async def first_receive(bot: Bot, event: Event, state: dict):
-    # 获取用户原始命令，如：/test
-    print(state["_prefix"]["raw_command"])
-    # 处理用户输入参数，如：/test arg1 arg2
-    raw_args = str(event.message).strip()
-    if raw_args:
-        arg_list = raw_args.split()
-        # 将参数存入state以阻止后续再向用户询问参数
-        state["arg1"] = arg_list[0]
-
-
-@matcher.got("arg1", prompt="参数？")
-async def arg_handle(bot: Bot, event: Event, state: dict):
-    # 在这里对参数进行验证
-    if state["arg1"] not in ["allow", "list"]:
-        await matcher.reject("参数不正确！请重新输入")
-    # 发送一些信息
-    await bot.send(event, "message")
-    await matcher.send("message")
-    await matcher.finish("message")
-```

archive/2.0.0a7/guide/creating-a-matcher.md

@@ -1,144 +0,0 @@
-# 注册事件响应器
-
-好了，现在插件已经创建完毕，我们可以开始编写实际代码了，下面将以一个简易单文件天气查询插件为例。
-
-在插件目录下 `weather.py` 中添加如下代码：
-
-```python
-from nonebot import on_command
-from nonebot.rule import to_me
-from nonebot.adapters.cqhttp import Bot, Event
-
-weather = on_command("天气", rule=to_me(), priority=5)
-
-
-@weather.handle()
-async def handle_first_receive(bot: Bot, event: Event, state: dict):
-    args = str(event.message).strip()  # 首次发送命令时跟随的参数，例：/天气 上海，则args为上海
-    if args:
-        state["city"] = args  # 如果用户发送了参数则直接赋值
-
-
-@weather.got("city", prompt="你想查询哪个城市的天气呢？")
-async def handle_city(bot: Bot, event: Event, state: dict):
-    city = state["city"]
-    if city not in ["上海", "北京"]:
-        await weather.reject("你想查询的城市暂不支持，请重新输入！")
-    city_weather = await get_weather(city)
-    await weather.finish(city_weather)
-
-
-async def get_weather(city: str):
-    return f"{city}的天气是..."
-```
-
-为了简单起见，我们在这里的例子中没有接入真实的天气数据，但要接入也非常简单，你可以使用中国天气网、和风天气等网站提供的 API。
-
-接下来我们来说明这段代码是如何工作的。
-
-:::tip 提示
-从这里开始，你需要对 Python 的 asyncio 编程有所了解，因为 NoneBot 是完全基于 asyncio 的，具体可以参考 [廖雪峰的 Python 教程](https://www.liaoxuefeng.com/wiki/1016959663602400/1017959540289152)
-:::
-
-## [事件响应器](../api/matcher.md)
-
-```python{4}
-from nonebot import on_command
-from nonebot.rule import to_me
-from nonebot.permission import Permission
-
-weather = on_command("天气", rule=to_me(), permission=Permission(), priority=5)
-```
-
-在上方代码中，我们注册了一个事件响应器 `Matcher`，它由几个部分组成：
-
-1. `on_command` 注册一个消息类型的命令处理器
-2. `"天气"` 指定 command 参数 - 命令名
-3. `rule` 补充事件响应器的匹配规则
-4. `priority` 事件响应器优先级
-5. `block` 是否阻止事件传递
-
-其他详细配置可以参考 API 文档，下面我们详细说明各个部分：
-
-### 事件响应器类型 type
-
-事件响应器类型其实就是对应事件的类型 `Event.type` ，NoneBot 提供了一个基础类型事件响应器 `on()` 以及一些其他内置的事件响应器。
-
-以下所有类型的事件响应器都是由 `on(type, rule)` 的形式进行了简化封装。
-
-- `on("事件类型")`: 基础事件响应器，第一个参数为事件类型，空字符串表示不限
-- `on_metaevent()` ~ `on("meta_event")`: 元事件响应器
-- `on_message()` ~ `on("message")`: 消息事件响应器
-- `on_request()` ~ `on("request")`: 请求事件响应器
-- `on_notice()` ~ `on("notice")`: 通知事件响应器
-- `on_startswith(str)` ~ `on("message", startswith(str))`: 消息开头匹配响应器，参考 [startswith](../api/rule.md#startswith-msg)
-- `on_endswith(str)` ~ `on("message", endswith(str))`: 消息结尾匹配响应器，参考 [endswith](../api/rule.md#endswith-msg)
-- `on_keyword(set)` ~ `on("message", keyword(str))`: 消息关键词匹配响应器，参考 [keyword](../api/rule.md#keyword-keywords)
-- `on_command(str|tuple)` ~ `on("message", command(str|tuple))`: 命令响应器，参考 [command](../api/rule.md#command-cmds)
-- `on_regex(pattern_str)` ~ `on("message", regex(pattern_str))`: 正则匹配处理器，参考 [regex](../api/rule.md#regex-regex-flags-0)
-
-### 匹配规则 rule
-
-事件响应器的匹配规则即 `Rule`，详细内容在下方介绍。[直达](#自定义-rule)
-
-### 优先级 priority
-
-事件响应器的优先级代表事件响应器的执行顺序，同一优先级的事件响应器会 **同时执行！**，优先级数字**越小**越先响应！优先级请从 `1` 开始排序！
-
-:::tip 提示
-使用 `nonebot-test` 可以看到当前所有事件响应器的执行流程，有助理解事件响应流程！
-
-```bash
-pip install nonebot2[test]
-```
-
-:::
-
-### 阻断 block
-
-当有任意事件响应器发出了阻止事件传递信号时，该事件将不再会传递给下一优先级，直接结束处理。
-
-NoneBot 内置的事件响应器中，所有 `message` 类的事件响应器默认会阻断事件传递，其他则不会。
-
-## 自定义 rule
-
-rule 的出现使得 nonebot 对事件的响应可以非常自由，nonebot 内置了一些规则：
-
-- [startswith(msg)](../api/rule.md#startswith-msg)
-- [endswith(msg)](../api/rule.md#endswith-msg)
-- [keyword(\*keywords)](../api/rule.md#keyword-keywords)
-- [command(\*cmds)](../api/rule.md#command-cmds)
-- [regex(regex, flag)](../api/rule.md#regex-regex-flags-0)
-
-以上规则都是返回类型为 `Rule` 的函数，`Rule` 由非负个 `RuleChecker` 组成，当所有 `RuleChecker` 返回 `True` 时匹配成功。这些 `Rule`, `RuleChecker` 的形式如下：
-
-```python
-from nonebot.rule import Rule
-
-async def async_checker(bot: Bot, event: Event, state: dict) -> bool:
-    return True
-
-def sync_checker(bot: Bot, event: Event, state: dict) -> bool:
-    return True
-
-def check(arg1, args2):
-
-    async def _checker(bot: Bot, event: Event, state: dict) -> bool:
-        return bool(arg1 + arg2)
-
-    return Rule(_check)
-```
-
-`Rule` 和 `RuleChecker` 之间可以使用 `与 &` 互相组合：
-
-```python
-from nonebot.rule import Rule
-
-Rule(async_checker1) & sync_checker & async_checker2
-```
-
-**_请勿将事件处理的逻辑写入 `rule` 中，这会使得事件处理返回奇怪的响应。_**
-
-:::danger 警告
-`Rule(*checkers)` 只接受 async function，或使用 `nonebot.utils.run_sync` 自行包裹 sync function。在使用 `与 &` 时，NoneBot 会自动包裹 sync function
-:::

archive/2.0.0a7/guide/creating-a-plugin.md

@@ -1,119 +0,0 @@
-# 创建插件
-
-如果之前使用 `nb-cli` 生成了项目结构，那我们已经有了一个空的插件目录 `Awesome-Bot/awesome_bot/plugins`，并且它已在 `bot.py` 中被加载，我们现在可以开始创建插件了！
-
-使用 `nb-cli` 创建包形式插件，或自行创建文件(夹)
-
-```bash
-nb plugin new
-```
-
-插件通常有两种形式，下面分别介绍
-
-## 单文件形式
-
-在插件目录下创建名为 `foo.py` 的 Python 文件，暂时留空，此时目录结构如下：
-
-<!-- prettier-ignore-start -->
-:::vue
-AweSome-Bot
-├── awesome_bot
-│   └── plugins
-│      └── `foo.py`
-├── .env
-├── .env.dev
-├── .env.prod
-├── .gitignore
-├── bot.py
-├── docker-compose.yml
-├── Dockerfile
-├── pyproject.toml
-└── README.md
-:::
-<!-- prettier-ignore-end -->
-
-这个时候它已经可以被称为一个插件了，尽管它还什么都没做。
-
-## 包形式(推荐)
-
-在插件目录下创建文件夹 `foo`，并在该文件夹下创建文件 `__init__.py`，此时目录结构如下：
-
-<!-- prettier-ignore-start -->
-:::vue
-AweSome-Bot
-├── awesome_bot
-│   └── plugins
-│      └── `foo`
-│         └── `__init__.py`
-├── .env
-├── .env.dev
-├── .env.prod
-├── .gitignore
-├── bot.py
-├── docker-compose.yml
-├── Dockerfile
-├── pyproject.toml
-└── README.md
-:::
-<!-- prettier-ignore-end -->
-
-这个时候 `foo` 就是一个合法的 Python 包了，同时也是合法的 NoneBot 插件，插件内容可以在 `__init__.py` 中编写。
-
-### 推荐结构(仅供参考)
-
-<!-- prettier-ignore-start -->
-:::vue
-foo
-├── `__init__.py`
-├── `config.py`
-├── `data_source.py`
-└── `model.py`
-:::
-<!-- prettier-ignore-end -->
-
-#### \_\_init\_\_.py
-
-在该文件中编写各类事件响应及处理逻辑。
-
-#### config.py
-
-在该文件中使用 `pydantic` 定义插件所需要的配置项以及类型。
-
-示例：
-
-```python
-from pydantic import BaseSetting
-
-
-class Config(BaseSetting):
-
-    # plugin custom config
-    plugin_setting: str = "default"
-
-    class Config:
-        extra = "ignore"
-```
-
-并在 `__init__.py` 文件中添加以下行
-
-```python
-import nonebot
-from .config import Config
-
-global_config = nonebot.get_driver().config
-plugin_config = Config(**global_config.dict())
-```
-
-此时就可以通过 `plugin_config.plugin_setting` 获取到插件所需要的配置项了。
-
-#### data_source.py
-
-在该文件中编写数据获取函数。
-
-:::warning 警告
-数据获取应尽量使用**异步**处理！例如使用 [httpx](https://www.python-httpx.org/) 而非 [requests](https://requests.readthedocs.io/en/master/)
-:::
-
-#### model.py
-
-在该文件中编写数据库模型。

archive/2.0.0a7/guide/creating-a-project.md

@@ -1,51 +0,0 @@
-# 创建一个完整的项目
-
-上一章中我们已经运行了一个最小的 NoneBot 实例，在这一章，我们将从零开始一个完整的项目。
-
-## 目录结构
-
-首先，我们可以使用 `nb-cli` 或者自行创建完整的项目目录：
-
-```bash
-nb create
-```
-
-<!-- prettier-ignore-start -->
-:::vue
-AweSome-Bot
-├── `awesome_bot` _(**或是 src**)_
-│   └── `plugins`
-├── `.env` _(**可选的**)_
-├── `.env.dev` _(**可选的**)_
-├── `.env.prod` _(**可选的**)_
-├── .gitignore
-├── `bot.py`
-├── docker-compose.yml
-├── Dockerfile
-├── `pyproject.toml`
-└── README.md
-:::
-<!-- prettier-ignore-end -->
-
-- `awesome_bot/plugins` 或 `src/plugins`: 用于存放编写的 bot 插件
-- `.env`, `.env.dev`, `.env.prod`: 各环境配置文件
-- `bot.py`: bot 入口文件
-- `pyproject.toml`: 项目依赖管理文件，默认使用 [poetry](https://python-poetry.org/)
-
-## 启动 Bot
-
-如果你使用 `nb-cli`
-
-```bash
-nb run [--file=bot.py] [--app=app]
-```
-
-或者使用
-
-```bash
-python bot.py
-```
-
-:::tip 提示
-如果在 bot 入口文件内定义了 asgi server， `nb-cli` 将会为你启动**冷重载模式**
-:::

archive/2.0.0a7/guide/end-or-start.md

@@ -1,9 +0,0 @@
-# 结语
-
-至此，相信你已经能够写出一个基础的插件了，更多的用法将会在 进阶 部分进行介绍，这里给出几个小提示：
-
-- 请千万注意事件处理器的优先级设定
-- 在匹配规则中请勿使用耗时极长的函数
-- 同一个用户可以**跨群**(**私聊**)继续他的事件处理（除非做出权限限制，将在后续介绍）
-
-如果你还不能满足，前往 [进阶](../advanced/README.md) 获得更多的功能信息。

archive/2.0.0a7/guide/getting-started.md

@@ -1,173 +0,0 @@
-# 开始使用
-
-一切都安装成功后，你就已经做好了进行简单配置以运行一个最小的 NoneBot 实例的准备。
-
-## 最小实例
-
-如果你已经按照推荐方式安装了 `nb-cli`，使用脚手架创建一个空项目：
-
-```bash
-nb create
-```
-
-根据脚手架引导，将在当前目录下创建一个项目目录，项目目录内包含 `bot.py`。
-
-如果未安装 `nb-cli`，使用你最熟悉的编辑器或 IDE，创建一个名为 `bot.py` 的文件，内容如下：
-
-```python{3,4,7}
-import nonebot
-from nonebot.adapters.cqhttp import Bot as CQHTTPBot
-
-nonebot.init()
-driver = nonebot.get_driver()
-driver.register_adapter("cqhttp", CQHTTPBot)
-nonebot.load_builtin_plugins()
-
-if __name__ == "__main__":
-    nonebot.run()
-```
-
-## 解读
-
-在上方 `bot.py` 中，这几行高亮代码将依次：
-
-1. 使用默认配置初始化 NoneBot
-2. 加载 NoneBot 内置的插件
-3. 在地址 `127.0.0.1:8080` 运行 NoneBot
-
-在命令行使用如下命令即可运行这个 NoneBot 实例：
-
-```bash
-# nb-cli
-nb run
-# 其他
-python bot.py
-```
-
-运行后会产生如下日志：
-
-```plain
-09-14 21:02:00 [INFO] nonebot | Succeeded to import "nonebot.plugins.base"
-09-14 21:02:00 [INFO] nonebot | Running NoneBot...
-09-14 21:02:00 [INFO] uvicorn | Started server process [1234]
-09-14 21:02:00 [INFO] uvicorn | Waiting for application startup.
-09-14 21:02:00 [INFO] uvicorn | Application startup complete.
-09-14 21:02:00 [INFO] uvicorn | Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit)
-```
-
-## 配置 QQ 协议端
-
-单纯运行 NoneBot 实例并不会产生任何效果，因为此刻 QQ 这边还不知道 NoneBot 的存在，也就无法把消息发送给它，因此现在需要使用一个无头 QQ 来把消息等事件上报给 NoneBot。
-
-目前支持的协议有:
-
-- [OneBot(CQHTTP)](https://github.com/howmanybots/onebot/blob/master/README.md)
-
-QQ 协议端举例:
-
-- [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) (基于 [MiraiGo](https://github.com/Mrs4s/MiraiGo))
-- [cqhttp-mirai-embedded](https://github.com/yyuueexxiinngg/cqhttp-mirai/tree/embedded)
-- [Mirai](https://github.com/mamoe/mirai) + [cqhttp-mirai](https://github.com/yyuueexxiinngg/cqhttp-mirai)
-- [Mirai](https://github.com/mamoe/mirai) + [Mirai Native](https://github.com/iTXTech/mirai-native) + [CQHTTP](https://github.com/richardchien/coolq-http-api)
-- [OICQ-http-api](https://github.com/takayama-lily/onebot) (基于 [OICQ](https://github.com/takayama-lily/oicq))
-
-这里以 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) 为例
-
-1. 下载 go-cqhttp 对应平台的 release 文件，[点此前往](https://github.com/Mrs4s/go-cqhttp/releases)
-2. 运行 exe 文件或者使用 `./go-cqhttp` 启动
-3. 生成默认配置文件并修改默认配置
-
-```json{2,3,35-36,42}
-{
-  "uin": 你的QQ号,
-  "password": "你的密码",
-  "encrypt_password": false,
-  "password_encrypted": "",
-  "enable_db": true,
-  "access_token": "",
-  "relogin": {
-    "enabled": true,
-    "relogin_delay": 3,
-    "max_relogin_times": 0
-  },
-  "_rate_limit": {
-    "enabled": false,
-    "frequency": 0,
-    "bucket_size": 0
-  },
-  "ignore_invalid_cqcode": false,
-  "force_fragmented": true,
-  "heartbeat_interval": 0,
-  "http_config": {
-    "enabled": false,
-    "host": "0.0.0.0",
-    "port": 5700,
-    "timeout": 0,
-    "post_urls": {}
-  },
-  "ws_config": {
-    "enabled": false,
-    "host": "0.0.0.0",
-    "port": 6700
-  },
-  "ws_reverse_servers": [
-    {
-      "enabled": true,
-      "reverse_url": "ws://127.0.0.1:8080/cqhttp/ws",
-      "reverse_api_url": "",
-      "reverse_event_url": "",
-      "reverse_reconnect_interval": 3000
-    }
-  ],
-  "post_message_format": "array",
-  "use_sso_address": false,
-  "debug": false,
-  "log_level": "",
-  "web_ui": {
-    "enabled": true,
-    "host": "0.0.0.0",
-    "web_ui_port": 9999,
-    "web_input": false
-  }
-}
-```
-
-其中 `ws://127.0.0.1:8080/cqhttp/ws` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT
-
-## 历史性的第一次对话
-
-一旦新的配置文件正确生效之后，NoneBot 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
-
-```default
-09-14 21:31:16 [INFO] uvicorn | ('127.0.0.1', 12345) - "WebSocket /cqhttp/ws" [accepted]
-09-14 21:31:16 [INFO] nonebot | WebSocket Connection from CQHTTP Bot 你的QQ号 Accepted!
-```
-
-这表示 QQ 协议端已经成功地使用 CQHTTP 协议连接上了 NoneBot。
-
-:::warning 注意
-如果到这一步你没有看到上面这样的成功日志，CQHTTP 的日志中在不断地重连或无反应，请注意检查配置中的 IP 和端口是否确实可以访问。比较常见的出错点包括：
-
-- NoneBot 监听 `0.0.0.0`，然后在 CQHTTP 配置中填了 `ws://0.0.0.0:8080/cqhttp/ws`
-- 在 Docker 容器内运行 CQHTTP，并通过 `127.0.0.1` 访问宿主机上的 NoneBot
-- 想从公网访问，但没有修改云服务商的安全组策略或系统防火墙
-- NoneBot 所监听的端口存在冲突，已被其它程序占用
-- 弄混了 NoneBot 的 `host`、`port` 参数与 CQHTTP 配置中的 `host`、`port` 参数
-- 使用了 `ws_reverse_api_url` 和 `ws_reverse_event_url` 而非 universal client
-- `ws://` 错填为 `http://`
-- CQHTTP 或 NoneBot 启动时遭到外星武器干扰
-
-请尝试重启 CQHTTP、重启 NoneBot、更换端口、修改防火墙、重启系统、仔细阅读前面的文档及提示、更新 CQHTTP 和 NoneBot 到最新版本等方式来解决。
-:::
-
-现在，尝试向你的 QQ 机器人账号发送如下内容：
-
-```default
-/echo 你好，世界
-```
-
-到这里如果一切 OK，你应该会收到机器人给你回复了 `你好，世界`。这一历史性的对话标志着你已经成功地运行了一个 NoneBot 的最小实例，开始了编写更强大的 QQ 机器人的创意之旅！
-
-<ClientOnly>
-  <Messenger :messages="[{ position: 'right', msg: '/echo 你好，世界' }, { position: 'left', msg: '你好，世界' }]"/>
-</ClientOnly>

archive/2.0.0a7/guide/installation.md

@@ -1,87 +0,0 @@
-# 安装
-
-## NoneBot
-
-:::warning 注意
-请确保你的 Python 版本 >= 3.7。
-:::
-
-:::warning 注意
-请在安装 nonebot2 之前卸载 nonebot 1.x
-
-```bash
-pip uninstall nonebot
-```
-
-:::
-
-### 通过脚手架安装(推荐安装方式)
-
-1. (可选)使用你喜欢的 Python 环境管理工具创建新的虚拟环境。
-2. 使用 `pip` (或其他) 安装 NoneBot 脚手架。
-
-   ```bash
-   pip install nb-cli
-   ```
-
-3. 点个 star 吧
-
-   nonebot2: [![nb-cli](https://img.shields.io/github/stars/nonebot/nonebot2?style=social)](https://github.com/nonebot/nonebot2)
-
-   nb-cli: [![nb-cli](https://img.shields.io/github/stars/nonebot/nb-cli?style=social)](https://github.com/nonebot/nb-cli)
-
-### 不使用脚手架(纯净安装)
-
-```bash
-# poetry
-poetry add nonebot2
-# pip
-pip install nonebot2
-```
-
-如果你需要使用最新的（可能**尚未发布**的）特性，可以直接从 GitHub 仓库安装：
-
-```bash
-# master
-poetry add git+https://github.com/nonebot/nonebot2.git#master
-# dev
-poetry add git+https://github.com/nonebot/nonebot2.git#dev
-```
-
-或者克隆 Git 仓库后手动安装：
-
-```bash
-git clone https://github.com/nonebot/nonebot2.git
-cd nonebot2
-poetry install --no-dev  # 推荐
-pip install .  # 不推荐
-```
-
-## 安装插件
-
-插件可以通过 `nb-cli` 进行安装，也可以自行安装并加载插件。
-
-```bash
-# 列出所有的插件
-nb plugin list
-# 搜索插件
-nb plugin search xxx
-# 安装插件
-nb plugin install xxx
-```
-
-如果急于上线 Bot 或想要使用现成的插件，以下插件可作为参考：
-
-### 官方插件
-
-~~自用插件~~ ~~确信~~
-
-- [NoneBot-Plugin-Docs](https://github.com/nonebot/nonebot2/tree/master/packages/nonebot-plugin-docs) 离线文档插件
-- [NoneBot-Plugin-Test](https://github.com/nonebot/plugin-test) 本地机器人测试前端插件
-- [NoneBot-Plugin-APScheduler](https://github.com/nonebot/plugin-apscheduler) 定时任务插件
-- [NoneBot-Plugin-Sentry](https://github.com/cscs181/QQ-GitHub-Bot/tree/master/src/plugins/nonebot_plugin_sentry) Sentry 在线日志分析插件
-- [NoneBot-Plugin-Status](https://github.com/cscs181/QQ-GitHub-Bot/tree/master/src/plugins/nonebot_plugin_status) 服务器状态查看插件
-
-### 其他插件
-
-还有更多的插件在 [这里](/plugin-store.md) 等着你发现～

archive/2.0.0a7/guide/loading-a-plugin.md

@@ -1,116 +0,0 @@
-# 加载插件
-
-在 [创建一个完整的项目](creating-a-project) 一章节中，我们已经创建了插件目录 `awesome_bot/plugins`，现在我们在机器人入口文件中加载它。当然，你也可以单独加载一个插件。
-
-## 加载内置插件
-
-在 `bot.py` 文件中添加以下行：
-
-```python{5}
-import nonebot
-
-nonebot.init()
-# 加载 nonebot 内置插件
-nonebot.load_builtin_plugins()
-
-app = nonebot.get_asgi()
-
-if __name__ == "__main__":
-    nonebot.run()
-```
-
-这将会加载 nonebot 内置的插件，它包含：
-
-- 命令 `say`：可由**superuser**使用，可以将消息内容由特殊纯文本转为富文本
-- 命令 `echo`：可由任何人使用，将消息原样返回
-
-以上命令均需要指定机器人，即私聊、群聊内@机器人、群聊内称呼机器人昵称。参考 [Rule: to_me](../api/rule.md#to-me)
-
-## 加载插件目录
-
-在 `bot.py` 文件中添加以下行：
-
-```python{5}
-import nonebot
-
-nonebot.init()
-# 加载插件目录，该目录下为各插件，以下划线开头的插件将不会被加载
-nonebot.load_plugins("awesome_bot/plugins")
-
-app = nonebot.get_asgi()
-
-if __name__ == "__main__":
-    nonebot.run()
-```
-
-:::tip 提示
-加载插件目录时，目录下以 `_` 下划线开头的插件将不会被加载！
-:::
-
-:::warning 提示
-**插件不能存在相同名称！**
-:::
-
-:::danger 警告
-插件间不应该存在过多的耦合，如果确实需要导入某个插件内的数据，可以参考 [进阶-跨插件访问](../advanced/export-and-require.md)
-:::
-
-## 加载单个插件
-
-在 `bot.py` 文件中添加以下行：
-
-```python{5,7}
-import nonebot
-
-nonebot.init()
-# 加载一个 pip 安装的插件
-nonebot.load_plugin("nonebot_plugin_status")
-# 加载本地的单独插件
-nonebot.load_plugin("awesome_bot.plugins.xxx")
-
-app = nonebot.get_asgi()
-
-if __name__ == "__main__":
-    nonebot.run()
-```
-
-## 子插件(嵌套插件)
-
-在插件中同样可以加载子插件，例如如下插件目录结构：
-
-<!-- prettier-ignore-start -->
-:::vue
-foo_plugin
-├── `plugins`
-│   ├── `sub_plugin1`
-│   │  └── \_\_init\_\_.py
-│   └── `sub_plugin2.py`
-├── `__init__.py`
-└── config.py
-:::
-<!-- prettier-ignore-end -->
-
-在插件目录下的 `__init__.py` 中添加如下代码：
-
-```python
-from pathlib import Path
-
-import nonebot
-
-# store all subplugins
-_sub_plugins = set()
-# load sub plugins
-_sub_plugins |= nonebot.load_plugins(
-    str((Path(__file__).parent / "plugins").resolve()))
-```
-
-插件将会被加载并存储于 `_sub_plugins` 中。
-
-## 运行结果
-
-尝试运行 `nb run` 或者 `python bot.py`，可以看到日志输出了类似如下内容：
-
-```plain
-09-19 21:51:59 [INFO] nonebot | Succeeded to import "nonebot.plugins.base"
-09-19 21:51:59 [INFO] nonebot | Succeeded to import "plugin_in_folder"
-```

archive/2.0.0a7/sidebar.config.json

@@ -1,161 +0,0 @@
-{
-  "sidebar": {},
-  "locales": {
-    "/": {
-      "label": "简体中文",
-      "selectText": "Languages",
-      "editLinkText": "在 GitHub 上编辑此页",
-      "lastUpdated": "上次更新",
-      "nav": [
-        {
-          "text": "主页",
-          "link": "/"
-        },
-        {
-          "text": "指南",
-          "link": "/guide/"
-        },
-        {
-          "text": "进阶",
-          "link": "/advanced/"
-        },
-        {
-          "text": "API",
-          "link": "/api/"
-        },
-        {
-          "text": "插件广场",
-          "link": "/plugin-store"
-        },
-        {
-          "text": "更新日志",
-          "link": "/changelog"
-        }
-      ],
-      "sidebarDepth": 2,
-      "sidebar": {
-        "/guide/": [
-          {
-            "title": "开始",
-            "collapsable": false,
-            "sidebar": "auto",
-            "children": [
-              "",
-              "installation",
-              "getting-started",
-              "creating-a-project",
-              "basic-configuration"
-            ]
-          },
-          {
-            "title": "编写插件",
-            "collapsable": false,
-            "sidebar": "auto",
-            "children": [
-              "loading-a-plugin",
-              "creating-a-plugin",
-              "creating-a-matcher",
-              "creating-a-handler",
-              "end-or-start"
-            ]
-          }
-        ],
-        "/advanced/": [
-          {
-            "title": "进阶",
-            "collapsable": false,
-            "sidebar": "auto",
-            "children": [
-              "",
-              "scheduler",
-              "permission",
-              "runtime-hook",
-              "export-and-require"
-            ]
-          },
-          {
-            "title": "发布",
-            "collapsable": false,
-            "sidebar": "auto",
-            "children": [
-              "publish-plugin"
-            ]
-          }
-        ],
-        "/api/": [
-          {
-            "title": "NoneBot Api Reference",
-            "path": "",
-            "collapsable": false,
-            "children": [
-              {
-                "title": "nonebot 模块",
-                "path": "nonebot"
-              },
-              {
-                "title": "nonebot.config 模块",
-                "path": "config"
-              },
-              {
-                "title": "nonebot.plugin 模块",
-                "path": "plugin"
-              },
-              {
-                "title": "nonebot.message 模块",
-                "path": "message"
-              },
-              {
-                "title": "nonebot.matcher 模块",
-                "path": "matcher"
-              },
-              {
-                "title": "nonebot.rule 模块",
-                "path": "rule"
-              },
-              {
-                "title": "nonebot.permission 模块",
-                "path": "permission"
-              },
-              {
-                "title": "nonebot.log 模块",
-                "path": "log"
-              },
-              {
-                "title": "nonebot.utils 模块",
-                "path": "utils"
-              },
-              {
-                "title": "nonebot.typing 模块",
-                "path": "typing"
-              },
-              {
-                "title": "nonebot.exception 模块",
-                "path": "exception"
-              },
-              {
-                "title": "nonebot.drivers 模块",
-                "path": "drivers/"
-              },
-              {
-                "title": "nonebot.drivers.fastapi 模块",
-                "path": "drivers/fastapi"
-              },
-              {
-                "title": "nonebot.adapters 模块",
-                "path": "adapters/"
-              },
-              {
-                "title": "nonebot.adapters.cqhttp 模块",
-                "path": "adapters/cqhttp"
-              },
-              {
-                "title": "nonebot.adapters.ding 模块",
-                "path": "adapters/ding"
-              }
-            ]
-          }
-        ]
-      }
-    }
-  }
-}

archive/2.0.0a8.post2/README.md

@@ -1,15 +0,0 @@
----
-home: true
-heroImage: /logo.png
-tagline: An asynchronous bot framework.
-actionText: 开始使用
-actionLink: guide/
-features:
-  - title: 简洁
-    details: 提供极其简洁易懂的 API，使你可以毫无压力地开始验证你的绝佳创意，只需编写最少量的代码，即可实现丰富的功能。
-  - title: 易于扩展
-    details: 精心设计的消息处理流程使得你可以很方便地将原型扩充为具有大量实用功能的完整聊天机器人，并持续保证扩展性。
-  - title: 高性能
-    details: 采用异步 I/O，利用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多账号同时接入，减少业务宕机的可能。
-footer: MIT Licensed | Copyright © 2018 - 2020 NoneBot Team
----

archive/2.0.0a8.post2/advanced/README.md

@@ -1,7 +0,0 @@
-# 深入
-
-## 它如何工作？
-
-<!-- TODO: how to work -->
-
-~~未填坑~~

archive/2.0.0a8.post2/advanced/export-and-require.md

@@ -1 +0,0 @@
-# 跨插件访问

archive/2.0.0a8.post2/advanced/overloaded-handlers.md

@@ -1 +0,0 @@
-# 事件处理函数重载

archive/2.0.0a8.post2/advanced/permission.md

@@ -1 +0,0 @@
-# 权限控制

archive/2.0.0a8.post2/advanced/publish-plugin.md

@@ -1 +0,0 @@
-# 发布插件

archive/2.0.0a8.post2/advanced/runtime-hook.md

@@ -1 +0,0 @@
-# 运行时插槽

archive/2.0.0a8.post2/advanced/scheduler.md

@@ -1,127 +0,0 @@
-# 定时任务
-
-[`APScheduler`](https://apscheduler.readthedocs.io/en/latest/index.html) —— Advanced Python Scheduler
-
-> Advanced Python Scheduler (APScheduler) is a Python library that lets you schedule your Python code to be executed later, either just once or periodically. You can add new jobs or remove old ones on the fly as you please. If you store your jobs in a database, they will also survive scheduler restarts and maintain their state. When the scheduler is restarted, it will then run all the jobs it should have run while it was offline.
-
-## 从 v1 迁移
-
-`APScheduler` 作为 `nonebot` v1 的可选依赖，为众多 bot 提供了方便的定时任务功能。`nonebot2` 已将 `APScheduler` 独立为 `nonebot_plugin_apscheduler` 插件，你可以在 [插件广场](https://v2.nonebot.dev/plugin-store.html) 中找到它。
-
-相比于 `nonebot` v1 ，只需要安装插件并修改 `scheduler` 的导入方式即可完成迁移。
-
-## 安装插件
-
-### 通过 nb-cli
-
-如正在使用 `nb-cli` 构建项目，你可以从插件市场复制安装命令或手动输入以下命令以添加 `nonebot_plugin_apscheduler`。
-
-```bash
-nb plugin install nonebot_plugin_apscheduler
-```
-
-:::tip 提示
-`nb-cli` 默认通过 `pypi` 安装，你可以使用 `-i [mirror]` 或 `--index [mirror]` 来使用镜像源安装。
-:::
-
-### 通过 poetry
-
-执行以下命令以添加 `nonebot_plugin_apscheduler`
-
-```bash
-poetry add nonebot-plugin-apscheduler
-```
-
-:::tip 提示
-由于稍后我们将使用 `nonebot.require()` 方法进行导入，所以无需额外的 `nonebot.load_plugin()`
-:::
-
-## 快速上手
-
-1. 在需要设置定时任务的插件中，通过 `nonebot.require` 从 `nonebot_plugin_apscheduler` 导入 `scheduler` 对象
-
-2. 在该对象的基础上，根据 `APScheduler` 的使用方法进一步配置定时任务
-
-将上述步骤归纳为最小实现的代码如下：
-
-```python
-from nonebot import require
-
-scheduler = require('nonebot_plugin_apscheduler').scheduler
-
-@scheduler.scheduled_job('cron', hour='*/2', id='xxx', args=[1], kwargs={arg2: 2})
-async def run_every_2_hour(arg1, arg2):
-    pass
-
-scheduler.add_job(run_every_day_from_program_start, "interval", days=1, id="xxx")
-```
-
-## 分步进行
-
-### 导入 scheduler 对象
-
-为了使插件能够实现定时任务，需要先将 `scheduler` 对象导入插件。
-
-`nonebot2` 提供了 `nonebot.require` 方法来实现导入其他插件的内容，此处我们使用这个方法来导入 `scheduler` 对象。
-
-`nonebot` 使用的 `scheduler` 对象为 `AsyncScheduler` 。
-
-> 使用该方法传入的插件本身也需要有对应实现，关于该方法的更多介绍可以参阅 [这里](./export-and-require.md)
-
-```python
-from nonebot import require
-
-scheduler = require('nonebot_plugin_apscheduler').scheduler
-```
-
-### 编写定时任务
-
-由于本部分为标准的通过 `APScheduler` 配置定时任务，有关指南请参阅 [APScheduler 官方文档](https://apscheduler.readthedocs.io/en/latest/userguide.html#adding-jobs)。
-
-### 配置插件选项
-
-根据项目的 `.env` 文件设置，向 `.env.*` 或 `bot.py` 文件添加 `nonebot_plugin_apscheduler` 的可选配置项
-
-:::warning 注意
-`.env.*` 文件的编写应遵循 nonebot2 对 `.env.*` 文件的编写要求
-:::
-
-#### `apscheduler_autostart`
-
-类型：`bool`
-
-默认值：`True`
-
-是否自动启动 `APScheduler`。
-
-对于大多数情况，我们需要在 `nonebot2` 项目被启动时启动定时任务，则此处设为 `true`
-
-```bash
-APSCHEDULER_AUTOSTART=true
-```
-
-```python
-nonebot.init(apscheduler_autostart=True)
-```
-
-#### `apscheduler_config`
-
-类型：`dict`
-
-默认值：`{"apscheduler.timezone": "Asia/Shanghai"}`
-
-`APScheduler` 相关配置。修改/增加其中配置项需要确保 `prefix: apscheduler`。
-
-对于 `APScheduler` 的相关配置，请参阅 [scheduler-config](https://apscheduler.readthedocs.io/en/latest/userguide.html#scheduler-config) 和 [BaseScheduler](https://apscheduler.readthedocs.io/en/latest/modules/schedulers/base.html#apscheduler.schedulers.base.BaseScheduler)
-
-> 官方文档在绝大多数时候能提供最准确和最具时效性的指南
-
-```bash
-APSCHEDULER_CONFIG={"apscheduler.timezone": "Asia/Shanghai"}
-```
-
-```python
-nonebot.init(apscheduler_config={
-    "apscheduler.timezone": "Asia/Shanghai"
-})
-```

archive/2.0.0a8.post2/api/README.md

@@ -1,52 +0,0 @@
-# NoneBot Api Reference
-
-
-* **模块索引**
-
-    
-    * [nonebot](nonebot.html)
-
-
-    * [nonebot.config](config.html)
-
-
-    * [nonebot.plugin](plugin.html)
-
-
-    * [nonebot.message](message.html)
-
-
-    * [nonebot.matcher](matcher.html)
-
-
-    * [nonebot.rule](rule.html)
-
-
-    * [nonebot.permission](permission.html)
-
-
-    * [nonebot.log](log.html)
-
-
-    * [nonebot.utils](utils.html)
-
-
-    * [nonebot.typing](typing.html)
-
-
-    * [nonebot.exception](exception.html)
-
-
-    * [nonebot.drivers](drivers/)
-
-
-    * [nonebot.drivers.fastapi](drivers/fastapi.html)
-
-
-    * [nonebot.adapters](adapters/)
-
-
-    * [nonebot.adapters.cqhttp](adapters/cqhttp.html)
-
-
-    * [nonebot.adapters.ding](adapters/ding.html)

archive/2.0.0a8.post2/api/adapters/README.md

@@ -1,423 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.adapters 模块
-
-## 协议适配基类
-
-各协议请继承以下基类，并使用 `driver.register_adapter` 注册适配器
-
-
-## _class_ `Bot`
-
-基类：`abc.ABC`
-
-Bot 基类。用于处理上报消息，并提供 API 调用接口。
-
-
-### _abstract_ `__init__(driver, connection_type, config, self_id, *, websocket=None)`
-
-
-* **参数**
-
-    
-    * `driver: Driver`: Driver 对象
-
-
-    * `connection_type: str`: http 或者 websocket
-
-
-    * `config: Config`: Config 对象
-
-
-    * `self_id: str`: 机器人 ID
-
-
-    * `websocket: Optional[WebSocket]`: Websocket 连接对象
-
-
-
-### `driver`
-
-Driver 对象
-
-
-### `connection_type`
-
-连接类型
-
-
-### `config`
-
-Config 配置对象
-
-
-### `self_id`
-
-机器人 ID
-
-
-### `websocket`
-
-Websocket 连接对象
-
-
-### _abstract property_ `type`
-
-Adapter 类型
-
-
-### _abstract async classmethod_ `check_permission(driver, connection_type, headers, body)`
-
-
-* **说明**
-
-    检查连接请求是否合法的函数，如果合法则返回当前连接 `唯一标识符`，通常为机器人 ID；如果不合法则抛出 `RequestDenied` 异常。
-
-
-
-* **参数**
-
-    
-    * `driver: Driver`: Driver 对象
-
-
-    * `connection_type: str`: 连接类型
-
-
-    * `headers: dict`: 请求头
-
-
-    * `body: Optional[dict]`: 请求数据，WebSocket 连接该部分为空
-
-
-
-* **返回**
-
-    
-    * `str`: 连接唯一标识符
-
-
-
-* **异常**
-
-    
-    * `RequestDenied`: 请求非法
-
-
-
-### _abstract async_ `handle_message(message)`
-
-
-* **说明**
-
-    处理上报消息的函数，转换为 `Event` 事件后调用 `nonebot.message.handle_event` 进一步处理事件。
-
-
-
-* **参数**
-
-    
-    * `message: dict`: 收到的上报消息
-
-
-
-### _abstract async_ `call_api(api, **data)`
-
-
-* **说明**
-
-    调用机器人 API 接口，可以通过该函数或直接通过 bot 属性进行调用
-
-
-
-* **参数**
-
-    
-    * `api: str`: API 名称
-
-
-    * `**data`: API 数据
-
-
-
-* **示例**
-
-
-```python
-await bot.call_api("send_msg", message="hello world")
-await bot.send_msg(message="hello world")
-```
-
-
-### _abstract async_ `send(event, message, **kwargs)`
-
-
-* **说明**
-
-    调用机器人基础发送消息接口
-
-
-
-* **参数**
-
-    
-    * `event: Event`: 上报事件
-
-
-    * `message: Union[str, Message, MessageSegment]`: 要发送的消息
-
-
-    * `**kwargs`
-
-
-
-## _class_ `MessageSegment`
-
-基类：`abc.ABC`
-
-消息段基类
-
-
-### `type`
-
-
-* 类型: `str`
-
-
-* 说明: 消息段类型
-
-
-### `data`
-
-
-* 类型: `Dict[str, Union[str, list]]`
-
-
-* 说明: 消息段数据
-
-
-## _class_ `Message`
-
-基类：`list`, `abc.ABC`
-
-消息数组
-
-
-### `__init__(message=None, *args, **kwargs)`
-
-
-* **参数**
-
-    
-    * `message: Union[str, list, dict, MessageSegment, Message, Any]`: 消息内容
-
-
-
-### `append(obj)`
-
-
-* **说明**
-
-    添加一个消息段到消息数组末尾
-
-
-
-* **参数**
-
-    
-    * `obj: Union[str, MessageSegment]`: 要添加的消息段
-
-
-
-### `extend(obj)`
-
-
-* **说明**
-
-    拼接一个消息数组或多个消息段到消息数组末尾
-
-
-
-* **参数**
-
-    
-    * `obj: Union[Message, Iterable[MessageSegment]]`: 要添加的消息数组
-
-
-
-### `reduce()`
-
-
-* **说明**
-
-    缩减消息数组，即按 MessageSegment 的实现拼接相邻消息段
-
-
-
-### `extract_plain_text()`
-
-
-* **说明**
-
-    提取消息内纯文本消息
-
-
-
-## _class_ `Event`
-
-基类：`abc.ABC`, `pydantic.main.BaseModel`
-
-Event 基类。提供获取关键信息的方法，其余信息可直接获取。
-
-
-### _abstract_ `get_type()`
-
-
-* **说明**
-
-    获取事件类型的方法，类型通常为 NoneBot 内置的四种类型。
-
-
-
-* **返回**
-
-    
-    * `Literal["message", "notice", "request", "meta_event"]`
-
-
-
-### _abstract_ `get_event_name()`
-
-
-* **说明**
-
-    获取事件名称的方法。
-
-
-
-* **返回**
-
-    
-    * `str`
-
-
-
-### _abstract_ `get_event_description()`
-
-
-* **说明**
-
-    获取事件描述的方法，通常为事件具体内容。
-
-
-
-* **返回**
-
-    
-    * `str`
-
-
-
-### `get_log_string()`
-
-
-* **说明**
-
-    获取事件日志信息的方法，通常你不需要修改这个方法，只有当希望 NoneBot 隐藏该事件日志时，可以抛出 `NoLogException` 异常。
-
-
-
-* **返回**
-
-    
-    * `str`
-
-
-
-* **异常**
-
-    
-    * `NoLogException`
-
-
-
-### _abstract_ `get_user_id()`
-
-
-* **说明**
-
-    获取事件主体 id 的方法，通常是用户 id 。
-
-
-
-* **返回**
-
-    
-    * `str`
-
-
-
-### _abstract_ `get_session_id()`
-
-
-* **说明**
-
-    获取会话 id 的方法，用于判断当前事件属于哪一个会话，通常是用户 id、群组 id 组合。
-
-
-
-* **返回**
-
-    
-    * `str`
-
-
-
-### _abstract_ `get_message()`
-
-
-* **说明**
-
-    获取事件消息内容的方法。
-
-
-
-* **返回**
-
-    
-    * `Message`
-
-
-
-### `get_plaintext()`
-
-
-* **说明**
-
-    获取消息纯文本的方法，通常不需要修改，默认通过 `get_message().extract_plain_text` 获取。
-
-
-
-* **返回**
-
-    
-    * `str`
-
-
-
-### _abstract_ `is_tome()`
-
-
-* **说明**
-
-    获取事件是否与机器人有关的方法。
-
-
-
-* **返回**
-
-    
-    * `bool`

archive/2.0.0a8.post2/api/adapters/cqhttp.md

@@ -1,564 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.adapters.cqhttp 模块
-
-## CQHTTP (OneBot) v11 协议适配
-
-协议详情请看: [CQHTTP](https://github.com/howmanybots/onebot/blob/master/README.md) | [OneBot](https://github.com/howmanybots/onebot/blob/master/README.md)
-
-# NoneBot.adapters.cqhttp.utils 模块
-
-
-## `escape(s, *, escape_comma=True)`
-
-
-* **说明**
-
-    对字符串进行 CQ 码转义。
-
-
-
-* **参数**
-
-    
-    * `s: str`: 需要转义的字符串
-
-
-    * `escape_comma: bool`: 是否转义逗号（`,`）。
-
-
-
-## `unescape(s)`
-
-
-* **说明**
-
-    对字符串进行 CQ 码去转义。
-
-
-
-* **参数**
-
-    
-    * `s: str`: 需要转义的字符串
-
-
-# NoneBot.adapters.cqhttp.exception 模块
-
-
-## _exception_ `ActionFailed`
-
-基类：[`nonebot.exception.ActionFailed`](../exception.md#nonebot.exception.ActionFailed), `nonebot.adapters.cqhttp.exception.CQHTTPAdapterException`
-
-
-* **说明**
-
-    API 请求返回错误信息。
-
-
-
-* **参数**
-
-    
-    * `retcode: Optional[int]`: 错误码
-
-
-
-## _exception_ `NetworkError`
-
-基类：[`nonebot.exception.NetworkError`](../exception.md#nonebot.exception.NetworkError), `nonebot.adapters.cqhttp.exception.CQHTTPAdapterException`
-
-
-* **说明**
-
-    网络错误。
-
-
-
-* **参数**
-
-    
-    * `retcode: Optional[int]`: 错误码
-
-
-# NoneBot.adapters.cqhttp.bot 模块
-
-
-## _async_ `_check_reply(bot, event)`
-
-
-* **说明**
-
-    检查消息中存在的回复，去除并赋值 `event.reply`, `event.to_me`
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-
-## `_check_at_me(bot, event)`
-
-
-* **说明**
-
-    检查消息开头或结尾是否存在 @机器人，去除并赋值 `event.to_me`
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-
-## `_check_nickname(bot, event)`
-
-
-* **说明**
-
-    检查消息开头是否存在，去除并赋值 `event.to_me`
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: Event 对象
-
-
-
-## `_handle_api_result(result)`
-
-
-* **说明**
-
-    处理 API 请求返回值。
-
-
-
-* **参数**
-
-    
-    * `result: Optional[Dict[str, Any]]`: API 返回数据
-
-
-
-* **返回**
-
-    
-    * `Any`: API 调用返回数据
-
-
-
-* **异常**
-
-    
-    * `ActionFailed`: API 调用失败
-
-
-
-## _class_ `Bot`
-
-基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
-
-CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
-
-
-### _property_ `type`
-
-
-* 返回: `"cqhttp"`
-
-
-### _async classmethod_ `check_permission(driver, connection_type, headers, body)`
-
-
-* **说明**
-
-    CQHTTP (OneBot) 协议鉴权。参考 [鉴权](https://github.com/howmanybots/onebot/blob/master/v11/specs/communication/authorization.md)
-
-
-
-### _async_ `handle_message(message)`
-
-
-* **说明**
-
-    调用 [_check_reply](#async-check-reply-bot-event), [_check_at_me](#check-at-me-bot-event), [_check_nickname](#check-nickname-bot-event) 处理事件并转换为 [Event](#class-event)
-
-
-
-### _async_ `call_api(api, **data)`
-
-
-* **说明**
-
-    调用 CQHTTP 协议 API
-
-
-
-* **参数**
-
-    
-    * `api: str`: API 名称
-
-
-    * `**data: Any`: API 参数
-
-
-
-* **返回**
-
-    
-    * `Any`: API 调用返回数据
-
-
-
-* **异常**
-
-    
-    * `NetworkError`: 网络错误
-
-
-    * `ActionFailed`: API 调用失败
-
-
-
-### _async_ `send(event, message, at_sender=False, **kwargs)`
-
-
-* **说明**
-
-    根据 `event`  向触发事件的主体发送消息。
-
-
-
-* **参数**
-
-    
-    * `event: Event`: Event 对象
-
-
-    * `message: Union[str, Message, MessageSegment]`: 要发送的消息
-
-
-    * `at_sender: bool`: 是否 @ 事件主体
-
-
-    * `**kwargs`: 覆盖默认参数
-
-
-
-* **返回**
-
-    
-    * `Any`: API 调用返回数据
-
-
-
-* **异常**
-
-    
-    * `ValueError`: 缺少 `user_id`, `group_id`
-
-
-    * `NetworkError`: 网络错误
-
-
-    * `ActionFailed`: API 调用失败
-
-
-# NoneBot.adapters.cqhttp.message 模块
-
-
-## _class_ `MessageSegment`
-
-基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
-
-CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
-
-
-## _class_ `Message`
-
-基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
-
-CQHTTP 协议 Message 适配。
-
-# NoneBot.adapters.cqhttp.permission 模块
-
-
-## `PRIVATE`
-
-
-* **说明**: 匹配任意私聊消息类型事件
-
-
-## `PRIVATE_FRIEND`
-
-
-* **说明**: 匹配任意好友私聊消息类型事件
-
-
-## `PRIVATE_GROUP`
-
-
-* **说明**: 匹配任意群临时私聊消息类型事件
-
-
-## `PRIVATE_OTHER`
-
-
-* **说明**: 匹配任意其他私聊消息类型事件
-
-
-## `GROUP`
-
-
-* **说明**: 匹配任意群聊消息类型事件
-
-
-## `GROUP_MEMBER`
-
-
-* **说明**: 匹配任意群员群聊消息类型事件
-
-:::warning 警告
-该权限通过 event.sender 进行判断且不包含管理员以及群主！
-:::
-
-
-## `GROUP_ADMIN`
-
-
-* **说明**: 匹配任意群管理员群聊消息类型事件
-
-
-## `GROUP_OWNER`
-
-
-* **说明**: 匹配任意群主群聊消息类型事件
-
-# NoneBot.adapters.cqhttp.event 模块
-
-
-## _class_ `Event`
-
-基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
-
-CQHTTP 协议事件，字段与 CQHTTP 一致。各事件字段参考 [CQHTTP 文档](https://github.com/howmanybots/onebot/blob/master/README.md)
-
-
-## _class_ `MessageEvent`
-
-基类：`nonebot.adapters.cqhttp.event.Event`
-
-消息事件
-
-
-### `to_me`
-
-
-* **说明**
-
-    消息是否与机器人有关
-
-
-
-* **类型**
-
-    `bool`
-
-
-
-### `reply`
-
-
-* **说明**
-
-    消息中提取的回复消息，内容为 `get_msg` API 返回结果
-
-
-
-* **类型**
-
-    `Optional[Reply]`
-
-
-
-## _class_ `PrivateMessageEvent`
-
-基类：`nonebot.adapters.cqhttp.event.MessageEvent`
-
-私聊消息
-
-
-## _class_ `GroupMessageEvent`
-
-基类：`nonebot.adapters.cqhttp.event.MessageEvent`
-
-群消息
-
-
-## _class_ `NoticeEvent`
-
-基类：`nonebot.adapters.cqhttp.event.Event`
-
-通知事件
-
-
-## _class_ `GroupUploadNoticeEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NoticeEvent`
-
-群文件上传事件
-
-
-## _class_ `GroupAdminNoticeEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NoticeEvent`
-
-群管理员变动
-
-
-## _class_ `GroupDecreaseNoticeEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NoticeEvent`
-
-群成员减少事件
-
-
-## _class_ `GroupIncreaseNoticeEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NoticeEvent`
-
-群成员增加事件
-
-
-## _class_ `GroupBanNoticeEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NoticeEvent`
-
-群禁言事件
-
-
-## _class_ `FriendAddNoticeEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NoticeEvent`
-
-好友添加事件
-
-
-## _class_ `GroupRecallNoticeEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NoticeEvent`
-
-群消息撤回事件
-
-
-## _class_ `FriendRecallNoticeEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NoticeEvent`
-
-好友消息撤回事件
-
-
-## _class_ `NotifyEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NoticeEvent`
-
-提醒事件
-
-
-## _class_ `PokeNotifyEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NotifyEvent`
-
-戳一戳提醒事件
-
-
-## _class_ `LuckyKingNotifyEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NotifyEvent`
-
-群红包运气王提醒事件
-
-
-## _class_ `HonorNotifyEvent`
-
-基类：`nonebot.adapters.cqhttp.event.NotifyEvent`
-
-群荣誉变更提醒事件
-
-
-## _class_ `RequestEvent`
-
-基类：`nonebot.adapters.cqhttp.event.Event`
-
-请求事件
-
-
-## _class_ `FriendRequestEvent`
-
-基类：`nonebot.adapters.cqhttp.event.RequestEvent`
-
-加好友请求事件
-
-
-## _class_ `GroupRequestEvent`
-
-基类：`nonebot.adapters.cqhttp.event.RequestEvent`
-
-加群请求/邀请事件
-
-
-## _class_ `MetaEvent`
-
-基类：`nonebot.adapters.cqhttp.event.Event`
-
-元事件
-
-
-## _class_ `LifecycleMetaEvent`
-
-基类：`nonebot.adapters.cqhttp.event.MetaEvent`
-
-生命周期元事件
-
-
-## _class_ `HeartbeatMetaEvent`
-
-基类：`nonebot.adapters.cqhttp.event.MetaEvent`
-
-心跳元事件
-
-
-## `get_event_model(event_name)`
-
-
-* **说明**
-
-    根据事件名获取对应 `Event Model` 及 `FallBack Event Model` 列表
-
-
-
-* **返回**
-
-    
-    * `List[Type[Event]]`

archive/2.0.0a8.post2/api/adapters/ding.md

@@ -1,293 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.adapters.ding 模块
-
-## 钉钉群机器人 协议适配
-
-协议详情请看: [钉钉文档](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p)
-
-# NoneBot.adapters.ding.exception 模块
-
-
-## _exception_ `DingAdapterException`
-
-基类：[`nonebot.exception.AdapterException`](../exception.md#nonebot.exception.AdapterException)
-
-
-* **说明**
-
-    钉钉 Adapter 错误基类
-
-
-
-## _exception_ `ActionFailed`
-
-基类：[`nonebot.exception.ActionFailed`](../exception.md#nonebot.exception.ActionFailed), `nonebot.adapters.ding.exception.DingAdapterException`
-
-
-* **说明**
-
-    API 请求返回错误信息。
-
-
-
-* **参数**
-
-    
-    * `errcode: Optional[int]`: 错误码
-
-
-    * `errmsg: Optional[str]`: 错误信息
-
-
-
-## _exception_ `NetworkError`
-
-基类：[`nonebot.exception.NetworkError`](../exception.md#nonebot.exception.NetworkError), `nonebot.adapters.ding.exception.DingAdapterException`
-
-
-* **说明**
-
-    网络错误。
-
-
-
-* **参数**
-
-    
-    * `retcode: Optional[int]`: 错误码
-
-
-
-## _exception_ `SessionExpired`
-
-基类：`nonebot.adapters.ding.exception.ApiNotAvailable`, `nonebot.adapters.ding.exception.DingAdapterException`
-
-
-* **说明**
-
-    发消息的 session 已经过期。
-
-
-# NoneBot.adapters.ding.bot 模块
-
-
-## _class_ `Bot`
-
-基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
-
-钉钉 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
-
-
-### _property_ `type`
-
-
-* 返回: `"ding"`
-
-
-### _async classmethod_ `check_permission(driver, connection_type, headers, body)`
-
-
-* **说明**
-
-    钉钉协议鉴权。参考 [鉴权](https://ding-doc.dingtalk.com/doc#/serverapi2/elzz1p)
-
-
-
-### _async_ `call_api(api, event=None, **data)`
-
-
-* **说明**
-
-    调用 钉钉 协议 API
-
-
-
-* **参数**
-
-    
-    * `api: str`: API 名称
-
-
-    * `**data: Any`: API 参数
-
-
-
-* **返回**
-
-    
-    * `Any`: API 调用返回数据
-
-
-
-* **异常**
-
-    
-    * `NetworkError`: 网络错误
-
-
-    * `ActionFailed`: API 调用失败
-
-
-
-### _async_ `send(event, message, at_sender=False, **kwargs)`
-
-
-* **说明**
-
-    根据 `event`  向触发事件的主体发送消息。
-
-
-
-* **参数**
-
-    
-    * `event: Event`: Event 对象
-
-
-    * `message: Union[str, Message, MessageSegment]`: 要发送的消息
-
-
-    * `at_sender: bool`: 是否 @ 事件主体
-
-
-    * `**kwargs`: 覆盖默认参数
-
-
-
-* **返回**
-
-    
-    * `Any`: API 调用返回数据
-
-
-
-* **异常**
-
-    
-    * `ValueError`: 缺少 `user_id`, `group_id`
-
-
-    * `NetworkError`: 网络错误
-
-
-    * `ActionFailed`: API 调用失败
-
-
-# NoneBot.adapters.ding.message 模块
-
-
-## _class_ `MessageSegment`
-
-基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
-
-钉钉 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
-
-
-### _static_ `atAll()`
-
-@全体
-
-
-### _static_ `atMobiles(*mobileNumber)`
-
-@指定手机号人员
-
-
-### _static_ `text(text)`
-
-发送 `text` 类型消息
-
-
-### _static_ `image(picURL)`
-
-发送 `image` 类型消息
-
-
-### _static_ `extension(dict_)`
-
-"标记 text 文本的 extension 属性，需要与 text 消息段相加。
-
-
-### _static_ `markdown(title, text)`
-
-发送 `markdown` 类型消息
-
-
-### _static_ `actionCardSingleBtn(title, text, singleTitle, singleURL)`
-
-发送 `actionCardSingleBtn` 类型消息
-
-
-### _static_ `actionCardMultiBtns(title, text, btns, hideAvatar=False, btnOrientation='1')`
-
-发送 `actionCardMultiBtn` 类型消息
-
-
-* **参数**
-
-    
-    * `btnOrientation`: 0：按钮竖直排列 1：按钮横向排列
-
-
-    * `btns`: [{ "title": title, "actionURL": actionURL }, ...]
-
-
-
-### _static_ `feedCard(links)`
-
-发送 `feedCard` 类型消息
-
-
-* **参数**
-
-    
-    * `links`: [{ "title": xxx, "messageURL": xxx, "picURL": xxx }, ...]
-
-
-
-## _class_ `Message`
-
-基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
-
-钉钉 协议 Message 适配。
-
-# NoneBot.adapters.ding.event 模块
-
-
-## _class_ `Event`
-
-基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
-
-钉钉协议事件。各事件字段参考 [钉钉文档](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p)
-
-
-## _class_ `ConversationType`
-
-基类：`str`, `enum.Enum`
-
-An enumeration.
-
-
-## _class_ `MessageEvent`
-
-基类：`nonebot.adapters.ding.event.Event`
-
-消息事件
-
-
-## _class_ `PrivateMessageEvent`
-
-基类：`nonebot.adapters.ding.event.MessageEvent`
-
-私聊消息事件
-
-
-## _class_ `GroupMessageEvent`
-
-基类：`nonebot.adapters.ding.event.MessageEvent`
-
-群消息事件

archive/2.0.0a8.post2/api/config.md

@@ -1,285 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.config 模块
-
-## 配置
-
-NoneBot 使用 [pydantic](https://pydantic-docs.helpmanual.io/) 以及 [python-dotenv](https://saurabh-kumar.com/python-dotenv/) 来读取配置。
-
-配置项需符合特殊格式或 json 序列化格式。详情见 [pydantic Field Type](https://pydantic-docs.helpmanual.io/usage/types/) 文档。
-
-
-## _class_ `Env`
-
-基类：`pydantic.env_settings.BaseSettings`
-
-运行环境配置。大小写不敏感。
-
-将会从 `nonebot.init 参数` > `环境变量` > `.env 环境配置文件` 的优先级读取配置。
-
-
-### `environment`
-
-
-* **类型**: `str`
-
-
-* **默认值**: `"prod"`
-
-
-* **说明**
-
-    当前环境名。 NoneBot 将从 `.env.{environment}` 文件中加载配置。
-
-
-
-## _class_ `Config`
-
-基类：`nonebot.config.BaseConfig`
-
-NoneBot 主要配置。大小写不敏感。
-
-除了 NoneBot 的配置项外，还可以自行添加配置项到 `.env.{environment}` 文件中。
-这些配置将会在 json 反序列化后一起带入 `Config` 类中。
-
-
-### `driver`
-
-
-* **类型**: `str`
-
-
-* **默认值**: `"nonebot.drivers.fastapi"`
-
-
-* **说明**
-
-    NoneBot 运行所使用的 `Driver` 。继承自 `nonebot.driver.BaseDriver` 。
-
-
-
-### `host`
-
-
-* **类型**: `IPvAnyAddress`
-
-
-* **默认值**: `127.0.0.1`
-
-
-* **说明**
-
-    NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP/主机名。
-
-
-
-### `port`
-
-
-* **类型**: `int`
-
-
-* **默认值**: `8080`
-
-
-* **说明**
-
-    NoneBot 的 HTTP 和 WebSocket 服务端监听的端口。
-
-
-
-### `debug`
-
-
-* **类型**: `bool`
-
-
-* **默认值**: `False`
-
-
-* **说明**
-
-    是否以调试模式运行 NoneBot。
-
-
-
-### `api_root`
-
-
-* **类型**: `Dict[str, str]`
-
-
-* **默认值**: `{}`
-
-
-* **说明**
-
-    以机器人 ID 为键，上报地址为值的字典，环境变量或文件中应使用 json 序列化。
-
-
-
-* **示例**
-
-
-```default
-API_ROOT={"123456": "http://127.0.0.1:5700"}
-```
-
-
-### `api_timeout`
-
-
-* **类型**: `Optional[float]`
-
-
-* **默认值**: `30.`
-
-
-* **说明**
-
-    API 请求超时时间，单位: 秒。
-
-
-
-### `access_token`
-
-
-* **类型**: `Optional[str]`
-
-
-* **默认值**: `None`
-
-
-* **说明**
-
-    API 请求以及上报所需密钥，在请求头中携带。
-
-
-
-* **示例**
-
-
-```http
-POST /cqhttp/ HTTP/1.1
-Authorization: Bearer kSLuTF2GC2Q4q4ugm3
-```
-
-
-### `secret`
-
-
-* **类型**: `Optional[str]`
-
-
-* **默认值**: `None`
-
-
-* **说明**
-
-    HTTP POST 形式上报所需签名，在请求头中携带。
-
-
-
-* **示例**
-
-
-```http
-POST /cqhttp/ HTTP/1.1
-X-Signature: sha1=f9ddd4863ace61e64f462d41ca311e3d2c1176e2
-```
-
-
-### `superusers`
-
-
-* **类型**: `Set[str]`
-
-
-* **默认值**: `set()`
-
-
-* **说明**
-
-    机器人超级用户。
-
-
-
-* **示例**
-
-
-```default
-SUPER_USERS=["12345789"]
-```
-
-
-### `nickname`
-
-
-* **类型**: `Set[str]`
-
-
-* **默认值**: `set()`
-
-
-* **说明**
-
-    机器人昵称。
-
-
-
-### `command_start`
-
-
-* **类型**: `Set[str]`
-
-
-* **默认值**: `{"/"}`
-
-
-* **说明**
-
-    命令的起始标记，用于判断一条消息是不是命令。
-
-
-
-### `command_sep`
-
-
-* **类型**: `Set[str]`
-
-
-* **默认值**: `{"."}`
-
-
-* **说明**
-
-    命令的分隔标记，用于将文本形式的命令切分为元组（实际的命令名）。
-
-
-
-### `session_expire_timeout`
-
-
-* **类型**: `timedelta`
-
-
-* **默认值**: `timedelta(minutes=2)`
-
-
-* **说明**
-
-    等待用户回复的超时时间。
-
-
-
-* **示例**
-
-
-```default
-SESSION_EXPIRE_TIMEOUT=120  # 单位: 秒
-SESSION_EXPIRE_TIMEOUT=[DD ][HH:MM]SS[.ffffff]
-SESSION_EXPIRE_TIMEOUT=P[DD]DT[HH]H[MM]M[SS]S  # ISO 8601
-```

archive/2.0.0a8.post2/api/drivers/README.md

@@ -1,318 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.drivers 模块
-
-## 后端驱动适配基类
-
-各驱动请继承以下基类
-
-
-## _class_ `Driver`
-
-基类：`abc.ABC`
-
-Driver 基类。将后端框架封装，以满足适配器使用。
-
-
-### `_adapters`
-
-
-* **类型**
-
-    `Dict[str, Type[Bot]]`
-
-
-
-* **说明**
-
-    已注册的适配器列表
-
-
-
-### `_ws_connection_hook`
-
-
-* **类型**
-
-    `Set[T_WebSocketConnectionHook]`
-
-
-
-* **说明**
-
-    WebSocket 连接建立时执行的函数
-
-
-
-### `_ws_disconnection_hook`
-
-
-* **类型**
-
-    `Set[T_WebSocketDisconnectionHook]`
-
-
-
-* **说明**
-
-    WebSocket 连接断开时执行的函数
-
-
-
-### _abstract_ `__init__(env, config)`
-
-
-* **参数**
-
-    
-    * `env: Env`: 包含环境信息的 Env 对象
-
-
-    * `config: Config`: 包含配置信息的 Config 对象
-
-
-
-### `env`
-
-
-* **类型**
-
-    `str`
-
-
-
-* **说明**
-
-    环境名称
-
-
-
-### `config`
-
-
-* **类型**
-
-    `Config`
-
-
-
-* **说明**
-
-    配置对象
-
-
-
-### `_clients`
-
-
-* **类型**
-
-    `Dict[str, Bot]`
-
-
-
-* **说明**
-
-    已连接的 Bot
-
-
-
-### _classmethod_ `register_adapter(name, adapter)`
-
-
-* **说明**
-
-    注册一个协议适配器
-
-
-
-* **参数**
-
-    
-    * `name: str`: 适配器名称，用于在连接时进行识别
-
-
-    * `adapter: Type[Bot]`: 适配器 Class
-
-
-
-### _abstract property_ `type`
-
-驱动类型名称
-
-
-### _abstract property_ `server_app`
-
-驱动 APP 对象
-
-
-### _abstract property_ `asgi`
-
-驱动 ASGI 对象
-
-
-### _abstract property_ `logger`
-
-驱动专属 logger 日志记录器
-
-
-### _property_ `bots`
-
-
-* **类型**
-
-    `Dict[str, Bot]`
-
-
-
-* **说明**
-
-    获取当前所有已连接的 Bot
-
-
-
-### _abstract_ `on_startup(func)`
-
-注册一个在驱动启动时运行的函数
-
-
-### _abstract_ `on_shutdown(func)`
-
-注册一个在驱动停止时运行的函数
-
-
-### `on_bot_connect(func)`
-
-
-* **说明**
-
-    装饰一个函数使他在 bot 通过 WebSocket 连接成功时执行。
-
-
-
-* **函数参数**
-
-    
-    * `bot: Bot`: 当前连接上的 Bot 对象
-
-
-
-### `on_bot_disconnect(func)`
-
-
-* **说明**
-
-    装饰一个函数使他在 bot 通过 WebSocket 连接断开时执行。
-
-
-
-* **函数参数**
-
-    
-    * `bot: Bot`: 当前连接上的 Bot 对象
-
-
-
-### `_bot_connect(bot)`
-
-在 WebSocket 连接成功后，调用该函数来注册 bot 对象
-
-
-### `_bot_disconnect(bot)`
-
-在 WebSocket 连接断开后，调用该函数来注销 bot 对象
-
-
-### _abstract_ `run(host=None, port=None, *args, **kwargs)`
-
-
-* **说明**
-
-    启动驱动框架
-
-
-
-* **参数**
-
-    
-    * `host: Optional[str]`: 驱动绑定 IP
-
-
-    * `post: Optional[int]`: 驱动绑定端口
-
-
-    * `*args`
-
-
-    * `**kwargs`
-
-
-
-### _abstract async_ `_handle_http()`
-
-用于处理 HTTP 类型请求的函数
-
-
-### _abstract async_ `_handle_ws_reverse()`
-
-用于处理 WebSocket 类型请求的函数
-
-
-## _class_ `WebSocket`
-
-基类：`object`
-
-WebSocket 连接封装，统一接口方便外部调用。
-
-
-### _abstract_ `__init__(websocket)`
-
-
-* **参数**
-
-    
-    * `websocket: Any`: WebSocket 连接对象
-
-
-
-### _property_ `websocket`
-
-WebSocket 连接对象
-
-
-### _abstract property_ `closed`
-
-
-* **类型**
-
-    `bool`
-
-
-
-* **说明**
-
-    连接是否已经关闭
-
-
-
-### _abstract async_ `accept()`
-
-接受 WebSocket 连接请求
-
-
-### _abstract async_ `close(code)`
-
-关闭 WebSocket 连接请求
-
-
-### _abstract async_ `receive()`
-
-接收一条 WebSocket 信息
-
-
-### _abstract async_ `send(data)`
-
-发送一条 WebSocket 信息

archive/2.0.0a8.post2/api/drivers/fastapi.md

@@ -1,68 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.drivers.fastapi 模块
-
-## FastAPI 驱动适配
-
-后端使用方法请参考: [FastAPI 文档](https://fastapi.tiangolo.com/)
-
-
-## _class_ `Driver`
-
-基类：[`nonebot.drivers.Driver`](README.md#nonebot.drivers.Driver)
-
-FastAPI 驱动框架
-
-
-* **上报地址**
-
-    
-    * `/{adapter name}/`: HTTP POST 上报
-
-
-    * `/{adapter name}/http/`: HTTP POST 上报
-
-
-    * `/{adapter name}/ws`: WebSocket 上报
-
-
-    * `/{adapter name}/ws/`: WebSocket 上报
-
-
-
-### _property_ `type`
-
-驱动名称: `fastapi`
-
-
-### _property_ `server_app`
-
-`FastAPI APP` 对象
-
-
-### _property_ `asgi`
-
-`FastAPI APP` 对象
-
-
-### _property_ `logger`
-
-fastapi 使用的 logger
-
-
-### `on_startup(func)`
-
-参考文档: [Events](https://fastapi.tiangolo.com/advanced/events/#startup-event)
-
-
-### `on_shutdown(func)`
-
-参考文档: [Events](https://fastapi.tiangolo.com/advanced/events/#startup-event)
-
-
-### `run(host=None, port=None, *, app=None, **kwargs)`
-
-使用 `uvicorn` 启动 FastAPI

archive/2.0.0a8.post2/api/exception.md

@@ -1,193 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.exception 模块
-
-## 异常
-
-下列文档中的异常是所有 NoneBot 运行时可能会抛出的。
-这些异常并非所有需要用户处理，在 NoneBot 内部运行时被捕获，并进行对应操作。
-
-
-## _exception_ `NoneBotException`
-
-基类：`Exception`
-
-
-* **说明**
-
-    所有 NoneBot 发生的异常基类。
-
-
-
-## _exception_ `IgnoredException`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
-
-
-
-* **参数**
-
-    
-    * `reason`: 忽略事件的原因
-
-
-
-## _exception_ `PausedException`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    指示 NoneBot 结束当前 `Handler` 并等待下一条消息后继续下一个 `Handler`。
-    可用于用户输入新信息。
-
-
-
-* **用法**
-
-    可以在 `Handler` 中通过 `Matcher.pause()` 抛出。
-
-
-
-## _exception_ `RejectedException`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    指示 NoneBot 结束当前 `Handler` 并等待下一条消息后重新运行当前 `Handler`。
-    可用于用户重新输入。
-
-
-
-* **用法**
-
-    可以在 `Handler` 中通过 `Matcher.reject()` 抛出。
-
-
-
-## _exception_ `FinishedException`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    指示 NoneBot 结束当前 `Handler` 且后续 `Handler` 不再被运行。
-    可用于结束用户会话。
-
-
-
-* **用法**
-
-    可以在 `Handler` 中通过 `Matcher.finish()` 抛出。
-
-
-
-## _exception_ `StopPropagation`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    指示 NoneBot 终止事件向下层传播。
-
-
-
-* **用法**
-
-    在 `Matcher.block == True` 时抛出。
-
-
-
-## _exception_ `RequestDenied`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    Bot 连接请求不合法。
-
-
-
-* **参数**
-
-    
-    * `status_code: int`: HTTP 状态码
-
-
-    * `reason: str`: 拒绝原因
-
-
-
-## _exception_ `AdapterException`
-
-基类：`nonebot.exception.NoneBotException`
-
-
-* **说明**
-
-    代表 `Adapter` 抛出的异常，所有的 `Adapter` 都要在内部继承自这个 `Exception`
-
-
-
-* **参数**
-
-    
-    * `adapter_name: str`: 标识 adapter
-
-
-
-## _exception_ `NoLogException`
-
-基类：`Exception`
-
-
-* **说明**
-
-    指示 NoneBot 对当前 `Event` 进行处理但不显示 Log 信息，可在 `get_log_string` 时抛出
-
-
-
-## _exception_ `ApiNotAvailable`
-
-基类：`nonebot.exception.AdapterException`
-
-
-* **说明**
-
-    在 API 连接不可用时抛出。
-
-
-
-## _exception_ `NetworkError`
-
-基类：`nonebot.exception.AdapterException`
-
-
-* **说明**
-
-    在网络出现问题时抛出，如: API 请求地址不正确, API 请求无返回或返回状态非正常等。
-
-
-
-## _exception_ `ActionFailed`
-
-基类：`nonebot.exception.AdapterException`
-
-
-* **说明**
-
-    API 请求成功返回数据，但 API 操作失败。

archive/2.0.0a8.post2/api/log.md

@@ -1,42 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.log 模块
-
-## 日志
-
-NoneBot 使用 [loguru](https://github.com/Delgan/loguru) 来记录日志信息。
-
-自定义 logger 请参考 [loguru](https://github.com/Delgan/loguru) 文档。
-
-
-## `logger`
-
-
-* **说明**
-
-    NoneBot 日志记录器对象。
-
-
-
-* **默认信息**
-
-    
-    * 格式: `[%(asctime)s %(name)s] %(levelname)s: %(message)s`
-
-
-    * 等级: `DEBUG` / `INFO` ，根据 config 配置改变
-
-
-    * 输出: 输出至 stdout
-
-
-
-* **用法**
-
-
-```python
-from nonebot.log import logger
-```

archive/2.0.0a8.post2/api/matcher.md

@@ -1,470 +0,0 @@
----
-contentSidebar: true
-sidebarDepth: 0
----
-
-# NoneBot.matcher 模块
-
-## 事件响应器
-
-该模块实现事件响应器的创建与运行，并提供一些快捷方法来帮助用户更好的与机器人进行 对话 。
-
-
-## `matchers`
-
-
-* **类型**
-
-    `Dict[int, List[Type[Matcher]]]`
-
-
-
-* **说明**
-
-    用于存储当前所有的事件响应器
-
-
-
-## _class_ `Matcher`
-
-基类：`object`
-
-事件响应器类
-
-
-### `module`
-
-
-* **类型**
-
-    `Optional[str]`
-
-
-
-* **说明**
-
-    事件响应器所在模块名称
-
-
-
-### `type`
-
-
-* **类型**
-
-    `str`
-
-
-
-* **说明**
-
-    事件响应器类型
-
-
-
-### `rule`
-
-
-* **类型**
-
-    `Rule`
-
-
-
-* **说明**
-
-    事件响应器匹配规则
-
-
-
-### `permission`
-
-
-* **类型**
-
-    `Permission`
-
-
-
-* **说明**
-
-    事件响应器触发权限
-
-
-
-### `priority`
-
-
-* **类型**
-
-    `int`
-
-
-
-* **说明**
-
-    事件响应器优先级
-
-
-
-### `block`
-
-
-* **类型**
-
-    `bool`
-
-
-
-* **说明**
-
-    事件响应器是否阻止事件传播
-
-
-
-### `temp`
-
-
-* **类型**
-
-    `bool`
-
-
-
-* **说明**
-
-    事件响应器是否为临时
-
-
-
-### `expire_time`
-
-
-* **类型**
-
-    `Optional[datetime]`
-
-
-
-* **说明**
-
-    事件响应器过期时间点
-
-
-
-### `_default_state`
-
-
-* **类型**
-
-    `T_State`
-
-
-
-* **说明**
-
-    事件响应器默认状态
-
-
-
-### `_default_state_factory`
-
-
-* **类型**
-
-    `Optional[T_State]`
-
-
-
-* **说明**
-
-    事件响应器默认工厂函数
-
-
-
-### `_default_parser`
-
-
-* **类型**
-
-    `Optional[T_ArgsParser]`
-
-
-
-* **说明**
-
-    事件响应器默认参数解析函数
-
-
-
-### `__init__()`
-
-实例化 Matcher 以便运行
-
-
-### `handlers`
-
-
-* **类型**
-
-    `List[T_Handler]`
-
-
-
-* **说明**
-
-    事件响应器拥有的事件处理函数列表
-
-
-
-### _classmethod_ `new(type_='', rule=None, permission=None, handlers=None, temp=False, priority=1, block=False, *, module=None, default_state=None, default_state_factory=None, expire_time=None)`
-
-
-* **说明**
-
-    创建一个新的事件响应器，并存储至 [matchers](#matchers)
-
-
-
-* **参数**
-
-    
-    * `type_: str`: 事件响应器类型，与 `event.get_type()` 一致时触发，空字符串表示任意
-
-
-    * `rule: Optional[Rule]`: 匹配规则
-
-
-    * `permission: Optional[Permission]`: 权限
-
-
-    * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
-
-
-    * `temp: bool`: 是否为临时事件响应器，即触发一次后删除
-
-
-    * `priority: int`: 响应优先级
-
-
-    * `block: bool`: 是否阻止事件向更低优先级的响应器传播
-
-
-    * `module: Optional[str]`: 事件响应器所在模块名称
-
-
-    * `default_state: Optional[T_State]`: 默认状态 `state`
-
-
-    * `default_state_factory: Optional[T_StateFactory]`: 默认状态 `state` 的工厂函数
-
-
-    * `expire_time: Optional[datetime]`: 事件响应器最终有效时间点，过时即被删除
-
-
-
-* **返回**
-
-    
-    * `Type[Matcher]`: 新的事件响应器类
-
-
-
-### _async classmethod_ `check_perm(bot, event)`
-
-
-* **说明**
-
-    检查是否满足触发权限
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: 上报事件
-
-
-
-* **返回**
-
-    
-    * `bool`: 是否满足权限
-
-
-
-### _async classmethod_ `check_rule(bot, event, state)`
-
-
-* **说明**
-
-    检查是否满足匹配规则
-
-
-
-* **参数**
-
-    
-    * `bot: Bot`: Bot 对象
-
-
-    * `event: Event`: 上报事件
-
-
-    * `state: T_State`: 当前状态
-
-
-
-* **返回**
-
-    
-    * `bool`: 是否满足匹配规则
-
-
-
-### _classmethod_ `args_parser(func)`
-
-
-* **说明**
-
-    装饰一个函数来更改当前事件响应器的默认参数解析函数
-
-
-
-* **参数**
-
-    
-    * `func: T_ArgsParser`: 参数解析函数
-
-
-
-### _classmethod_ `handle()`
-
-
-* **说明**
-
-    装饰一个函数来向事件响应器直接添加一个处理函数
-
-
-
-* **参数**
-
-    
-    * 无
-
-
-
-### _classmethod_ `receive()`
-
-
-* **说明**
-
-    装饰一个函数来指示 NoneBot 在接收用户新的一条消息后继续运行该函数
-
-
-
-* **参数**
-
-    
-    * 无
-
-
-
-### _classmethod_ `got(key, prompt=None, args_parser=None)`
-
-
-* **说明**
-
-    装饰一个函数来指示 NoneBot 当要获取的 `key` 不存在时接收用户新的一条消息并经过 `ArgsParser` 处理后再运行该函数，如果 `key` 已存在则直接继续运行
-
-
-
-* **参数**
-
-    
-    * `key: str`: 参数名
-
-
-    * `prompt: Optional[Union[str, Message, MessageSegment]]`: 在参数不存在时向用户发送的消息
-
-
-    * `args_parser: Optional[T_ArgsParser]`: 可选参数解析函数，空则使用默认解析函数
-
-
-
-### _async classmethod_ `send(message, **kwargs)`
-
-
-* **说明**
-
-    发送一条消息给当前交互用户
-
-
-
-* **参数**
-
-    
-    * `message: Union[str, Message, MessageSegment]`: 消息内容
-
-
-    * `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
-
-
-
-### _async classmethod_ `finish(message=None, **kwargs)`
-
-
-* **说明**
-
-    发送一条消息给当前交互用户并结束当前事件响应器
-
-
-
-* **参数**
-
-    
-    * `message: Union[str, Message, MessageSegment]`: 消息内容
-
-
-    * `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
-
-
-
-### _async classmethod_ `pause(prompt=None, **kwargs)`
-
-
-* **说明**
-
-    发送一条消息给当前交互用户并暂停事件响应器，在接收用户新的一条消息后继续下一个处理函数
-
-
-
-* **参数**
-
-    
-    * `prompt: Union[str, Message, MessageSegment]`: 消息内容
-
-
-    * `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
-
-
-
-### _async classmethod_ `reject(prompt=None, **kwargs)`
-
-
-* **说明**
-
-    发送一条消息给当前交互用户并暂停事件响应器，在接收用户新的一条消息后重新运行当前处理函数
-
-
-
-* **参数**
-
-    
-    * `prompt: Union[str, Message, MessageSegment]`: 消息内容
-
-
-    * `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api