Changeset View
Changeset View
Standalone View
Standalone View
swh/web/common/typing.py
| # Copyright (C) 2020 The Software Heritage developers | # Copyright (C) 2020 The Software Heritage developers | ||||
| # See the AUTHORS file at the top-level directory of this distribution | # See the AUTHORS file at the top-level directory of this distribution | ||||
| # License: GNU Affero General Public License version 3, or any later version | # License: GNU Affero General Public License version 3, or any later version | ||||
| # See top-level LICENSE file for more information | # See top-level LICENSE file for more information | ||||
| from typing import Any, Dict, Union | from typing import Any, Dict, List, Optional, Union | ||||
| from typing_extensions import TypedDict | |||||
| from django.http import QueryDict | from django.http import QueryDict | ||||
| QueryParameters = Union[Dict[str, Any], QueryDict] | QueryParameters = Union[Dict[str, Any], QueryDict] | ||||
| class OriginInfo(TypedDict): | |||||
| url: str | |||||
| """URL of the origin""" | |||||
| class OriginVisitInfo(TypedDict): | |||||
| date: str | |||||
| """date of the visit in iso format""" | |||||
| formatted_date: str | |||||
| """formatted date of the visit""" | |||||
| metadata: Dict[str, Any] | |||||
| """metadata associated to the visit""" | |||||
| origin: str | |||||
| """visited origin URL""" | |||||
| snapshot: str | |||||
| """snapshot identifier computed during the visit""" | |||||
| status: str | |||||
| """status of the visit ("ongoing", "full" or "partial") """ | |||||
| type: str | |||||
| """visit type (git, hg, debian, ...)""" | |||||
| url: str | |||||
| """URL to browse the snapshot""" | |||||
| visit: int | |||||
| """visit identifier""" | |||||
| class SnapshotBranchInfo(TypedDict): | |||||
| date: Optional[str] | |||||
| """"author date of branch heading revision""" | |||||
| directory: Optional[str] | |||||
| """directory associated to branch heading revision""" | |||||
| message: Optional[str] | |||||
| """message of branch heading revision""" | |||||
| name: Optional[str] | |||||
| """branch name""" | |||||
| revision: str | |||||
| """branch heading revision""" | |||||
| url: Optional[str] | |||||
| """optional browse URL (content, directory, ...) scoped to branch""" | |||||
| class SnapshotReleaseInfo(TypedDict): | |||||
| branch_name: str | |||||
| """branch name associated to release in snapshot""" | |||||
| date: str | |||||
| """release date""" | |||||
| directory: Optional[str] | |||||
| """optional directory associatd to the release""" | |||||
| id: str | |||||
| """release identifier""" | |||||
| message: str | |||||
| """release message""" | |||||
| name: str | |||||
| """release name""" | |||||
| target: str | |||||
| """release target""" | |||||
| target_type: str | |||||
| """release target_type""" | |||||
| url: Optional[str] | |||||
| """optional browse URL (content, directory, ...) scoped to release""" | |||||
| class SnapshotContext(TypedDict): | |||||
| branch: Optional[str] | |||||
| """optional branch name set when browsing snapshot int that scope""" | |||||
| branches: List[SnapshotBranchInfo] | |||||
| """list of snapshot branches (possibly truncated)""" | |||||
| branches_url: str | |||||
| """snapshot branches list browse URL""" | |||||
| is_empty: bool | |||||
| """indicates if the snapshot is empty""" | |||||
| origin_info: Optional[OriginInfo] | |||||
| """optional origin info associated to the snapshot""" | |||||
| origin_visits_url: Optional[str] | |||||
| """optional origin visits URL""" | |||||
| query_params: QueryParameters | |||||
| """common query parameters when browsing snapshot content""" | |||||
| release: Optional[str] | |||||
| """optional release name set when browsing snapshot int that scope""" | |||||
| release_id: Optional[str] | |||||
| """optional release identifier set when browsing snapshot int that scope""" | |||||
| releases: List[SnapshotReleaseInfo] | |||||
| """list of snapshot releases (possibly truncated)""" | |||||
| releases_url: str | |||||
| """snapshot releases list browse URL""" | |||||
| revision_id: Optional[str] | |||||
| """optional revision identifier set when browsing snapshot int that scope""" | |||||
| root_directory: Optional[str] | |||||
| """optional root directory identifier set when browsing snapshot content""" | |||||
| snapshot_id: str | |||||
| """snapshot identifier""" | |||||
| snapshot_sizes: Dict[str, int] | |||||
| """snapshot sizes grouped by branch target type""" | |||||
| snapshot_swhid: str | |||||
| """snapshot SWHID""" | |||||
| url_args: Dict[str, Any] | |||||
| """common URL arguments when browsing snapshot content""" | |||||
| visit_info: Optional[OriginVisitInfo] | |||||
| """optional origin visit info associated to the snapshot""" | |||||