src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvMeta.html

branch
eric7
changeset 10194
2c26b4fe25db
child 10229
e50bbf250343
equal deleted inserted replaced
10193:0d7392e49c48 10194:2c26b4fe25db
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.VirtualEnv.VirtualenvMeta</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.VirtualEnv.VirtualenvMeta</h1>
10
11 <p>
12 Module implementing a dataclass containing the metadata of a virtual environment.
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="#VirtualenvMetaData">VirtualenvMetaData</a></td>
25 <td>Class implementing a container for the metadata of a virtual environment.</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="VirtualenvMetaData" ID="VirtualenvMetaData"></a>
36 <h2>VirtualenvMetaData</h2>
37
38 <p>
39 Class implementing a container for the metadata of a virtual environment.
40 </p>
41 <h3>Derived from</h3>
42 None
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51
52 <tr>
53 <td><a href="#VirtualenvMetaData.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="#VirtualenvMetaData.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="VirtualenvMetaData.from_dict" ID="VirtualenvMetaData.from_dict"></a>
73 <h4>VirtualenvMetaData.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 metadata object
90 </dd>
91 </dl>
92 <dl>
93 <dt>Return Type:</dt>
94 <dd>
95 VirtualenvMetaData
96 </dd>
97 </dl>
98 <a NAME="VirtualenvMetaData.as_dict" ID="VirtualenvMetaData.as_dict"></a>
99 <h4>VirtualenvMetaData.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>

eric ide

mercurial