FovesConfig 0.1.1__tar.gz

fovesconfig-0.1.1/.gitignore

@@ -0,0 +1,222 @@
+.ilina
+mygo.py
+temp
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

fovesconfig-0.1.1/FovesConfig/__init__.py

@@ -0,0 +1 @@
+from .loader import ConfigLoader

fovesconfig-0.1.1/FovesConfig/loader.py

@@ -0,0 +1,29 @@
+from typing import Type
+from pathlib import Path
+from pydantic import BaseModel
+
+class ConfigLoader[T: BaseModel]:
+    def __init__(self, path: str|Path, model: Type[T]):
+        self.path = Path(path)
+        self.model_cls = model
+    
+    def _read(self):
+        if self.path.exists():
+            self.model = self.model_cls.model_validate_json(self.path.read_text("UTF8"))
+        else:
+            self.model = self.model_cls()
+
+    def readonly(self) -> T:
+        self._read()
+        return self.model
+
+    def __enter__(self) -> T:
+        self._read()
+        return self.model
+
+    def __exit__(self, exc_type, exc, tb):
+        self.path.parent.mkdir(parents=True, exist_ok=True)
+        self.path.write_text(
+            self.model.model_dump_json(indent=2, ensure_ascii=False),
+            encoding="utf-8",
+        )

fovesconfig-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Foves7017
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fovesconfig-0.1.1/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: FovesConfig
+Version: 0.1.1
+Summary: 四叶的配置管理工具 — 基于 Pydantic 的配置加载器，上下文管理器自动读写
+Project-URL: Repository, https://github.com/Foves7017/FovesLib
+Author: Foves7017
+License: MIT License
+        
+        Copyright (c) 2026 Foves7017
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.0.0
+Description-Content-Type: text/markdown
+
+# FovesConfig
+
+基于 Pydantic 的配置管理工具，上下文管理器自动读写 JSON 配置文件。
+
+可使用 pip 安装或下载源码使用：
+```BASH
+pip install FovesConfig
+```
+
+项目主页：
+https://github.com/Foves7017/FovesLib
+
+## ConfigLoader
+
+泛型配置加载器。把你的配置定义成一个 Pydantic 模型，然后用 `ConfigLoader` 包裹它——进入上下文自动读取 JSON，退出时自动写回，省去所有手工序列化的麻烦。
+
+### 基本用法
+
+```Python
+from pydantic import BaseModel
+from FovesConfig import ConfigLoader
+
+class AppConfig(BaseModel):
+    host: str = "localhost"
+    port: int = 8080
+    debug: bool = False
+
+with ConfigLoader("config.json", AppConfig) as cfg:
+    print(cfg.host)   # 首次运行会使用默认值
+    cfg.port = 9090   # 修改配置
+# 退出上下文时自动写入 config.json
+```
+
+### 参数
+
+`path: str | Path` — 配置文件路径。文件存在则读取，不存在则使用模型默认值。
+
+`model: Type[T]` — 一个 Pydantic BaseModel 子类，定义了配置的结构和默认值。
+
+### 只读
+你可以使用如下的方法只读取磁盘上的配置，在此例中，就算修改 cfg 的值也不会同步到磁盘中。
+
+```Python
+loader = ConfigLoader("config.json", AppConfig)
+cfg = loader.readonly()
+print(cfg.host)
+```
+
+### 读写行为
+
+- **读取**：进入上下文管理器时，若文件存在则 `model_validate_json` 反序列化，否则用 `model_cls()` 构造默认实例。
+- **写入**：退出上下文管理器时自动创建父目录，以 `indent=2`、`ensure_ascii=False` 写出 JSON。
+
+### 其他
+如果你发现自己需要手动调用 save() 或 exit()，请先考虑是否应该使用上下文管理器。大多数修改配置的场景都更适合：
+
+```Python
+with ConfigLoader(...) as config:
+    ...
+```
+
+而不是手动管理配置对象的生命周期。

fovesconfig-0.1.1/README.md

@@ -0,0 +1,62 @@
+# FovesConfig
+
+基于 Pydantic 的配置管理工具，上下文管理器自动读写 JSON 配置文件。
+
+可使用 pip 安装或下载源码使用：
+```BASH
+pip install FovesConfig
+```
+
+项目主页：
+https://github.com/Foves7017/FovesLib
+
+## ConfigLoader
+
+泛型配置加载器。把你的配置定义成一个 Pydantic 模型，然后用 `ConfigLoader` 包裹它——进入上下文自动读取 JSON，退出时自动写回，省去所有手工序列化的麻烦。
+
+### 基本用法
+
+```Python
+from pydantic import BaseModel
+from FovesConfig import ConfigLoader
+
+class AppConfig(BaseModel):
+    host: str = "localhost"
+    port: int = 8080
+    debug: bool = False
+
+with ConfigLoader("config.json", AppConfig) as cfg:
+    print(cfg.host)   # 首次运行会使用默认值
+    cfg.port = 9090   # 修改配置
+# 退出上下文时自动写入 config.json
+```
+
+### 参数
+
+`path: str | Path` — 配置文件路径。文件存在则读取，不存在则使用模型默认值。
+
+`model: Type[T]` — 一个 Pydantic BaseModel 子类，定义了配置的结构和默认值。
+
+### 只读
+你可以使用如下的方法只读取磁盘上的配置，在此例中，就算修改 cfg 的值也不会同步到磁盘中。
+
+```Python
+loader = ConfigLoader("config.json", AppConfig)
+cfg = loader.readonly()
+print(cfg.host)
+```
+
+### 读写行为
+
+- **读取**：进入上下文管理器时，若文件存在则 `model_validate_json` 反序列化，否则用 `model_cls()` 构造默认实例。
+- **写入**：退出上下文管理器时自动创建父目录，以 `indent=2`、`ensure_ascii=False` 写出 JSON。
+
+### 其他
+如果你发现自己需要手动调用 save() 或 exit()，请先考虑是否应该使用上下文管理器。大多数修改配置的场景都更适合：
+
+```Python
+with ConfigLoader(...) as config:
+    ...
+```
+
+而不是手动管理配置对象的生命周期。

fovesconfig-0.1.1/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "FovesConfig"
+version = "0.1.1"
+description = "四叶的配置管理工具 — 基于 Pydantic 的配置加载器，上下文管理器自动读写"
+readme = "README.md"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Foves7017"}
+]
+requires-python = ">=3.12"
+dependencies = [
+    "pydantic>=2.0.0",
+]
+
+[project.urls]
+Repository = "https://github.com/Foves7017/FovesLib"
+
+[tool.hatch.build.targets.wheel]
+packages = ["FovesConfig"]