ENH: to_graphics now has `no_shadow` option.

Summary

Just a small new option for plantuml generation

Focus

• Does this option do what it should?
• Are there any negative side-effects?

Test Environment

import caosdb as db; from caosdb.utils import plantuml
cont = db.Container().append(db.RecordType(name="test"))
plantuml.to_graphics(cont, "test_with")
plantuml.to_graphics(cont, "test_without", no_shadow=True)

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues There are no issues.
• Up-to-date CHANGELOG.md (or not necessary)
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/caosdb/utils/plantuml.py

@@ -88,6 +88,7 @@ def recordtypes_to_plantuml_string(iterable,
                                    add_properties: bool = True,
                                    add_recordtypes: bool = True,
                                    add_legend: bool = True,
+                                   no_shadow: bool = False,
                                    style: str = "default"):
     """Converts RecordTypes into a string for PlantUML.
 
@@ -109,6 +110,20 @@ def recordtypes_to_plantuml_string(iterable,
       either the "type" attribute is None or
       type(element) == RecordType.
     - Inheritance of Properties is not rendered nicely at the moment.
+
+    Parameters
+    ----------
+    iterable: iterable of caosdb.Entity
+      The objects to be rendered with plantuml.
+
+    no_shadow : bool, optional
+      If true, tell plantuml to use a skin without blurred shadows.
+
+
+    Returns
+    -------
+    out : str
+      The plantuml string for the given container.
     """
 
     # TODO: This function needs a review of python type hints.
@@ -158,6 +173,9 @@ def recordtypes_to_plantuml_string(iterable,
 
     result = "@startuml\n\n"
 
+    if no_shadow:
+        result += "skinparam shadowing false\n"
+
     if style == "default":
         result += "skinparam classAttributeIconSize 0\n"
     elif style == "salexan":
@@ -330,6 +348,7 @@ def to_graphics(recordtypes: list[db.Entity], filename: str,
                 add_properties: bool = True,
                 add_recordtypes: bool = True,
                 add_legend: bool = True,
+                no_shadow: bool = False,
                 style: str = "default"):
     """Calls recordtypes_to_plantuml_string(), saves result to file and
     creates an svg image
@@ -352,12 +371,15 @@ def to_graphics(recordtypes: list[db.Entity], filename: str,
               list of target formats as defined by the -t"..." options by plantuml, e.g. "tsvg"
     silent : bool
              Don't output messages.
+    no_shadow : bool, optional
+      If true, tell plantuml to use a skin without blurred shadows.
     """
-    pu = recordtypes_to_plantuml_string(recordtypes,
-                                        add_properties,
-                                        add_recordtypes,
-                                        add_legend,
-                                        style)
+    pu = recordtypes_to_plantuml_string(iterable=recordtypes,
+                                        add_properties=add_properties,
+                                        add_recordtypes=add_recordtypes,
+                                        add_legend=add_legend,
+                                        no_shadow=no_shadow,
+                                        style=style)
 
     if output_dirname is None:
         output_dirname = os.getcwd()