rbm_tools 0.0.0__tar.gz

rbm_tools-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DeepSeek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

rbm_tools-0.0.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: rbm_tools
+Version: 0.0.0
+Summary: 
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.13,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: aiomysql (>=0.3.2,<0.4.0)
+Requires-Dist: click (>=8.5.0,<9.0.0)
+Requires-Dist: fastapi (>=0.141.1,<0.142.0)
+Requires-Dist: func_timeout (>=4.3.5,<5.0.0)
+Requires-Dist: gunicorn (>=26.2.0,<27.0.0)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: jsonargparse (==4.52.0)
+Requires-Dist: openai (>=3.13.0,<4.0.0)
+Requires-Dist: opentelemetry-exporter-otlp-proto-http (>=1.44.0,<2.0.0)
+Requires-Dist: opentelemetry-instrumentation-fastapi (>=0.65b0,<0.66)
+Requires-Dist: opentelemetry-instrumentation-logging (>=0.65b0,<0.66)
+Requires-Dist: opentelemetry-instrumentation-openai (>=0.62.3,<0.63.0)
+Requires-Dist: pre-commit (>=4.6.2,<5.0.0)
+Requires-Dist: prometheus-fastapi-instrumentator (>=8.1.0,<9.0.0)
+Requires-Dist: pydantic (>=2.13.5,<3.0.0)
+Requires-Dist: pydantic-settings (>=2.15.0,<3.0.0)
+Requires-Dist: pymysql (>=1.2.3,<2.0.0)
+Requires-Dist: redis (>=8.1.0,<9.0.0)
+Requires-Dist: setuptools (==78.1.1)
+Requires-Dist: sqlalchemy (>=2.0.54,<3.0.0)
+Requires-Dist: sqlmodel (>=0.0.42,<0.0.43)
+Requires-Dist: starlette-context (>=0.5.1,<0.6.0)
+Requires-Dist: starlette_exporter (>=0.24.0,<0.25.0)
+Requires-Dist: uvicorn (>=0.53.0,<0.54.0)
+Description-Content-Type: text/markdown
+
+## 1. 开发环境 Get Started
+### 1.1 使用 Anaconda 安装 python 3.13
+
+```
+conda remove -n py313 --all
+conda create -n py313 python=3.13
+source activate py313
+```
+
+### 1.2 安装 VS Code 插件
+
+详见文件 .vscode/extensions.json 中的 recommendations 配置
+
+### 1.3 设置 VS Code
+
+详见文件 .vscode/setting.json
+
+### 1.4 依赖管理 poetry
+
+```
+python -m pip install poetry==2.4.1
+poetry install --no-root
+```
+
+### 1.5 pre-commit
+
+```
+# Install pre-commit
+python -m pip install pre-commit
+# Install libcst (only-binary if you don't have rust compiler)
+python -m pip install --only-binary=:all: libcst
+# Execute below command at root directory to install git hooks into your `.git/` directory.
+pre-commit install --config ./.pre-commit-config.yaml
+```
+
+
+## 2. 代码风格
+### 规则
+
+- 必须按照该文档的 `开发环境 Get Started` 准备好开发环境
+- VS Code 飘红提示必须解决，遇到 python 语言特性导致的飘红可以使用 `# type: ignore` 或 `# pylint: disable=W0212` 忽略
+- 函数的出入参必须要有类型声明
+- 写注释时，字母和汉字之间需要有一个空格
+
+
+## 其他
+### poetry 的注意事项
+
+其他可能会用到的命令
+
+```
+# 增加依赖
+poetry add {依赖名}
+ 
+# 安装依赖
+poetry install
+
+# 更新依赖
+poetry update {依赖名}
+
+# 删除依赖
+poetry remove {依赖名}
+
+# 环境信息
+poetry env info
+
+# 展示依赖版本
+poetry show -t
+```
+
+如果 poetry.lock 文件冲突，应该删除 `rm poetry.lock` 并使用 `poetry update` 重新生成 poetry.lock 文件
+
+### sdk 开发和发版
+
+```
+# 开发 sdk 时为了解决 python 项目的路径问题，需要运行下面这个命令（**千万注意修改的代码是不是该项目中的代码**）
+cd ..
+pip install -e ./rbm_tools
+
+# sdk 发版
+cd ./rbm_tools
+vi pyproject.toml # 修改 sdk pyproject.toml 的 version
+./build.sh
+
+# 修改项目中使用的 sdk 版本
+vi pyproject.toml # 修改 pyproject.toml sdk 的 version
+rm poetry.lock
+poetry update
+```
+

rbm_tools-0.0.0/README.md

@@ -0,0 +1,89 @@
+## 1. 开发环境 Get Started
+### 1.1 使用 Anaconda 安装 python 3.13
+
+```
+conda remove -n py313 --all
+conda create -n py313 python=3.13
+source activate py313
+```
+
+### 1.2 安装 VS Code 插件
+
+详见文件 .vscode/extensions.json 中的 recommendations 配置
+
+### 1.3 设置 VS Code
+
+详见文件 .vscode/setting.json
+
+### 1.4 依赖管理 poetry
+
+```
+python -m pip install poetry==2.4.1
+poetry install --no-root
+```
+
+### 1.5 pre-commit
+
+```
+# Install pre-commit
+python -m pip install pre-commit
+# Install libcst (only-binary if you don't have rust compiler)
+python -m pip install --only-binary=:all: libcst
+# Execute below command at root directory to install git hooks into your `.git/` directory.
+pre-commit install --config ./.pre-commit-config.yaml
+```
+
+
+## 2. 代码风格
+### 规则
+
+- 必须按照该文档的 `开发环境 Get Started` 准备好开发环境
+- VS Code 飘红提示必须解决，遇到 python 语言特性导致的飘红可以使用 `# type: ignore` 或 `# pylint: disable=W0212` 忽略
+- 函数的出入参必须要有类型声明
+- 写注释时，字母和汉字之间需要有一个空格
+
+
+## 其他
+### poetry 的注意事项
+
+其他可能会用到的命令
+
+```
+# 增加依赖
+poetry add {依赖名}
+ 
+# 安装依赖
+poetry install
+
+# 更新依赖
+poetry update {依赖名}
+
+# 删除依赖
+poetry remove {依赖名}
+
+# 环境信息
+poetry env info
+
+# 展示依赖版本
+poetry show -t
+```
+
+如果 poetry.lock 文件冲突，应该删除 `rm poetry.lock` 并使用 `poetry update` 重新生成 poetry.lock 文件
+
+### sdk 开发和发版
+
+```
+# 开发 sdk 时为了解决 python 项目的路径问题，需要运行下面这个命令（**千万注意修改的代码是不是该项目中的代码**）
+cd ..
+pip install -e ./rbm_tools
+
+# sdk 发版
+cd ./rbm_tools
+vi pyproject.toml # 修改 sdk pyproject.toml 的 version
+./build.sh
+
+# 修改项目中使用的 sdk 版本
+vi pyproject.toml # 修改 pyproject.toml sdk 的 version
+rm poetry.lock
+poetry update
+```

rbm_tools-0.0.0/pyproject.toml

@@ -0,0 +1,45 @@
+[tool.poetry]
+name = "rbm_tools"
+version = "0.0.0"
+description = ""
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+aiomysql = "^0.3.2"
+click = "^8.5.0"
+fastapi = "^0.141.1"
+func_timeout = "^4.3.5"
+gunicorn = "^26.2.0"
+httpx = "^0.28.1"
+jsonargparse = "4.52.0"
+openai = "^3.13.0"
+opentelemetry-exporter-otlp-proto-http = "^1.44.0"
+opentelemetry-instrumentation-fastapi = "^0.65b0"
+opentelemetry-instrumentation-logging = "^0.65b0"
+opentelemetry-instrumentation-openai = "^0.62.3"
+pre-commit = "^4.6.2"
+prometheus-fastapi-instrumentator = "^8.1.0"
+pydantic = "^2.13.5"
+pydantic-settings = "^2.15.0"
+pymysql = "^1.2.3"
+python = "^3.13"
+redis = "^8.1.0"
+setuptools = "78.1.1"
+sqlalchemy = "^2.0.54"
+sqlmodel = "^0.0.42"
+starlette_exporter = "^0.24.0"
+starlette-context = "^0.5.1"
+uvicorn = "^0.53.0"
+
+[[tool.poetry.source]]
+name = "backup_pypi"
+url = "https://pypi.org/simple"
+priority = "primary"
+
+[tool.poetry.scripts]
+rbm_tools = "rbm_tools.client.rbm_tools_cli:main"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

rbm_tools-0.0.0/rbm_tools/__init__.py

@@ -0,0 +1,5 @@
+"""
+定义 sdk 为 python 的一个包，注意导包顺序，必须保证 logger 最先导包，否则会导致 opentelemetry 注册失效
+"""
+
+from rbm_tools import logger

rbm_tools-0.0.0/rbm_tools/client/rbm_tools_cli.py

@@ -0,0 +1,51 @@
+"""
+命令行工具类
+"""
+import sys
+import os
+
+from jsonargparse import auto_cli
+from rbm_tools.client.sort_class_methods import reorder_class_methods
+
+class RBMToolsCLI:
+    """
+    命令行工具类
+    """
+    def __init__(self):
+        pass
+
+    def check_code_style(self):
+        """
+        检查代码风格
+        """
+        success_flag = True
+        directory = os.getcwd()
+        entries = os.listdir(directory)
+        # 只看 py 文件
+        filename_list = [
+            os.path.join(directory, i) for i in entries
+            if os.path.isfile(os.path.join(directory, i)) and i.endswith(".py")
+        ]
+        for filename in filename_list:
+            # 检查对象的成员方法排序
+            old_code = ""
+            with open(filename, "r", encoding="utf-8") as f:
+                old_code = f.read()
+            new_code = reorder_class_methods(old_code)
+            with open(filename, "w", encoding="utf-8") as f:
+                f.write(new_code)
+            if old_code != new_code:
+                success_flag = False
+        if success_flag:
+            sys.exit(0)
+        else:
+            sys.exit(1)
+
+def main():
+    """
+    入口函数
+    """
+    auto_cli(RBMToolsCLI)
+
+if __name__ == "__main__":
+    main()

rbm_tools-0.0.0/rbm_tools/client/sort_class_methods.py

@@ -0,0 +1,78 @@
+"""
+自动整理 Python 类中的方法顺序
+
+依赖：
+    需要安装 libcst 库（pip install libcst）
+
+适用场景：
+    适用于需要规范化类方法顺序、提升代码可读性和维护性的场景
+"""
+
+import libcst as cst
+import libcst.matchers as m
+
+
+class ClassMethodSorter(cst.CSTTransformer):
+    """
+    一个 CSTTransformer，用于对每个类中的方法按如下规则排序：
+    1. 魔法方法（即名称前后都有双下划线，如 __init__、__str__ 等），按名称排序，排在最前面；
+    2. 公共方法（不以下划线开头），按名称排序，排在中间；
+    3. 私有方法（以下划线开头，但不是魔法方法），按名称排序，排在最后；
+    其他类成员（如属性、docstring、嵌套类等）保持原有顺序，并始终排在方法之前。
+    """
+
+    def leave_ClassDef(self, original_node, updated_node):
+        """
+        在离开类定义节点时，对类体中的方法按指定规则排序。
+        非方法成员保持原有顺序，并排在方法之前。
+
+        :param original_node: 原始的 ClassDef 节点
+        :param updated_node: 可能已被修改的 ClassDef 节点
+        :return: 排序后的新的 ClassDef 节点
+        """
+        # 分离方法和其他成员
+        magic_methods = []
+        public_methods = []
+        private_methods = []
+        others = []
+        for stmt in updated_node.body.body:
+            if m.matches(stmt, m.FunctionDef()):
+                name = stmt.name.value  # type: ignore
+                # 魔法方法：前后都有双下划线
+                if name.startswith("__") and name.endswith("__"):
+                    magic_methods.append(stmt)
+                # 私有方法：以单下划线或双下划线开头，但不是魔法方法
+                elif name.startswith("_"):
+                    private_methods.append(stmt)
+                # 公共方法：不以下划线开头
+                else:
+                    public_methods.append(stmt)
+            else:
+                others.append(stmt)
+        # 分别排序
+        magic_methods_sorted = sorted(magic_methods, key=lambda f: f.name.value)
+        public_methods_sorted = sorted(public_methods, key=lambda f: f.name.value)
+        private_methods_sorted = sorted(private_methods, key=lambda f: f.name.value)
+        # 合并：其他成员 + 魔法方法 + 公共方法 + 私有方法
+        new_body = (
+            list(others)
+            + magic_methods_sorted
+            + public_methods_sorted
+            + private_methods_sorted
+        )
+        # 返回新的类定义节点
+        return updated_node.with_changes(
+            body=updated_node.body.with_changes(body=new_body)
+        )
+
+
+def reorder_class_methods(source_code):
+    """
+    对给定 Python 源代码中的每个类的方法和成员按照 ClassMethodSorter 定义的规则排序
+
+    :param source_code: 需要处理的 Python 源代码字符串
+    :return: 方法已按类型排序后的新源代码字符串
+    """
+    tree = cst.parse_module(source_code)
+    new_tree = tree.visit(ClassMethodSorter())
+    return new_tree.code

rbm_tools-0.0.0/rbm_tools/env.py

@@ -0,0 +1,11 @@
+"""
+环境变量注册
+"""
+
+import os
+
+CONF_ENV = os.getenv("CONF_ENV", "test")
+HOSTNAME = os.getenv("HOSTNAME", "localhost")
+MODULE = os.getenv("MODULE", "defaultmodule")
+POD_IP = os.getenv("POD_IP", "127.0.0.1")
+POD_NAME = os.getenv("POD_NAME", "defaultpodname")