Skip to main content

一个面向中大型项目的Python基础工具库,涵盖配置管理、日志、上下文、ID生成、数据处理、设计模式、定时、异常处理等基础功能。

Project description

smartutils

smartutils 是一个面向 Python 的通用工具库,集成了配置管理、上下文、ID生成、数据处理、设计模式、文件操作、日志、定时器、异常处理等常用功能,适用于中大型项目的基础设施搭建和快速开发。

主要功能模块

  • 配置管理:支持 YAML 配置加载、工厂模式、配置键管理。
  • 上下文管理:基于 contextvars,支持多种上下文变量注册与管理。
  • ID 生成:支持多种分布式唯一 ID 生成方案。
  • 数据处理:包括类型校验、哈希环、URL、CSV、中文数字等工具。
  • 设计模式:内置单例、工厂、弃用等常用设计模式实现。
  • 文件操作:文件读写、压缩、路径、锁、类型判断等。
  • 日志系统:基于 loguru,支持多级别日志与自定义扩展。
  • 定时与计时:Timer 类和 timeit 装饰器,支持同步/异步计时。
  • 异常处理:业务异常、系统异常、异常映射与工厂。
  • 系统工具:进程管理、平台信息、cgroup 资源管理等。
  • 应用层支持:插件、适配器、请求上下文、FastAPI 响应模型等。

安装依赖

项目使用 Poetry 管理依赖,核心依赖如下:

  • Python >= 3.8
  • PyYAML
  • loguru
  • contextvars
  • python-dotenv
  • orjson

可选依赖(数据库、缓存、Web 框架等)详见 pyproject.toml

安装命令:

poetry install

依赖配置

[project]
dependencies = [
    # "smartutils-py[fastapi,mysql,kafka,redis,client-http] @ git+https://github.com/wuruimiao/smartutils.git@main",
    "smartutils-py[fastapi,mysql,kafka,redis,client-http]==0.0.7",
]

[tool.poetry.dependencies]
# smartutils-py = { git = "https://github.com/wuruimiao/smartutils.git", branch = "main", extras = [
#     "fastapi",
#     "mysql",
#     "redis",
#     "auth",
# ] }
smartutils-py = { version = "0.0.7", extras = ["fastapi", "mysql", "redis", "auth"] }

快速开始

from smartutils.init import init

# 初始化 smartutils,加载配置
await init("config.yaml")

# 使用时间工具
from smartutils import time
now = time.get_now_str()

# 使用定时器
from smartutils import timer

@timer.timeit("任务耗时:")
def my_task():
    # ... 业务逻辑 ...
    pass

my_task()

测试

项目内置丰富的单元测试,运行如下:

pytest -s --cov=smartutils --cov-report=html tests tests_real

贡献

欢迎提交 issue 和 PR,完善文档和功能!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smartutils_py-0.0.8.5.tar.gz (86.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

smartutils_py-0.0.8.5-py3-none-any.whl (149.3 kB view details)

Uploaded Python 3

File details

Details for the file smartutils_py-0.0.8.5.tar.gz.

File metadata

  • Download URL: smartutils_py-0.0.8.5.tar.gz
  • Upload date:
  • Size: 86.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.10.12 Linux/6.8.0-79-generic

File hashes

Hashes for smartutils_py-0.0.8.5.tar.gz
Algorithm Hash digest
SHA256 037d5ef9e2f5fae1a80169b93d6db1882f969bfc045ee6cec1d0ff7c59bd43a8
MD5 76e9515aee6cc24ad95677f769a2e23d
BLAKE2b-256 1be85f3e1ae07395177d58b84538e82aac0a64f1e0da8bcc54583d75be6edae6

See more details on using hashes here.

File details

Details for the file smartutils_py-0.0.8.5-py3-none-any.whl.

File metadata

  • Download URL: smartutils_py-0.0.8.5-py3-none-any.whl
  • Upload date:
  • Size: 149.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.10.12 Linux/6.8.0-79-generic

File hashes

Hashes for smartutils_py-0.0.8.5-py3-none-any.whl
Algorithm Hash digest
SHA256 10f74ef85532fec2841d0a3d190af094c3dd4ac29287a7b0a32a83ca9afba52d
MD5 4a2e35e403eca5a7c7d56e823ab9c64c
BLAKE2b-256 c83fb1c08f8ab0559efc0018b522ff2bb6e219b16a51c66db54603c3d42eee27

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page