eafig 0.1.0__tar.gz

eafig-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+.vscode/
+.idea/
+
+.venv/
+
+.DS_Store/
+__pycache__/
+*.pyc
+
+dist/
+config/

eafig-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MugeTong
+
+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.

eafig-0.1.0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: eafig
+Version: 0.1.0
+Summary: A simple figure generation library
+Project-URL: Homepage, https://github.com/MugeTong/eafig
+Project-URL: Issues, https://github.com/MugeTong/eafig/issues
+Author-email: MugeTong <here5320@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 MugeTong
+        
+        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
+Description-Content-Type: text/markdown
+
+# Eafig
+
+Manage your hyperparameters more easily.

eafig-0.1.0/README.md

@@ -0,0 +1,3 @@
+# Eafig
+
+Manage your hyperparameters more easily.

eafig-0.1.0/examples/main.py

@@ -0,0 +1,23 @@
+from eafig import load_config, register_config, save_config
+
+
+@register_config
+class MyConfig:
+    a: int
+    b: str
+    c: float = 1.0
+
+
+def main():
+    # Load config from a file
+    load_config()
+
+    # Create a config instance using the loaded config
+    config_instance = MyConfig(1, "asd")
+    print("Config instance:", config_instance)
+
+    # Save the current config to a file
+    save_config()
+
+if __name__ == "__main__":
+    main()

eafig-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "eafig"
+version = "0.1.0"
+description = "A simple figure generation library"
+authors = [{ name = "MugeTong", email = "here5320@gmail.com" }]
+license = {"file" = "LICENSE"}
+readme = "README.md"
+requires-python = ">=3.12"
+requires = [
+    "pyyaml",
+    "omegaconf"
+]
+
+[project.urls]
+Homepage = "https://github.com/MugeTong/eafig"
+Issues = "https://github.com/MugeTong/eafig/issues"

eafig-0.1.0/src/eafig/__init__.py

@@ -0,0 +1,5 @@
+from .load import load_config
+from .registry import register_config
+from .save import parse_config, save_config
+
+__all__ = ["load_config", "register_config", "parse_config", "save_config"]

eafig-0.1.0/src/eafig/load.py

@@ -0,0 +1,40 @@
+import os
+from omegaconf import OmegaConf
+
+from .state import _LOADED_CONFIG, _LOAD_PATH
+
+_initialized = False
+
+
+def load_config(
+    config_path: str | None = None,
+    cmd: bool = True,
+) -> None:
+    """Load configuration from a file and optionally from command line arguments.
+
+    Priorities (from highest to lowest):
+        1. Command line arguments
+        2. Configuration file
+        3. Given values for class instantiation
+        4. Default values in the decorator definition
+    """
+
+    global _initialized, _LOAD_PATH
+    if _initialized:
+        print("Configuration from file and command line already loaded. Skipping.")
+        return
+    _initialized = True
+
+    if config_path is None:
+        print(
+            f"No configuration file path provided. Using default path: '{_LOAD_PATH}'"
+        )
+    _LOAD_PATH = config_path or _LOAD_PATH
+
+    _LOADED_CONFIG.update(
+        OmegaConf.load(_LOAD_PATH) if os.path.exists(_LOAD_PATH) else {}
+    )
+
+    if cmd:
+        # Command line overrides have the highest priority
+        _LOADED_CONFIG.update(OmegaConf.from_cli())

eafig-0.1.0/src/eafig/registry.py

@@ -0,0 +1,98 @@
+from typing import (
+    Any,
+    Optional,
+    Type,
+    TypeVar,
+    cast,
+    get_type_hints,
+    dataclass_transform,
+)
+from dataclasses import MISSING, dataclass, fields, is_dataclass
+
+from .state import _CURRENT_INSTANCES, _LOADED_CONFIG
+
+T = TypeVar("T")
+
+
+def _convert_type(value: Any, target_type: Any) -> Any:
+    """Best-effort conversion for loaded config values."""
+    if value is None:
+        return None
+    if isinstance(value, target_type):
+        return value
+    try:
+        return target_type(value)
+    except Exception as e:
+        raise TypeError(
+            f"Failed to convert {value} ({type(value)}) to {target_type}"
+        ) from e
+
+
+@dataclass_transform()
+def register_config(cls: Optional[Type[T]] = None, /, *, frozen: bool = False):
+    """
+    A decorator to register a config class to the registry.
+    """
+
+    def wrap(cls: Type[T]) -> Type[T]:
+        if not is_dataclass(cls):
+            cls = dataclass(cls, frozen=frozen)
+
+        ori_init = cls.__init__
+        ori_cls = cast(type[Any], cls)
+
+        def new_init(self, *args, **kwargs):
+            field_list = list(fields(ori_cls))
+            if len(args) > len(field_list):
+                raise TypeError(
+                    f"Too many positional arguments for '{ori_cls.__name__}'"
+                )
+
+            # Parameters provided via class instantiation
+            provided = {field_list[i].name: arg for i, arg in enumerate(args)}
+            provided.update(kwargs)
+            if frozen and provided:
+                raise TypeError(
+                    f"Cannot provide parameters to frozen configuration '{ori_cls.__name__}'"
+                )
+
+            # Type hints for type conversion
+            hints = get_type_hints(ori_cls)
+
+            # Loaded configuration from file or command line
+            loaded_config = _LOADED_CONFIG.get(ori_cls.__name__, {})
+
+            # Priority: command > file > provided > default
+            init_kwargs = {}
+            for f in field_list:
+                if f.name in loaded_config:
+                    value = loaded_config[f.name]
+                elif f.name in provided:
+                    value = provided[f.name]
+                elif f.default is not MISSING:
+                    value = f.default
+                elif f.default_factory is not MISSING:
+                    value = f.default_factory()
+                else:
+                    raise TypeError(
+                        f"{ori_cls.__name__}.__init__() missing required field: '{f.name}'"
+                    )
+
+                if f.name in hints:
+                    value = _convert_type(value, hints[f.name])
+                init_kwargs[f.name] = value
+
+            ori_init(self, **init_kwargs)
+            if ori_cls.__name__ in _CURRENT_INSTANCES:
+                raise ValueError(
+                    f"Registered configuration '{ori_cls.__name__}' already has an instance. Multiple instances are not allowed."
+                )
+            _CURRENT_INSTANCES[ori_cls.__name__] = self
+
+        ori_cls.__init__ = new_init
+        return ori_cls
+
+    if cls is None:
+        return wrap
+    else:
+        return wrap(cls)

eafig-0.1.0/src/eafig/save.py

@@ -0,0 +1,32 @@
+from dataclasses import asdict
+import os
+from typing import Dict, Any
+import yaml
+from .state import _CURRENT_INSTANCES, _LOADED_CONFIG, _SAVE_PATH
+
+
+def parse_config() -> Dict[str, Any]:
+    """
+    Parse all stored configuration.
+    """
+    config = {}
+    for name, instance in _CURRENT_INSTANCES.items():
+        config[name] = asdict(instance)
+
+    for name, loaded in _LOADED_CONFIG.items():
+        if name not in config:
+            config[name] = loaded
+    return config
+
+
+def save_config(to: str | None = None) -> None:
+    """
+    Save the current loaded configuration to a file.
+    """
+    global _SAVE_PATH
+    _SAVE_PATH = to or _SAVE_PATH
+    config_to_save = parse_config()
+
+    os.makedirs(os.path.dirname(_SAVE_PATH), exist_ok=True)
+    with open(_SAVE_PATH, "w") as f:
+        yaml.dump(config_to_save, f)

eafig-0.1.0/src/eafig/state.py

@@ -0,0 +1,4 @@
+_CURRENT_INSTANCES = {}
+_LOADED_CONFIG = {}
+_LOAD_PATH: str = "./config/default.yaml"
+_SAVE_PATH: str = "./config/default.yaml"