from __future__ import annotations from pathlib import Path from typing import TYPE_CHECKING import logistro from ._utils import path_tools if TYPE_CHECKING: from typing import Tuple, Union from typing_extensions import TypeAlias UrlAndCharset: TypeAlias = Tuple[Union[str, Path], str] """A tuple to explicitly set charset= in the """ """The header is the HTML that always goes at the top. Rarely needs changing.""" footer = f""" """ """The footer is the HTML that always goes on the bottom. Rarely needs changing.""" def __init__( # noqa: C901 self, *, plotly: None | Path | str | UrlAndCharset = None, mathjax: None | Path | str | bool | UrlAndCharset = None, others: None | list[Path | str | UrlAndCharset] = None, force_cdn: bool = False, ): """ Create a PageGenerator. Args: plotly: The url to the plotly.js to use. Defaults to plotly.js present in plotly.py, if installed. Otherwise fallback to value of DEFAULT_PLOTLY. mathjax: The url to the mathjax script. Defaults to values of DEFAULT_MATHJAX. Can be set to false to disable mathjax. others: A list of other script urls to include. Usually strings, but can be (str, str) where it's (url, encoding). force_cdn: Set True to force CDN use, defaults to False. """ self._scripts = [] if mathjax is not False: if mathjax is None or mathjax is True: mathjax = DEFAULT_MATHJAX elif mathjax: _ensure_file(mathjax) self._scripts.append(mathjax) if force_cdn: plotly = (DEFAULT_PLOTLY, "utf-8") elif not plotly: try: # ruff: noqa: PLC0415 # is this the best way to do this? can't we use importlib? import plotly as pltly # type: ignore[import-untyped] plotly_path = ( Path(pltly.__file__).parent / "package_data" / "plotly.min.js" ) plotly = ( plotly_path.as_uri(), "utf-8", ) if not plotly_path.is_file(): _logger.warning( f"Found plotly but path to js is wrong? {plotly[0]}", ) plotly = (DEFAULT_PLOTLY, "utf-8") else: plotly[0] except ImportError: _logger.info("Plotly not installed. Using CDN.") plotly = (DEFAULT_PLOTLY, "utf-8") elif isinstance(plotly, (str, Path)): _ensure_file(plotly) plotly = (plotly, "utf-8") _logger.debug(f"Plotly script: {plotly}") self._scripts.append(plotly) if others: for o in others: _ensure_file(o) self._scripts.extend(others) def generate_index(self): """Generate the page.""" page = self.header script_tag = '\n ' script_tag_charset = '\n ' for script in self._scripts: if isinstance(script, (str, Path)): page += script_tag % str(script) else: page += script_tag_charset % script page += self.footer _logger.debug2(page) return page