NbgraderFormat#

Submodules#

Common#

class BaseMetadataValidator(**kwargs: Any)[source]#
upgrade_cell_metadata(cell: nbformat.notebooknode.NotebookNode) → nbformat.notebooknode.NotebookNode[source]#
upgrade_notebook_metadata(nb: nbformat.notebooknode.NotebookNode) → nbformat.notebooknode.NotebookNode[source]#
validate_cell(cell: nbformat.notebooknode.NotebookNode) → None[source]#
validate_nb(nb: nbformat.notebooknode.NotebookNode) → None[source]#
exception SchemaMismatchError(message, actual_version, expected_version)[source]#
exception SchemaTooNewError(message, actual_version, expected_version)[source]#
exception SchemaTooOldError(message, actual_version, expected_version)[source]#

V1#

class MetadataValidatorV1(**kwargs: Any)[source]#
schema_version = 1#
upgrade_cell_metadata(cell: nbformat.notebooknode.NotebookNode) → nbformat.notebooknode.NotebookNode[source]#
validate_cell(cell: nbformat.notebooknode.NotebookNode) → None[source]#
validate_nb(nb: nbformat.notebooknode.NotebookNode) → None[source]#
read_v1(source: TextIO, as_version: int, **kwargs: Any) → nbformat.notebooknode.NotebookNode[source]#
reads_v1(source: str, as_version: int, **kwargs: Any) → nbformat.notebooknode.NotebookNode[source]#
write_v1(nb: nbformat.notebooknode.NotebookNode, fp: TextIO, **kwargs: Any) → None[source]#
writes_v1(nb: nbformat.notebooknode.NotebookNode, **kwargs: Any) → None[source]#

V2#

class MetadataValidatorV2(**kwargs: Any)[source]#
schema_version = 2#
upgrade_cell_metadata(cell: nbformat.notebooknode.NotebookNode) → nbformat.notebooknode.NotebookNode[source]#
validate_cell(cell: nbformat.notebooknode.NotebookNode) → None[source]#
validate_nb(nb: nbformat.notebooknode.NotebookNode) → None[source]#
read_v2(source: TextIO, as_version: int, **kwargs: Any) → nbformat.notebooknode.NotebookNode[source]#
reads_v2(source: str, as_version: int, **kwargs: Any) → nbformat.notebooknode.NotebookNode[source]#
write_v2(nb: nbformat.notebooknode.NotebookNode, fp: TextIO, **kwargs: Any) → None[source]#
writes_v2(nb: nbformat.notebooknode.NotebookNode, **kwargs: Any) → None[source]#

V3#

class MetadataValidatorV3(**kwargs: Any)[source]#
schema_version = 3#
upgrade_cell_metadata(cell: nbformat.notebooknode.NotebookNode) → nbformat.notebooknode.NotebookNode[source]#
validate_cell(cell: nbformat.notebooknode.NotebookNode) → None[source]#
validate_nb(nb: nbformat.notebooknode.NotebookNode) → None[source]#
read_v3(source: TextIO, as_version: int, **kwargs: Any) → nbformat.notebooknode.NotebookNode[source]#
reads_v3(source: str, as_version: int, **kwargs: Any) → nbformat.notebooknode.NotebookNode[source]#
write_v3(nb: nbformat.notebooknode.NotebookNode, fp: TextIO, **kwargs: Any) → None[source]#
writes_v3(nb: nbformat.notebooknode.NotebookNode, **kwargs: Any) → None[source]#

previous

Gradebook

next

Preprocessors