from typing import Any
from pybdl.api.client import (
BaseAPIClient,
FormatLiteral,
LanguageLiteral,
)
[docs]
class YearsAPI(BaseAPIClient):
"""
Client for the BDL /years endpoints.
Provides access to available data years in the Local Data Bank (BDL), including
listing all years, retrieving year details, and accessing years API metadata.
"""
[docs]
def list_years(
self,
sort: str | None = None,
page_size: int = 100,
max_pages: int | None = None,
lang: LanguageLiteral | None = None,
format: FormatLiteral | None = None,
if_none_match: str | None = None,
if_modified_since: str | None = None,
extra_query: dict[str, Any] | None = None,
) -> list[dict[str, Any]]:
"""
List all available years for which data is present in the BDL API.
Maps to: GET /years
Args:
sort: Optional sort parameter.
page_size: Number of results per page.
max_pages: Maximum number of pages to fetch (None for all).
lang: Expected response content language (defaults to config.language).
format: Expected response content type (defaults to config.format).
if_none_match: Conditional request header If-None-Match (entity tag).
if_modified_since: Conditional request header If-Modified-Since.
extra_query: Additional query parameters.
Returns:
List of available years as dicts.
"""
extra_params: dict[str, Any] = {}
if sort:
extra_params["sort"] = sort
if extra_query:
extra_params.update(extra_query)
params, headers = self._prepare_api_params_and_headers(
lang=lang,
format=format,
if_none_match=if_none_match,
if_modified_since=if_modified_since,
extra_params=extra_params,
)
return self.fetch_all_results(
"years",
params=params if params else None,
headers=headers if headers else None,
page_size=page_size,
max_pages=max_pages,
)
[docs]
def get_year(
self,
year_id: int,
lang: LanguageLiteral | None = None,
format: FormatLiteral | None = None,
if_none_match: str | None = None,
if_modified_since: str | None = None,
extra_query: dict[str, Any] | None = None,
) -> dict[str, Any]:
"""
Retrieve metadata for a specific year.
Maps to: GET /years/{id}
Args:
year_id: Year identifier (integer, e.g. 2020).
lang: Expected response content language (defaults to config.language).
format: Expected response content type (defaults to config.format).
if_none_match: Conditional request header If-None-Match (entity tag).
if_modified_since: Conditional request header If-Modified-Since.
extra_query: Additional query parameters.
Returns:
Dictionary with year metadata.
"""
params, headers = self._prepare_api_params_and_headers(
lang=lang,
format=format,
if_none_match=if_none_match,
if_modified_since=if_modified_since,
extra_params=extra_query,
)
return self.fetch_single_result(
f"years/{year_id}", params=params if params else None, headers=headers if headers else None
)
[docs]
async def alist_years(
self,
sort: str | None = None,
page_size: int = 100,
max_pages: int | None = None,
lang: LanguageLiteral | None = None,
format: FormatLiteral | None = None,
if_none_match: str | None = None,
if_modified_since: str | None = None,
extra_query: dict[str, Any] | None = None,
) -> list[dict[str, Any]]:
"""
Asynchronously list all available years for which data is present in the BDL API.
Maps to: GET /years
Args:
sort: Optional sort parameter.
page_size: Number of results per page.
max_pages: Maximum number of pages to fetch (None for all).
lang: Expected response content language (defaults to config.language).
format: Expected response content type (defaults to config.format).
if_none_match: Conditional request header If-None-Match (entity tag).
if_modified_since: Conditional request header If-Modified-Since.
extra_query: Additional query parameters.
Returns:
List of available years as dicts.
"""
extra_params: dict[str, Any] = {}
if sort:
extra_params["sort"] = sort
if extra_query:
extra_params.update(extra_query)
params, headers = self._prepare_api_params_and_headers(
lang=lang,
format=format,
if_none_match=if_none_match,
if_modified_since=if_modified_since,
extra_params=extra_params,
)
return await self.afetch_all_results(
"years",
params=params if params else None,
headers=headers if headers else None,
page_size=page_size,
max_pages=max_pages,
)
[docs]
async def aget_year(
self,
year_id: int,
lang: LanguageLiteral | None = None,
format: FormatLiteral | None = None,
if_none_match: str | None = None,
if_modified_since: str | None = None,
extra_query: dict[str, Any] | None = None,
) -> dict[str, Any]:
"""
Asynchronously retrieve metadata for a specific year.
Maps to: GET /years/{id}
Args:
year_id: Year identifier (integer, e.g. 2020).
lang: Expected response content language (defaults to config.language).
format: Expected response content type (defaults to config.format).
if_none_match: Conditional request header If-None-Match (entity tag).
if_modified_since: Conditional request header If-Modified-Since.
extra_query: Additional query parameters.
Returns:
Dictionary with year metadata.
"""
params, headers = self._prepare_api_params_and_headers(
lang=lang,
format=format,
if_none_match=if_none_match,
if_modified_since=if_modified_since,
extra_params=extra_query,
)
return await self.afetch_single_result(
f"years/{year_id}", params=params if params else None, headers=headers if headers else None
)