--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvMeta.html Wed Sep 06 10:28:50 2023 +0200 @@ -0,0 +1,119 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.VirtualEnv.VirtualenvMeta</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.VirtualEnv.VirtualenvMeta</h1> + +<p> +Module implementing a dataclass containing the metadata of a virtual environment. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#VirtualenvMetaData">VirtualenvMetaData</a></td> +<td>Class implementing a container for the metadata of a virtual environment.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="VirtualenvMetaData" ID="VirtualenvMetaData"></a> +<h2>VirtualenvMetaData</h2> + +<p> + Class implementing a container for the metadata of a virtual environment. +</p> +<h3>Derived from</h3> +None +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> + +<tr> +<td><a href="#VirtualenvMetaData.from_dict">from_dict</a></td> +<td>Class method to create a metadata object from the given dictionary.</td> +</tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#VirtualenvMetaData.as_dict">as_dict</a></td> +<td>Public method to convert the metadata into a dictionary.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="VirtualenvMetaData.from_dict" ID="VirtualenvMetaData.from_dict"></a> +<h4>VirtualenvMetaData.from_dict (class method)</h4> +<b>from_dict</b>(<i>data</i>) + +<p> + Class method to create a metadata object from the given dictionary. +</p> +<dl> + +<dt><i>data</i> (dict)</dt> +<dd> +dictionary containing the metadata +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +created metadata object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +VirtualenvMetaData +</dd> +</dl> +<a NAME="VirtualenvMetaData.as_dict" ID="VirtualenvMetaData.as_dict"></a> +<h4>VirtualenvMetaData.as_dict</h4> +<b>as_dict</b>(<i></i>) + +<p> + Public method to convert the metadata into a dictionary. +</p> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the metadata +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file