#!/usr/bin/env python3
#
# Copyright 2022 Graviti. Licensed under MIT License.
#
"""The implementation of the Commit and CommitManager."""
from datetime import datetime
from typing import TYPE_CHECKING, Any, Dict, Generator, List, Optional, Tuple, Type, TypeVar, Union
from graviti.dataframe import DataFrame
from graviti.exception import NoCommitsError
from graviti.manager.common import CURRENT_COMMIT, LIMIT, check_head_status
from graviti.manager.lazy import LazyPagingList
from graviti.manager.sheets import Sheets
from graviti.openapi import (
get_commit,
get_commit_sheet,
get_revision,
list_commit_data,
list_commit_sheets,
list_commits,
)
from graviti.operation import SheetOperation
from graviti.utility import LazyAttr, check_type, convert_iso_to_datetime
if TYPE_CHECKING:
from graviti.manager.dataset import Dataset
_C = TypeVar("_C", bound="Commit")
_NC = TypeVar("_NC", bound="NamedCommit")
[docs]class Commit(Sheets): # pylint: disable=too-many-instance-attributes
"""This class defines the structure of a commit.
Arguments:
dataset: Class :class:`~graviti.dataset.dataset.Dataset` instance.
commit_id: The commit id.
Attributes:
commit_id: The commit id of the commit.
parent: The parent commit of the commit.
title: The title of the commit.
description: The description of the commit.
committer: The committer of the commit.
committed_at: The commit time of the commit.
"""
_repr_attrs: Tuple[str, ...] = ("parent", "title", "committer", "committed_at")
[docs] parent = LazyAttr[Optional["Commit"]]()
[docs] title = LazyAttr[str]()
[docs] description = LazyAttr[str]()
[docs] committer = LazyAttr[str]()
[docs] committed_at = LazyAttr[datetime]()
def __init__(
self,
dataset: "Dataset",
commit_id: Optional[str],
) -> None:
self._dataset = dataset
self.commit_id = commit_id
self.operations: List[SheetOperation] = []
def _init(self, response: Dict[str, Any]) -> None:
parent_commit_id = response["parent_commit_id"]
self.parent = None if parent_commit_id is None else Commit(self._dataset, parent_commit_id)
self.title = response["title"]
self.description = response["description"]
self.committer = response["committer"]
self.committed_at = convert_iso_to_datetime(response["committed_at"])
def _load(self) -> None:
if self.commit_id is None:
raise AttributeError(
"The attribute is not available due to this commit has no commit history."
)
_workspace = self._dataset.workspace
response = get_commit(
_workspace.access_key,
_workspace.url,
_workspace.name,
self._dataset.name,
commit_id=self.commit_id,
)
self._init(response)
def _repr_head(self) -> str:
return f'{self.__class__.__name__}("{self.commit_id}")'
def _list_data(self, offset: int, limit: int, sheet_name: str) -> Dict[str, Any]:
_workspace = self._dataset.workspace
return list_commit_data( # type: ignore[no-any-return]
_workspace.access_key,
_workspace.url,
_workspace.name,
self._dataset.name,
commit_id=self.commit_id, # type: ignore[arg-type]
sheet=sheet_name,
offset=offset,
limit=limit,
)["data"]
def _list_sheets(self) -> Dict[str, Any]:
if self.commit_id is None:
return {"sheets": []}
_workspace = self._dataset.workspace
return list_commit_sheets(
_workspace.access_key,
_workspace.url,
_workspace.name,
self._dataset.name,
commit_id=self.commit_id,
)
def _get_sheet(self, sheet_name: str) -> Dict[str, Any]:
_workspace = self._dataset.workspace
return get_commit_sheet(
_workspace.access_key,
_workspace.url,
_workspace.name,
self._dataset.name,
commit_id=self.commit_id, # type: ignore[arg-type]
sheet=sheet_name,
with_record_count=True,
)
def _init_dataframe(self, sheet_name: str) -> DataFrame:
df = super()._init_dataframe(sheet_name)
df.search_creator = (
lambda criteria: self._dataset.searches._create( # pylint: disable=protected-access
self.commit_id, None, sheet_name, criteria
)
)
return df
@classmethod
[docs] def from_response(cls: Type[_C], dataset: "Dataset", response: Dict[str, Any]) -> _C:
"""Create a :class:`Commit` instance from python dict.
Arguments:
dataset: The dataset of the commit.
response: A python dict containing all the information of the commit::
{
"commit_id": <str>
"parent_commit_id": <Optional[str]>
"title": <str>
"description": <str>
"committer": <str>
"committed_at": <str>
}
Returns:
A :class:`Commit` instance created from the input python dict.
"""
obj = cls(dataset, response["commit_id"])
obj._init(response)
return obj
[docs]class NamedCommit(Commit):
"""This class defines the structure of a named commit.
:class:`NamedCommit` is the base class of :class:`~graviti.manager.branch.Branch`
and :class:`~graviti.manager.tag.Tag`.
Arguments:
dataset: Class :class:`~graviti.dataset.dataset.Dataset` instance.
name: The name of the named commit.
commit_id: The commit id.
"""
_repr_attrs = ("commit_id",) + Commit._repr_attrs
def __init__(
self,
dataset: "Dataset",
name: str,
commit_id: Optional[str],
) -> None:
super().__init__(dataset, commit_id)
self.name = name
def _repr_head(self) -> str:
return f'{self.__class__.__name__}("{self.name}")'
@classmethod
[docs] def from_response(cls: Type[_NC], dataset: "Dataset", response: Dict[str, Any]) -> _NC:
"""Create a :class:`NamedCommit` instance from python dict.
Arguments:
dataset: The dataset of the NamedCommit.
response: A python dict containing all the information of the NamedCommit::
{
"name": <str>
"commit_id": <Optional[str]>
"parent_commit_id": <Optional[str]>
"title": <str>
"description": <str>
"committer": <str>
"committed_at": <str>
}
Returns:
A :class:`NamedCommit` instance created from the input python dict.
"""
obj = cls(dataset, response["name"], response["commit_id"])
obj._init(response)
return obj
[docs]class CommitManager:
"""This class defines the operations on the commit in Graviti.
Arguments:
dataset: :class:`~graviti.manager.dataset.Dataset` instance.
"""
def __init__(self, dataset: "Dataset") -> None:
self._dataset = dataset
def _generate(self, revision: str, offset: int, limit: int) -> Generator[Commit, None, int]:
_dataset = self._dataset
_workspace = _dataset.workspace
head = _dataset.HEAD
response = list_commits(
_workspace.access_key,
_workspace.url,
_workspace.name,
_dataset.name,
revision=revision,
offset=offset,
limit=limit,
)
commits = response["commits"]
if offset == 0 and commits:
check_head_status(head, revision, commits[0]["commit_id"])
for item in commits:
yield Commit.from_response(_dataset, item)
return response["total_count"] # type: ignore[no-any-return]
[docs] def get(self, revision: str = CURRENT_COMMIT) -> Commit:
"""Get the certain commit with the given revision.
Arguments:
revision: The information to locate the specific commit, which can be the commit id,
the branch name, or the tag name. The default value is the current commit of the
dataset.
Raises:
NoCommitsError: When revision is not given and the commit id of current dataset is None,
or when the given branch has no commit history yet.
Returns:
The :class:`.Commit` instance with the given revision.
"""
_dataset = self._dataset
_workspace = _dataset.workspace
head = _dataset.HEAD
if revision is CURRENT_COMMIT:
_revision = head.commit_id
if _revision is None:
raise NoCommitsError("No commits on the default branch yet")
else:
check_type("revision", revision, str)
_revision = revision
response = get_revision(
_workspace.access_key,
_workspace.url,
_workspace.name,
_dataset.name,
revision=_revision,
)
if response["commit_id"] is None:
raise NoCommitsError("No commits on the default branch yet")
check_head_status(head, _revision, response["commit_id"])
return Commit.from_response(_dataset, response)
[docs] def list(
self, revision: str = CURRENT_COMMIT
) -> Union[LazyPagingList[Commit], List[Optional[Commit]]]:
"""List the commits.
Arguments:
revision: The information to locate the specific commit, which can be the commit id,
the branch name, or the tag name.
If it is given, list the commits before the given commit.
If it is not given, list the commits before the current commit.
Returns:
The LazyPagingList of :class:`commits<.Commit>` instances.
"""
if revision is CURRENT_COMMIT:
_revision = self._dataset.HEAD.commit_id
if _revision is None:
return []
else:
check_type("revision", revision, str)
_revision = revision
return LazyPagingList(
lambda offset, limit: self._generate(
_revision, offset, limit # type: ignore[arg-type]
),
LIMIT,
)