src/eric7/Documentation/Source/eric7.SystemUtilities.PythonUtilities.html

branch
eric7
changeset 9624
b47dfa7a137d
child 10358
957c9de01d42
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.SystemUtilities.PythonUtilities.html	Sun Dec 18 19:33:46 2022 +0100
@@ -0,0 +1,184 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.SystemUtilities.PythonUtilities</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.SystemUtilities.PythonUtilities</h1>
+
+<p>
+Module implementing Python related utility functions.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#determinePythonVersion">determinePythonVersion</a></td>
+<td>Function to determine the python version of a given file.</td>
+</tr>
+<tr>
+<td><a href="#getPythonExecutable">getPythonExecutable</a></td>
+<td>Function to determine the path of the (non-windowed) Python executable.</td>
+</tr>
+<tr>
+<td><a href="#getPythonLibPath">getPythonLibPath</a></td>
+<td>Function to determine the path to Python's library.</td>
+</tr>
+<tr>
+<td><a href="#getPythonLibraryDirectory">getPythonLibraryDirectory</a></td>
+<td>Function to determine the path to Python's library directory.</td>
+</tr>
+<tr>
+<td><a href="#getPythonScriptsDirectory">getPythonScriptsDirectory</a></td>
+<td>Function to determine the path to Python's scripts directory.</td>
+</tr>
+<tr>
+<td><a href="#getPythonVersion">getPythonVersion</a></td>
+<td>Function to get the Python version (major, minor) as an integer value.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="determinePythonVersion" ID="determinePythonVersion"></a>
+<h2>determinePythonVersion</h2>
+<b>determinePythonVersion</b>(<i>filename, source, editor=None</i>)
+
+<p>
+    Function to determine the python version of a given file.
+</p>
+<dl>
+
+<dt><i>filename</i></dt>
+<dd>
+name of the file with extension (str)
+</dd>
+<dt><i>source</i></dt>
+<dd>
+of the file (str)
+</dd>
+<dt><i>editor</i></dt>
+<dd>
+reference to the editor, if the file is opened
+        already (Editor object)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+Python version if file is Python3 (int)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getPythonExecutable" ID="getPythonExecutable"></a>
+<h2>getPythonExecutable</h2>
+<b>getPythonExecutable</b>(<i></i>)
+
+<p>
+    Function to determine the path of the (non-windowed) Python executable.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+path of the Python executable
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getPythonLibPath" ID="getPythonLibPath"></a>
+<h2>getPythonLibPath</h2>
+<b>getPythonLibPath</b>(<i></i>)
+
+<p>
+    Function to determine the path to Python's library.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+path to the Python library (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getPythonLibraryDirectory" ID="getPythonLibraryDirectory"></a>
+<h2>getPythonLibraryDirectory</h2>
+<b>getPythonLibraryDirectory</b>(<i></i>)
+
+<p>
+    Function to determine the path to Python's library directory.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+path to the Python library directory
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getPythonScriptsDirectory" ID="getPythonScriptsDirectory"></a>
+<h2>getPythonScriptsDirectory</h2>
+<b>getPythonScriptsDirectory</b>(<i></i>)
+
+<p>
+    Function to determine the path to Python's scripts directory.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+path to the Python scripts directory
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getPythonVersion" ID="getPythonVersion"></a>
+<h2>getPythonVersion</h2>
+<b>getPythonVersion</b>(<i></i>)
+
+<p>
+    Function to get the Python version (major, minor) as an integer value.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+An integer representing major and minor version number (integer)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial