serde-dataclass 0.0.1__tar.gz

serde_dataclass-0.0.1/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: serde-dataclass
+Version: 0.0.1
+Summary: Convert dataclasses to TOML, preserving comments.
+Author: Sunip K. Mukherjee <sunipkmukherjee@gmail.com>
+License: MIT
+Keywords: serde,dataclass,toml,json
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: dacite>=1.8
+Requires-Dist: tomlkit>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: numpy>=1.22; extra == "dev"
+Requires-Dist: astropy>=5.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material>=9.5; extra == "docs"
+
+# serde-dataclass
+
+TOML and JSON serialization for Python dataclasses is provided through a small, explicit API.
+
+Comment-preserving TOML output, renamed keys, nested dataclasses, and typed round-trips are supported.
+
+## Documentation
+
+Project documentation is provided through MkDocs.
+
+```bash
+pip install -e .[docs]
+mkdocs serve
+```
+
+Detailed usage is documented in `docs/`.
+
+## Installation
+
+```bash
+pip install serde-dataclass
+```
+
+For development and example dependencies:
+
+```bash
+pip install -e .[dev]
+```
+
+## Quick Start
+
+```python
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import Literal
+
+from serde_dataclass import TomlDataclass
+
+
+class Mode(str, Enum):
+    DEV = "dev"
+    PROD = "prod"
+
+
+@dataclass
+class Database:
+    host: str = field(metadata={"description": "Database host"})
+    port: int = field(default=5432, metadata={"description": "Database port"})
+
+
+@dataclass
+class AppConfig(TomlDataclass):
+    """Application configuration"""
+
+    app_name: str = field(
+        default="demo",
+        metadata={"description": "Application name", "toml": "app-name"},
+    )
+    log_level: Literal["debug", "info", "warning", "error"] = field(
+        default="info",
+        metadata={"description": "Logging verbosity", "toml": "log-level"},
+    )
+    mode: Mode = field(default=Mode.DEV, metadata={"description": "Runtime mode"})
+    database: Database = field(
+        default_factory=lambda: Database(host="localhost"),
+        metadata={"description": "Database settings"},
+    )
+
+
+cfg = AppConfig()
+text = cfg.to_toml()
+loaded = AppConfig.from_toml(text)
+
+assert loaded == cfg
+print(text)
+```
+
+Example output:
+
+```toml
+# Application configuration
+
+app-name = "demo" # Application name
+log-level = "info" # Logging verbosity
+mode = "dev" # Runtime mode
+
+# Database settings
+[database]
+host = "localhost" # Database host
+port = 5432 # Database port
+```
+
+## Summary
+
+- `TomlDataclass` and `JsonDataclass` are provided as base [mixins](https://en.wikipedia.org/wiki/Mixin).
+- Root comments, field comments, renamed keys, and nested dataclasses are supported.
+- `Enum`, `Literal`, `Optional`, lists, tuples, sets, and `dict[str, T]` are supported.
+- Custom loading is configured through `dacite.Config`.
+- Custom serialization is integrated through `json.JSONEncoder` and `tomlkit` encoders.
+
+## Notes
+
+- TOML comments are emitted only for TOML serialization.
+- Dictionary keys are required to be strings.
+- Fields with `None` values are omitted from TOML output.
+
+## Development
+
+```bash
+pytest -q
+```
+
+## License
+
+MIT

serde_dataclass-0.0.1/README.md

@@ -0,0 +1,115 @@
+# serde-dataclass
+
+TOML and JSON serialization for Python dataclasses is provided through a small, explicit API.
+
+Comment-preserving TOML output, renamed keys, nested dataclasses, and typed round-trips are supported.
+
+## Documentation
+
+Project documentation is provided through MkDocs.
+
+```bash
+pip install -e .[docs]
+mkdocs serve
+```
+
+Detailed usage is documented in `docs/`.
+
+## Installation
+
+```bash
+pip install serde-dataclass
+```
+
+For development and example dependencies:
+
+```bash
+pip install -e .[dev]
+```
+
+## Quick Start
+
+```python
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import Literal
+
+from serde_dataclass import TomlDataclass
+
+
+class Mode(str, Enum):
+    DEV = "dev"
+    PROD = "prod"
+
+
+@dataclass
+class Database:
+    host: str = field(metadata={"description": "Database host"})
+    port: int = field(default=5432, metadata={"description": "Database port"})
+
+
+@dataclass
+class AppConfig(TomlDataclass):
+    """Application configuration"""
+
+    app_name: str = field(
+        default="demo",
+        metadata={"description": "Application name", "toml": "app-name"},
+    )
+    log_level: Literal["debug", "info", "warning", "error"] = field(
+        default="info",
+        metadata={"description": "Logging verbosity", "toml": "log-level"},
+    )
+    mode: Mode = field(default=Mode.DEV, metadata={"description": "Runtime mode"})
+    database: Database = field(
+        default_factory=lambda: Database(host="localhost"),
+        metadata={"description": "Database settings"},
+    )
+
+
+cfg = AppConfig()
+text = cfg.to_toml()
+loaded = AppConfig.from_toml(text)
+
+assert loaded == cfg
+print(text)
+```
+
+Example output:
+
+```toml
+# Application configuration
+
+app-name = "demo" # Application name
+log-level = "info" # Logging verbosity
+mode = "dev" # Runtime mode
+
+# Database settings
+[database]
+host = "localhost" # Database host
+port = 5432 # Database port
+```
+
+## Summary
+
+- `TomlDataclass` and `JsonDataclass` are provided as base [mixins](https://en.wikipedia.org/wiki/Mixin).
+- Root comments, field comments, renamed keys, and nested dataclasses are supported.
+- `Enum`, `Literal`, `Optional`, lists, tuples, sets, and `dict[str, T]` are supported.
+- Custom loading is configured through `dacite.Config`.
+- Custom serialization is integrated through `json.JSONEncoder` and `tomlkit` encoders.
+
+## Notes
+
+- TOML comments are emitted only for TOML serialization.
+- Dictionary keys are required to be strings.
+- Fields with `None` values are omitted from TOML output.
+
+## Development
+
+```bash
+pytest -q
+```
+
+## License
+
+MIT

serde_dataclass-0.0.1/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "serde-dataclass"
+version = "0.0.1"
+description = "Convert dataclasses to TOML, preserving comments."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+  "dacite>=1.8",
+  "tomlkit>=0.12",
+]
+authors = [{ name = "Sunip K. Mukherjee <sunipkmukherjee@gmail.com>" }]
+license = { text = "MIT" }
+keywords = ["serde", "dataclass", "toml", "json"]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.0", 
+  "numpy>=1.22", 
+  "astropy>=5.0"
+]
+docs = [
+  "mkdocs>=1.6",
+  "mkdocs-material>=9.5",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]

serde_dataclass-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

serde_dataclass-0.0.1/src/serde_dataclass/__init__.py

@@ -0,0 +1,71 @@
+"""Public package interface for serde-dataclass.
+
+The package exposes two dataclass mixins:
+
+- ``TomlDataclass`` for TOML serialization and deserialization
+- ``JsonDataclass`` for JSON serialization and deserialization
+
+TOML support includes:
+
+- root document comments from a class docstring or ``toml_config(...)``
+- field comments via dataclass field metadata
+- field renaming for serialized keys
+- nested dataclasses and arrays of tables
+- validation for ``Enum`` and ``Literal`` annotations
+- custom loaders through ``dacite.Config``
+
+The expected usage pattern is to inherit from one or both mixins and still
+decorate the class with ``@dataclass``.
+
+Example:
+
+    >>> from dataclasses import dataclass, field
+    >>> from enum import Enum
+    >>> from typing import Literal
+    >>>
+    >>> class Mode(str, Enum):
+    ...     DEV = "dev"
+    ...     PROD = "prod"
+    ...
+    >>> @dataclass
+    ... class Database:
+    ...     host: str = field(metadata={"description": "Database host"})
+    ...     port: int = field(default=5432, metadata={"description": "Database port"})
+    ...
+    >>> @dataclass
+    ... class AppConfig(TomlDataclass):
+    ...     '''Application configuration'''
+    ...     app_name: str = field(
+    ...         default="demo",
+    ...         metadata={"description": "Application name", "toml": "app-name"},
+    ...     )
+    ...     log_level: Literal["debug", "info", "warning", "error"] = field(
+    ...         default="info",
+    ...         metadata={"description": "Logging verbosity", "toml": "log-level"},
+    ...     )
+    ...     mode: Mode = field(default=Mode.DEV, metadata={"description": "Runtime mode"})
+    ...     database: Database = field(
+    ...         default_factory=lambda: Database(host="localhost"),
+    ...         metadata={"description": "Database settings"},
+    ...     )
+    ...
+    >>> cfg = AppConfig()
+    >>> loaded = AppConfig.from_toml(cfg.to_toml())
+    >>> loaded == cfg
+    True
+
+For fuller usage guidance, see the repository documentation under ``docs/``.
+"""
+from importlib.metadata import version
+
+from .iface import JsonDataclass, TomlDataclass, json_config, toml_config
+from .core import TypeChecker
+
+__version__ = version(__package__ or "toml_dataclass")
+
+__all__ = [
+    "JsonDataclass", "TomlDataclass",
+    "json_config", "toml_config",
+    "TypeChecker",
+    "__version__"
+]