📝 docs: standardized code text

Author: ProgramRipper

README.md

@@ -90,18 +90,18 @@ Options:
 Commands:
   branches        显示所有的分支。
   check           检查数据库是否与模型定义一致。
-  current         显示当前的修订。
+  current         显示当前的迁移。
   downgrade       回退到先前版本。
-  edit            使用 $EDITOR 编辑修订文件。
+  edit            使用 $EDITOR 编辑迁移脚本。
   ensure_version  创建版本表。
   heads           显示所有的分支头。
-  history         显示修订的历史。
+  history         显示迁移的历史。
   init            初始化脚本目录。
   list_templates  列出所有可用的模板。
-  merge           合并多个修订。创建一个新的修订文件。
-  revision        创建一个新修订文件。
-  show            显示修订的信息。
-  stamp           将数据库标记为特定的修订版本，不运行任何迁移。
+  merge           合并多个迁移。创建一个新的迁移脚本。
+  revision        创建一个新迁移脚本。
+  show            显示迁移的信息。
+  stamp           将数据库标记为特定的迁移版本，不运行任何迁移。
   upgrade         升级到较新版本。
 ```
 

nonebot_plugin_orm/__init__.py

@@ -84,9 +84,13 @@ async def init_orm() -> None:
 
     with migrate.AlembicConfig(stdout=StreamToLogger()) as alembic_config:
         if plugin_config.alembic_startup_check:
-            await greenlet_spawn(migrate.check, alembic_config)
+            try:
+                await greenlet_spawn(migrate.check, alembic_config)
+            except click.UsageError:
+                logger.error("启动检查失败")
+                raise
         else:
-            logger.warning("跳过启动检查，正在同步数据库模式...")
+            logger.warning("跳过启动检查, 正在同步数据库模式...")
             await greenlet_spawn(migrate.sync, alembic_config)
 
 
@@ -171,7 +175,8 @@ def _init_engines():
         from nonebot_plugin_localstore import get_data_file
     except (ImportError, RuntimeError):
         raise ValueError(
-            '必须指定一个默认数据库引擎 (SQLALCHEMY_DATABASE_URL 或 SQLALCHEMY_BINDS[""])'
+            '必须指定一个默认数据库 (SQLALCHEMY_DATABASE_URL 或 SQLALCHEMY_BINDS[""]). '
+            "可以通过 `pip install nonebot-plugin-orm[default]` 获得开箱即用的数据库配置."
         ) from None
 
     _engines[""] = _create_engine(

nonebot_plugin_orm/__main__.py

@@ -19,7 +19,7 @@
     "--config",
     envvar="ALEMBIC_CONFIG",
     type=click.Path(exists=True, dir_okay=False, path_type=Path),
-    help='可选的配置文件；默认为 ALEMBIC_CONFIG 环境变量的值，或者 "alembic.ini"（如果存在）',
+    help='可选的配置文件; 默认为 ALEMBIC_CONFIG 环境变量的值, 或者 "alembic.ini" (如果存在)',
 )
 @click.option(
     "-n",
@@ -31,7 +31,7 @@
 @click.option(
     "-x",
     multiple=True,
-    help="自定义 env.py 脚本使用的其他参数，例如：-x setting1=somesetting -x setting2=somesetting",
+    help="自定义 env.py 脚本使用的其他参数, 例如：-x setting1=somesetting -x setting2=somesetting",
 )
 @click.option("-q", "--quite", is_flag=True, help="不要输出日志到标准输出")
 @click.pass_context
@@ -67,7 +67,8 @@ def move_script(config_: AlembicConfig, scripts: Iterable[Script] | None, **_) -
 @orm.command("list_templates")
 @click.pass_obj
 def list_templates(*args, **kwargs) -> None:
-    """列出所有可用的模板。"""
+    """列出所有可用的模板."""
+
     return migrate.list_templates(*args, **kwargs)
 
 
@@ -81,143 +82,158 @@ def list_templates(*args, **kwargs) -> None:
 @click.option("--package", is_flag=True, help="在脚本目录和版本目录中创建 __init__.py 文件")
 @click.pass_obj
 def init(*args, **kwargs) -> None:
-    """初始化脚本目录。"""
+    """初始化脚本目录."""
+
     return migrate.init(*args, **kwargs)
 
 
 @orm.command()
 @click.option("-m", "--message", help="描述")
-@click.option("--sql", is_flag=True, help="以 SQL 的形式输出修订脚本")
+@click.option("--sql", is_flag=True, help="以 SQL 的形式输出迁移脚本")
 @click.option("--head", help="基准版本")
-@click.option("--splice", is_flag=True, help="允许非头部修订作为基准版本")
+@click.option("--splice", is_flag=True, help="允许非头部迁移作为基准版本")
 @click.option("--branch-label", help="分支标签")
 @click.option(
     "--version-path",
     default=None,
     type=click.Path(file_okay=False, writable=True, resolve_path=True, path_type=Path),
-    help="存放修订文件的目录",
+    help="存放迁移脚本的目录",
 )
-@click.option("--rev-id", help="指定而不是使用生成的修订 ID")
-@click.option("--depends-on", help="依赖的修订")
+@click.option("--rev-id", help="指定而不是使用生成的迁移 ID")
+@click.option("--depends-on", help="依赖的迁移")
 @click.pass_obj
 def revision(*args, **kwargs) -> Iterable[Script]:
-    """创建一个新修订文件。"""
+    """创建一个新迁移脚本."""
+
     return migrate.revision(*args, **kwargs)
 
 
 @orm.command()
 @click.pass_obj
 def check(*args, **kwargs) -> None:
-    """检查数据库是否与模型定义一致。"""
+    """检查数据库是否与模型定义一致."""
+
     return migrate.check(*args, **kwargs)
 
 
 @orm.command()
 @click.argument("revisions", nargs=-1)
 @click.option("-m", "--message", help="描述")
 @click.option("--branch-label", help="分支标签")
-@click.option("--rev-id", help="指定而不是使用生成的修订 ID")
+@click.option("--rev-id", help="指定而不是使用生成的迁移 ID")
 @click.pass_obj
 def merge(*args, **kwargs) -> Iterable[Script]:
-    """合并多个修订。创建一个新的修订文件。"""
+    """合并多个迁移.创建一个新的迁移脚本."""
+
     return migrate.merge(*args, **kwargs)
 
 
 @orm.command()
 @click.argument("revision", required=False)
-@click.option("--sql", is_flag=True, help="以 SQL 的形式输出修订脚本")
+@click.option("--sql", is_flag=True, help="以 SQL 的形式输出迁移脚本")
 @click.option("--tag", help="一个任意的字符串, 可在自定义的 env.py 中使用")
 @click.pass_obj
 def upgrade(*args, **kwargs) -> None:
-    """升级到较新版本。"""
+    """升级到较新版本."""
+
     return migrate.upgrade(*args, **kwargs)
 
 
 @orm.command()
 @click.argument("revision")
-@click.option("--sql", is_flag=True, help="以 SQL 的形式输出修订脚本")
+@click.option("--sql", is_flag=True, help="以 SQL 的形式输出迁移脚本")
 @click.option("--tag", help="一个任意的字符串, 可在自定义的 env.py 中使用")
 @click.pass_obj
 def downgrade(*args, **kwargs) -> None:
-    """回退到先前版本。"""
+    """回退到先前版本."""
+
     return migrate.downgrade(*args, **kwargs)
 
 
 @orm.command()
 @click.argument("revision", required=False)
 @click.pass_obj
 def sync(*args, **kwargs) -> None:
-    """同步数据库模式 (仅用于开发)。"""
+    """同步数据库模式 (仅用于开发)."""
+
     return migrate.sync(*args, **kwargs)
 
 
 @orm.command()
 @click.argument("revs", nargs=-1)
 @click.pass_obj
 def show(*args, **kwargs) -> None:
-    """显示修订的信息。"""
+    """显示迁移的信息."""
+
     return migrate.show(*args, **kwargs)
 
 
 @orm.command()
 @click.option("-r", "--rev-range", required=False, help="范围")
 @click.option("-v", "--verbose", is_flag=True, help="显示详细信息")
-@click.option("-i", "--indicate-current", is_flag=True, help="指示出当前修订")
+@click.option("-i", "--indicate-current", is_flag=True, help="指示出当前迁移")
 @click.pass_obj
 def history(*args, **kwargs) -> None:
-    """显示修订的历史。"""
+    """显示迁移的历史."""
+
     return migrate.history(*args, **kwargs)
 
 
 @orm.command()
 @click.option("-v", "--verbose", is_flag=True, help="显示详细信息")
-@click.option("--resolve-dependencies", is_flag=True, help="将依赖的修订视作父修订")
+@click.option("--resolve-dependencies", is_flag=True, help="将依赖的迁移视作父迁移")
 @click.pass_obj
 def heads(*args, **kwargs) -> None:
-    """显示所有的分支头。"""
+    """显示所有的分支头."""
+
     return migrate.heads(*args, **kwargs)
 
 
 @orm.command()
 @click.option("-v", "--verbose", is_flag=True, help="显示详细信息")
 @click.pass_obj
 def branches(*args, **kwargs) -> None:
-    """显示所有的分支。"""
+    """显示所有的分支."""
+
     return migrate.branches(*args, **kwargs)
 
 
 @orm.command()
 @click.option("-v", "--verbose", is_flag=True, help="显示详细信息")
 @click.pass_obj
 def current(*args, **kwargs) -> None:
-    """显示当前的修订。"""
+    """显示当前的迁移."""
+
     return migrate.current(*args, **kwargs)
 
 
 @orm.command()
 @click.argument("revisions", nargs=-1)
-@click.option("--sql", is_flag=True, help="以 SQL 的形式输出修订脚本")
+@click.option("--sql", is_flag=True, help="以 SQL 的形式输出迁移脚本")
 @click.option("--tag", help="一个任意的字符串, 可在自定义的 env.py 中使用")
 @click.option("--purge", is_flag=True, help="在标记前清空数据库版本表")
 @click.pass_obj
 def stamp(*args, **kwargs) -> None:
-    """将数据库标记为特定的修订版本，不运行任何迁移。"""
+    """将数据库标记为特定的迁移版本, 不运行任何迁移."""
+
     return migrate.stamp(*args, **kwargs)
 
 
 @orm.command()
 @click.argument("rev", default="current")
 @click.pass_obj
 def edit(*args, **kwargs) -> None:
-    """使用 $EDITOR 编辑修订文件。"""
+    """使用 $EDITOR 编辑迁移脚本."""
+
     return migrate.edit(*args, **kwargs)
 
 
 @orm.command("ensure_version")
-@click.option("--sql", is_flag=True, help="以 SQL 的形式输出修订脚本")
+@click.option("--sql", is_flag=True, help="以 SQL 的形式输出迁移脚本")
 @click.pass_obj
 def ensure_version(*args, **kwargs) -> None:
-    """创建版本表。"""
+    """创建版本表."""
+
     return migrate.ensure_version(*args, **kwargs)