`granicus_archiver.web.types`¶

granicus_archiver.web.types.ConfigKey = <AppKey(granicus_archiver.web.types.Config, type=granicus_archiver.config.Config)>¶: App key for the granicus_archiver.config.Config instance

granicus_archiver.web.types.DataFileType¶: alias of Literal[‘clips’, ‘legistar’, ‘legistar_rguid’]

granicus_archiver.web.types.DataFiles¶: alias of dict[Literal[‘clips’, ‘legistar’, ‘legistar_rguid’], Path]

granicus_archiver.web.types.DataFileLockKey = <AppKey(granicus_archiver.web.types.DataFileLock, type=asyncio.locks.Lock)>¶: App key for the asyncio.Lock used to protect data files

granicus_archiver.web.types.ClipsKey = <AppKey(granicus_archiver.web.types.Clips, type=granicus_archiver.clips.model.ClipCollection)>¶: App key for the granicus_archiver.model.ClipCollection instance

granicus_archiver.web.types.LegistarDataKey = <AppKey(granicus_archiver.web.types.LegistarData, type=granicus_archiver.legistar.model.LegistarData)>¶: App key for the granicus_archiver.legistar.model.LegistarData instance

granicus_archiver.web.types.RGuidLegistarDataKey = <AppKey(granicus_archiver.web.types.RGuidLegistarDataKey, type=granicus_archiver.legistar.guid_model.RGuidLegistarData)>¶: App key for the granicus_archiver.legistar.guid_model.RGuidLegistarData instance

granicus_archiver.web.types.TimezoneKey = <AppKey(granicus_archiver.web.types.Timezone, type=zoneinfo.ZoneInfo)>¶

App key for the server’s default timezone

(Set from granicus_archiver.config.Config.local_timezone_name)

class granicus_archiver.web.types.StaticRoots[source]¶

Bases: TypedDict

Filesystem paths for static files if serving locally

assets: Path¶: Files specific to the web app

granicus: Path¶: Granicus clips

legistar: Path¶: Legistar data

legistar_rguid: Path¶: Legistar data with RGUIDs

class granicus_archiver.web.types.StaticUrlRoots[source]¶

Bases: TypedDict

Root URLs for static files

assets: URL¶: Files specific to the web app

granicus: URL¶: Granicus clips

legistar: URL¶: Legistar data

legistar_rguid: URL¶: Legistar data with RGUIDs

class granicus_archiver.web.types.NavLink(name: str, title: str, url: str | URL, view_kwargs: dict[str, Any] | None = None)[source]¶

Bases: NamedTuple

A navigation link

Parameters:

name (str)
title (str)
url (str | URL)
view_kwargs (dict[str, Any] | None)

name: str¶: Name of the link

title: str¶: Title of the link

url: str | URL¶: URL or view name for the link

view_kwargs: dict[str, Any] | None¶: Keyword arguments for the view, if any

get_url(app: Application) → URL[source]¶

Get the URL for the link

Parameters:: app (Application)
Return type:: URL

granicus_archiver.web.types.NavLinksKey = <AppKey(granicus_archiver.web.types.NavLinks, type=typing.Sequence[granicus_archiver.web.types.NavLink])>¶: App key for NavLink instances