feat(cli): add "gas log" to display commit history

Author: machearn

tensorbay/cli/cli.py

@@ -345,5 +345,28 @@ def tag(obj: Dict[str, str], tbrn: str) -> None:
     _implement_tag(obj, tbrn)
 
 
+@cli.command()
+@click.argument("tbrn", type=str)
+@click.option("-n", "--max-count", type=int, help="Limit the max number of commits to be showed")
+@click.option("--oneline", is_flag=True, help="Limit commit message to oneline")
+@click.pass_obj
+def log(  # pylint: disable=too-many-arguments
+    obj: Dict[str, str], tbrn: str, max_count: int, oneline: bool,
+) -> None:
+    """Display the log.\f
+
+    Arguments:
+        obj: A dict contains config information.
+        tbrn: The dataset to be showed.
+        max_count: Max number of commits.
+        is_all: Whether to show all commits of all branches.
+        oneline: Whether to show a commit message in oneline.
+        graph: Whether to plot the text-based graphical commits
+    """  # noqa: D301,D415
+    from .log import _implement_log
+
+    _implement_log(obj, tbrn, max_count, oneline)
+
+
 if __name__ == "__main__":
     cli()  # pylint: disable=no-value-for-parameter

tensorbay/cli/log.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+#
+# Copyright 2021 Graviti. Licensed under MIT License.
+#
+
+"""Implementation of gas log."""
+
+import sys
+from datetime import datetime
+from typing import Dict
+
+import click
+
+from ..client.struct import Commit
+from .tbrn import TBRN
+from .utility import get_dataset_client, get_gas
+
+
+def _convert_to_commit_log(commit: Commit, oneline: bool) -> str:
+    commit_id = commit.commit_id
+    author = commit.committer.name
+    date = datetime.fromtimestamp(commit.committer.date)
+    message = commit.message
+
+    if oneline:
+        commit_log = f"{commit_id[:7]} {message}"
+    else:
+        commit_log = (
+            f"commit {commit_id}\n"
+            f"Author: {author}\n"
+            f"Date: {date.strftime('%a %b %d %H:%M:%S %Y')}\n\n    {message}\n"
+        )
+
+    return commit_log
+
+
+def _implement_log(  # pylint: disable=too-many-arguments
+    obj: Dict[str, str], tbrn: str, max_count: int, oneline: bool,
+) -> None:
+    gas = get_gas(**obj)
+
+    if not tbrn:
+        click.echo("Must specify the dataset to be showed")
+        sys.exit(1)
+
+    info = TBRN(tbrn=tbrn)
+    dataset_client = get_dataset_client(gas, info)
+
+    commit_list = dataset_client.list_commits(info.revision)[:max_count]
+
+    click.echo_via_pager([_convert_to_commit_log(commit, oneline) for commit in commit_list])