Source code for cdp_scrapers.types

#!/usr/bin/env python

from typing import Callable, Dict, List, NamedTuple, Optional

from bs4 import BeautifulSoup
from cdp_backend.pipeline.ingestion_models import Body, Person, Seat

###############################################################################




class ContentURIs(NamedTuple):
    video_uri: Optional[str]
    caption_uri: Optional[str] = None





class ScraperStaticData(NamedTuple):
    seats: Dict[str, Seat] = None
    primary_bodies: Dict[str, Body] = None
    persons: Dict[str, Person] = None





class PersonsComparison(NamedTuple):
    old_names: List[str] = []
    new_names: List[str] = []



LegistarContentParser = Callable[[str, BeautifulSoup], Optional[List[ContentURIs]]]
"""
Function that returns URLs for videos and captions
from a Legistar/Granicus-hosted video web page

Parameters
----------
client: str
    Which legistar client to target. Ex: "seattle"
video web page: BeautifulSoup
    Video web page loaded into bs4

Returns
-------
uris: Optional[List[ContentURIs]]
    URIs for video and optional caption

See Also
--------
cdp_scrapers.legistar_content_parsers
cdp_scrapers.legistar_utils.get_legistar_content_uris
"""