|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.MultiProject.MultiProjectProjectMeta</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.MultiProject.MultiProjectProjectMeta</h1> |
|
10 |
|
11 <p> |
|
12 Module defining a class containing the individual project metadata. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#MultiProjectProjectMeta">MultiProjectProjectMeta</a></td> |
|
25 <td>Class containing the individual project metadata.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="MultiProjectProjectMeta" ID="MultiProjectProjectMeta"></a> |
|
36 <h2>MultiProjectProjectMeta</h2> |
|
37 |
|
38 <p> |
|
39 Class containing the individual project metadata. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 None |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>category</td></tr><tr><td>description</td></tr><tr><td>file</td></tr><tr><td>master</td></tr><tr><td>name</td></tr><tr><td>removed</td></tr><tr><td>uid</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 |
|
52 <tr> |
|
53 <td><a href="#MultiProjectProjectMeta.from_dict">from_dict</a></td> |
|
54 <td>Class method to create a metadata object from the given dictionary.</td> |
|
55 </tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 |
|
59 <table> |
|
60 |
|
61 <tr> |
|
62 <td><a href="#MultiProjectProjectMeta.as_dict">as_dict</a></td> |
|
63 <td>Public method to convert the metadata into a dictionary.</td> |
|
64 </tr> |
|
65 </table> |
|
66 <h3>Static Methods</h3> |
|
67 |
|
68 <table> |
|
69 <tr><td>None</td></tr> |
|
70 </table> |
|
71 |
|
72 <a NAME="MultiProjectProjectMeta.from_dict" ID="MultiProjectProjectMeta.from_dict"></a> |
|
73 <h4>MultiProjectProjectMeta.from_dict (class method)</h4> |
|
74 <b>from_dict</b>(<i>data</i>) |
|
75 |
|
76 <p> |
|
77 Class method to create a metadata object from the given dictionary. |
|
78 </p> |
|
79 <dl> |
|
80 |
|
81 <dt><i>data</i> (dict)</dt> |
|
82 <dd> |
|
83 dictionary containing the metadata |
|
84 </dd> |
|
85 </dl> |
|
86 <dl> |
|
87 <dt>Return:</dt> |
|
88 <dd> |
|
89 created project metadata object |
|
90 </dd> |
|
91 </dl> |
|
92 <dl> |
|
93 <dt>Return Type:</dt> |
|
94 <dd> |
|
95 MultiProjectProjectMeta |
|
96 </dd> |
|
97 </dl> |
|
98 <a NAME="MultiProjectProjectMeta.as_dict" ID="MultiProjectProjectMeta.as_dict"></a> |
|
99 <h4>MultiProjectProjectMeta.as_dict</h4> |
|
100 <b>as_dict</b>(<i></i>) |
|
101 |
|
102 <p> |
|
103 Public method to convert the metadata into a dictionary. |
|
104 </p> |
|
105 <dl> |
|
106 <dt>Return:</dt> |
|
107 <dd> |
|
108 dictionary containing the metadata |
|
109 </dd> |
|
110 </dl> |
|
111 <dl> |
|
112 <dt>Return Type:</dt> |
|
113 <dd> |
|
114 dict |
|
115 </dd> |
|
116 </dl> |
|
117 <div align="right"><a href="#top">Up</a></div> |
|
118 <hr /> |
|
119 </body></html> |