Source code for grader_convert.nbgraderformat.v2

import typing

from nbformat import read as _read
from nbformat import reads as _reads
from nbformat import write as _write
from nbformat import writes as _writes
from nbformat.notebooknode import NotebookNode

from .common import BaseMetadataValidator, ValidationError
from .v1 import MetadataValidatorV1


class MetadataValidatorV2(BaseMetadataValidator):

    schema_version = 2

    def __init__(self) -> None:
        super().__init__()
        self.v1 = MetadataValidatorV1()

    def _upgrade_v1_to_v2(self, cell: NotebookNode) -> NotebookNode:
        meta = cell.metadata["nbgrader"]

        # only add cell type if the checksum has also already been set
        if "checksum" in meta and "cell_type" not in meta:
            self.log.warning(
                "Cell does not have a stored cell type! Adding default cell type."
            )
            meta["cell_type"] = cell.cell_type

        meta["schema_version"] = self.schema_version

        return cell

    def upgrade_cell_metadata(self, cell: NotebookNode) -> NotebookNode:
        if "nbgrader" not in cell.metadata:
            return cell

        if "schema_version" not in cell.metadata["nbgrader"]:
            cell.metadata["nbgrader"]["schema_version"] = 0

        if cell.metadata["nbgrader"]["schema_version"] == 0:
            cell = self.v1._upgrade_v0_to_v1(cell)
            if "nbgrader" not in cell.metadata:
                return cell

        if cell.metadata["nbgrader"]["schema_version"] == 1:
            cell = self._upgrade_v1_to_v2(cell)

        self._remove_extra_keys(cell)
        return cell

    def validate_cell(self, cell: NotebookNode) -> None:
        super(MetadataValidatorV2, self).validate_cell(cell)

        if "nbgrader" not in cell.metadata:
            return

        meta = cell.metadata["nbgrader"]
        grade = meta["grade"]
        solution = meta["solution"]
        locked = meta["locked"]

        # check if the cell type has changed
        if "cell_type" in meta:
            if meta["cell_type"] != cell.cell_type:
                self.log.warning(
                    "Cell type has changed from {} to {}!".format(
                        meta["cell_type"], cell.cell_type
                    ),
                    cell,
                )

        # check for a valid grade id
        if grade or solution or locked:
            if "grade_id" not in meta:
                raise ValidationError(
                    "nbgrader cell does not have a grade_id: {}".format(cell.source)
                )
            if meta["grade_id"] == "":
                raise ValidationError("grade_id is empty")

        # check for valid points
        if grade:
            if "points" not in meta:
                raise ValidationError(
                    "nbgrader cell '{}' does not have points".format(meta["grade_id"])
                )

        # check that markdown cells are grade AND solution (not either/or)
        if cell.cell_type == "markdown" and grade and not solution:
            raise ValidationError(
                "Markdown grade cell '{}' is not marked as a solution cell".format(
                    meta["grade_id"]
                )
            )
        if cell.cell_type == "markdown" and not grade and solution:
            raise ValidationError(
                "Markdown solution cell is not marked as a grade cell: {}".format(
                    cell.source
                )
            )

    def validate_nb(self, nb: NotebookNode) -> None:
        super(MetadataValidatorV2, self).validate_nb(nb)

        ids = set([])
        for cell in nb.cells:

            if "nbgrader" not in cell.metadata:
                continue

            grade = cell.metadata["nbgrader"]["grade"]
            solution = cell.metadata["nbgrader"]["solution"]
            locked = cell.metadata["nbgrader"]["locked"]

            if not grade and not solution and not locked:
                continue

            grade_id = cell.metadata["nbgrader"]["grade_id"]
            if grade_id in ids:
                raise ValidationError("Duplicate grade id: {}".format(grade_id))
            ids.add(grade_id)


def read_v2(
    source: typing.io.TextIO, as_version: int, **kwargs: typing.Any
) -> NotebookNode:
    nb = _read(source, as_version, **kwargs)
    MetadataValidatorV2().validate_nb(nb)
    return nb


def write_v2(nb: NotebookNode, fp: typing.io.TextIO, **kwargs: typing.Any) -> None:
    MetadataValidatorV2().validate_nb(nb)
    _write(nb, fp, **kwargs)


def reads_v2(source: str, as_version: int, **kwargs: typing.Any) -> NotebookNode:
    nb = _reads(source, as_version, **kwargs)
    MetadataValidatorV2().validate_nb(nb)
    return nb


def writes_v2(nb: NotebookNode, **kwargs: typing.Any) -> None:
    MetadataValidatorV2().validate_nb(nb)
    _writes(nb, **kwargs)