Source code for qmmm_pme.records.files

#! /usr/bin/env python3
"""A module defining the :class:`Files` data container.
"""
from __future__ import annotations

from dataclasses import dataclass

from .record import Record
from .record import Variable


class FilesVariable(Variable):
    """A wrapper class for variables belonging to the :class:`Files`
    record.
    """
    _value: list[str] = []

    def update(self, value: list[str]) -> None:
        """Update the value of the :class:`FilesVariable`.

        :param value: The updated value to set the
            :class:`FilesVariable` value to.
        """
        self._value = value
        for notify in self._notifiers:
            notify(value)

    def __call__(self) -> list[str]:
        """Get the value of the :class:`FilesVariable`.

        :return: The value of the :class:`FilesVariable`.
        """
        return self._value


@dataclass(frozen=True)
class Files(Record):
    """A data container for records about input file paths.
    """
    pdb_list: FilesVariable = FilesVariable()
    topology_list: FilesVariable = FilesVariable()
    forcefield_list: FilesVariable = FilesVariable()
    input_json: FilesVariable = FilesVariable()