# PythonProject-pycacho

**Repository Path**: Cacho/pycacho

## Basic Information

- **Project Name**: PythonProject-pycacho
- **Description**: 常用的第三方库介绍和应用；
封装一些频繁使用的方法；

- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-10
- **Last Updated**: 2026-04-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PythonProject-pycacho

#### 介绍
常用的第三方库介绍和应用；
封装一些频繁使用的方法；


#### 软件架构1
软件架构说明


#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

1.  导入基础工具：`from pycacho.cachobase.deal_excel import get_info`
2.  使用第三方库封装：`from pycacho.cachomodule.requests_model import get_json`
3.  参考实践案例：查看 `cachopractice` 目录下的示例代码


#### Python 代码规范

##### 1. 命名规范
- **模块名**：使用小写字母，多个单词用下划线分隔（如：`deal_excel.py`）
- **类名**：使用大驼峰命名法（如：`QwenClient`、`Logger`）
- **函数名/方法名**：使用小写字母，多个单词用下划线分隔（如：`get_info`、`crop_image`）
- **变量名**：使用小写字母，多个单词用下划线分隔（如：`file_path`、`st_row`）
- **常量名**：使用全大写字母，多个单词用下划线分隔（如：`AES_key`、`sender`）
- **私有成员**：以单下划线或双下划线开头（如：`_private_method`、`__private_attr`）

##### 2. 文件头部注释规范
每个 Python 文件应包含以下标准注释：
```python
# -!- coding: utf-8 -!-
"""
作者：cacho_37967865
博客：https://blog.csdn.net/sinat_37967865
文件：文件名.py
日期：YYYY-MM-DD
备注：功能描述
"""
```

##### 3. 函数注释规范
使用 docstring 说明函数的参数、返回值和功能：
```python
def chat(self, message, model="qwen-plus", **kwargs):
    """
    发送聊天消息

    Args:
        message: 用户消息内容
        model: 模型名称，默认 qwen-plus
        **kwargs: 其他参数（temperature, max_tokens等）

    Returns:
        str: 模型回复内容
    """
```

##### 4. 代码格式规范
- **缩进**：使用 4 个空格进行缩进，不使用 Tab
- **行长度**：每行代码不超过 120 个字符
- **空行**：
  - 顶级函数和类定义之间空 2 行
  - 类内方法定义之间空 1 行
  - 逻辑相关的代码块之间空 1 行
- **空格**：
  - 运算符两侧各加一个空格（如：`a = b + c`）
  - 逗号后加一个空格（如：`[1, 2, 3]`）
  - 冒号后加一个空格（如：`dict = {"key": "value"}`）

##### 5. 导入规范
- 导入顺序：标准库 → 第三方库 → 本地模块
- 每个导入语句单独一行
- 避免使用 `from module import *`
```python
import os
import sys

import requests
import pandas as pd

from pycacho.cachobase.deal_excel import get_info
```

##### 6. 异常处理规范
- 捕获具体的异常类型，避免使用裸 `except`
- 异常处理后应有适当的日志记录或错误提示
```python
try:
    response = client.chat.completions.create(...)
except AuthenticationError:
    logger.error("认证失败，请检查 API Key 是否正确")
    raise
except Exception as e:
    logger.error(f"未知错误: {e}")
    raise
```

##### 7. 日志记录规范
- 使用 logging 或 loguru 模块记录日志
- 日志级别：DEBUG < INFO < WARNING < ERROR < CRITICAL
- 关键操作必须记录日志
```python
import logging
logger = logging.getLogger(__name__)
logger.info("操作成功")
logger.error("操作失败")
```

##### 8. 路径处理规范
- 使用 `os.path.join()` 拼接路径，避免硬编码路径分隔符
- 使用原始字符串或双反斜杠表示 Windows 路径
```python
import os
file_path = os.path.join('F:\\PythonProject', 'test.xls')
```

##### 9. 最佳实践
- **单一职责**：每个函数只做一件事
- **DRY 原则**：不要重复自己，复用代码
- **注释清晰**：复杂逻辑必须添加注释
- **类型提示**：建议使用类型注解提高代码可读性
- **主程序入口**：使用 `if __name__ == '__main__':` 保护测试代码

##### 10. 常见注意事项
- 敏感信息（密码、密钥等）不要硬编码在代码中，使用环境变量或配置文件
- 文件操作后要正确关闭资源，或使用 `with` 语句
- 数据库连接使用后要及时关闭
- 大量数据处理时注意内存管理

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)