Sat, 11 Nov 2023 12:44:51 +0100
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <!DOCTYPE html> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric7.eric7_api</title> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <meta charset="UTF-8"> |
8596
d64760b2da50
Documentation Generator: streamlined the code to use an external style sheet file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
8372
diff
changeset
|
5 | <link rel="stylesheet" href="styles.css"> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | </head> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | <body> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | <a NAME="top" ID="top"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | <h1>eric7.eric7_api</h1> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | eric API Generator. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | </p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | This is the main Python script of the API generator. It is |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | this script that gets called via the API generation interface. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | This script can be used via the commandline as well. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | </p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | <h3>Global Attributes</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | <tr><td>None</td></tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | </table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | <h3>Classes</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | <tr><td>None</td></tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | </table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | <h3>Functions</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <tr> |
10303
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
34 | <td><a href="#createArgumentParser">createArgumentParser</a></td> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
35 | <td>Function to create an argument parser.</td> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
36 | </tr> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
37 | <tr> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | <td><a href="#main">main</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | <td>Main entry point into the application.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | </table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | <hr /> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <hr /> |
10303
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
44 | <a NAME="createArgumentParser" ID="createArgumentParser"></a> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
45 | <h2>createArgumentParser</h2> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
46 | <b>createArgumentParser</b>(<i></i>) |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
47 | |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
48 | <p> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
49 | Function to create an argument parser. |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
50 | </p> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
51 | <dl> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
52 | <dt>Return:</dt> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
53 | <dd> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
54 | created argument parser object |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
55 | </dd> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
56 | </dl> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
57 | <dl> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
58 | <dt>Return Type:</dt> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
59 | <dd> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
60 | argparse.ArgumentParser |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
61 | </dd> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
62 | </dl> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
63 | <div align="right"><a href="#top">Up</a></div> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
64 | <hr /> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
65 | <hr /> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | <a NAME="main" ID="main"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | <h2>main</h2> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | <b>main</b>(<i></i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | Main entry point into the application. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | </p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | <div align="right"><a href="#top">Up</a></div> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | <hr /> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | </body></html> |