LogGuru 项目使用教程

LogGuru 项目使用教程

1. 项目的目录结构及介绍

LogGuru 项目的目录结构如下：

LogGuru/
├── docs/
│   ├── README.rst
│   ├── CONTRIBUTING.rst
│   ├── CHANGELOG.rst
│   └── LICENSE
├── loguru/
│   ├── __init__.py
│   ├── logger.py
│   └── handlers.py
├── tests/
│   ├── __init__.py
│   ├── test_logger.py
│   └── test_handlers.py
├── .gitignore
├── .pre-commit-config.yaml
├── .readthedocs.yml
├── codecov.yml
├── pyproject.toml
├── tox.ini
└── README.rst

目录介绍

• docs/: 包含项目的文档文件，如 README、贡献指南、变更日志和许可证。
• loguru/: 包含项目的主要代码文件，如 __init__.py、logger.py 和 handlers.py。
• tests/: 包含项目的测试文件，如 __init__.py、test_logger.py 和 test_handlers.py。
• .gitignore: Git 忽略文件配置。
• .pre-commit-config.yaml: 预提交钩子配置。
• .readthedocs.yml: Read the Docs 配置文件。
• codecov.yml: Codecov 配置文件。
• pyproject.toml: 项目构建配置文件。
• tox.ini: 自动化测试配置文件。
• README.rst: 项目说明文档。

2. 项目的启动文件介绍

LogGuru 项目的启动文件是 loguru/__init__.py。这个文件负责初始化日志记录器，并提供一些默认配置。

from .logger import logger

__all__ = ['logger']

启动文件介绍

• loguru/__init__.py: 初始化日志记录器，并导出 logger 对象供其他模块使用。

3. 项目的配置文件介绍

LogGuru 项目的配置文件主要包括 pyproject.toml 和 tox.ini。

pyproject.toml

pyproject.toml 文件用于定义项目的构建系统和依赖项。

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "loguru"
version = "0.5.3"
description = "Python logging made (stupidly) simple"
authors = [
    { name="Delgan", email="delgan.py@gmail.com" }
]
dependencies = [
    "colorama",
    "dateutil"
]

tox.ini

tox.ini 文件用于配置自动化测试环境。

[tox]
envlist = py36,py37,py38
skipsdist = true

[testenv]
deps =
    pytest
commands =
    pytest tests/

配置文件介绍

• pyproject.toml: 定义项目的构建系统和依赖项。
• tox.ini: 配置自动化测试环境，指定测试依赖和命令。

以上是 LogGuru 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 LogGuru 项目。