企业级的Python类库
@emailto: 9727005@qq.com
@creator: ShanDong Xiedali
@company: HiLand & RainyTop
整理常用的代码块，形成企业级的类库工具，供更多项目使用。 注意事项：
- Python环境使用3.13，不用使用3.14。（pywin32在3.14版本中暂时不支持，需等待作者适配）
【零.1】目录格式
- 最外层是整个项目的根目录(本项目中为 BasicLibrary.PY)，这个目录作为 git 的根目录。
- 根目录下分布"部署文件""说明文件"等周边辅助文件(比如 setup.py、README.md等)
- 根目录下用 Python 包的形式架构项目的业务逻辑代码(本项目下为 BasicLibrary) (一般每个项目只架构一个根 Python 包,然后再决定是在根包下再架构子包，还是在根包下直接写 ***.py 代码)
【零.2】命名规则
- 文件名、文件夹名: 全部小写开头；如果多个单词第一单词全部小写，第二、三个单词首字母大写，单词之间不用下划线连接，不使用空格。
- 文件内的类型名称: 每个单词的首字母都大写，单词之间不用下划线连接，不使用空格。
- 函数名、变量名: 每个单词的首字母都小写，单词之间用下划线连接，不使用空格。
- 常量名: 全部大写开头，单词之间不用下划线连接，不使用空格。
- 不供外部调用的模块或者文件名称，统一使用“_”(单下划线)或“__”(双下划线)开头。其余同第2条。
- 以
“_”“__”开头命名的模块或者文件，内部的类型名称，正常命名（即不使用“_”和“__”开头）。 - 不提供给外部调用的函数、变量、常量: 统一使用“_”(单下划线)或“__”(双下划线)开头。其余同第3条。
【一】发布步骤：
- 打开文件
pyproject.toml,修改version = '0.4.3'为新的值 - 打开本项目的"终端"窗口(或者通过 windows 的资源管理器定位到本项目根目录所在的位置)
- 打包项目。运行命令：
poetry build - 发布项目。运行命令：
poetry publish
【二】其他
将本项目需求的第三方软件包统一组织在 pyproject.toml 文件内。
- 安装第三方软件包。运行命令：
poetry add 包名 - 更新第三方软件包。运行命令：
poetry update 包名 - 删除第三方软件包。运行命令：
poetry remove 包名 - 查看已安装的第三方软件包。运行命令：
poetry show
【三】本库的使用说明
1. 库安装（更新）说明
更新公司类库 BasicLibrary.PY 的命令：
- 传统pip方式
pip install BasicLibrary.PY -U # (因为本地的pip通常都为了加速，进行过换源处理了，换源之后缓存更新会比较慢。 # 所以为了使用最新的库功能，可以使用原始的PIPY源，代码如下：) pip install BasicLibrary.PY -U -i https://pypi.org/simple pip install BasicLibrary.PY -U -i https://pypi.tuna.tsinghua.edu.cn/simple
- poetry方式
poetry add BasicLibrary.PY poetry update BasicLibrary.PY poetry remove BasicLibrary.PY
2. 库使用说明
-
以下两个文件复制到项目根目录下
__projectConfig.ini改名为_projectConfig.ini__projectHelper.py改名为_projectHelper.py
-
如果有敏感信息(比如账号口令等)不适合写在 ini 文件内的，可以将
.env.default文件拷贝到文件_projectConfig.ini所在的项目根目录,然后改名为.env,然后在 .env 文件内配置这些信息. ( ini 文件是嵌入到 vcs 系统的，但 .env 是不嵌入 vcs 系统的)
【四】类库自动更新版本号的说明
4.1. 每次提交git的时候，自动更新类库的版本号功能的实现与使用
- 复制
BasicLibrary/_res/pre-commit.auto-increase-version到.git/hooks目录下， 并改名为pre-commit - 适当修改文件中的个别信息
- 这样当每次git有提交的时候，就会自动更新类库的版本号
1 maintainer
Metadata
1 maintainer
Release files for BasicLibrary.PY 0.6.60
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| basiclibrary_py-0.6.60.tar.gz | 66.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| basiclibrary_py-0.6.60-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 180.1 kB
Release files / basiclibrary_py-0.6.60.tar.gz
| Download URL | basiclibrary_py-0.6.60.tar.gz |
|---|---|
| Size | 66.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6a9c55bd3da2fdc5a15328f59084aece848e407bb03f516806d62f4f5b0dc950
|
|
BLAKE2b-256 checksum How to use checksums |
7630739c208ea2ce2e6a13fcc0e5014583ecb8f72381d7e34f0f9f52cd0ca94b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.14.2 Windows/11
|
Release files / basiclibrary_py-0.6.60-py3-none-any.whl
| Download URL | basiclibrary_py-0.6.60-py3-none-any.whl |
|---|---|
| Size | 113.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6473883cffa9878cb12ad45e638a997842e24412142e54e6a602549d3cf4d0e5
|
|
BLAKE2b-256 checksum How to use checksums |
fa34c6d48de985264bee22a88d4fc0fb30d8344b834f0a92dae84adf3d7f2a24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.14.2 Windows/11
|
