1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
#!/usr/bin/env python3
import os
import re
import pathlib
import subprocess
cmd_type_terms = {"child": "child command", "user": "user command", "option": ""}
def run_command(cmd):
print(f"*** Executing: {cmd}")
p = subprocess.run(cmd, capture_output=True, text=True)
return p.stdout, p.stderr
class Entry:
def __init__(self, name, type, desc):
self.name = name
self.type = type
self.desc = desc
def __repr__(self):
return f"Entry('{self.name}', '{self.type}', '{self.desc}')"
def load_help_table(command):
entries = []
o, _ = run_command(command)
o = o.split("\n")
for line in o:
m = re.search(r"""(\S+)\s+(child|user|option)\s+(.*)""", line)
if m and m.groups and len(m.groups()) == 3:
entry = Entry(m.group(1), m.group(2), m.group(3))
entries.append(entry)
return entries
def load_commands():
return load_help_table(["ecflow_client", "--help=summary"])
def load_options():
return load_help_table(["ecflow_client", "--help=option"])
def load_description_file(name):
description_file = pathlib.Path(__file__).parent / "desc" / f"{name}.description"
try:
with open(description_file.resolve(), 'r') as file:
return file.read()
except FileNotFoundError:
return f"" # If the file does not exist, there is no description available
except IOError:
return f""
def render_single_page_rst(name):
description = load_description_file(name)
description_title = "Description"
description_header = "" if not description else f"\n.. rubric:: {description_title}\n\n"
output, _ = run_command(["ecflow_client", f"--help={name}"])
output = '\n'.join([' ' + line for line in output.split('\n')]) + '\n' # prefix each line of the output with the necessary indentation
output_title = f"Output of :code:`--help={name}`"
output_header = f"\n.. rubric:: {output_title}\n\n"
title = f"{name}"
txt = f"""
.. _{name}_cli:
{title}
{"*" * len(title)}
{description_header}
{description}
{output_header}
The following help text is generated by :code:`ecflow_client --help={name}`
::
{output}
"""
return txt
def render_user_option_rst():
title = f"user"
txt = f"""
.. _user_cli:
{title}
{"/" * len(title)}
::
user
----
Specifies the user name used to contact the server. Must be used in combination with option --password.
"""
return txt
def render_index_rst():
title = "Command line interface (CLI)"
txt = f"""
.. _ecflow_cli:
{title}
{"/" * len(title)}
The :term:`ecFlow command line interface (CLI) <ecflow_client>` is provided by the :code:`ecflow_client` executable.
A large number of commands/options enabled by the :ref:`ecflow_ui` are also available as CLI commands.
:code:`ecflow_client` accepts a variety of commands, specified as ``--<command>``.
For example, the command :code:`--load` can be used, as in the example below, to load the given file into the server.
.. code-block:: shell
ecflow_client --load host1.3141.check
The comprehensive :ref:`list of ecflow_client commands <ecflow_client_commands>` is presented below.
These commands can be combined with :ref:`ecflow_client common options <ecflow_client_options>` to further customise the
:term:`ecflow_client` behaviour.
.. rubric:: Getting help
The list of commands, amongst other details, can be displayed by using the option ``--help``.
.. code-block:: shell
ecflow_client --help
.. rubric:: Using the ecFlow command line interface
.. toctree::
:maxdepth: 1
desc/cli_option_overriding
desc/cli_scripting_in_batch
desc/using_backup_servers
"""
txt += """
.. rubric:: Reference Commands
.. list-table:: List of :term:`ecflow_client` commands
:header-rows: 1
:width: 100%
:widths: 20 20 60
:name: ecflow_client_commands
* - Command
- Type
- Description
"""
command_entries = load_commands()
for entry in command_entries:
txt += f"""
* - :ref:`{entry.name}_cli`
- :term:`{cmd_type_terms[entry.type]}`
- {entry.desc}
"""
txt += f"""
.. rubric:: Reference Options
.. list-table:: List of common options for `ecflow_client` commands
:header-rows: 1
:width: 100%
:widths: 20 80
:name: ecflow_client_options
* - Option
- Description
"""
option_entries = load_options()
for entry in option_entries:
txt += f"""
* - :ref:`{entry.name}_cli`
- {entry.desc}
"""
txt += f"""
.. toctree::
:maxdepth: 1
:hidden:
"""
for entry in command_entries:
txt += f""" {entry.name} <api/{entry.name}.rst>\n"""
for entry in option_entries:
txt += f""" {entry.name} (option) <api/{entry.name}.rst>\n"""
return txt
if __name__ == "__main__":
# Render and store index.rst
content = render_index_rst()
with open("index.rst", "w") as f:
f.write(content)
# Ensure api sub-folders is present
pathlib.Path("api").mkdir(parents=True, exist_ok=True)
# Render and store each of the command/option.rst
entries = load_commands()
for entry in entries:
content = render_single_page_rst(entry.name)
with open(f"api/{entry.name}.rst", "w") as f:
f.write(content)
entries = load_options()
for entry in entries:
if entry.name == "user":
content = render_user_option_rst()
else:
content = render_single_page_rst(entry.name)
with open(f"api/{entry.name}.rst", "w") as f:
f.write(content)
|
