hubvault.remote.serde

Serialization helpers for hubvault.remote.

This module reconstructs public hubvault dataclasses and exception types from server JSON payloads.

The module contains:

decode_json_payload() - Normalize one decoded JSON payload
decode_error_response() - Map one error payload back to a public exception
decode_commit_change_info() - Decode one commit-diff entry
decode_commit_detail_info() - Decode one commit-detail payload

decode_json_payload

hubvault.remote.serde.decode_json_payload(payload)[source]

Return the decoded JSON payload unchanged for the skeleton stage.

Parameters:: payload (object) – Decoded JSON-compatible payload
Returns:: The same payload value
Return type:: object

decode_error_response

hubvault.remote.serde.decode_error_response(payload, *, status_code: int)[source]

Map one error payload back to a public exception object.

Parameters:

payload (object) – Raw decoded JSON payload
status_code (int) – HTTP status code attached to the response

Returns:

Public exception instance matching the server response

Return type:

Exception

decode_repo_info

hubvault.remote.serde.decode_repo_info(payload) → RepoInfo[source]

Decode repository metadata from JSON.

Parameters:: payload (object) – Raw repository payload
Returns:: Decoded repository metadata
Return type:: RepoInfo

decode_commit_info

hubvault.remote.serde.decode_commit_info(payload) → CommitInfo[source]

Decode one write-commit result from JSON.

Parameters:: payload (object) – Raw commit payload
Returns:: Decoded commit metadata
Return type:: CommitInfo

decode_commit_change_info

hubvault.remote.serde.decode_commit_change_info(payload) → CommitChangeInfo[source]

Decode one file-level commit change payload.

Parameters:: payload (object) – Raw commit change payload
Returns:: Decoded commit change metadata
Return type:: CommitChangeInfo

decode_repo_entry

hubvault.remote.serde.decode_repo_entry(payload)[source]

Decode one repository file or folder entry.

Parameters:: payload (object) – Raw repository entry payload
Returns:: Decoded file or folder entry
Return type:: Union[RepoFile, RepoFolder]
Raises:: HubVaultRemoteProtocolError – Raised when the entry type is unsupported.

decode_repo_entries

hubvault.remote.serde.decode_repo_entries(payload) → list[source]

Decode repository file and folder entries from JSON.

Parameters:: payload (object) – Raw repository entries payload
Returns:: Decoded repository entries
Return type:: list

decode_git_commit_info

hubvault.remote.serde.decode_git_commit_info(payload) → GitCommitInfo[source]

Decode one commit-list entry from JSON.

Parameters:: payload (object) – Raw commit-list payload
Returns:: Decoded commit-list entry
Return type:: GitCommitInfo

decode_git_commit_list

hubvault.remote.serde.decode_git_commit_list(payload) → list[source]

Decode commit-list entries from JSON.

Parameters:: payload (object) – Raw commit-list payload
Returns:: Decoded commit-list entries
Return type:: list

decode_commit_detail_info

hubvault.remote.serde.decode_commit_detail_info(payload) → CommitDetailInfo[source]

Decode one commit-detail payload.

Parameters:: payload (object) – Raw commit-detail payload
Returns:: Decoded commit detail metadata
Return type:: CommitDetailInfo

decode_git_ref_info

hubvault.remote.serde.decode_git_ref_info(payload) → GitRefInfo[source]

Decode one git reference entry from JSON.

Parameters:: payload (object) – Raw ref payload
Returns:: Decoded git ref entry
Return type:: GitRefInfo

decode_git_refs

hubvault.remote.serde.decode_git_refs(payload) → GitRefs[source]

Decode branch and tag refs from JSON.

Parameters:: payload (object) – Raw refs payload
Returns:: Decoded refs collection
Return type:: GitRefs

decode_reflog_entry

hubvault.remote.serde.decode_reflog_entry(payload) → ReflogEntry[source]

Decode one reflog entry from JSON.

Parameters:: payload (object) – Raw reflog payload
Returns:: Decoded reflog entry
Return type:: ReflogEntry

decode_reflog_entries

hubvault.remote.serde.decode_reflog_entries(payload) → list[source]

Decode reflog entries from JSON.

Parameters:: payload (object) – Raw reflog payload
Returns:: Decoded reflog entries
Return type:: list

decode_merge_conflict

hubvault.remote.serde.decode_merge_conflict(payload) → MergeConflict[source]

Decode one merge conflict from JSON.

Parameters:: payload (object) – Raw conflict payload
Returns:: Decoded merge conflict
Return type:: MergeConflict

decode_merge_result

hubvault.remote.serde.decode_merge_result(payload) → MergeResult[source]

Decode one structured merge result from JSON.

Parameters:: payload (object) – Raw merge payload
Returns:: Decoded merge result
Return type:: MergeResult

decode_verify_report

hubvault.remote.serde.decode_verify_report(payload) → VerifyReport[source]

Decode one verification report from JSON.

Parameters:: payload (object) – Raw verification payload
Returns:: Decoded verification report
Return type:: VerifyReport

decode_storage_section_info

hubvault.remote.serde.decode_storage_section_info(payload) → StorageSectionInfo[source]

Decode one storage-section entry from JSON.

Parameters:: payload (object) – Raw storage-section payload
Returns:: Decoded storage-section entry
Return type:: StorageSectionInfo

decode_storage_overview

hubvault.remote.serde.decode_storage_overview(payload) → StorageOverview[source]

Decode one storage-overview report from JSON.

Parameters:: payload (object) – Raw storage-overview payload
Returns:: Decoded storage overview
Return type:: StorageOverview

decode_gc_report

hubvault.remote.serde.decode_gc_report(payload) → GcReport[source]

Decode one GC report from JSON.

Parameters:: payload (object) – Raw GC payload
Returns:: Decoded GC report
Return type:: GcReport

decode_squash_report

hubvault.remote.serde.decode_squash_report(payload) → SquashReport[source]

Decode one history-squash report from JSON.

Parameters:: payload (object) – Raw squash payload
Returns:: Decoded squash report
Return type:: SquashReport

decode_snapshot_plan

hubvault.remote.serde.decode_snapshot_plan(payload) → dict[source]

Decode a snapshot-plan manifest from JSON.

Parameters:: payload (object) – Raw snapshot-plan payload
Returns:: Normalized snapshot-plan manifest
Return type:: dict