nbprint.config.content.ContentLayout

pydantic model nbprint.config.content.ContentLayout

Bases: Content

Show JSON schema

{
   "title": "ContentLayout",
   "type": "object",
   "properties": {
      "tags": {
         "items": {
            "type": "string"
         },
         "title": "Tags",
         "type": "array"
      },
      "role": {
         "$ref": "#/$defs/Role",
         "default": "layout"
      },
      "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
      }
   },
   "$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"
      },
      "Element": {
         "enum": [
            "div",
            "span",
            "p",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
         ],
         "title": "Element",
         "type": "string"
      },
      "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"
      },
      "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"
      },
      "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"
      }
   }
}

Fields:

• role (nbprint.config.base.Role)

field role: Role = Role.LAYOUT

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.