feat: Add asterisk to mandatory parameters (#50)

* Default parameters asterisk

* Documentation for mandatory parameters.

Author: davidhozic

docs/source/changelog.rst

@@ -26,6 +26,10 @@ Glossary
 Releases
 ---------------------
 
+v1.5.0
+=====================
+- Added an asterisk (*) to mandatory parameters.
+
 v1.4.10
 =====================
 - Fixed string casting sometimes being cast to a list type.

docs/source/guide/defining.rst

@@ -115,6 +115,17 @@ We will click on the "New" button located in the same row as the ``name`` label
   :width: 15cm
 
 
+
+Mandatory & optional parameters
+-----------------------------------
+When a parameter has a default value assigned to it, it is considered an optional parameter.
+Parameters without a default value are considered mandatory. Mandatory parameters are marked
+with the asterisk (``*``) symbol.
+
+.. image:: ./images/mandatory_parameter_asterisk.png
+  :width: 15cm
+
+
 Defining strings
 =====================
 Clicking on "New -> str", as seen on the previous picture, will open up a new definition frame (page),

docs/source/guide/images/mandatory_parameter_asterisk.png

@@ -27,7 +27,7 @@
 SOFTWARE.
 """
 
-__version__ = "1.4.10"
+__version__ = "1.5.0"
 
 
 from .object_frame import *

tkclasswiz/__init__.py

@@ -57,4 +57,4 @@ def show_error(cls, title: str, message: str, **kwargs):
         @classmethod
         def show_info(cls, title: str, message: str, **kwargs):
             cls._process_kwargs(kwargs)
-            mb.showinfo(title, message, **kwargs)
+            mb.showinfo(title, message, **kwargs)

tkclasswiz/messagebox.py

@@ -151,12 +151,23 @@ def _create_fields(self, annotations: dict[str, type], additional_values: dict,
         dpi_5h = dpi_5 // 2
 
         labels: list[ttk.Label] = []
+
+        # Get parameters with default values.
+        # This is used for adding an asterisk to parameters without a default (mandatory parameters).
+        signature = inspect.signature(self.class_)
+        param_defaults = set([k for k, v in signature.parameters.items() if v.default is not v.empty])
+
         for (k, v) in annotations.items():
             # Init widgets
             entry_types = convert_types(v)
             frame_annotated = ttk.Frame(frame)
             frame_annotated.pack(fill=tk.BOTH, expand=True, pady=dpi_5)
-            label = ttk.Label(frame_annotated, text=k)
+
+            text = k
+            if k not in param_defaults:  # Parameter is mandatory
+                text = f'* {text}'
+
+            label = ttk.Label(frame_annotated, text=text)
             labels.append(label)
             label.pack(side="left")