diff -r 9c1f429cb56b -r b47dfa7a137d src/eric7/Documentation/Source/eric7.Utilities.__init__.html --- a/src/eric7/Documentation/Source/eric7.Utilities.__init__.html Sun Dec 18 14:19:10 2022 +0100 +++ b/src/eric7/Documentation/Source/eric7.Utilities.__init__.html Sun Dec 18 19:33:46 2022 +0100 @@ -38,22 +38,6 @@ <td>Protected function called for replacing % codes.</td> </tr> <tr> -<td><a href="#absolutePath">absolutePath</a></td> -<td>Public method to convert a path relative to a start path to an absolute path.</td> -</tr> -<tr> -<td><a href="#absoluteUniversalPath">absoluteUniversalPath</a></td> -<td>Public method to convert a path relative to a start path with universal separators to an absolute path.</td> -</tr> -<tr> -<td><a href="#checkPyside">checkPyside</a></td> -<td>Module function to check the presence of PySide2/PySide6.</td> -</tr> -<tr> -<td><a href="#compactPath">compactPath</a></td> -<td>Function to return a compacted path fitting inside the given width.</td> -</tr> -<tr> <td><a href="#convertLineEnds">convertLineEnds</a></td> <td>Function to convert the end of line characters.</td> </tr> @@ -70,14 +54,6 @@ <td>Function to decode a string containing Unicode encoded characters.</td> </tr> <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="#direntries">direntries</a></td> -<td>Function returning a list of all files and directories.</td> -</tr> -<tr> <td><a href="#encode">encode</a></td> <td>Function to encode text into a byte text.</td> </tr> @@ -106,14 +82,6 @@ <td>Function to filter out ANSI escape sequences (color only).</td> </tr> <tr> -<td><a href="#findVolume">findVolume</a></td> -<td>Function to find the directory belonging to a given volume name.</td> -</tr> -<tr> -<td><a href="#fromNativeSeparators">fromNativeSeparators</a></td> -<td>Function returning a path, that is using "/" separator characters.</td> -</tr> -<tr> <td><a href="#generateDistroInfo">generateDistroInfo</a></td> <td>Module function to generate a string with distribution infos.</td> </tr> @@ -122,18 +90,6 @@ <td>Module function to generate a string with plugins version infos.</td> </tr> <tr> -<td><a href="#generatePyQtToolPath">generatePyQtToolPath</a></td> -<td>Module function to generate the executable path for a PyQt tool.</td> -</tr> -<tr> -<td><a href="#generatePySideToolPath">generatePySideToolPath</a></td> -<td>Module function to generate the executable path for a PySide2/PySide6 tool.</td> -</tr> -<tr> -<td><a href="#generateQtToolName">generateQtToolName</a></td> -<td>Module function to generate the executable name for a Qt tool like designer.</td> -</tr> -<tr> <td><a href="#generateVersionInfo">generateVersionInfo</a></td> <td>Module function to generate a string with various version infos.</td> </tr> @@ -146,26 +102,6 @@ <td>Function to build a list of coverage data file names.</td> </tr> <tr> -<td><a href="#getDirs">getDirs</a></td> -<td>Function returning a list of all directories below path.</td> -</tr> -<tr> -<td><a href="#getEnvironmentEntry">getEnvironmentEntry</a></td> -<td>Module function to get an environment entry.</td> -</tr> -<tr> -<td><a href="#getExecutablePath">getExecutablePath</a></td> -<td>Function to build the full path of an executable file from the environment.</td> -</tr> -<tr> -<td><a href="#getExecutablePaths">getExecutablePaths</a></td> -<td>Function to build all full path of an executable file from the environment.</td> -</tr> -<tr> -<td><a href="#getHomeDir">getHomeDir</a></td> -<td>Function to get a users home directory.</td> -</tr> -<tr> <td><a href="#getPercentReplacement">getPercentReplacement</a></td> <td>Function to get the replacement for code.</td> </tr> @@ -182,22 +118,6 @@ <td>Function to build a list of profile data file names.</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="#getPythonVersion">getPythonVersion</a></td> -<td>Function to get the Python version (major, minor) as an integer value.</td> -</tr> -<tr> -<td><a href="#getQtMacBundle">getQtMacBundle</a></td> -<td>Module function to determine the correct Mac OS X bundle name for Qt tools.</td> -</tr> -<tr> -<td><a href="#getRealName">getRealName</a></td> -<td>Function to get the real name of the user.</td> -</tr> -<tr> <td><a href="#getSysPath">getSysPath</a></td> <td>Module function to get the Python path (sys.path) of a specific interpreter.</td> </tr> @@ -206,18 +126,6 @@ <td>Function to build the potential file names of a test file.</td> </tr> <tr> -<td><a href="#getUserName">getUserName</a></td> -<td>Function to get the user name.</td> -</tr> -<tr> -<td><a href="#getVolumeName">getVolumeName</a></td> -<td>Local function to determine the volume of a disk or device.</td> -</tr> -<tr> -<td><a href="#getWindowsExecutablePath">getWindowsExecutablePath</a></td> -<td>Function to build the full path of an executable file from the environment on Windows platforms.</td> -</tr> -<tr> <td><a href="#get_coding">get_coding</a></td> <td>Function to get the coding of a text.</td> </tr> @@ -226,10 +134,6 @@ <td>Function to get the coding of a bytes text.</td> </tr> <tr> -<td><a href="#hasEnvironmentEntry">hasEnvironmentEntry</a></td> -<td>Module function to check, if the environment contains an entry.</td> -</tr> -<tr> <td><a href="#html_encode">html_encode</a></td> <td>Function to correctly encode a text for html.</td> </tr> @@ -242,54 +146,18 @@ <td>Function to correctly encode a unicode text for html.</td> </tr> <tr> -<td><a href="#isDrive">isDrive</a></td> -<td>Function to check, if a path is a Windows drive.</td> -</tr> -<tr> -<td><a href="#isExecutable">isExecutable</a></td> -<td>Function to check, if a file is executable.</td> -</tr> -<tr> -<td><a href="#isinpath">isinpath</a></td> -<td>Function to check for an executable file.</td> -</tr> -<tr> -<td><a href="#joinext">joinext</a></td> -<td>Function to join a file extension to a path.</td> -</tr> -<tr> <td><a href="#linesep">linesep</a></td> <td>Function to return the line separator used by the editor.</td> </tr> <tr> -<td><a href="#normabsjoinpath">normabsjoinpath</a></td> -<td>Function returning a normalized, absolute path of the joined parts passed into it.</td> -</tr> -<tr> <td><a href="#normalizeCode">normalizeCode</a></td> <td>Function to normalize the given code.</td> </tr> <tr> -<td><a href="#normcaseabspath">normcaseabspath</a></td> -<td>Function returning an absolute path, that is normalized with respect to its case and references.</td> -</tr> -<tr> -<td><a href="#normcasepath">normcasepath</a></td> -<td>Function returning a path, that is normalized with respect to its case and references.</td> -</tr> -<tr> -<td><a href="#normjoinpath">normjoinpath</a></td> -<td>Function returning a normalized path of the joined parts passed into it.</td> -</tr> -<tr> <td><a href="#parseOptionString">parseOptionString</a></td> <td>Function used to convert an option string into a list of options.</td> </tr> <tr> -<td><a href="#prepareQtMacBundle">prepareQtMacBundle</a></td> -<td>Module function for starting Qt tools that are Mac OS X bundles.</td> -</tr> -<tr> <td><a href="#readEncodedFile">readEncodedFile</a></td> <td>Function to read a file and decode its contents into proper text.</td> </tr> @@ -306,54 +174,14 @@ <td>Module function to read a string from the given stream.</td> </tr> <tr> -<td><a href="#relativeUniversalPath">relativeUniversalPath</a></td> -<td>Function to convert a file path to a path relative to a start path with universal separators.</td> -</tr> -<tr> <td><a href="#rxIndex">rxIndex</a></td> <td>Function to get the index (start position) of a regular expression match within some text.</td> </tr> <tr> -<td><a href="#samefilepath">samefilepath</a></td> -<td>Function to compare two paths.</td> -</tr> -<tr> -<td><a href="#samepath">samepath</a></td> -<td>Function to compare two paths.</td> -</tr> -<tr> -<td><a href="#splitPath">splitPath</a></td> -<td>Function to split a pathname into a directory part and a file part.</td> -</tr> -<tr> -<td><a href="#startswithPath">startswithPath</a></td> -<td>Function to check, if a path starts with a given start path.</td> -</tr> -<tr> -<td><a href="#toBool">toBool</a></td> -<td>Module function to convert a string to a boolean value.</td> -</tr> -<tr> -<td><a href="#toNativeSeparators">toNativeSeparators</a></td> -<td>Function returning a path, that is using native separator characters.</td> -</tr> -<tr> <td><a href="#unescape_uentities">unescape_uentities</a></td> <td>Function to decode html entities.</td> </tr> <tr> -<td><a href="#win32_GetUserName">win32_GetUserName</a></td> -<td>Function to get the user name under Win32.</td> -</tr> -<tr> -<td><a href="#win32_Kill">win32_Kill</a></td> -<td>Function to provide an os.kill equivalent for Win32.</td> -</tr> -<tr> -<td><a href="#win32_getRealName">win32_getRealName</a></td> -<td>Function to get the user's real name (aka.</td> -</tr> -<tr> <td><a href="#writeEncodedFile">writeEncodedFile</a></td> <td>Function to write a file with properly encoded text.</td> </tr> @@ -518,123 +346,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="absolutePath" ID="absolutePath"></a> -<h2>absolutePath</h2> -<b>absolutePath</b>(<i>path, start</i>) - -<p> - Public method to convert a path relative to a start path to an - absolute path. -</p> -<dl> - -<dt><i>path</i></dt> -<dd> -file or directory name to convert (string) -</dd> -<dt><i>start</i></dt> -<dd> -start path (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -absolute path (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="absoluteUniversalPath" ID="absoluteUniversalPath"></a> -<h2>absoluteUniversalPath</h2> -<b>absoluteUniversalPath</b>(<i>path, start</i>) - -<p> - Public method to convert a path relative to a start path with - universal separators to an absolute path. -</p> -<dl> - -<dt><i>path</i></dt> -<dd> -file or directory name to convert (string) -</dd> -<dt><i>start</i></dt> -<dd> -start path (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -absolute path with native separators (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="checkPyside" ID="checkPyside"></a> -<h2>checkPyside</h2> -<b>checkPyside</b>(<i>variant=2</i>) - -<p> - Module function to check the presence of PySide2/PySide6. -</p> -<dl> - -<dt><i>variant</i> (int or str)</dt> -<dd> -indicator for the PySide variant -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flags indicating the presence of PySide2/PySide6 -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="compactPath" ID="compactPath"></a> -<h2>compactPath</h2> -<b>compactPath</b>(<i>path, width, measure=len</i>) - -<p> - Function to return a compacted path fitting inside the given width. -</p> -<dl> - -<dt><i>path</i></dt> -<dd> -path to be compacted (string) -</dd> -<dt><i>width</i></dt> -<dd> -width for the compacted path (integer) -</dd> -<dt><i>measure</i></dt> -<dd> -reference to a function used to measure the length of the - string -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -compacted path (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="convertLineEnds" ID="convertLineEnds"></a> <h2>convertLineEnds</h2> <b>convertLineEnds</b>(<i>text, eol</i>) @@ -731,86 +442,6 @@ <div align="right"><a href="#top">Up</a></div> <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="direntries" ID="direntries"></a> -<h2>direntries</h2> -<b>direntries</b>(<i>path, filesonly=False, pattern=None, followsymlinks=True, checkStop=None</i>) - -<p> - Function returning a list of all files and directories. -</p> -<dl> - -<dt><i>path</i> (str)</dt> -<dd> -root of the tree to check -</dd> -<dt><i>filesonly</i> (bool)</dt> -<dd> -flag indicating that only files are wanted -</dd> -<dt><i>pattern</i> (str or list of str)</dt> -<dd> -a filename pattern or list of filename patterns to check - against -</dd> -<dt><i>followsymlinks</i> (bool)</dt> -<dd> -flag indicating whether symbolic links - should be followed -</dd> -<dt><i>checkStop</i> (function)</dt> -<dd> -function to be called to check for a stop -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -list of all files and directories in the tree rooted - at path. The names are expanded to start with path. -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -list of strs -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="encode" ID="encode"></a> <h2>encode</h2> <b>encode</b>(<i>text, origEncoding, forcedEncoding=""</i>) @@ -1026,70 +657,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="findVolume" ID="findVolume"></a> -<h2>findVolume</h2> -<b>findVolume</b>(<i>volumeName, findAll=False</i>) - -<p> - Function to find the directory belonging to a given volume name. -</p> -<dl> - -<dt><i>volumeName</i> (str)</dt> -<dd> -name of the volume to search for -</dd> -<dt><i>findAll</i> (bool (optional))</dt> -<dd> -flag indicating to get the directories for all volumes - starting with the given name (defaults to False) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -directory path or list of directory paths for the given volume - name -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str or list of str -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="fromNativeSeparators" ID="fromNativeSeparators"></a> -<h2>fromNativeSeparators</h2> -<b>fromNativeSeparators</b>(<i>path</i>) - -<p> - Function returning a path, that is using "/" separator characters. -</p> -<dl> - -<dt><i>path</i> (str)</dt> -<dd> -path to be converted -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -path with converted separator characters -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="generateDistroInfo" ID="generateDistroInfo"></a> <h2>generateDistroInfo</h2> <b>generateDistroInfo</b>(<i>linesep="\n"</i>) @@ -1148,96 +715,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="generatePyQtToolPath" ID="generatePyQtToolPath"></a> -<h2>generatePyQtToolPath</h2> -<b>generatePyQtToolPath</b>(<i>toolname, alternatives=None</i>) - -<p> - Module function to generate the executable path for a PyQt tool. -</p> -<dl> - -<dt><i>toolname</i> (str)</dt> -<dd> -base name of the tool -</dd> -<dt><i>alternatives</i> (list of str)</dt> -<dd> -list of alternative tool names to try -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -executable path name of the tool -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="generatePySideToolPath" ID="generatePySideToolPath"></a> -<h2>generatePySideToolPath</h2> -<b>generatePySideToolPath</b>(<i>toolname, variant=2</i>) - -<p> - Module function to generate the executable path for a PySide2/PySide6 tool. -</p> -<dl> - -<dt><i>toolname</i> (str)</dt> -<dd> -base name of the tool -</dd> -<dt><i>variant</i> (int or str)</dt> -<dd> -indicator for the PySide variant -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -the PySide2/PySide6 tool path with extension -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="generateQtToolName" ID="generateQtToolName"></a> -<h2>generateQtToolName</h2> -<b>generateQtToolName</b>(<i>toolname</i>) - -<p> - Module function to generate the executable name for a Qt tool like - designer. -</p> -<dl> - -<dt><i>toolname</i></dt> -<dd> -base name of the tool (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -the Qt tool name without extension (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="generateVersionInfo" ID="generateVersionInfo"></a> <h2>generateVersionInfo</h2> <b>generateVersionInfo</b>(<i>linesep="\n"</i>) @@ -1330,128 +807,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="getDirs" ID="getDirs"></a> -<h2>getDirs</h2> -<b>getDirs</b>(<i>path, excludeDirs</i>) - -<p> - Function returning a list of all directories below path. -</p> -<dl> - -<dt><i>path</i></dt> -<dd> -root of the tree to check -</dd> -<dt><i>excludeDirs</i></dt> -<dd> -basename of directories to ignore -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -list of all directories found -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getEnvironmentEntry" ID="getEnvironmentEntry"></a> -<h2>getEnvironmentEntry</h2> -<b>getEnvironmentEntry</b>(<i>key, default=None</i>) - -<p> - Module function to get an environment entry. -</p> -<dl> - -<dt><i>key</i></dt> -<dd> -key of the requested environment entry (string) -</dd> -<dt><i>default</i></dt> -<dd> -value to be returned, if the environment doesn't contain - the requested entry (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -the requested entry or the default value, if the entry wasn't - found (string or None) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getExecutablePath" ID="getExecutablePath"></a> -<h2>getExecutablePath</h2> -<b>getExecutablePath</b>(<i>file</i>) - -<p> - Function to build the full path of an executable file from the environment. -</p> -<dl> - -<dt><i>file</i></dt> -<dd> -filename of the executable to check (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -full executable name, if the executable file is accessible - via the searchpath defined by the PATH environment variable, or an - empty string otherwise. -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getExecutablePaths" ID="getExecutablePaths"></a> -<h2>getExecutablePaths</h2> -<b>getExecutablePaths</b>(<i>file</i>) - -<p> - Function to build all full path of an executable file from the environment. -</p> -<dl> - -<dt><i>file</i></dt> -<dd> -filename of the executable (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -list of full executable names (list of strings), if the executable - file is accessible via the searchpath defined by the PATH environment - variable, or an empty list otherwise. -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getHomeDir" ID="getHomeDir"></a> -<h2>getHomeDir</h2> -<b>getHomeDir</b>(<i></i>) - -<p> - Function to get a users home directory. -</p> -<dl> -<dt>Return:</dt> -<dd> -home directory (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="getPercentReplacement" ID="getPercentReplacement"></a> <h2>getPercentReplacement</h2> <b>getPercentReplacement</b>(<i>code</i>) @@ -1560,77 +915,6 @@ <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="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 /> -<hr /> -<a NAME="getQtMacBundle" ID="getQtMacBundle"></a> -<h2>getQtMacBundle</h2> -<b>getQtMacBundle</b>(<i>toolname</i>) - -<p> - Module function to determine the correct Mac OS X bundle name for Qt tools. -</p> -<dl> - -<dt><i>toolname</i></dt> -<dd> -plain name of the tool (e.g. "designer") (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -bundle name of the Qt tool (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getRealName" ID="getRealName"></a> -<h2>getRealName</h2> -<b>getRealName</b>(<i></i>) - -<p> - Function to get the real name of the user. -</p> -<dl> -<dt>Return:</dt> -<dd> -real name of the user (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="getSysPath" ID="getSysPath"></a> <h2>getSysPath</h2> <b>getSysPath</b>(<i>interpreter</i>) @@ -1696,71 +980,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="getUserName" ID="getUserName"></a> -<h2>getUserName</h2> -<b>getUserName</b>(<i></i>) - -<p> - Function to get the user name. -</p> -<dl> -<dt>Return:</dt> -<dd> -user name (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getVolumeName" ID="getVolumeName"></a> -<h2>getVolumeName</h2> -<b>getVolumeName</b>(<i>diskName</i>) - -<p> - Local function to determine the volume of a disk or device. -</p> -<p> - Each disk or external device connected to windows has an - attribute called "volume name". This function returns the - volume name for the given disk/device. -</p> -<p> - Code from http://stackoverflow.com/a/12056414 -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getWindowsExecutablePath" ID="getWindowsExecutablePath"></a> -<h2>getWindowsExecutablePath</h2> -<b>getWindowsExecutablePath</b>(<i>file</i>) - -<p> - Function to build the full path of an executable file from the environment - on Windows platforms. -</p> -<p> - First an executable with the extension .exe is searched for, thereafter - such with the extensions .cmd or .bat and finally the given file name as - is. The first match is returned. -</p> -<dl> - -<dt><i>file</i></dt> -<dd> -filename of the executable to check (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -full executable name, if the executable file is accessible - via the searchpath defined by the PATH environment variable, or an - empty string otherwise. -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="get_coding" ID="get_coding"></a> <h2>get_coding</h2> <b>get_coding</b>(<i>text</i>) @@ -1807,35 +1026,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="hasEnvironmentEntry" ID="hasEnvironmentEntry"></a> -<h2>hasEnvironmentEntry</h2> -<b>hasEnvironmentEntry</b>(<i>key</i>) - -<p> - Module function to check, if the environment contains an entry. -</p> -<dl> - -<dt><i>key</i> (str)</dt> -<dd> -key of the requested environment entry -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating the presence of the requested entry -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="html_encode" ID="html_encode"></a> <h2>html_encode</h2> <b>html_encode</b>(<i>text, pattern=_escape</i>) @@ -1917,113 +1107,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="isDrive" ID="isDrive"></a> -<h2>isDrive</h2> -<b>isDrive</b>(<i>path</i>) - -<p> - Function to check, if a path is a Windows drive. -</p> -<dl> - -<dt><i>path</i> (str)</dt> -<dd> -path name to be checked -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating a Windows drive -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="isExecutable" ID="isExecutable"></a> -<h2>isExecutable</h2> -<b>isExecutable</b>(<i>exe</i>) - -<p> - Function to check, if a file is executable. -</p> -<dl> - -<dt><i>exe</i></dt> -<dd> -filename of the executable to check (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating executable status (boolean) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="isinpath" ID="isinpath"></a> -<h2>isinpath</h2> -<b>isinpath</b>(<i>file</i>) - -<p> - Function to check for an executable file. -</p> -<dl> - -<dt><i>file</i></dt> -<dd> -filename of the executable to check (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag to indicate, if the executable file is accessible - via the searchpath defined by the PATH environment variable. -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="joinext" ID="joinext"></a> -<h2>joinext</h2> -<b>joinext</b>(<i>prefix, ext</i>) - -<p> - Function to join a file extension to a path. -</p> -<p> - The leading "." of ext is replaced by a platform specific extension - separator if necessary. -</p> -<dl> - -<dt><i>prefix</i></dt> -<dd> -the basepart of the filename (string) -</dd> -<dt><i>ext</i></dt> -<dd> -the extension part (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -the complete filename (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="linesep" ID="linesep"></a> <h2>linesep</h2> <b>linesep</b>(<i></i>) @@ -2040,34 +1123,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="normabsjoinpath" ID="normabsjoinpath"></a> -<h2>normabsjoinpath</h2> -<b>normabsjoinpath</b>(<i>a, *p</i>) - -<p> - Function returning a normalized, absolute path of the joined parts passed - into it. -</p> -<dl> - -<dt><i>a</i></dt> -<dd> -first path to be joined (string) -</dd> -<dt><i>p</i></dt> -<dd> -variable number of path parts to be joind (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -absolute, normalized path (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="normalizeCode" ID="normalizeCode"></a> <h2>normalizeCode</h2> <b>normalizeCode</b>(<i>codestring</i>) @@ -2091,81 +1146,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="normcaseabspath" ID="normcaseabspath"></a> -<h2>normcaseabspath</h2> -<b>normcaseabspath</b>(<i>path</i>) - -<p> - Function returning an absolute path, that is normalized with respect to - its case and references. -</p> -<dl> - -<dt><i>path</i></dt> -<dd> -file path (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -absolute, normalized path (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="normcasepath" ID="normcasepath"></a> -<h2>normcasepath</h2> -<b>normcasepath</b>(<i>path</i>) - -<p> - Function returning a path, that is normalized with respect to its case - and references. -</p> -<dl> - -<dt><i>path</i></dt> -<dd> -file path (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -case normalized path (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="normjoinpath" ID="normjoinpath"></a> -<h2>normjoinpath</h2> -<b>normjoinpath</b>(<i>a, *p</i>) - -<p> - Function returning a normalized path of the joined parts passed into it. -</p> -<dl> - -<dt><i>a</i></dt> -<dd> -first path to be joined (string) -</dd> -<dt><i>p</i></dt> -<dd> -variable number of path parts to be joined (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -normalized path (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="parseOptionString" ID="parseOptionString"></a> <h2>parseOptionString</h2> <b>parseOptionString</b>(<i>s</i>) @@ -2195,39 +1175,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="prepareQtMacBundle" ID="prepareQtMacBundle"></a> -<h2>prepareQtMacBundle</h2> -<b>prepareQtMacBundle</b>(<i>toolname, args</i>) - -<p> - Module function for starting Qt tools that are Mac OS X bundles. -</p> -<dl> - -<dt><i>toolname</i> (str)</dt> -<dd> -plain name of the tool (e.g. "designer") -</dd> -<dt><i>args</i> (list of str)</dt> -<dd> -name of input file for tool, if any -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -command-name and args for QProcess -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -tuple of (str, list of str) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="readEncodedFile" ID="readEncodedFile"></a> <h2>readEncodedFile</h2> <b>readEncodedFile</b>(<i>filename</i>) @@ -2326,35 +1273,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="relativeUniversalPath" ID="relativeUniversalPath"></a> -<h2>relativeUniversalPath</h2> -<b>relativeUniversalPath</b>(<i>path, start</i>) - -<p> - Function to convert a file path to a path relative to a start path - with universal separators. -</p> -<dl> - -<dt><i>path</i></dt> -<dd> -file or directory name to convert (string) -</dd> -<dt><i>start</i></dt> -<dd> -start path (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -relative path or unchanged path, if path does not start with - the start path with universal separators (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="rxIndex" ID="rxIndex"></a> <h2>rxIndex</h2> <b>rxIndex</b>(<i>rx, txt</i>) @@ -2389,171 +1307,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="samefilepath" ID="samefilepath"></a> -<h2>samefilepath</h2> -<b>samefilepath</b>(<i>f1, f2</i>) - -<p> - Function to compare two paths. Strips the filename. -</p> -<dl> - -<dt><i>f1</i></dt> -<dd> -first filepath for the compare (string) -</dd> -<dt><i>f2</i></dt> -<dd> -second filepath for the compare (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating whether the two paths represent the - same path on disk. -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="samepath" ID="samepath"></a> -<h2>samepath</h2> -<b>samepath</b>(<i>f1, f2</i>) - -<p> - Function to compare two paths. -</p> -<dl> - -<dt><i>f1</i></dt> -<dd> -first path for the compare (string) -</dd> -<dt><i>f2</i></dt> -<dd> -second path for the compare (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating whether the two paths represent the - same path on disk. -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="splitPath" ID="splitPath"></a> -<h2>splitPath</h2> -<b>splitPath</b>(<i>name</i>) - -<p> - Function to split a pathname into a directory part and a file part. -</p> -<dl> - -<dt><i>name</i></dt> -<dd> -path name (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -a tuple of 2 strings (dirname, filename). -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="startswithPath" ID="startswithPath"></a> -<h2>startswithPath</h2> -<b>startswithPath</b>(<i>path, start</i>) - -<p> - Function to check, if a path starts with a given start path. -</p> -<dl> - -<dt><i>path</i> (str)</dt> -<dd> -path to be checked -</dd> -<dt><i>start</i> (str)</dt> -<dd> -start path -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating that the path starts with the given start - path -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="toBool" ID="toBool"></a> -<h2>toBool</h2> -<b>toBool</b>(<i>dataStr</i>) - -<p> - Module function to convert a string to a boolean value. -</p> -<dl> - -<dt><i>dataStr</i></dt> -<dd> -string to be converted (string) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -converted boolean value (boolean) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="toNativeSeparators" ID="toNativeSeparators"></a> -<h2>toNativeSeparators</h2> -<b>toNativeSeparators</b>(<i>path</i>) - -<p> - Function returning a path, that is using native separator characters. -</p> -<dl> - -<dt><i>path</i> (str)</dt> -<dd> -path to be converted -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -path with converted separator characters -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="unescape_uentities" ID="unescape_uentities"></a> <h2>unescape_uentities</h2> <b>unescape_uentities</b>(<i>m</i>) @@ -2577,61 +1330,6 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="win32_GetUserName" ID="win32_GetUserName"></a> -<h2>win32_GetUserName</h2> -<b>win32_GetUserName</b>(<i></i>) - -<p> - Function to get the user name under Win32. -</p> -<dl> -<dt>Return:</dt> -<dd> -user name (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="win32_Kill" ID="win32_Kill"></a> -<h2>win32_Kill</h2> -<b>win32_Kill</b>(<i>pid</i>) - -<p> - Function to provide an os.kill equivalent for Win32. -</p> -<dl> - -<dt><i>pid</i></dt> -<dd> -process id (integer) -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -result of the kill (boolean) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="win32_getRealName" ID="win32_getRealName"></a> -<h2>win32_getRealName</h2> -<b>win32_getRealName</b>(<i></i>) - -<p> - Function to get the user's real name (aka. display name) under Win32. -</p> -<dl> -<dt>Return:</dt> -<dd> -real name of the current user (string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> <a NAME="writeEncodedFile" ID="writeEncodedFile"></a> <h2>writeEncodedFile</h2> <b>writeEncodedFile</b>(<i>filename, text, origEncoding, forcedEncoding=""</i>)