Skip to content

Commit 4a34283

Browse files
FredHappyfaceFredHappyface
committed
2022.2: basic support for subparsers (argparse)
1 parent 688b2b5 commit 4a34283

33 files changed

+907
-517
lines changed

‎CHANGELOG.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,23 @@
33
All major and minor version changes will be documented in this file. Details of
44
patch-level version changes can be found in [commit messages](../../commits/master).
55

6+
## 2022.2 - 2022/09/02
7+
8+
- Fix https://github.com/FHPythonUtils/Cli2Gui/issues/10, basic support for subparsers. `parser.add_subparsers()`
9+
10+
```py
11+
parser = argparse.ArgumentParser(description="this is an example parser")
12+
subparsers = parser.add_subparsers(help='types of A')
13+
parser.add_argument("-v",)
14+
15+
a_parser = subparsers.add_parser("A")
16+
b_parser = subparsers.add_parser("B")
17+
18+
a_parser.add_argument("something", choices=['a1', 'a2'])
19+
20+
args = parser.parse_args()
21+
```
22+
623
## 2022.1 - 2022/04/07
724

825
- Fix https://github.com/FHPythonUtils/Cli2Gui/issues/7

‎cli2gui/tojson/argparse2json.py‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,16 @@ def iterParsers(
3535
parser: argparse.ArgumentParser,
3636
) -> list[tuple[str, argparse.ArgumentParser]]:
3737
"""Iterate over name, parser pairs."""
38-
try:
39-
# Get the actions from the subparser
40-
return [action for action in parser._actions if isinstance(action, _SubParsersAction)][
41-
0
42-
].choices.arg_items()
43-
except IndexError:
44-
# There is no subparser
45-
return list([("::cli2gui/default", parser)])
38+
defaultParser = [
39+
("::cli2gui/default", parser),
40+
]
41+
candidateSubparsers = [
42+
action for action in parser._actions if isinstance(action, _SubParsersAction)
43+
]
44+
if len(candidateSubparsers) == 0:
45+
return defaultParser
46+
47+
return defaultParser + list(candidateSubparsers[0].choices.items())
4648

4749

4850
def isDefaultProgname(name: str, subparser: argparse.ArgumentParser) -> bool:

‎documentation/reference/MODULES.md‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎documentation/reference/README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
# Cli2gui Modules
1+
# Cli2gui Index
22

3-
> Auto-generated documentation modules index.
3+
> Auto-generated documentation index.
44
5-
Full list of [Cli2gui](README.md#cli2gui-index) project modules.
5+
A full list of `Cli2gui` project modules.
66

7-
- [Cli2gui Index](README.md#cli2gui-index)
87
- [Cli2gui](cli2gui/index.md#cli2gui)
98
- [Application](cli2gui/application/index.md#application)
109
- [Application](cli2gui/application/application.md#application)

‎documentation/reference/cli2gui/application/application.md‎

Lines changed: 88 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
11
# Application
22

3-
> Auto-generated documentation for [cli2gui.application.application](../../../../cli2gui/application/application.py) module.
3+
[Cli2gui Index](../../README.md#cli2gui-index) /
4+
[Cli2gui](../index.md#cli2gui) /
5+
[Application](./index.md#application) /
6+
Application
47

5-
Application here uses PySimpleGUI.
8+
> Auto-generated documentation for [cli2gui.application.application](../../../../cli2gui/application/application.py) module.
69
7-
- [Cli2gui](../../README.md#cli2gui-index) / [Modules](../../MODULES.md#cli2gui-modules) / [Cli2gui](../index.md#cli2gui) / [Application](index.md#application) / Application
8-
- [addItemsAndGroups](#additemsandgroups)
9-
- [createLayout](#createlayout)
10-
- [generatePopup](#generatepopup)
11-
- [run](#run)
12-
- [setBase24Theme](#setbase24theme)
13-
- [setupWidgets](#setupwidgets)
14-
- [themeFromFile](#themefromfile)
10+
- [Application](#application)
11+
- [addItemsAndGroups](#additemsandgroups)
12+
- [createLayout](#createlayout)
13+
- [generatePopup](#generatepopup)
14+
- [run](#run)
15+
- [setBase24Theme](#setbase24theme)
16+
- [setupWidgets](#setupwidgets)
17+
- [themeFromFile](#themefromfile)
1518

1619
## addItemsAndGroups
1720

18-
[[find in source code]](../../../../cli2gui/application/application.py#L165)
19-
20-
```python
21-
def addItemsAndGroups(
22-
section: c2gtypes.Group,
23-
argConstruct: list[list[Element]],
24-
widgets: Widgets,
25-
):
26-
```
21+
[Show source in application.py:165](../../../../cli2gui/application/application.py#L165)
2722

2823
Add arg_items and groups to the argConstruct list.
2924

@@ -40,19 +35,21 @@ argConstruct
4035

4136
- `list` - updated argConstruct
4237

43-
## createLayout
44-
45-
[[find in source code]](../../../../cli2gui/application/application.py#L298)
38+
#### Signature
4639

4740
```python
48-
def createLayout(
49-
buildSpec: c2gtypes.FullBuildSpec,
50-
widgets: Widgets,
51-
pySimpleGui: Any,
52-
menu: str | list[str],
53-
) -> list[list[Element]]:
41+
def addItemsAndGroups(
42+
section: c2gtypes.Group, argConstruct: list[list[Element]], widgets: Widgets
43+
):
44+
...
5445
```
5546

47+
48+
49+
## createLayout
50+
51+
[Show source in application.py:298](../../../../cli2gui/application/application.py#L298)
52+
5653
Create the pysimplegui layout from the build spec.
5754

5855
#### Arguments
@@ -66,19 +63,24 @@ Create the pysimplegui layout from the build spec.
6663

6764
- `list[list[Element]]` - list of widgets (layout list)
6865

69-
## generatePopup
70-
71-
[[find in source code]](../../../../cli2gui/application/application.py#L229)
66+
#### Signature
7267

7368
```python
74-
def generatePopup(
69+
def createLayout(
7570
buildSpec: c2gtypes.FullBuildSpec,
76-
values: dict[Any, Any] | list[Any],
7771
widgets: Widgets,
7872
pySimpleGui: Any,
79-
) -> Window:
73+
menu: str | list[str],
74+
) -> list[list[Element]]:
75+
...
8076
```
8177

78+
79+
80+
## generatePopup
81+
82+
[Show source in application.py:229](../../../../cli2gui/application/application.py#L229)
83+
8284
Create the popup window.
8385

8486
#### Arguments
@@ -93,33 +95,44 @@ as the menu
9395

9496
- `pySimpleGui.Window` - A PySimpleGui Window
9597

96-
## run
97-
98-
[[find in source code]](../../../../cli2gui/application/application.py#L361)
98+
#### Signature
9999

100100
```python
101-
def run(buildSpec: c2gtypes.FullBuildSpec):
101+
def generatePopup(
102+
buildSpec: c2gtypes.FullBuildSpec,
103+
values: dict[Any, Any] | list[Any],
104+
widgets: Widgets,
105+
pySimpleGui: Any,
106+
) -> Window:
107+
...
102108
```
103109

110+
111+
112+
## run
113+
114+
[Show source in application.py:361](../../../../cli2gui/application/application.py#L361)
115+
104116
Main entry point for the application.
105117

106118
#### Arguments
107119

108120
- `buildSpec` *c2gtypes.FullBuildSpec* - args that customise the application such as the theme
109121
or the function to run
110122

111-
## setBase24Theme
112-
113-
[[find in source code]](../../../../cli2gui/application/application.py#L36)
123+
#### Signature
114124

115125
```python
116-
def setBase24Theme(
117-
theme: str | list[str],
118-
darkTheme: str | list[str],
119-
pySimpleGui: Any,
120-
) -> None:
126+
def run(buildSpec: c2gtypes.FullBuildSpec):
127+
...
121128
```
122129

130+
131+
132+
## setBase24Theme
133+
134+
[Show source in application.py:36](../../../../cli2gui/application/application.py#L36)
135+
123136
Set the base24 theme to the application.
124137

125138
#### Arguments
@@ -128,18 +141,21 @@ theme (Union[str, list[str]]): the light theme
128141
darkTheme (Union[str, list[str]]): the dark theme
129142
- `pySimpleGui` *Any* - pysimplegui module
130143

131-
## setupWidgets
132-
133-
[[find in source code]](../../../../cli2gui/application/application.py#L125)
144+
#### Signature
134145

135146
```python
136-
def setupWidgets(
137-
gui: str,
138-
sizes: dict[str, Any],
139-
pySimpleGui: Any,
140-
) -> Widgets:
147+
def setBase24Theme(
148+
theme: str | list[str], darkTheme: str | list[str], pySimpleGui: Any
149+
) -> None:
150+
...
141151
```
142152

153+
154+
155+
## setupWidgets
156+
157+
[Show source in application.py:125](../../../../cli2gui/application/application.py#L125)
158+
143159
Set the widget sizes to the application.
144160

145161
#### Arguments
@@ -152,14 +168,19 @@ sizes (Union[dict[str, Any]]): widget sizes
152168

153169
- `Widgets` - widgets object all set up nicely
154170

155-
## themeFromFile
156-
157-
[[find in source code]](../../../../cli2gui/application/application.py#L23)
171+
#### Signature
158172

159173
```python
160-
def themeFromFile(themeFile: str) -> list[str]:
174+
def setupWidgets(gui: str, sizes: dict[str, Any], pySimpleGui: Any) -> Widgets:
175+
...
161176
```
162177

178+
179+
180+
## themeFromFile
181+
182+
[Show source in application.py:23](../../../../cli2gui/application/application.py#L23)
183+
163184
Set the base24 theme from a base24 scheme.yaml to the application.
164185

165186
#### Arguments
@@ -169,3 +190,12 @@ Set the base24 theme from a base24 scheme.yaml to the application.
169190
#### Returns
170191

171192
- `list[str]` - theme to set
193+
194+
#### Signature
195+
196+
```python
197+
def themeFromFile(themeFile: str) -> list[str]:
198+
...
199+
```
200+
201+

‎documentation/reference/cli2gui/application/index.md‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# Application
22

3+
[Cli2gui Index](../../README.md#cli2gui-index) /
4+
[Cli2gui](../index.md#cli2gui) /
5+
Application
6+
37
> Auto-generated documentation for [cli2gui.application](../../../../cli2gui/application/__init__.py) module.
48
5-
- [Cli2gui](../../README.md#cli2gui-index) / [Modules](../../MODULES.md#cli2gui-modules) / [Cli2gui](../index.md#cli2gui) / Application
6-
- Modules
7-
- [Application](application.md#application)
8-
- [Pysimplegui2args](pysimplegui2args.md#pysimplegui2args)
9-
- [Widgets](widgets.md#widgets)
9+
- [Application](#application)
10+
- [Modules](#modules)
11+
12+
## Modules
13+
14+
- [Application](./application.md)
15+
- [Pysimplegui2args](./pysimplegui2args.md)
16+
- [Widgets](./widgets.md)

0 commit comments

Comments
 (0)