nbprint.models.SeabornDisplayConfiguration

pydantic model nbprint.models.SeabornDisplayConfiguration[source]

Bases: Content

Show JSON schema
{
   "title": "SeabornDisplayConfiguration",
   "type": "object",
   "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": {
         "default": "whitegrid",
         "enum": [
            "white",
            "dark",
            "whitegrid",
            "darkgrid",
            "ticks"
         ],
         "title": "Style",
         "type": "string"
      },
      "context": {
         "default": "notebook",
         "enum": [
            "paper",
            "notebook",
            "talk",
            "poster"
         ],
         "title": "Context",
         "type": "string"
      },
      "palette": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            }
         ],
         "default": "tab10",
         "title": "Palette"
      }
   },
   "$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"
      },
      "Role": {
         "enum": [
            "undefined",
            "configuration",
            "context",
            "outputs",
            "parameters",
            "content",
            "page",
            "layout"
         ],
         "title": "Role",
         "type": "string"
      }
   }
}

Fields:
  • context (Literal['paper', 'notebook', 'talk', 'poster'])

  • palette (str | list[str])

  • style (Literal['white', 'dark', 'whitegrid', 'darkgrid', 'ticks'])

field style: Literal['white', 'dark', 'whitegrid', 'darkgrid', 'ticks'] = 'whitegrid'
field context: Literal['paper', 'notebook', 'talk', 'poster'] = 'notebook'
field palette: str | Annotated[list[str], SerializeAsAny()] = 'tab10'
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.