mirror of
https://github.com/tembo-pages/tembo-core.git
synced 2025-12-22 13:35:43 +00:00
2421 lines
76 KiB
HTML
2421 lines
76 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<meta name="description" content="Tembo: A simple folder organiser for your work notes.">
|
|
|
|
|
|
|
|
<meta name="author" content="Daniel Tomlinson">
|
|
|
|
|
|
<link rel="canonical" href="https://tembo-pages.github.io/tembo-core/code_reference/journal/pages/">
|
|
|
|
<link rel="icon" href="../../../assets/images/favicon.png">
|
|
<meta name="generator" content="mkdocs-1.2.3, mkdocs-material-7.3.6">
|
|
|
|
|
|
|
|
<title>pages.py - Tembo</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../../assets/stylesheets/main.a57b2b03.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../../../assets/stylesheets/palette.3f5d1f46.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
|
|
<style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
|
|
|
<link rel="stylesheet" href="../../../css/mkdocstrings.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="deep-orange" data-md-color-accent="orange">
|
|
|
|
|
|
<script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
|
|
|
|
<script>var palette=__get("__palette");if(null!==palette&&"object"==typeof palette.color)for(var key in palette.color)document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#tembo.journal.pages" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href="../../.." title="Tembo" class="md-header__button md-logo" aria-label="Tembo" data-md-component="logo">
|
|
|
|
<img src="../../../assets/tembo_doc_logo.png" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
Tembo
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
pages.py
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<form class="md-header__option" data-md-component="palette">
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="deep-orange" data-md-color-accent="orange" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22z"/></svg>
|
|
</label>
|
|
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="deep-orange" data-md-color-accent="orange" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31z"/></svg>
|
|
</label>
|
|
|
|
|
|
</form>
|
|
|
|
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
</label>
|
|
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
</label>
|
|
<nav class="md-search__options" aria-label="Search">
|
|
|
|
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
|
|
</button>
|
|
</nav>
|
|
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-header__source">
|
|
|
|
<a href="https://github.com/tembo-pages/tembo-core/" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
tembo-pages/tembo-core
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
|
|
<div class="md-tabs__inner md-grid">
|
|
<ul class="md-tabs__list">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../.." class="md-tabs__link">
|
|
Home
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../__init__/" class="md-tabs__link md-tabs__link--active">
|
|
Code Reference
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../../cli_reference/main/" class="md-tabs__link">
|
|
CLI Reference
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../../coverage/" class="md-tabs__link">
|
|
Development
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href="../../.." title="Tembo" class="md-nav__button md-logo" aria-label="Tembo" data-md-component="logo">
|
|
|
|
<img src="../../../assets/tembo_doc_logo.png" alt="logo">
|
|
|
|
</a>
|
|
Tembo
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
|
|
<a href="https://github.com/tembo-pages/tembo-core/" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
tembo-pages/tembo-core
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_1" type="checkbox" id="__nav_1" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1">
|
|
Home
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Home" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Home
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../.." class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../home/changelog/" class="md-nav__link">
|
|
Changelog
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../home/license/" class="md-nav__link">
|
|
License
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2">
|
|
Code Reference
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Code Reference" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Code Reference
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../__init__/" class="md-nav__link">
|
|
__init__.py
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../__main__/" class="md-nav__link">
|
|
__main__.py
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../_version/" class="md-nav__link">
|
|
_version.py
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_4" type="checkbox" id="__nav_2_4" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_4">
|
|
cli
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="cli" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_2_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
cli
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cli/__init__/" class="md-nav__link">
|
|
__init__.py
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cli/cli/" class="md-nav__link">
|
|
cli.py
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../exceptions/" class="md-nav__link">
|
|
exceptions.py
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_6" type="checkbox" id="__nav_2_6" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_6">
|
|
journal
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="journal" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_2_6">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
journal
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../__init__/" class="md-nav__link">
|
|
__init__.py
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
pages.py
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
pages.py
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages" class="md-nav__link">
|
|
tembo.journal.pages
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.Page" class="md-nav__link">
|
|
Page
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Page">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.Page.path" class="md-nav__link">
|
|
path
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.Page.__init__" class="md-nav__link">
|
|
__init__()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.Page.save_to_disk" class="md-nav__link">
|
|
save_to_disk()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.PageCreator" class="md-nav__link">
|
|
PageCreator
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="PageCreator">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.PageCreator.options" class="md-nav__link">
|
|
options
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.PageCreator.__init__" class="md-nav__link">
|
|
__init__()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.PageCreator.create_page" class="md-nav__link">
|
|
create_page()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.PageCreatorOptions" class="md-nav__link">
|
|
PageCreatorOptions
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPage" class="md-nav__link">
|
|
ScopedPage
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ScopedPage">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPage.path" class="md-nav__link">
|
|
path
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPage.__init__" class="md-nav__link">
|
|
__init__()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPage.__str__" class="md-nav__link">
|
|
__str__()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPage.save_to_disk" class="md-nav__link">
|
|
save_to_disk()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPageCreator" class="md-nav__link">
|
|
ScopedPageCreator
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ScopedPageCreator">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPageCreator.options" class="md-nav__link">
|
|
options
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPageCreator.__init__" class="md-nav__link">
|
|
__init__()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPageCreator.create_page" class="md-nav__link">
|
|
create_page()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_7" type="checkbox" id="__nav_2_7" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_7">
|
|
utils
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="utils" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_2_7">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
utils
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../utils/__init__/" class="md-nav__link">
|
|
__init__.py
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3">
|
|
CLI Reference
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="CLI Reference" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
CLI Reference
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../cli_reference/main/" class="md-nav__link">
|
|
tembo
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4">
|
|
Development
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Development" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Development
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../../coverage/" class="md-nav__link">
|
|
Coverage report
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages" class="md-nav__link">
|
|
tembo.journal.pages
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.Page" class="md-nav__link">
|
|
Page
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Page">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.Page.path" class="md-nav__link">
|
|
path
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.Page.__init__" class="md-nav__link">
|
|
__init__()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.Page.save_to_disk" class="md-nav__link">
|
|
save_to_disk()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.PageCreator" class="md-nav__link">
|
|
PageCreator
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="PageCreator">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.PageCreator.options" class="md-nav__link">
|
|
options
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.PageCreator.__init__" class="md-nav__link">
|
|
__init__()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.PageCreator.create_page" class="md-nav__link">
|
|
create_page()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.PageCreatorOptions" class="md-nav__link">
|
|
PageCreatorOptions
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPage" class="md-nav__link">
|
|
ScopedPage
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ScopedPage">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPage.path" class="md-nav__link">
|
|
path
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPage.__init__" class="md-nav__link">
|
|
__init__()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPage.__str__" class="md-nav__link">
|
|
__str__()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPage.save_to_disk" class="md-nav__link">
|
|
save_to_disk()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPageCreator" class="md-nav__link">
|
|
ScopedPageCreator
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ScopedPageCreator">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPageCreator.options" class="md-nav__link">
|
|
options
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPageCreator.__init__" class="md-nav__link">
|
|
__init__()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tembo.journal.pages.ScopedPageCreator.create_page" class="md-nav__link">
|
|
create_page()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
<a href="https://github.com/tembo-pages/tembo-core/edit/master/docs/tembo/journal/pages.py" title="Edit this page" class="md-content__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
|
|
</a>
|
|
|
|
|
|
<h1>pages.py</h1>
|
|
|
|
<div class="doc doc-object doc-module">
|
|
|
|
<a id="tembo.journal.pages"></a>
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Submodule containing the factories & page objects to create Tembo pages.</p>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h2 id="tembo.journal.pages.Page" class="doc doc-heading">
|
|
<code>
|
|
Page </code>
|
|
|
|
|
|
|
|
<a href="#tembo.journal.pages.Page" class="headerlink" title="Permanent link">¤</a></h2>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Abstract Page class.</p>
|
|
<p>This interface is used to define a <code>Page</code> object.</p>
|
|
<p>A <code>Page</code> represents a note/page that will be saved to disk.</p>
|
|
<div class="admonition abstract">
|
|
<p class="admonition-title">Abstract</p>
|
|
<p>This object is an abstract base class and should be implemented for each <code>Page</code> type.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.Page.path" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span></code>
|
|
|
|
<span class="doc doc-properties">
|
|
<small class="doc doc-property doc-property-property"><code>property</code></small>
|
|
<small class="doc doc-property doc-property-readonly"><code>readonly</code></small>
|
|
</span>
|
|
|
|
<a href="#tembo.journal.pages.Page.path" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>When implemented this should return the full path of the page including the filename.</p>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>pathlib.Path</code></td>
|
|
<td><p>the path as a <a href="https://docs.python.org/3/library/pathlib.html#pathlib.Path">Path</a> object.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table> <div class="admonition abstract">
|
|
<p class="admonition-title">Abstract</p>
|
|
</div>
|
|
<p>This property is abstract and should be implemented for each <code>Page</code> type.</p>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-method">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.Page.__init__" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">page_content</span><span class="p">)</span></code>
|
|
|
|
<span class="doc doc-properties">
|
|
<small class="doc doc-property doc-property-special"><code>special</code></small>
|
|
</span>
|
|
|
|
<a href="#tembo.journal.pages.Page.__init__" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>When implemented this should initalise a Page object.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>path</code></td>
|
|
<td><code>pathlib.Path</code></td>
|
|
<td><p>the full path of the page including the filename as a
|
|
<a href="https://docs.python.org/3/library/pathlib.html#pathlib.Path">Path</a>.</p></td>
|
|
<td><em>required</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page_content</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>the contents of the page.</p></td>
|
|
<td><em>required</em></td>
|
|
</tr>
|
|
</tbody>
|
|
</table> <div class="admonition abstract">
|
|
<p class="admonition-title">Abstract</p>
|
|
</div>
|
|
<p>This method is abstract and should be implemented for each <code>Page</code> type.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>tembo/journal/pages.py</code></summary>
|
|
<div class="highlight"><pre><span></span><code><span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">page_content</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> When implemented this should initalise a Page object.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> path (pathlib.Path): the full path of the page including the filename as a</span>
|
|
<span class="sd"> [Path][pathlib.Path].</span>
|
|
<span class="sd"> page_content (str): the contents of the page.</span>
|
|
|
|
<span class="sd"> !!! abstract</span>
|
|
<span class="sd"> This method is abstract and should be implemented for each `Page` type.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
|
|
</code></pre></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-method">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.Page.save_to_disk" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">save_to_disk</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></code>
|
|
|
|
|
|
<a href="#tembo.journal.pages.Page.save_to_disk" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>When implemented this should save the page to disk.</p>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>tembo.utils.Success</code></td>
|
|
<td><p>A Tembo <a href="../../utils/__init__/#tembo.utils.__init__.Success">Success</a> object.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table> <div class="admonition abstract">
|
|
<p class="admonition-title">Abstract</p>
|
|
</div>
|
|
<p>This method is abstract and should be implemented for each <code>Page</code> type.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>tembo/journal/pages.py</code></summary>
|
|
<div class="highlight"><pre><span></span><code><span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">save_to_disk</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">tembo</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">Success</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> When implemented this should save the page to disk.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> tembo.utils.Success: A Tembo [Success][tembo.utils.__init__.Success] object.</span>
|
|
|
|
<span class="sd"> !!! abstract</span>
|
|
<span class="sd"> This method is abstract and should be implemented for each `Page` type.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
|
|
</code></pre></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h2 id="tembo.journal.pages.PageCreator" class="doc doc-heading">
|
|
<code>
|
|
PageCreator </code>
|
|
|
|
|
|
|
|
<a href="#tembo.journal.pages.PageCreator" class="headerlink" title="Permanent link">¤</a></h2>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>A PageCreator factory base class.</p>
|
|
<p>This factory should implement methods to create <a href="#tembo.journal.pages.Page">Page</a> objects.</p>
|
|
<div class="admonition abstract">
|
|
<p class="admonition-title">Abstract</p>
|
|
<p>This factory is an abstract base class and should be implemented for each
|
|
<a href="#tembo.journal.pages.Page">Page</a> type.</p>
|
|
</div>
|
|
<p>The private methods</p>
|
|
<ul>
|
|
<li><code>_check_base_path_exists()</code></li>
|
|
<li><code>_convert_base_path_to_path()</code></li>
|
|
<li><code>_load_template()</code></li>
|
|
</ul>
|
|
<p>are not abstract and are shared between all <a href="#tembo.journal.pages.Page">Page</a> types.</p>
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.PageCreator.options" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">options</span><span class="p">:</span> <span class="n">PageCreatorOptions</span></code>
|
|
|
|
<span class="doc doc-properties">
|
|
<small class="doc doc-property doc-property-property"><code>property</code></small>
|
|
<small class="doc doc-property doc-property-readonly"><code>readonly</code></small>
|
|
</span>
|
|
|
|
<a href="#tembo.journal.pages.PageCreator.options" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>When implemented this should return the <code>PageCreatorOptions</code> on the class.</p>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>PageCreatorOptions</code></td>
|
|
<td><p>the instance of
|
|
<a href="#tembo.journal.pages.PageCreatorOptions">PageCreatorOptions</a> set on the class.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table> <div class="admonition abstract">
|
|
<p class="admonition-title">Abstract</p>
|
|
</div>
|
|
<p>This method is abstract and should be implemented for each
|
|
<a href="#tembo.journal.pages.Page">Page</a> type.</p>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-method">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.PageCreator.__init__" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span></code>
|
|
|
|
<span class="doc doc-properties">
|
|
<small class="doc doc-property doc-property-special"><code>special</code></small>
|
|
</span>
|
|
|
|
<a href="#tembo.journal.pages.PageCreator.__init__" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>When implemented this should initialise the <code>PageCreator</code> factory.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>options</code></td>
|
|
<td><code>PageCreatorOptions</code></td>
|
|
<td><p>An instance of
|
|
<a href="#tembo.journal.pages.PageCreatorOptions">PageCreatorOptions</a></p></td>
|
|
<td><em>required</em></td>
|
|
</tr>
|
|
</tbody>
|
|
</table> <div class="admonition abstract">
|
|
<p class="admonition-title">Abstract</p>
|
|
</div>
|
|
<p>This method is abstract and should be implemented for each
|
|
<a href="#tembo.journal.pages.Page">Page</a> type.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>tembo/journal/pages.py</code></summary>
|
|
<div class="highlight"><pre><span></span><code><span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="p">:</span> <span class="n">PageCreatorOptions</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> When implemented this should initialise the `PageCreator` factory.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> options (PageCreatorOptions): An instance of</span>
|
|
<span class="sd"> [PageCreatorOptions][tembo.journal.pages.PageCreatorOptions]</span>
|
|
|
|
<span class="sd"> !!! abstract</span>
|
|
<span class="sd"> This method is abstract and should be implemented for each</span>
|
|
<span class="sd"> [Page][tembo.journal.pages.Page] type.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
|
|
</code></pre></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-method">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.PageCreator.create_page" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">create_page</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></code>
|
|
|
|
|
|
<a href="#tembo.journal.pages.PageCreator.create_page" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>When implemented this should create a <code>Page</code> object.</p>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>Page</code></td>
|
|
<td><p>an implemented instance of <a href="#tembo.journal.pages.Page">Page</a> such as
|
|
<a href="#tembo.journal.pages.ScopedPage">ScopedPage</a>.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table> <div class="admonition abstract">
|
|
<p class="admonition-title">Abstract</p>
|
|
</div>
|
|
<p>This method is abstract and should be implemented for each
|
|
<a href="#tembo.journal.pages.Page">Page</a> type.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>tembo/journal/pages.py</code></summary>
|
|
<div class="highlight"><pre><span></span><code><span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">create_page</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Page</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> When implemented this should create a `Page` object.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> Page: an implemented instance of [Page][tembo.journal.pages.Page] such as</span>
|
|
<span class="sd"> [ScopedPage][tembo.journal.pages.ScopedPage].</span>
|
|
|
|
<span class="sd"> !!! abstract</span>
|
|
<span class="sd"> This method is abstract and should be implemented for each</span>
|
|
<span class="sd"> [Page][tembo.journal.pages.Page] type.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span>
|
|
</code></pre></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h2 id="tembo.journal.pages.PageCreatorOptions" class="doc doc-heading">
|
|
<code>
|
|
PageCreatorOptions </code>
|
|
|
|
|
|
<span class="doc doc-properties">
|
|
<small class="doc doc-property doc-property-dataclass"><code>dataclass</code></small>
|
|
</span>
|
|
|
|
<a href="#tembo.journal.pages.PageCreatorOptions" class="headerlink" title="Permanent link">¤</a></h2>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Options <a href="https://docs.python.org/3/library/dataclasses.html#dataclasses.dataclass">dataclass</a> to create a Page.</p>
|
|
<p>This is passed to an implemented instance of <a href="#tembo.journal.pages.PageCreator">PageCreator</a></p>
|
|
|
|
<p><strong>Attributes:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>base_path</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>The base path.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page_path</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>The path of the page relative to the base path.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>filename</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>The filename of the page.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>extension</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>The extension of the page.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>name</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>The name of the scope.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>user_input</code></td>
|
|
<td><code>Collection[str] | None</code></td>
|
|
<td><p>User input tokens.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>example</code></td>
|
|
<td><code>str | None</code></td>
|
|
<td><p>User example command.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template_path</code></td>
|
|
<td><code>str | None</code></td>
|
|
<td><p>The path which contains the templates. This should
|
|
be the full path and not relative to the base path.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>template_filename</code></td>
|
|
<td><code>str | None</code></td>
|
|
<td><p>The template filename with extension relative
|
|
to the template path.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h2 id="tembo.journal.pages.ScopedPage" class="doc doc-heading">
|
|
<code>
|
|
ScopedPage (<a title="tembo.journal.pages.Page" href="#tembo.journal.pages.Page">Page</a>)
|
|
</code>
|
|
|
|
|
|
|
|
<a href="#tembo.journal.pages.ScopedPage" class="headerlink" title="Permanent link">¤</a></h2>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>A page that uses substitute tokens.</p>
|
|
|
|
<p><strong>Attributes:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>path</code></td>
|
|
<td><code>pathlib.Path</code></td>
|
|
<td><p>a <a href="https://docs.python.org/3/library/pathlib.html#pathlib.Path">Path</a> object of the page's filepath including the
|
|
filename.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page_content</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>the content of the page from the template.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.ScopedPage.path" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span></code>
|
|
|
|
<span class="doc doc-properties">
|
|
<small class="doc doc-property doc-property-property"><code>property</code></small>
|
|
<small class="doc doc-property doc-property-readonly"><code>readonly</code></small>
|
|
</span>
|
|
|
|
<a href="#tembo.journal.pages.ScopedPage.path" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return the full path of the page.</p>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>pathlib.path</code></td>
|
|
<td><p>The full path of the page as a <a href="https://docs.python.org/3/library/pathlib.html#pathlib.Path">Path</a> object.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table> </div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-method">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.ScopedPage.__init__" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">page_content</span><span class="p">)</span></code>
|
|
|
|
<span class="doc doc-properties">
|
|
<small class="doc doc-property doc-property-special"><code>special</code></small>
|
|
</span>
|
|
|
|
<a href="#tembo.journal.pages.ScopedPage.__init__" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Initalise a scoped page object.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>path</code></td>
|
|
<td><code>pathlib.Path</code></td>
|
|
<td><p>a <a href="https://docs.python.org/3/library/pathlib.html#pathlib.Path">Path</a> object of the page's filepath including
|
|
the filename.</p></td>
|
|
<td><em>required</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page_content</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>the content of the page from the template.</p></td>
|
|
<td><em>required</em></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<details class="quote">
|
|
<summary>Source code in <code>tembo/journal/pages.py</code></summary>
|
|
<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">page_content</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Initalise a scoped page object.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> path (pathlib.Path): a [Path][pathlib.Path] object of the page's filepath including</span>
|
|
<span class="sd"> the filename.</span>
|
|
<span class="sd"> page_content (str): the content of the page from the template.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">path</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">page_content</span> <span class="o">=</span> <span class="n">page_content</span>
|
|
</code></pre></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-method">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.ScopedPage.__str__" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></code>
|
|
|
|
<span class="doc doc-properties">
|
|
<small class="doc doc-property doc-property-special"><code>special</code></small>
|
|
</span>
|
|
|
|
<a href="#tembo.journal.pages.ScopedPage.__str__" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return a <code>str</code> representation of a <code>ScopedPage</code>.</p>
|
|
|
|
<p><strong>Examples:</strong></p>
|
|
<div class="highlight"><pre><span></span><code>>>> str(ScopedPage(Path("/home/bob/tembo/meetings/my_meeting_0.md"), ""))
|
|
ScopedPage("/home/bob/tembo/meetings/my_meeting_0.md")
|
|
</code></pre></div>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>str</code></td>
|
|
<td><p>The <code>ScopedPage</code> as a <code>str</code>.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<details class="quote">
|
|
<summary>Source code in <code>tembo/journal/pages.py</code></summary>
|
|
<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Return a `str` representation of a `ScopedPage`.</span>
|
|
|
|
<span class="sd"> Examples:</span>
|
|
<span class="sd"> ```</span>
|
|
<span class="sd"> >>> str(ScopedPage(Path("/home/bob/tembo/meetings/my_meeting_0.md"), ""))</span>
|
|
<span class="sd"> ScopedPage("/home/bob/tembo/meetings/my_meeting_0.md")</span>
|
|
<span class="sd"> ```</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> str: The `ScopedPage` as a `str`.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="sa">f</span><span class="s1">'ScopedPage("</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="si">}</span><span class="s1">")'</span>
|
|
</code></pre></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-method">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.ScopedPage.save_to_disk" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">save_to_disk</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></code>
|
|
|
|
|
|
<a href="#tembo.journal.pages.ScopedPage.save_to_disk" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Save the scoped page to disk and write the <code>page_content</code>.</p>
|
|
|
|
<p><strong>Exceptions:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>exceptions.ScopedPageAlreadyExists</code></td>
|
|
<td><p>If the page already exists a
|
|
<a href="../../exceptions/#tembo.exceptions.ScopedPageAlreadyExists">ScopedPageAlreadyExists</a> exception
|
|
is raised.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>tembo.utils.Success</code></td>
|
|
<td><p>A <a href="../../utils/__init__/#tembo.utils.__init__.Success">Success</a> with the path of the
|
|
ScopedPage as the message.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<details class="quote">
|
|
<summary>Source code in <code>tembo/journal/pages.py</code></summary>
|
|
<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">save_to_disk</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">tembo</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">Success</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Save the scoped page to disk and write the `page_content`.</span>
|
|
|
|
<span class="sd"> Raises:</span>
|
|
<span class="sd"> exceptions.ScopedPageAlreadyExists: If the page already exists a</span>
|
|
<span class="sd"> [ScopedPageAlreadyExists][tembo.exceptions.ScopedPageAlreadyExists] exception</span>
|
|
<span class="sd"> is raised.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> tembo.utils.Success: A [Success][tembo.utils.__init__.Success] with the path of the</span>
|
|
<span class="sd"> ScopedPage as the message.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="c1"># create the parent directories</span>
|
|
<span class="n">scoped_page_file</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
|
|
<span class="n">scoped_page_file</span><span class="o">.</span><span class="n">parents</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">parents</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">exist_ok</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">scoped_page_file</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
|
<span class="k">raise</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">ScopedPageAlreadyExists</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="si">}</span><span class="s2"> already exists"</span><span class="p">)</span>
|
|
<span class="k">with</span> <span class="n">scoped_page_file</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">"w"</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">)</span> <span class="k">as</span> <span class="n">scoped_page</span><span class="p">:</span>
|
|
<span class="n">scoped_page</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">page_content</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">tembo</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">Success</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">))</span>
|
|
</code></pre></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h2 id="tembo.journal.pages.ScopedPageCreator" class="doc doc-heading">
|
|
<code>
|
|
ScopedPageCreator (<a title="tembo.journal.pages.PageCreator" href="#tembo.journal.pages.PageCreator">PageCreator</a>)
|
|
</code>
|
|
|
|
|
|
|
|
<a href="#tembo.journal.pages.ScopedPageCreator" class="headerlink" title="Permanent link">¤</a></h2>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Factory to create a scoped page.</p>
|
|
|
|
<p><strong>Attributes:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>base_path</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>base path of tembo.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>page_path</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>path of the page relative to the base path.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>filename</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>filename relative to the page path.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>extension</code></td>
|
|
<td><code>str</code></td>
|
|
<td><p>extension of file.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.ScopedPageCreator.options" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">options</span><span class="p">:</span> <span class="n">PageCreatorOptions</span></code>
|
|
|
|
<span class="doc doc-properties">
|
|
<small class="doc doc-property doc-property-property"><code>property</code></small>
|
|
<small class="doc doc-property doc-property-readonly"><code>readonly</code></small>
|
|
</span>
|
|
|
|
<a href="#tembo.journal.pages.ScopedPageCreator.options" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Return the <code>PageCreatorOptions</code> instance set on the factory.</p>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>PageCreatorOptions</code></td>
|
|
<td><p>An instance of <a href="#tembo.journal.pages.PageCreatorOptions">PageCreatorOptions</a>.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table> </div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-method">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.ScopedPageCreator.__init__" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span></code>
|
|
|
|
<span class="doc doc-properties">
|
|
<small class="doc doc-property doc-property-special"><code>special</code></small>
|
|
</span>
|
|
|
|
<a href="#tembo.journal.pages.ScopedPageCreator.__init__" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Initialise a <code>ScopedPageCreator</code> factory.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>options</code></td>
|
|
<td><code>PageCreatorOptions</code></td>
|
|
<td><p>An instance of
|
|
<a href="#tembo.journal.pages.PageCreatorOptions">PageCreatorOptions</a>.</p></td>
|
|
<td><em>required</em></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<details class="quote">
|
|
<summary>Source code in <code>tembo/journal/pages.py</code></summary>
|
|
<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="p">:</span> <span class="n">PageCreatorOptions</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Initialise a `ScopedPageCreator` factory.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> options (PageCreatorOptions): An instance of</span>
|
|
<span class="sd"> [PageCreatorOptions][tembo.journal.pages.PageCreatorOptions].</span>
|
|
<span class="sd"> """</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_all_input_tokens</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_options</span> <span class="o">=</span> <span class="n">options</span>
|
|
</code></pre></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-method">
|
|
|
|
|
|
|
|
<h3 id="tembo.journal.pages.ScopedPageCreator.create_page" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">create_page</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></code>
|
|
|
|
|
|
<a href="#tembo.journal.pages.ScopedPageCreator.create_page" class="headerlink" title="Permanent link">¤</a></h3>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Create a <a href="#tembo.journal.pages.ScopedPage">ScopedPage</a> object.</p>
|
|
<p>This method will</p>
|
|
<ul>
|
|
<li>Check the <code>base_path</code> exists</li>
|
|
<li>Verify the input tokens match the number defined in the <code>config.yml</code></li>
|
|
<li>Substitue the input tokens in the filepath</li>
|
|
<li>Load the template contents and substitue the input tokens</li>
|
|
</ul>
|
|
|
|
<p><strong>Exceptions:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>exceptions.MismatchedTokenError</code></td>
|
|
<td><p>Raises
|
|
<a href="../../exceptions/#tembo.exceptions.MismatchedTokenError">MismatchedTokenError</a> if the number of
|
|
input tokens does not match the number of unique input tokens defined.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exceptions.BasePathDoesNotExistError</code></td>
|
|
<td><p>Raises
|
|
<a href="../../exceptions/#tembo.exceptions.BasePathDoesNotExistError">BasePathDoesNotExistError</a> if the
|
|
base path does not exist.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>exceptions.TemplateFileNotFoundError</code></td>
|
|
<td><p>Raises
|
|
<a href="../../exceptions/#tembo.exceptions.TemplateFileNotFoundError">TemplateFileNotFoundError</a> if the
|
|
template file is specified but not found.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>Page</code></td>
|
|
<td><p>A <a href="#tembo.journal.pages.ScopedPage">ScopedPage</a> object using the
|
|
<code>PageCreatorOptions</code>.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<details class="quote">
|
|
<summary>Source code in <code>tembo/journal/pages.py</code></summary>
|
|
<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">create_page</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Page</span><span class="p">:</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Create a [ScopedPage][tembo.journal.pages.ScopedPage] object.</span>
|
|
|
|
<span class="sd"> This method will</span>
|
|
|
|
<span class="sd"> - Check the `base_path` exists</span>
|
|
<span class="sd"> - Verify the input tokens match the number defined in the `config.yml`</span>
|
|
<span class="sd"> - Substitue the input tokens in the filepath</span>
|
|
<span class="sd"> - Load the template contents and substitue the input tokens</span>
|
|
|
|
<span class="sd"> Raises:</span>
|
|
<span class="sd"> exceptions.MismatchedTokenError: Raises</span>
|
|
<span class="sd"> [MismatchedTokenError][tembo.exceptions.MismatchedTokenError] if the number of</span>
|
|
<span class="sd"> input tokens does not match the number of unique input tokens defined.</span>
|
|
<span class="sd"> exceptions.BasePathDoesNotExistError: Raises</span>
|
|
<span class="sd"> [BasePathDoesNotExistError][tembo.exceptions.BasePathDoesNotExistError] if the</span>
|
|
<span class="sd"> base path does not exist.</span>
|
|
<span class="sd"> exceptions.TemplateFileNotFoundError: Raises</span>
|
|
<span class="sd"> [TemplateFileNotFoundError][tembo.exceptions.TemplateFileNotFoundError] if the</span>
|
|
<span class="sd"> template file is specified but not found.</span>
|
|
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> Page: A [ScopedPage][tembo.journal.pages.ScopedPage] object using the</span>
|
|
<span class="sd"> `PageCreatorOptions`.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_check_base_path_exists</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">BasePathDoesNotExistError</span> <span class="k">as</span> <span class="n">base_path_does_not_exist_error</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">base_path_does_not_exist_error</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_all_input_tokens</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_input_tokens</span><span class="p">()</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_verify_input_tokens</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">MismatchedTokenError</span> <span class="k">as</span> <span class="n">mismatched_token_error</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">mismatched_token_error</span>
|
|
|
|
<span class="n">path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_convert_base_path_to_path</span><span class="p">()</span>
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_substitute_tokens</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">)))</span>
|
|
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">template_contents</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_template</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">TemplateFileNotFoundError</span> <span class="k">as</span> <span class="n">template_not_found_error</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">template_not_found_error</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">template_filename</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">template_contents</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_substitute_tokens</span><span class="p">(</span><span class="n">template_contents</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">ScopedPage</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">template_contents</span><span class="p">)</span>
|
|
</code></pre></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
|
|
<a href="#" class="md-top md-icon" data-md-component="top" data-md-state="hidden">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"/></svg>
|
|
Back to top
|
|
</a>
|
|
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
<nav class="md-footer__inner md-grid" aria-label="Footer">
|
|
|
|
|
|
<a href="../__init__/" class="md-footer__link md-footer__link--prev" aria-label="Previous: __init__.py" rel="prev">
|
|
<div class="md-footer__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
</div>
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Previous
|
|
</span>
|
|
__init__.py
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="../../utils/__init__/" class="md-footer__link md-footer__link--next" aria-label="Next: __init__.py" rel="next">
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Next
|
|
</span>
|
|
__init__.py
|
|
</div>
|
|
</div>
|
|
<div class="md-footer__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-footer-copyright">
|
|
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="md-footer-social">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/tembo-pages/tembo-core" target="_blank" rel="noopener" title="github.com" class="md-footer-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="mailto:dtomlinson@panaetius.co.uk" target="_blank" rel="noopener" title="" class="md-footer-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M476 3.2 12.5 270.6c-18.1 10.4-15.8 35.6 2.2 43.2L121 358.4l287.3-253.2c5.5-4.9 13.3 2.6 8.6 8.3L176 407v80.5c0 23.6 28.5 32.9 42.5 15.8L282 426l124.6 52.2c14.2 6 30.4-2.9 33-18.2l72-432C515 7.8 493.3-6.8 476 3.2z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://twitter.com/dmot7291" target="_blank" rel="noopener" title="twitter.com" class="md-footer-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.top", "navigation.instant"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../../assets/javascripts/workers/search.fcfe8b6d.min.js", "version": null}</script>
|
|
|
|
|
|
<script src="../../../assets/javascripts/bundle.b1047164.min.js"></script>
|
|
|
|
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |