"""
Provide demonstration site functionality.
"""
from __future__ import annotations
from contextlib import AsyncExitStack
from typing import TYPE_CHECKING
from typing_extensions import override
from betty import load, generate, serve
from betty.app import App
from betty.app.extension import Extension
from betty.extension.cotton_candy import CottonCandyConfiguration
from betty.load import Loader
from betty.locale import Date, DateRange, Str, DEFAULT_LOCALIZER, Localizable
from betty.model.ancestry import (
Place,
PlaceName,
Person,
Presence,
Subject,
PersonName,
Link,
Source,
Citation,
Event,
Enclosure,
Note,
)
from betty.model.event_type import Marriage, Birth, Death
from betty.project import (
LocaleConfiguration,
ExtensionConfiguration,
EntityReference,
Project,
)
from betty.serve import Server, NoPublicUrlBecauseServerNotStartedError
if TYPE_CHECKING:
from betty.model import Entity
[docs]
class Demo(Extension, Loader):
"""
Provide demonstration site functionality.
"""
[docs]
@override
@classmethod
def name(cls) -> str:
return "betty.extension.Demo"
[docs]
@override
@classmethod
def depends_on(cls) -> set[type[Extension]]:
from betty.extension import CottonCandy, HttpApiDoc, Maps, Trees, Wikipedia
return {CottonCandy, HttpApiDoc, Maps, Trees, Wikipedia}
def _load(self, *entities: Entity) -> None:
self._app.project.ancestry.add(*entities)
[docs]
@classmethod
def project(cls) -> Project:
"""
Create a new demonstration project.
"""
from betty.extension import CottonCandy, Demo
project = Project()
project.configuration.name = cls.name()
project.configuration.extensions.append(ExtensionConfiguration(Demo))
project.configuration.extensions.append(
ExtensionConfiguration(
CottonCandy,
extension_configuration=CottonCandyConfiguration(
featured_entities=[
EntityReference(Place, "betty-demo-amsterdam"),
EntityReference(Person, "betty-demo-liberta-lankester"),
EntityReference(Place, "betty-demo-netherlands"),
],
),
)
)
# Include all of the translations Betty ships with.
project.configuration.locales.replace(
LocaleConfiguration(
"en-US",
alias="en",
),
LocaleConfiguration(
"nl-NL",
alias="nl",
),
LocaleConfiguration(
"fr-FR",
alias="fr",
),
LocaleConfiguration(
"uk",
alias="uk",
),
LocaleConfiguration(
"de-DE",
alias="de",
),
)
return project
[docs]
@override
async def load(self) -> None:
netherlands = Place(
id="betty-demo-netherlands",
names=[
PlaceName(name="Netherlands"),
PlaceName(
name="Nederland",
locale="nl",
),
PlaceName(
name="Нідерланди",
locale="uk",
),
PlaceName(
name="Pays-Bas",
locale="fr",
),
],
links=[Link("https://en.wikipedia.org/wiki/Netherlands")],
)
self._load(netherlands)
north_holland = Place(
id="betty-demo-north-holland",
names=[
PlaceName(name="North Holland"),
PlaceName(
name="Noord-Holland",
locale="nl",
),
PlaceName(
name="Північна Голландія",
locale="uk",
),
PlaceName(
name="Hollande-Septentrionale",
locale="fr",
),
],
links=[
Link("https://en.wikipedia.org/wiki/North_Holland"),
Link("https://www.noord-holland.nl/Home"),
],
)
self._load(Enclosure(encloses=north_holland, enclosed_by=netherlands))
self._load(north_holland)
amsterdam_note = Note(
"""
Did you know that while Amsterdam is the country's official capital, The Hague is the Netherlands' administrative center and seat of government?
"""
)
amsterdam = Place(
id="betty-demo-amsterdam",
names=[
PlaceName(name="Amsterdam"),
PlaceName(
name="Амстерда́м",
locale="uk",
),
],
links=[
Link("https://nl.wikipedia.org/wiki/Amsterdam"),
Link("https://www.amsterdam.nl/"),
],
notes=[amsterdam_note],
)
self._load(Enclosure(encloses=amsterdam, enclosed_by=north_holland))
self._load(amsterdam)
ilpendam = Place(
id="betty-demo-ilpendam",
names=[
PlaceName(name="Ilpendam"),
PlaceName(
name="Илпендам",
locale="uk",
),
],
links=[Link("https://nl.wikipedia.org/wiki/Ilpendam")],
)
self._load(Enclosure(encloses=ilpendam, enclosed_by=north_holland))
self._load(ilpendam)
personal_accounts = Source(
id="betty-demo-personal-accounts",
name="Personal accounts",
)
self._load(personal_accounts)
cite_first_person_account = Citation(
id="betty-demo-first-person-account",
source=personal_accounts,
)
self._load(cite_first_person_account)
noord_hollands_archief = Source(
id="betty-demo-noord-hollands-archief",
name="Noord-Hollands Archief",
links=[Link("https://noord-hollandsarchief.nl/")],
)
self._load(noord_hollands_archief)
bevolkingsregister_amsterdam = Source(
id="betty-demo-bevolkingsregister-amsterdam",
name="Bevolkingsregister Amsterdam",
author="Gemeente Amsterdam",
publisher="Gemeente Amsterdam",
contained_by=noord_hollands_archief,
)
self._load(bevolkingsregister_amsterdam)
david_marinus_lankester = Person(id="betty-demo-david-marinus-lankester")
self._load(
PersonName(
person=david_marinus_lankester,
individual="David Marinus",
affiliation="Lankester",
),
david_marinus_lankester,
)
geertruida_van_ling = Person(id="betty-demo-geertruida-van-ling")
self._load(
PersonName(
person=geertruida_van_ling,
individual="Geertruida",
affiliation="Van Ling",
),
geertruida_van_ling,
)
marriage_of_dirk_jacobus_lankester_and_jannigje_palsen = Event(
id="betty-demo-marriage-of-dirk-jacobus-lankester-and-jannigje-palsen",
event_type=Marriage,
date=Date(1922, 7, 4),
place=ilpendam,
)
self._load(marriage_of_dirk_jacobus_lankester_and_jannigje_palsen)
birth_of_dirk_jacobus_lankester = Event(
id="betty-demo-birth-of-dirk-jacobus-lankester",
event_type=Birth,
date=Date(1897, 8, 25),
place=amsterdam,
)
self._load(birth_of_dirk_jacobus_lankester)
death_of_dirk_jacobus_lankester = Event(
id="betty-demo-death-of-dirk-jacobus-lankester",
event_type=Death,
date=Date(1986, 8, 18),
place=amsterdam,
)
self._load(death_of_dirk_jacobus_lankester)
dirk_jacobus_lankester = Person(
id="betty-demo-dirk-jacobus-lankester",
parents=(david_marinus_lankester, geertruida_van_ling),
)
self._load(
PersonName(
person=dirk_jacobus_lankester,
individual="Dirk Jacobus",
affiliation="Lankester",
),
Presence(
dirk_jacobus_lankester, Subject(), birth_of_dirk_jacobus_lankester
),
Presence(
dirk_jacobus_lankester, Subject(), death_of_dirk_jacobus_lankester
),
Presence(
dirk_jacobus_lankester,
Subject(),
marriage_of_dirk_jacobus_lankester_and_jannigje_palsen,
),
)
self._load(dirk_jacobus_lankester)
birth_of_marinus_david_lankester = Event(
id="betty-demo-birth-of-marinus-david",
event_type=Birth,
date=DateRange(
Date(1874, 1, 15),
Date(1874, 3, 21),
start_is_boundary=True,
end_is_boundary=True,
),
place=amsterdam,
)
self._load(birth_of_marinus_david_lankester)
death_of_marinus_david_lankester = Event(
id="betty-demo-death-of-marinus-david",
event_type=Death,
date=Date(1971),
place=amsterdam,
)
self._load(death_of_marinus_david_lankester)
marinus_david_lankester = Person(
id="betty-demo-marinus-david-lankester",
parents=(david_marinus_lankester, geertruida_van_ling),
)
self._load(
PersonName(
person=marinus_david_lankester,
individual="Marinus David",
affiliation="Lankester",
),
Presence(
marinus_david_lankester, Subject(), birth_of_marinus_david_lankester
),
Presence(
marinus_david_lankester, Subject(), death_of_marinus_david_lankester
),
)
self._load(marinus_david_lankester)
birth_of_jacoba_gesina_lankester = Event(
id="betty-demo-birth-of-jacoba-gesina",
event_type=Birth,
date=Date(1900, 3, 14),
place=amsterdam,
)
self._load(birth_of_jacoba_gesina_lankester)
jacoba_gesina_lankester = Person(
id="betty-demo-jacoba-gesina-lankester",
parents=(david_marinus_lankester, geertruida_van_ling),
)
self._load(
PersonName(
person=jacoba_gesina_lankester,
individual="Jacoba Gesina",
affiliation="Lankester",
),
Presence(
jacoba_gesina_lankester, Subject(), birth_of_jacoba_gesina_lankester
),
)
self._load(jacoba_gesina_lankester)
jannigje_palsen = Person(id="betty-demo-jannigje-palsen")
self._load(
PersonName(
person=jannigje_palsen,
individual="Jannigje",
affiliation="Palsen",
),
Presence(
jannigje_palsen,
Subject(),
marriage_of_dirk_jacobus_lankester_and_jannigje_palsen,
),
jannigje_palsen,
)
marriage_of_johan_de_boer_and_liberta_lankester = Event(
id="betty-demo-marriage-of-johan-de-boer-and-liberta-lankester",
event_type=Marriage,
date=Date(1953, 6, 19),
place=amsterdam,
)
self._load(marriage_of_johan_de_boer_and_liberta_lankester)
cite_birth_of_liberta_lankester_from_bevolkingsregister_amsterdam = Citation(
id="betty-demo-birth-of-liberta-lankester-from-bevolkingsregister-amsterdam",
source=bevolkingsregister_amsterdam,
location=Str.plain("Amsterdam"),
)
self._load(cite_birth_of_liberta_lankester_from_bevolkingsregister_amsterdam)
birth_of_liberta_lankester = Event(
id="betty-demo-birth-of-liberta-lankester",
event_type=Birth,
date=Date(1929, 12, 22),
place=amsterdam,
citations=[
cite_birth_of_liberta_lankester_from_bevolkingsregister_amsterdam
],
)
self._load(birth_of_liberta_lankester)
death_of_liberta_lankester = Event(
id="betty-demo-death-of-liberta-lankester",
event_type=Death,
date=Date(2015, 1, 17),
place=amsterdam,
citations=[cite_first_person_account],
)
self._load(death_of_liberta_lankester)
liberta_lankester_note = Note(
"""
Did you know that Liberta "Betty" Lankester is Betty's namesake?
"""
)
liberta_lankester = Person(
id="betty-demo-liberta-lankester",
parents=(dirk_jacobus_lankester, jannigje_palsen),
notes=[liberta_lankester_note],
)
self._load(
PersonName(
person=liberta_lankester,
individual="Liberta",
affiliation="Lankester",
),
PersonName(
person=liberta_lankester,
individual="Betty",
),
Presence(liberta_lankester, Subject(), birth_of_liberta_lankester),
Presence(liberta_lankester, Subject(), death_of_liberta_lankester),
Presence(
liberta_lankester,
Subject(),
marriage_of_johan_de_boer_and_liberta_lankester,
),
)
self._load(liberta_lankester)
birth_of_johan_de_boer = Event(
id="betty-demo-birth-of-johan-de-boer",
event_type=Birth,
date=Date(1930, 6, 20),
place=amsterdam,
)
self._load(birth_of_johan_de_boer)
death_of_johan_de_boer = Event(
id="betty-demo-death-of-johan-de-boer",
event_type=Death,
date=Date(1999, 3, 10),
place=amsterdam,
citations=[cite_first_person_account],
)
self._load(death_of_johan_de_boer)
johan_de_boer = Person(id="betty-demo-johan-de-boer")
self._load(
PersonName(
person=johan_de_boer,
individual="Johan",
affiliation="De Boer",
),
PersonName(
person=johan_de_boer,
individual="Hans",
),
Presence(johan_de_boer, Subject(), birth_of_johan_de_boer),
Presence(johan_de_boer, Subject(), death_of_johan_de_boer),
Presence(
johan_de_boer,
Subject(),
marriage_of_johan_de_boer_and_liberta_lankester,
),
johan_de_boer,
)
parent_of_bart_feenstra_child_of_liberta_lankester = Person(
id="betty-demo-parent-of-bart-feenstra-child-of-liberta-lankester",
parents=(johan_de_boer, liberta_lankester),
)
self._load(
PersonName(
person=parent_of_bart_feenstra_child_of_liberta_lankester,
individual="Bart's parent",
)
)
self._load(parent_of_bart_feenstra_child_of_liberta_lankester)
bart_feenstra = Person(
id="betty-demo-bart-feenstra",
parents=(parent_of_bart_feenstra_child_of_liberta_lankester,),
)
self._load(
PersonName(
person=bart_feenstra,
individual="Bart",
affiliation="Feenstra",
)
)
self._load(bart_feenstra)
[docs]
class DemoServer(Server):
"""
Serve the Betty demonstration site.
"""
[docs]
def __init__(
self,
app: App,
):
super().__init__(localizer=DEFAULT_LOCALIZER)
self._app = app
self._server: Server | None = None
self._exit_stack = AsyncExitStack()
[docs]
@override
@classmethod
def label(cls) -> Localizable:
return Str._("Demo")
@override
@property
def public_url(self) -> str:
if self._server is not None:
return self._server.public_url
raise NoPublicUrlBecauseServerNotStartedError()
[docs]
@override
async def start(self) -> None:
from betty.extension import Demo
await super().start()
project = Demo.project()
isolated_app_factory = App.new_from_app(
self._app,
project=project,
)
try:
isolated_app = await self._exit_stack.enter_async_context(
isolated_app_factory
)
await self._exit_stack.enter_async_context(isolated_app)
self._localizer = isolated_app.localizer
await load.load(isolated_app)
self._server = serve.BuiltinAppServer(isolated_app)
await self._exit_stack.enter_async_context(self._server)
isolated_app.project.configuration.base_url = self._server.public_url
await generate.generate(isolated_app)
except BaseException:
await self.stop()
raise
await self.assert_available()
[docs]
@override
async def stop(self) -> None:
await self._exit_stack.aclose()
await super().stop()