Changeset View
Changeset View
Standalone View
Standalone View
swh/web/common/typing.py
| Show First 20 Lines • Show All 106 Lines • ▼ Show 20 Lines | class SnapshotContext(TypedDict): | ||||
| snapshot_swhid: str | snapshot_swhid: str | ||||
| """snapshot SWHID""" | """snapshot SWHID""" | ||||
| url_args: Dict[str, Any] | url_args: Dict[str, Any] | ||||
| """common URL arguments when browsing snapshot content""" | """common URL arguments when browsing snapshot content""" | ||||
| visit_info: Optional[OriginVisitInfo] | visit_info: Optional[OriginVisitInfo] | ||||
| """optional origin visit info associated to the snapshot""" | """optional origin visit info associated to the snapshot""" | ||||
| class SWHObjectMetadata(TypedDict, total=False): | class SWHObjectInfo(TypedDict): | ||||
| object_type: str | object_type: str | ||||
| object_id: str | |||||
| class SWHIDContext(TypedDict, total=False): | |||||
| origin: str | |||||
| anchor: str | |||||
| visit: str | |||||
| path: str | |||||
| lines: str | |||||
| class SWHIDInfo(SWHObjectInfo): | |||||
| swhid: str | |||||
| swhid_url: str | |||||
| context: SWHIDContext | |||||
| swhid_with_context: Optional[str] | |||||
| swhid_with_context_url: Optional[str] | |||||
| class SWHObjectInfoMetadata(TypedDict, total=False): | |||||
| origin_url: Optional[str] | origin_url: Optional[str] | ||||
| visit_date: Optional[str] | visit_date: Optional[str] | ||||
| visit_type: Optional[str] | visit_type: Optional[str] | ||||
| directory_url: Optional[str] | directory_url: Optional[str] | ||||
| revision_url: Optional[str] | revision_url: Optional[str] | ||||
| release_url: Optional[str] | release_url: Optional[str] | ||||
| snapshot_url: Optional[str] | snapshot_url: Optional[str] | ||||
| class ContentMetadata(SWHObjectMetadata): | class ContentMetadata(SWHObjectInfo, SWHObjectInfoMetadata): | ||||
| sha1: str | sha1: str | ||||
| sha1_git: str | sha1_git: str | ||||
| sha256: str | sha256: str | ||||
| blake2s256: str | blake2s256: str | ||||
| content_url: str | content_url: str | ||||
| mimetype: str | mimetype: str | ||||
| encoding: str | encoding: str | ||||
| size: str | size: str | ||||
| language: str | language: str | ||||
| licenses: str | licenses: str | ||||
| path: Optional[str] | path: Optional[str] | ||||
| filename: Optional[str] | filename: Optional[str] | ||||
| directory: Optional[str] | directory: Optional[str] | ||||
| root_directory: Optional[str] | |||||
| revision: Optional[str] | revision: Optional[str] | ||||
| release: Optional[str] | release: Optional[str] | ||||
| snapshot: Optional[str] | snapshot: Optional[str] | ||||
| class DirectoryMetadata(SWHObjectMetadata): | class DirectoryMetadata(SWHObjectInfo, SWHObjectInfoMetadata): | ||||
| directory: str | directory: str | ||||
| nb_files: int | nb_files: int | ||||
| nb_dirs: int | nb_dirs: int | ||||
| sum_file_sizes: str | sum_file_sizes: str | ||||
| root_directory: Optional[str] | |||||
| path: str | path: str | ||||
| revision: Optional[str] | revision: Optional[str] | ||||
| revision_found: Optional[bool] | revision_found: Optional[bool] | ||||
| release: Optional[str] | release: Optional[str] | ||||
| snapshot: Optional[str] | snapshot: Optional[str] | ||||
| class ReleaseMetadata(SWHObjectMetadata): | class ReleaseMetadata(SWHObjectInfo, SWHObjectInfoMetadata): | ||||
| release: str | release: str | ||||
| author: str | author: str | ||||
| author_url: str | author_url: str | ||||
| date: str | date: str | ||||
| name: str | name: str | ||||
| synthetic: bool | synthetic: bool | ||||
| target: str | target: str | ||||
| target_type: str | target_type: str | ||||
| target_url: str | target_url: str | ||||
| snapshot: Optional[str] | snapshot: Optional[str] | ||||
| class RevisionMetadata(SWHObjectMetadata): | class RevisionMetadata(SWHObjectInfo, SWHObjectInfoMetadata): | ||||
| revision: str | revision: str | ||||
| author: str | author: str | ||||
| author_url: str | author_url: str | ||||
| committer: str | committer: str | ||||
| committer_url: str | committer_url: str | ||||
| date: str | date: str | ||||
| committer_date: str | committer_date: str | ||||
| directory: str | directory: str | ||||
| merge: bool | merge: bool | ||||
| metadata: str | metadata: str | ||||
| parents: List[str] | parents: List[str] | ||||
| synthetic: bool | synthetic: bool | ||||
| type: str | type: str | ||||
| snapshot: Optional[str] | snapshot: Optional[str] | ||||