rel 2024.3

Author: FredHappyface

CHANGELOG.md

@@ -3,6 +3,10 @@
 All major and minor version changes will be documented in this file. Details of
 patch-level version changes can be found in [commit messages](../../commits/master).
 
+## 2024.3 - 2024/10/05
+
+- Code improvements
+
 ## 2024.2 - 2024/10/04
 
 - Add `freesimplegui`

documentation/reference/cli2gui/application/application.md

@@ -22,5 +22,5 @@ Establish the main entry point.
 #### Signature
 
 ```python
-def run(buildSpec: types.FullBuildSpec) -> None: ...
+def run(buildSpec: types.FullBuildSpec) -> Any: ...
 ```

documentation/reference/cli2gui/application/application2args.md

@@ -11,10 +11,11 @@
   - [docoptFormat](#docoptformat)
   - [getoptFormat](#getoptformat)
   - [optparseFormat](#optparseformat)
+  - [processValue](#processvalue)
 
 ## argFormat
 
-[Show source in application2args.py:59](../../../../cli2gui/application/application2args.py#L59)
+[Show source in application2args.py:86](../../../../cli2gui/application/application2args.py#L86)
 
 Format the args for the desired parser.
 
@@ -39,7 +40,7 @@ def argFormat(values: dict[str, Any], argumentParser: str | ParserType) -> Any:
 
 ## argparseFormat
 
-[Show source in application2args.py:11](../../../../cli2gui/application/application2args.py#L11)
+[Show source in application2args.py:41](../../../../cli2gui/application/application2args.py#L41)
 
 Format args for argparse.
 
@@ -53,7 +54,7 @@ def argparseFormat(values: dict[str, Any]) -> argparse.Namespace: ...
 
 ## clickFormat
 
-[Show source in application2args.py:49](../../../../cli2gui/application/application2args.py#L49)
+[Show source in application2args.py:75](../../../../cli2gui/application/application2args.py#L75)
 
 Format args for click.
 
@@ -67,7 +68,7 @@ def clickFormat(values: dict[str, Any]) -> list[Any]: ...
 
 ## docoptFormat
 
-[Show source in application2args.py:39](../../../../cli2gui/application/application2args.py#L39)
+[Show source in application2args.py:64](../../../../cli2gui/application/application2args.py#L64)
 
 Format args for docopt.
 
@@ -81,7 +82,7 @@ def docoptFormat(values: dict[str, Any]) -> dict[str, Any]: ...
 
 ## getoptFormat
 
-[Show source in application2args.py:34](../../../../cli2gui/application/application2args.py#L34)
+[Show source in application2args.py:59](../../../../cli2gui/application/application2args.py#L59)
 
 Format args for getopt.
 
@@ -95,12 +96,24 @@ def getoptFormat(values: dict[str, Any]) -> tuple[list[Any], list[Any]]: ...
 
 ## optparseFormat
 
-[Show source in application2args.py:26](../../../../cli2gui/application/application2args.py#L26)
+[Show source in application2args.py:50](../../../../cli2gui/application/application2args.py#L50)
 
 Format args for optparse.
 
 #### Signature
 
 ```python
-def optparseFormat(values: dict[str, Any]) -> dict[str, Any]: ...
+def optparseFormat(values: dict[str, Any]) -> tuple[optparse.Values, list[str]]: ...
+```
+
+
+
+## processValue
+
+[Show source in application2args.py:13](../../../../cli2gui/application/application2args.py#L13)
+
+#### Signature
+
+```python
+def processValue(key: str, value: str) -> tuple[str, Any]: ...
 ```

documentation/reference/cli2gui/decorators.md

@@ -11,7 +11,7 @@
 
 ## Cli2Gui
 
-[Show source in decorators.py:168](../../../cli2gui/decorators.py#L168)
+[Show source in decorators.py:172](../../../cli2gui/decorators.py#L172)
 
 Use this decorator in the function containing the argument parser.
 Serialises data to JSON and launches the Cli2Gui application.
@@ -73,7 +73,7 @@ def Cli2Gui(
 
 ## Click2Gui
 
-[Show source in decorators.py:105](../../../cli2gui/decorators.py#L105)
+[Show source in decorators.py:109](../../../cli2gui/decorators.py#L109)
 
 Use this decorator in the function containing the argument parser.
 Serializes data to JSON and launches the Cli2Gui application.

documentation/reference/cli2gui/gui/abstract_gui.md

@@ -18,12 +18,13 @@ Abstract base class for GUI wrappers.
 
 ```python
 class AbstractGUI(ABC):
+    @abstractmethod
     def __init__(self) -> None: ...
 ```
 
 ### AbstractGUI().main
 
-[Show source in abstract_gui.py:14](../../../../cli2gui/gui/abstract_gui.py#L14)
+[Show source in abstract_gui.py:15](../../../../cli2gui/gui/abstract_gui.py#L15)
 
 Abstract method for the main function.
 

documentation/reference/cli2gui/gui/dearpygui_wrapper.md

@@ -31,40 +31,53 @@ class DearPyGuiWrapper(AbstractGUI):
 
 ### DearPyGuiWrapper().addItemsAndGroups
 
-[Show source in dearpygui_wrapper.py:86](../../../../cli2gui/gui/dearpygui_wrapper.py#L86)
+[Show source in dearpygui_wrapper.py:104](../../../../cli2gui/gui/dearpygui_wrapper.py#L104)
 
 Items and groups and return a list of these so we can get values from the dpg widgets.
 
-:param types.Group section: section with a name to display and items
+#### Arguments
+
+- `section` *Group* - section with a name to display and items
 
 #### Returns
 
-Type: *list[types.Item]*
+Type: *list[Item]*
 flattened list of items
 
 #### Signature
 
 ```python
-def addItemsAndGroups(self, section: types.Group) -> list[types.Item]: ...
+def addItemsAndGroups(self, section: Group) -> list[Item]: ...
 ```
 
+#### See also
+
+- [Group](../types.md#group)
+- [Item](../types.md#item)
+
 ### DearPyGuiWrapper().addWidgetFromItem
 
-[Show source in dearpygui_wrapper.py:70](../../../../cli2gui/gui/dearpygui_wrapper.py#L70)
+[Show source in dearpygui_wrapper.py:83](../../../../cli2gui/gui/dearpygui_wrapper.py#L83)
 
 Select a widget based on the item type.
 
-:param types.Item item: the item
+#### Arguments
+
+- `item` *Item* - the item
 
 #### Signature
 
 ```python
-def addWidgetFromItem(self, item: types.Item) -> None: ...
+def addWidgetFromItem(self, item: Item) -> None: ...
 ```
 
+#### See also
+
+- [Item](../types.md#item)
+
 ### DearPyGuiWrapper().main
 
-[Show source in dearpygui_wrapper.py:130](../../../../cli2gui/gui/dearpygui_wrapper.py#L130)
+[Show source in dearpygui_wrapper.py:148](../../../../cli2gui/gui/dearpygui_wrapper.py#L148)
 
 Run the gui (dpg) with a given buildSpec, quit_callback, and run_callback.
 
@@ -73,7 +86,9 @@ Run the gui (dpg) with a given buildSpec, quit_callback, and run_callback.
 - Create Window, set up Menu and Widgets
 - Then, start dpg
 
-:param types.FullBuildSpec buildSpec: Full cli parse/ build spec
+#### Arguments
+
+- `buildSpec` *FullBuildSpec* - Full cli parse/ build spec
 :param Callable[[], None] quit_callback: generic callable used to quit
 :param Callable[[dict[str, Any]], None] run_callback: generic callable used to run
 
@@ -82,15 +97,19 @@ Run the gui (dpg) with a given buildSpec, quit_callback, and run_callback.
 ```python
 def main(
     self,
-    buildSpec: types.FullBuildSpec,
+    buildSpec: FullBuildSpec,
     quit_callback: Callable[[], None],
     run_callback: Callable[[dict[str, Any]], None],
 ) -> None: ...
 ```
 
+#### See also
+
+- [FullBuildSpec](../types.md#fullbuildspec)
+
 ### DearPyGuiWrapper().open_menu_item
 
-[Show source in dearpygui_wrapper.py:116](../../../../cli2gui/gui/dearpygui_wrapper.py#L116)
+[Show source in dearpygui_wrapper.py:134](../../../../cli2gui/gui/dearpygui_wrapper.py#L134)
 
 Open a menu item.