Source code for pyrevs.database.config

from dataclasses import dataclass
from dataclasses import field
from pyrevs.core import MergePolicy


@dataclass(frozen=True)

[docs]
class DatabaseConfig:
    """Database configuration."""

    __section__ = "database"
    __merge_policy__ = MergePolicy.IMMUTABLE


[docs]
    path: str | None = field(
        default=None,
        metadata={
            "doc": "path to the database folder (DB not saved if None)",
        },
    )



[docs]
    restart: bool = field(
        default=False,
        metadata={
            "doc": "force restart the database: pre-existing database is archived",
        },
    )



[docs]
    format: str = field(
        default="XML",
        metadata={
            "doc": "database format (only XML supported for now)",
        },
    )



[docs]
    archive_discarded: bool = field(
        default=True,
        metadata={
            "doc": "archive discarded trajectories",
        },
    )