dtomlinson/tembo-core
1
0
Fork 0
mirror of https://github.com/tembo-pages/tembo-core.git synced 2025-12-21 21:25:44 +00:00
Code Issues Projects Releases Wiki Activity

chore: remove duplicate abstract Page from pages submodule

Browse Source
This commit is contained in:
Daniel Tomlinson
2022-01-24 21:25:02 +00:00
parent a6f0852201
commit 86ffac8d67
1 changed files with 0 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
tembo/journal/pages.py
View File

@@ -4,7 +4,6 @@ from __future__ import annotations
import pathlib import pathlib
import re import re
from abc import ABCMeta, abstractmethod
from dataclasses import dataclass from dataclasses import dataclass
from typing import Collection, Optional from typing import Collection, Optional
@@ -356,61 +355,6 @@ class ScopedPageCreator(PageCreator):
return tokenified_string return tokenified_string
class Page(metaclass=ABCMeta):
"""
Abstract Page class.
This interface is used to define a `Page` object.
A `Page` represents a note/page that will be saved to disk.
!!! abstract
This object is an abstract base class and should be implemented for each `Page` type.
"""
@abstractmethod
def __init__(self, path: pathlib.Path, page_content: str) -> None:
"""
When implemented this should initalise a Page object.
Args:
path (pathlib.Path): the full path of the page including the filename as a
[Path][pathlib.Path].
page_content (str): the contents of the page.
!!! abstract
This method is abstract and should be implemented for each `Page` type.
"""
raise NotImplementedError
@property
@abstractmethod
def path(self) -> pathlib.Path:
"""
When implemented this should return the full path of the page including the filename.
Returns:
pathlib.Path: the path as a [Path][pathlib.Path] object.
!!! abstract
This property is abstract and should be implemented for each `Page` type.
"""
raise NotImplementedError
@abstractmethod
def save_to_disk(self) -> tembo.utils.Success:
"""
When implemented this should save the page to disk.
Returns:
tembo.utils.Success: A Tembo [Success][tembo.utils.__init__.Success] object.
!!! abstract
This method is abstract and should be implemented for each `Page` type.
"""
raise NotImplementedError
class ScopedPage(Page): class ScopedPage(Page):
""" """
A page that uses substitute tokens. A page that uses substitute tokens.