NotebookRunnerData#

pydantic model mobu.models.business.notebookrunner.NotebookRunnerData#

Status of a running NotebookRunner business.

Parameters:

data (Any)

Show JSON schema
{
   "title": "NotebookRunnerData",
   "description": "Status of a running NotebookRunner business.",
   "type": "object",
   "properties": {
      "name": {
         "examples": [
            "Business"
         ],
         "title": "Type of business",
         "type": "string"
      },
      "failure_count": {
         "examples": [
            0
         ],
         "title": "Number of failures",
         "type": "integer"
      },
      "success_count": {
         "examples": [
            25
         ],
         "title": "Number of successes",
         "type": "integer"
      },
      "refreshing": {
         "title": "If the business is currently in the process of refreshing",
         "type": "boolean"
      },
      "image": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunningImage"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Will only be present when there is an active Jupyter lab",
         "title": "Jupyter lab image information"
      },
      "notebook": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Will not be present if no notebook is being executed",
         "examples": [
            "cluster.ipynb"
         ],
         "title": "Name of the currently running notebook"
      },
      "running_code": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Will not be present if no code is being executed",
         "examples": [
            "import json\nprint(json.dumps({\"foo\": \"bar\"})\n"
         ],
         "title": "Currently running code"
      }
   },
   "$defs": {
      "RunningImage": {
         "description": "Information about the running Jupyter lab image.",
         "properties": {
            "reference": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Docker reference for the image"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Human-readable description of the image"
            }
         },
         "title": "RunningImage",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "failure_count",
      "success_count",
      "refreshing"
   ]
}

Config:
  • extra: str = forbid

Fields:
field failure_count: int [Required]#
field image: RunningImage | None = None#

Will only be present when there is an active Jupyter lab

field name: str [Required]#
field notebook: str | None = None#

Will not be present if no notebook is being executed

field refreshing: bool [Required]#
field running_code: str | None = None#

Will not be present if no code is being executed

field success_count: int [Required]#