graviti.manager.common#

Common tools.

Module Contents#

Classes#

DefaultValue

This class defines the default value of parameters from methods in manager.

Functions#

check_head_status(head, remote_revision, remote_commit_id)

Check if the commit for the HEAD of the current dataset is up-to-date.

Attributes#

LIMIT

CURRENT_COMMIT

CURRENT_BRANCH

ALL_BRANCHES

graviti.manager.common.LIMIT = 128[source]#
class graviti.manager.common.DefaultValue(name)[source]#

This class defines the default value of parameters from methods in manager.

Parameters

name (str) – The name of the default value.

graviti.manager.common.CURRENT_COMMIT :Any[source]#
graviti.manager.common.CURRENT_BRANCH :Any[source]#
graviti.manager.common.ALL_BRANCHES :Any[source]#
exception graviti.manager.common.StatusWarning(revision_type, name)[source]#

Bases: Warning

This class defines the warning that the commit of dataset branch or tag is not up-to-date.

Parameters

  • revision_type (str) – The type of current dataset revision.

  • name (str) – The name of current dataset revision.

graviti.manager.common.check_head_status(head, remote_revision, remote_commit_id)[source]#

Check if the commit for the HEAD of the current dataset is up-to-date.

Parameters

  • head (graviti.manager.commit.Commit) – The current revision of the local dataset.

  • remote_revision (str) – The revision of the remote dataset in server.

  • remote_commit_id (Optional[str]) – The commit id of the remote dataset in server.

Return type

None