Merge pull request #255 from Oxid15/description_update

Description update

Author: Oxid15

cascade/base/traceable.py

@@ -210,25 +210,30 @@ def __repr__(self) -> str:
         # Removes adress part of basic object repr and leading < symbol
         return super().__repr__().split()[0][1:]
 
-    def describe(self, desc: Optional[str]):
+    def describe(self, desc: str):
         """
         Add description to an object
 
         Parameters
         ----------
-        desc : Optional[str]
-            String description of an object.
-            May be None to use the method in default initializer
+        desc : str
+            String description of an object
 
         Raises
         ------
         TypeError
             If the input is not None and not a string either
         """
-        if not isinstance(desc, str) and desc is not None:
+        if not isinstance(desc, str):
             raise TypeError(f"Description should be str, got {type(desc)}")
         self.description = desc
 
+    def remove_description(self) -> None:
+        """
+        Empties object's description
+        """
+        self.description = None
+
     def tag(self, tag: Union[str, Iterable[str]]) -> None:
         """
         If tag is a string:
@@ -498,6 +503,7 @@ def __getattribute__(self, name: str) -> Any:
         attr = super().__getattribute__(name)
         if name in (
             "describe",
+            "remove_description",
             "comment",
             "remove_comment",
             "tag",

cascade/cli/desc.py

@@ -37,3 +37,15 @@ def desc_add(ctx, d):
     tr = TraceableOnDisk(ctx.obj["cwd"], meta_fmt=ctx.obj["meta_fmt"])
     tr.sync_meta()
     tr.describe(d)
+
+@desc.command("rm")
+@click.pass_context
+def desc_rm(ctx):
+    if not ctx.obj.get("meta"):
+        return
+
+    from cascade.base import TraceableOnDisk
+
+    tr = TraceableOnDisk(ctx.obj["cwd"], meta_fmt=ctx.obj["meta_fmt"])
+    tr.sync_meta()
+    tr.remove_description()

cascade/tests/base/test_traceable.py

@@ -79,6 +79,9 @@ def test_descriptions():
     tr.describe("test2")
     assert tr.description == "test2"
 
+    tr.remove_description()
+    assert tr.description is None
+
 
 def test_tags():
     tr = Traceable(tags=["a", "b"])

cascade/tests/cli/test_description.py

@@ -47,3 +47,21 @@ def test_add(tmp_path_str):
         del meta[0]["updated_at"]
         del init_meta[0]["updated_at"]
         assert meta == init_meta
+
+
+def test_rm(tmp_path_str):
+    runner = CliRunner()
+    with runner.isolated_filesystem(temp_dir=tmp_path_str) as td:
+        mh = MetaHandler()
+        repo = Repo(td)
+
+        result = runner.invoke(cli, args=["desc", "add"], input="Hello")
+
+        assert result.exit_code == 0
+
+        runner.invoke(cli, args=["desc", "rm"])
+
+        meta = mh.read_dir(td)
+
+        assert "description" in meta[0]
+        assert meta[0]["description"] is None