from typing import TYPE_CHECKING, Optional
from IPython.display import HTML
from nbformat import NotebookNode
from pydantic import Field, SerializeAsAny, field_validator
from nbprint.config.base import BaseModel, Role, _append_or_extend
from nbprint.config.common import Style
from nbprint.config.exceptions import NBPrintNullCellError
if TYPE_CHECKING:
from nbprint.config.core import Configuration
[docs]
class Content(BaseModel):
content: str | list[SerializeAsAny[BaseModel]] | None = ""
tags: list[str] = Field(default_factory=list)
role: Role = Role.CONTENT
# cell magics
magics: list[str] | None = Field(default_factory=list, description="List of cell magics to apply to the cell")
# output key
output: str | None = Field(
default=None,
description="If set, the cell's outputs will be collected into the `Outputs` context under this key (only for code cells).",
)
# used by lots of things
style: Style | None = None
@field_validator("tags", mode="after")
@classmethod
def _ensure_tags(cls, v: list[str]) -> list[str]:
if "nbprint:content" not in v:
v.append("nbprint:content")
return v
def _merge_style_css(self) -> None:
"""Merge structured ``style`` properties into ``self.css`` for rendering."""
if not isinstance(self.style, Style):
return
style_css = self.style.to_css_properties()
if not style_css:
return
# Wrap in :scope so @scope(...) in the template targets the cell wrapper
scoped = f":scope {{\n{style_css}\n}}"
if self.css:
self.css = f"{self.css}\n{scoped}"
else:
self.css = scoped
[docs]
def render(self, **kwargs) -> None:
super().render(**kwargs)
self._merge_style_css()
def _postprocess_cell(self, cell) -> None:
if isinstance(self.content, str) and self.content:
# replace content if its a str
cell.source = self.content
# remove the data, redundant
cell.metadata.nbprint.data = ""
if self.output:
# Add output tag
if f"nbprint:output:{self.output}" not in cell.metadata.get("tags", []):
cell.metadata.tags.append(f"nbprint:output:{self.output}")
# Add to nbprint meta
cell.metadata.nbprint.output = self.output
[docs]
def generate(
self,
metadata: dict | None = None,
config: Optional["Configuration"] = None,
parent: Optional["BaseModel"] = None,
attr: str = "",
counter: int | None = None,
) -> NotebookNode | list[NotebookNode] | None:
# make a cell for yourself
self_cell = super().generate(
metadata=metadata,
config=config,
parent=parent,
attr=attr or "content",
counter=counter,
)
self._postprocess_cell(self_cell)
cells = [self_cell]
if isinstance(self.content, list):
for i, cell in enumerate(self.content):
_append_or_extend(
cells,
cell.generate(metadata=metadata, config=config, parent=self, attr=attr or "content", counter=i),
)
for cell in cells:
if cell is None:
raise NBPrintNullCellError
# prefix cells with magics
for cell in cells:
cell: NotebookNode
if self.magics:
for magic in self.magics:
cell.source = f"%%{magic}\n{cell.source}"
return cells
[docs]
@field_validator("content", mode="before")
@classmethod
def convert_content_from_obj(cls, v) -> "Content":
if v is None:
return []
if isinstance(v, list):
for i, element in enumerate(v):
if isinstance(element, str):
v[i] = Content(type_=element)
elif isinstance(element, dict):
v[i] = BaseModel._to_type(element)
return v
def __call__(self, **_) -> HTML:
return HTML("")
[docs]
class ContentMarkdown(Content):
content: str | None = ""
[docs]
def generate(
self,
metadata: dict | None = None,
config: Optional["Configuration"] = None,
parent: Optional["BaseModel"] = None,
**_,
) -> NotebookNode | list[NotebookNode] | None:
cell = super()._base_generate_md(metadata=metadata, config=config, parent=parent)
cell.source = self.content
return cell
[docs]
class ContentCode(Content): ...