FovesConfig 0.1.1__py3-none-any.whl

FovesConfig/__init__.py

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

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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,6 @@
+FovesConfig/__init__.py,sha256=zE5ODSOZMCdZHMsHZ7JcxLxlm7XgaXadpfQyv2JwP54,34
+FovesConfig/loader.py,sha256=uTjfq2WyNBdvShWVwbrSAONvq8Ih52JP-kfpCc7sL3U,861
+fovesconfig-0.1.1.dist-info/METADATA,sha256=tDaHFjtvqB21UM5_RmkJ5w0cwMDWKWjp8bHdWSd5cNY,3487
+fovesconfig-0.1.1.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+fovesconfig-0.1.1.dist-info/licenses/LICENSE,sha256=lXz0pZeICx_-HWjVeatkJhfuZp5Wd4jOPYzVs57mLfM,1087
+fovesconfig-0.1.1.dist-info/RECORD,,

fovesconfig-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

fovesconfig-0.1.1.dist-info/licenses/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.