# {py:mod}`phystool.evaluation` ```{py:module} phystool.evaluation ``` ```{autodoc2-docstring} phystool.evaluation :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`DataType ` - * - {py:obj}`Klass ` - ```{autodoc2-docstring} phystool.evaluation.Klass :summary: ``` * - {py:obj}`Evaluation ` - ```{autodoc2-docstring} phystool.evaluation.Evaluation :summary: ``` ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`save ` - ```{autodoc2-docstring} phystool.evaluation.save :summary: ``` * - {py:obj}`load_klass_and_evaluation_data ` - ```{autodoc2-docstring} phystool.evaluation.load_klass_and_evaluation_data :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`logger ` - ```{autodoc2-docstring} phystool.evaluation.logger :summary: ``` ```` ### API ````{py:data} logger :canonical: phystool.evaluation.logger :value: > 'getLogger(...)' ```{autodoc2-docstring} phystool.evaluation.logger ``` ```` `````{py:class} DataType() :canonical: phystool.evaluation.DataType Bases: {py:obj}`typing.TypedDict` ````{py:attribute} title :canonical: phystool.evaluation.DataType.title :type: str :value: > None ```{autodoc2-docstring} phystool.evaluation.DataType.title ``` ```` ````{py:attribute} cluuid :canonical: phystool.evaluation.DataType.cluuid :type: uuid.UUID :value: > None ```{autodoc2-docstring} phystool.evaluation.DataType.cluuid ``` ```` ````{py:attribute} date :canonical: phystool.evaluation.DataType.date :type: datetime.date :value: > None ```{autodoc2-docstring} phystool.evaluation.DataType.date ``` ```` ````{py:attribute} exercises :canonical: phystool.evaluation.DataType.exercises :type: list[uuid.UUID] :value: > None ```{autodoc2-docstring} phystool.evaluation.DataType.exercises ``` ```` ````` `````{py:class} Klass(name: str, extra: str, year: int, evaluations: list[uuid.UUID] | None = None) :canonical: phystool.evaluation.Klass ```{autodoc2-docstring} phystool.evaluation.Klass ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} phystool.evaluation.Klass.__init__ ``` ````{py:attribute} all :canonical: phystool.evaluation.Klass.all :type: dict[uuid.UUID, phystool.evaluation.Klass] :value: > 'dict(...)' ```{autodoc2-docstring} phystool.evaluation.Klass.all ``` ```` ````{py:method} is_current() -> bool :canonical: phystool.evaluation.Klass.is_current ```{autodoc2-docstring} phystool.evaluation.Klass.is_current ``` ```` ````{py:method} to_dict() -> dict[str, str | list[str] | int] :canonical: phystool.evaluation.Klass.to_dict ```{autodoc2-docstring} phystool.evaluation.Klass.to_dict ``` ```` ````{py:method} search(name: str = '', year: int = 0) -> list[uuid.UUID] :canonical: phystool.evaluation.Klass.search :classmethod: ```{autodoc2-docstring} phystool.evaluation.Klass.search ``` ```` ````{py:method} display(uuid: uuid.UUID) -> None :canonical: phystool.evaluation.Klass.display :classmethod: ```{autodoc2-docstring} phystool.evaluation.Klass.display ``` ```` ````{py:method} update(uuid: uuid.UUID, name: str = '', extra: str = '', year: int = 0) -> Klass | None :canonical: phystool.evaluation.Klass.update :classmethod: ```{autodoc2-docstring} phystool.evaluation.Klass.update ``` ```` ````{py:method} create(name: str, extra: str, year: int) -> Klass | None :canonical: phystool.evaluation.Klass.create :classmethod: ```{autodoc2-docstring} phystool.evaluation.Klass.create ``` ```` ````` `````{py:class} Evaluation(cluuid: uuid.UUID, title: str, date: datetime.date, extra: list[str] | None = None, exercises: list[uuid.UUID] | None = None) :canonical: phystool.evaluation.Evaluation ```{autodoc2-docstring} phystool.evaluation.Evaluation ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} phystool.evaluation.Evaluation.__init__ ``` ````{py:attribute} all :canonical: phystool.evaluation.Evaluation.all :type: dict[uuid.UUID, phystool.evaluation.Evaluation] :value: > 'dict(...)' ```{autodoc2-docstring} phystool.evaluation.Evaluation.all ``` ```` ````{py:property} scolar_year :canonical: phystool.evaluation.Evaluation.scolar_year :type: int ```{autodoc2-docstring} phystool.evaluation.Evaluation.scolar_year ``` ```` ````{py:method} to_dict() -> dict[str, str | list[str]] :canonical: phystool.evaluation.Evaluation.to_dict ```{autodoc2-docstring} phystool.evaluation.Evaluation.to_dict ``` ```` ````{py:method} update(evuuid: uuid.UUID, fname: pathlib.Path | None) -> Evaluation | None :canonical: phystool.evaluation.Evaluation.update :classmethod: ```{autodoc2-docstring} phystool.evaluation.Evaluation.update ``` ```` ````{py:method} create(fname: pathlib.Path | None) -> Evaluation | None :canonical: phystool.evaluation.Evaluation.create :classmethod: ```{autodoc2-docstring} phystool.evaluation.Evaluation.create ``` ```` ````{py:method} display(uuid: uuid.UUID) -> None :canonical: phystool.evaluation.Evaluation.display :classmethod: ```{autodoc2-docstring} phystool.evaluation.Evaluation.display ``` ```` ````{py:method} search(year: int = 0, evuuid: uuid.UUID | None = None, exuuid: uuid.UUID | None = None, cluuid: uuid.UUID | None = None) -> list[uuid.UUID] :canonical: phystool.evaluation.Evaluation.search :classmethod: ```{autodoc2-docstring} phystool.evaluation.Evaluation.search ``` ```` ````` ````{py:function} save() :canonical: phystool.evaluation.save ```{autodoc2-docstring} phystool.evaluation.save ``` ```` ````{py:function} load_klass_and_evaluation_data() -> None :canonical: phystool.evaluation.load_klass_and_evaluation_data ```{autodoc2-docstring} phystool.evaluation.load_klass_and_evaluation_data ``` ````