nbprint.config.core.Configuration

pydantic model nbprint.config.core.Configuration[source]

Bases: CallableModel, BaseModel

Show JSON schema
{
   "title": "Configuration",
   "type": "object",
   "properties": {
      "tags": {
         "items": {
            "type": "string"
         },
         "title": "Tags",
         "type": "array"
      },
      "role": {
         "$ref": "#/$defs/Role",
         "default": "configuration"
      },
      "ignore": {
         "default": true,
         "title": "Ignore",
         "type": "boolean"
      },
      "css": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "",
         "title": "Css"
      },
      "esm": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "",
         "title": "Esm"
      },
      "classname": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": "",
         "title": "Classname"
      },
      "attrs": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "string"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "title": "Attrs"
      },
      "meta": {
         "$ref": "#/$defs/MetaData"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "resources": {
         "additionalProperties": {
            "$ref": "#/$defs/BaseModel"
         },
         "title": "Resources",
         "type": "object"
      },
      "outputs": {
         "default": null,
         "title": "Outputs"
      },
      "parameters": {
         "$ref": "#/$defs/Parameters"
      },
      "page": {
         "$ref": "#/$defs/Page"
      },
      "context": {
         "$ref": "#/$defs/Context"
      },
      "content": {
         "$ref": "#/$defs/ContentMarshall"
      },
      "pagedjs": {
         "default": true,
         "title": "Pagedjs",
         "type": "boolean"
      },
      "debug": {
         "default": true,
         "title": "Debug",
         "type": "boolean"
      }
   },
   "$defs": {
      "BaseModel": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            }
         },
         "title": "BaseModel",
         "type": "object"
      },
      "Border": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "important": {
               "default": false,
               "title": "Important",
               "type": "boolean"
            },
            "right": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BorderStyle"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "left": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BorderStyle"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "top": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BorderStyle"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "bottom": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BorderStyle"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "Border",
         "type": "object"
      },
      "BorderLineStyle": {
         "enum": [
            "none",
            "hidden",
            "dotted",
            "dashed",
            "solid",
            "double",
            "groove",
            "ridge",
            "inset",
            "outset"
         ],
         "title": "BorderLineStyle",
         "type": "string"
      },
      "BorderLineWidth": {
         "enum": [
            "thin",
            "medium",
            "thick"
         ],
         "title": "BorderLineWidth",
         "type": "string"
      },
      "BorderStyle": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "important": {
               "default": false,
               "title": "Important",
               "type": "boolean"
            },
            "width": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BorderLineWidth"
                  },
                  {
                     "type": "integer"
                  }
               ],
               "title": "Width"
            },
            "style": {
               "$ref": "#/$defs/BorderLineStyle"
            },
            "color": {
               "format": "color",
               "title": "Color",
               "type": "string"
            }
         },
         "required": [
            "width",
            "style",
            "color"
         ],
         "title": "BorderStyle",
         "type": "object"
      },
      "Content": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "content"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "content": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "$ref": "#/$defs/BaseModel"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Content"
            },
            "magics": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "List of cell magics to apply to the cell",
               "title": "Magics"
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If set, the cell's outputs will be collected into the `Outputs` context under this key (only for code cells).",
               "title": "Output"
            },
            "style": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Style"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentMarshall": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "prematter": {
               "items": {
                  "$ref": "#/$defs/Content"
               },
               "title": "Prematter",
               "type": "array"
            },
            "frontmatter": {
               "items": {
                  "$ref": "#/$defs/Content"
               },
               "title": "Frontmatter",
               "type": "array"
            },
            "middlematter": {
               "items": {
                  "$ref": "#/$defs/Content"
               },
               "title": "Middlematter",
               "type": "array"
            },
            "endmatter": {
               "items": {
                  "$ref": "#/$defs/Content"
               },
               "title": "Endmatter",
               "type": "array"
            }
         },
         "title": "ContentMarshall",
         "type": "object"
      },
      "Context": {
         "additionalProperties": true,
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "context"
            },
            "ignore": {
               "default": true,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "parameters": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Parameters"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "Context",
         "type": "object"
      },
      "Element": {
         "enum": [
            "div",
            "span",
            "p",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
         ],
         "title": "Element",
         "type": "string"
      },
      "EvaluatorBase": {
         "additionalProperties": false,
         "description": "Base class for evaluators, which are higher-order models that evaluate ModelAndContext.\n\nNote that evaluators don't use the Flow decorator on __call__ and __deps__ by design.",
         "properties": {
            "meta": {
               "$ref": "#/$defs/MetaData"
            }
         },
         "title": "EvaluatorBase",
         "type": "object"
      },
      "FlowOptions": {
         "additionalProperties": false,
         "description": "Options for Flow evaluation.\n\nThis class is typically used by exporting it to a dict with exclude_unset=True, such that only fields that have been\nexplicitly passed by the user will be used for overriding. This allows default behavior to be separately defined\n(i.e. by an evaluator) if the user has not explicitly specified a field.",
         "properties": {
            "log_level": {
               "default": 10,
               "description": "If no 'evaluator' is set, will use a LoggingEvaluator with this log level",
               "title": "Log Level",
               "type": "integer"
            },
            "verbose": {
               "default": true,
               "description": "Whether to use verbose logging",
               "title": "Verbose",
               "type": "boolean"
            },
            "validate_result": {
               "default": true,
               "description": "Whether to validate the result to the model's result_type before returning",
               "title": "Validate Result",
               "type": "boolean"
            },
            "volatile": {
               "default": false,
               "description": "Whether this function is volatile (i.e. always returns a different value), and hence should always be excluded from caching",
               "title": "Volatile",
               "type": "boolean"
            },
            "cacheable": {
               "default": false,
               "description": "Whether the model results should be cached if possible. This is False by default so that caching is opt-in",
               "title": "Cacheable",
               "type": "boolean"
            },
            "evaluator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/EvaluatorBase"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A hook to set a custom evaluator",
               "title": "Evaluator"
            }
         },
         "title": "FlowOptions",
         "type": "object"
      },
      "Font": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "important": {
               "default": false,
               "title": "Important",
               "type": "boolean"
            },
            "family": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FontFamily"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Family"
            },
            "size": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Size"
            },
            "transform": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/TextTransform"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "decoration": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/TextDecoration"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "style": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FontStyle"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "weight": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FontWeight"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "color": {
               "anyOf": [
                  {
                     "format": "color",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Color"
            }
         },
         "title": "Font",
         "type": "object"
      },
      "FontFamily": {
         "enum": [
            "serif",
            "sans-serif",
            "monospace"
         ],
         "title": "FontFamily",
         "type": "string"
      },
      "FontStyle": {
         "enum": [
            "normal",
            "italic"
         ],
         "title": "FontStyle",
         "type": "string"
      },
      "FontWeight": {
         "enum": [
            "normal",
            "bold"
         ],
         "title": "FontWeight",
         "type": "string"
      },
      "Margin": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "important": {
               "default": false,
               "title": "Important",
               "type": "boolean"
            },
            "right": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Right"
            },
            "left": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Left"
            },
            "top": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Top"
            },
            "bottom": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bottom"
            }
         },
         "title": "Margin",
         "type": "object"
      },
      "MetaData": {
         "additionalProperties": false,
         "description": "Class to represent metadata for all callable models",
         "properties": {
            "name": {
               "default": "",
               "title": "Name",
               "type": "string"
            },
            "description": {
               "default": "",
               "title": "Description",
               "type": "string"
            },
            "options": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FlowOptions"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "MetaData",
         "type": "object"
      },
      "Padding": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "important": {
               "default": false,
               "title": "Important",
               "type": "boolean"
            },
            "right": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Right"
            },
            "left": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Left"
            },
            "top": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Top"
            },
            "bottom": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bottom"
            }
         },
         "title": "Padding",
         "type": "object"
      },
      "Page": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "default": "",
               "title": "Css",
               "type": "string"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "top": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "top_left": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "top_right": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "bottom": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "bottom_left": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "bottom_right": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "left": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "left_top": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "left_bottom": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "right": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "right_top": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "right_bottom": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegion"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "size": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageSize"
                  },
                  {
                     "maxItems": 2,
                     "minItems": 2,
                     "prefixItems": [
                        {
                           "type": "number"
                        },
                        {
                           "type": "number"
                        }
                     ],
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "letter",
               "title": "Size"
            },
            "orientation": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageOrientation"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "portrait"
            },
            "pages": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Page"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Pages"
            }
         },
         "title": "Page",
         "type": "object"
      },
      "PageOrientation": {
         "enum": [
            "portrait",
            "landscape"
         ],
         "title": "PageOrientation",
         "type": "string"
      },
      "PageRegion": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "page"
            },
            "ignore": {
               "default": true,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "default": "",
               "title": "Css",
               "type": "string"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "content": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PageRegionContent"
                  },
                  {
                     "type": "null"
                  }
               ]
            },
            "style": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Style"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "PageRegion",
         "type": "object"
      },
      "PageRegionContent": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "page"
            },
            "ignore": {
               "default": true,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "content": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Content"
            }
         },
         "title": "PageRegionContent",
         "type": "object"
      },
      "PageSize": {
         "enum": [
            "A0",
            "A1",
            "A2",
            "A3",
            "A4",
            "A5",
            "A6",
            "A7",
            "A10",
            "B4",
            "B5",
            "letter",
            "legal",
            "ledger"
         ],
         "title": "PageSize",
         "type": "string"
      },
      "Parameters": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "parameters"
            },
            "ignore": {
               "default": true,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            }
         },
         "title": "Parameters",
         "type": "object"
      },
      "PseudoClass": {
         "enum": [
            "active",
            "checked",
            "disabled",
            "empty",
            "enabled",
            "first-child",
            "focus",
            "hover",
            "last-child",
            "visited"
         ],
         "title": "PseudoClass",
         "type": "string"
      },
      "PseudoElement": {
         "enum": [
            "after",
            "before",
            "first-letter",
            "first-line",
            "marker",
            "placeholder",
            "selection"
         ],
         "title": "PseudoElement",
         "type": "string"
      },
      "Role": {
         "enum": [
            "undefined",
            "configuration",
            "context",
            "outputs",
            "parameters",
            "content",
            "page",
            "layout"
         ],
         "title": "Role",
         "type": "string"
      },
      "Scope": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "element": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Element"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Element"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Id"
            },
            "selector": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Selector"
            },
            "pseudoclass": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PseudoClass"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": ""
            },
            "pseudoelement": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PseudoElement"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": ""
            }
         },
         "title": "Scope",
         "type": "object"
      },
      "Spacing": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "important": {
               "default": false,
               "title": "Important",
               "type": "boolean"
            },
            "padding": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Padding"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "margin": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Margin"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "Spacing",
         "type": "object"
      },
      "Style": {
         "properties": {
            "tags": {
               "items": {
                  "type": "string"
               },
               "title": "Tags",
               "type": "array"
            },
            "role": {
               "$ref": "#/$defs/Role",
               "default": "undefined"
            },
            "ignore": {
               "default": false,
               "title": "Ignore",
               "type": "boolean"
            },
            "css": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Css"
            },
            "esm": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Esm"
            },
            "classname": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "",
               "title": "Classname"
            },
            "attrs": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Attrs"
            },
            "scope": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Scope"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "spacing": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Spacing"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "font": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Font"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "border": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Border"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "Style",
         "type": "object"
      },
      "TextDecoration": {
         "enum": [
            "none",
            "underline",
            "overline",
            "dotted",
            "wavy"
         ],
         "title": "TextDecoration",
         "type": "string"
      },
      "TextTransform": {
         "enum": [
            "capitalize",
            "lowercase",
            "uppercase"
         ],
         "title": "TextTransform",
         "type": "string"
      }
   },
   "required": [
      "name"
   ]
}

Fields:

  • content (nbprint.config.core.content.ContentMarshall)

  • context (nbprint.config.core.context.Context)

  • debug (bool)

  • ignore (bool)

  • name (str)

  • outputs (nbprint.config.core.outputs.Outputs)

  • page (nbprint.config.page.Page)

  • pagedjs (bool)

  • parameters (nbprint.config.core.parameters.Parameters)

  • resources (dict[str, nbprint.config.base.BaseModel])

  • role (nbprint.config.base.Role)

  • tags (list[str])

field name: str [Required]
field resources: Annotated[dict[str, BaseModel], SerializeAsAny()] [Optional]
field outputs: Annotated[Outputs, SerializeAsAny()] [Required]
field parameters: Annotated[Parameters, SerializeAsAny()] [Optional]
field page: Annotated[Page, SerializeAsAny()] [Optional]
field context: Annotated[Context, SerializeAsAny()] [Optional]
field content: Annotated[ContentMarshall, SerializeAsAny()] [Optional]
field tags: Annotated[list[str], SerializeAsAny()] [Optional]
field role: Role = Role.CONFIGURATION
field ignore: bool = True
field pagedjs: bool = True
field debug: bool = True
Configuration.convert_content_from_obj[source]
generate(**_) → list[NotebookNode][source]

Generate a notebook node for this model. This will be called before the runtime of the notebook, use it for code generation.

Args:

metadata (dict): common cell metadata

Returns:

NotebookNode: the content of the notebook node

static load(path_or_model: str | Path | dict | Configuration, name: str) → Configuration[source]
run(dry_run: bool = False, *, _multi: bool = False) → Path | None[source]
property context_type: Type[ContextType]

Return the context type for the model.

By default, it reads the value from the function signature (if a concrete value is provided), otherwise the implementation needs to be overridden.

property result_type: Type[ResultType]

Return the result type for the model.

By default, it reads the value from the function signature (if a concrete value is provided), otherwise the implementation needs to be overridden.

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self – The BaseModel instance.

  • context – The context.