# zfx

`zfx` 是一个以中文函数命名为核心风格的 Python 多功能工具包，适合日常脚本、数据整理、文本处理、文件操作、系统辅助、网络请求和自动化任务。

它的目标很直接：

- 按功能分组
- 调用方式尽量简单
- 常用操作尽量开箱即用
- 让中文语境下写 Python 工具代码更顺手

## 项目特点

- 使用中文函数名，查找和理解成本低
- 模块分类明确，适合在 IDE 中按名称排序后浏览
- 覆盖从基础数据处理到系统、网络、自动化的一整套常见场景
- 大量函数采用“一个函数一个文件”的组织方式，便于维护和扩展

## 当前已覆盖的模块方向

- 基础数据：`列表`、`元组`、`字典`、`类型转换`、`数学`、`常量`
- 文本相关：`文本处理`、`文本文件`、`编码`、`json`、`html`
- 文件系统：`文件`、`目录`、`配置文件`
- 时间日期：`时间`
- 系统相关：`系统`、`进程`、`多线程`、`多进程`
- 网络相关：`http`、`网页协议`、`公共API`
- 自动化相关：`playwright`、`谷歌填表`
- 数据与通信：`mysqlx`、`邮件IMAP`、`邮件POP3`

## 安装

```bash
pip install zfx
```

如果你只打算使用其中一部分功能，也可以按需关注这些依赖对应的模块：

- `requests`：网络请求、公共 API、部分系统网络功能
- `beautifulsoup4`：HTML 提取
- `psutil`：进程信息
- `pyperclip`：剪贴板
- `pymysql`：MySQL 相关功能
- `selenium`、`pyotp`：谷歌填表相关功能
- `playwright`：Playwright 自动化相关功能
- `pyinstaller`：代码打包为 EXE 的相关功能

## 快速开始

### 示例 1：获取当前日期

```python
from zfx.时间 import 取当前日期

print(取当前日期())
```

### 示例 2：读取目录下所有文件

```python
from zfx.目录 import 取目录下所有文件

文件列表 = 取目录下所有文件(r"D:\Python源码", 是否递归=False)
print(文件列表)
```

### 示例 3：安全获取字典路径中的值

```python
from zfx.字典 import 取值_路径

数据 = {"用户": {"信息": [{"城市": "上海"}]}}
结果 = 取值_路径(数据, "用户.信息.0.城市", 默认值="未找到")
print(结果)
```

### 示例 4：进行基础 HTTP 请求

```python
from zfx.http import GET, 取响应文本

响应 = GET("https://httpbin.org/get")
文本 = 取响应文本(响应)
print(文本)
```

## 适合的使用场景

- 写个人常用脚本工具箱
- 快速处理文本、文件、目录和时间数据
- 整理接口返回结果或嵌套字典数据
- 编写自动化脚本和辅助工具
- 作为中文风格的 Python 学习参考项目

## 使用建议

- 在 PyCharm 等 IDE 中导入后，建议按名称排序查看模块
- 功能较多时，优先从分类目录进入，再查找对应函数
- 涉及浏览器自动化、数据库、邮件等功能时，请先确认本地环境和依赖已就绪

## 说明

本项目更偏向“实用工具库”和“个人积累型函数库”的风格，强调的是常见任务的快速完成，而不是统一的大型框架设计。

如果你习惯中文命名、希望快速找到现成函数，`zfx` 会比较适合你。

## 免责声明

本项目按“原样”提供。请在理解相关功能用途、运行环境和潜在风险的前提下自行评估并使用，作者不对因使用本项目造成的任何直接或间接损失承担责任。
