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

Sun, 14 Jan 2024 12:39:11 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 14 Jan 2024 12:39:11 +0100
branch
eric7
changeset 10500
40fc136e7002
parent 10479
856476537696
child 10784
521fd465b048
permissions
-rw-r--r--

Log Viewer
- Added code to show an indicator for the log viewer icon, if new messages were added and the "Autoshow" option is deactivated.

10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric7.VirtualEnv.VirtualenvMeta</title>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <link rel="stylesheet" href="styles.css">
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 </head>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 <body>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 <a NAME="top" ID="top"></a>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 <h1>eric7.VirtualEnv.VirtualenvMeta</h1>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 <p>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 Module implementing a dataclass containing the metadata of a virtual environment.
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 </p>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
13
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 <h3>Global Attributes</h3>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 <table>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 <tr><td>None</td></tr>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
18
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 <h3>Classes</h3>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 <table>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <tr>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <td><a href="#VirtualenvMetaData">VirtualenvMetaData</a></td>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <td>Class implementing a container for the metadata of a virtual environment.</td>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 </tr>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
26
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <h3>Functions</h3>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <table>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <tr><td>None</td></tr>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
31
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <hr />
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <hr />
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <a NAME="VirtualenvMetaData" ID="VirtualenvMetaData"></a>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <h2>VirtualenvMetaData</h2>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <p>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 Class implementing a container for the metadata of a virtual environment.
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 </p>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
39
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <h3>Derived from</h3>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 None
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Class Attributes</h3>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
44 <tr><td>description</td></tr>
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
45 <tr><td>exec_path</td></tr>
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
46 <tr><td>interpreter</td></tr>
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
47 <tr><td>is_conda</td></tr>
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
48 <tr><td>is_global</td></tr>
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
49 <tr><td>is_remote</td></tr>
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
50 <tr><td>name</td></tr>
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
51 <tr><td>path</td></tr>
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
53
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <h3>Class Methods</h3>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <table>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <tr>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <td><a href="#VirtualenvMetaData.from_dict">from_dict</a></td>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <td>Class method to create a metadata object from the given dictionary.</td>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 </tr>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
61
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <h3>Methods</h3>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <table>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <tr>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <td><a href="#VirtualenvMetaData.as_dict">as_dict</a></td>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <td>Public method to convert the metadata into a dictionary.</td>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 </tr>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
69
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <h3>Static Methods</h3>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <table>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <tr><td>None</td></tr>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 </table>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
75
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <a NAME="VirtualenvMetaData.from_dict" ID="VirtualenvMetaData.from_dict"></a>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <h4>VirtualenvMetaData.from_dict (class method)</h4>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <b>from_dict</b>(<i>data</i>)
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 <p>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 Class method to create a metadata object from the given dictionary.
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 </p>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
82
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <dl>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <dt><i>data</i> (dict)</dt>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <dd>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 dictionary containing the metadata
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 </dd>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 </dl>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <dl>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <dt>Return:</dt>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <dd>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 created metadata object
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 </dd>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 </dl>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <dl>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <dt>Return Type:</dt>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 <dd>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 VirtualenvMetaData
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 </dd>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 </dl>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <a NAME="VirtualenvMetaData.as_dict" ID="VirtualenvMetaData.as_dict"></a>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <h4>VirtualenvMetaData.as_dict</h4>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <b>as_dict</b>(<i></i>)
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <p>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 Public method to convert the metadata into a dictionary.
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </p>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
108
10194
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <dl>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 <dt>Return:</dt>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <dd>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 dictionary containing the metadata
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 </dd>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 </dl>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 <dl>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 <dt>Return Type:</dt>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <dd>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 dict
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 </dd>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 </dl>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 <div align="right"><a href="#top">Up</a></div>
2c26b4fe25db Refactored the 'VirtualEnv' code for better maintainability.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 <hr />
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 10229
diff changeset
123 </body></html>

eric ide

mercurial