eric3.Utilities.__init__
Package implementing various functions/classes needed everywhere within eric3.
Classes
Functions
compile |
Function to compile one Python source file to Python bytecode. |
decode |
Function to decode a text. |
direntries |
Function returning a list of all files and directories. |
encode |
Function to encode a text. |
escape |
Function to escape &, <, and > in a string of data. |
escape_entities |
Function to encode html entities. |
escape_uentities |
Function to encode html entities. |
getConfigDir |
Module function to get the name of the directory storing the config data. |
getDirs |
Function returning a list of all directories below path. |
getExecutablePath |
Function to build the full path of an executable file from the environment. |
getPythonLibPath |
Function to determine the path to Pythons library. |
getPythonVersion |
Function to get the Python version (major, minor) as an integer value. |
getTestFileName |
Function to build the filename of a unittest file. |
get_coding |
Function to get the coding of a text. |
html_encode |
Function to correctly encode a text for html. |
html_uencode |
Function to correctly encode a unicode text for html. |
isinpath |
Function to check for an executable file. |
joinext |
Function to join a file extension to a path. |
normabsjoinpath |
Function returning a normalized, absolute path of the joined parts passed into it. |
normabspath |
Function returning a normalized, absolute path. |
normcasepath |
Function returning a path, that is normalized with respect to its case and references. |
normjoinpath |
Function returning a normalized path of the joined parts passed into it. |
parseEnvironmentString |
Function used to convert an environment string into a list of environment settings. |
parseOptionString |
Function used to convert an option string into a list of options. |
parseString |
Function used to convert a string into a list. |
samepath |
Function to compare two paths. |
splitPath |
Function to split a pathname into a directory part and a file part. |
toUnicode |
Private method to convert a string to unicode. |
win32_Kill |
Function to provide an os.kill equivalent for Win32. |
compile
compile(file)
Function to compile one Python source file to Python bytecode.
- file
-
source filename (string)
- Returns:
-
A tuple indicating status (1 = an error was found), the
filename, the linenumber, the code string and the error message
(boolean, string, string, string, string). The values are only
valid, if the status equals 1.
decode
decode(text)
Function to decode a text.
- text
-
text to decode (string)
- Returns:
-
decoded text
direntries
direntries(path, filesonly=0, pattern=None, followsymlinks=1)
Function returning a list of all files and directories.
- filesonly
-
flag indicating that only files are wanted
- followsymlinks
-
flag indicating whether symbolic links
should be followed
- path
-
root of the tree to check
- pattern
-
a filename pattern to check against
- Returns:
-
list of all files and directories in the tree rooted
at path. The names are expanded to start with path.
encode
encode(text, orig_coding)
Function to encode a text.
- orig_coding
-
type of the original coding (string)
- text
-
text to encode (string)
- Returns:
-
encoded text
escape
escape(data)
Function to escape &, <, and > in a string of data.
- data
-
data to be escaped (string)
- Returns:
-
the escaped data (string)
escape_entities
escape_entities(m, map=_escape_map)
Function to encode html entities.
- m
-
the match object
- map
-
the map of entioties to encode
- Returns:
-
the converted text (string)
escape_uentities
escape_uentities(m)
Function to encode html entities.
- m
-
the match object
- Returns:
-
the converted text (string)
getConfigDir
getConfigDir()
Module function to get the name of the directory storing the config data.
- Returns:
-
directory name of the config dir (string)
getDirs
getDirs(path, excludeDirs)
Function returning a list of all directories below path.
- excludeDirs
-
basename of directories to ignore
- path
-
root of the tree to check
- Returns:
-
list of all directories found
getExecutablePath
getExecutablePath(file)
Function to build the full path of an executable file from the environment.
- file
-
filename of the executable to check (string)
- Returns:
-
full executable name, if the executable file is accessible
via the searchpath defined by the PATH environment variable, or an
empty string otherwise.
getPythonLibPath
getPythonLibPath()
Function to determine the path to Pythons library.
- Returns:
-
path to the Python library (string)
getPythonVersion
getPythonVersion()
Function to get the Python version (major, minor) as an integer value.
- Returns:
-
An integer representing major and minor version number (integer)
getTestFileName
getTestFileName(fn)
Function to build the filename of a unittest file.
The filename for the unittest file is built by prepending
the string "test" to the filename passed into this function.
- fn
-
filename basis to be used for the unittest filename (string)
- Returns:
-
filename of the corresponding unittest file (string)
get_coding
get_coding(text)
Function to get the coding of a text.
- text
-
text to inspect (string)
- Returns:
-
coding string
html_encode
html_encode(text, pattern=_escape)
Function to correctly encode a text for html.
- pattern
-
search pattern for text to be encoded (string)
- text
-
text to be encoded (string)
- Returns:
-
the encoded text (string)
html_uencode
html_uencode(text, pattern=_uescape)
Function to correctly encode a unicode text for html.
- pattern
-
search pattern for text to be encoded (string)
- text
-
text to be encoded (string)
- Returns:
-
the encoded text (string)
isinpath
isinpath(file)
Function to check for an executable file.
- file
-
filename of the executable to check (string)
- Returns:
-
flag to indicate, if the executable file is accessible
via the searchpath defined by the PATH environment variable.
joinext
joinext(prefix, ext)
Function to join a file extension to a path.
The leading "." of ext is replaced by a platform specific extension
separator if neccessary.
- ext
-
the extension part (string)
- prefix
-
the basepart of the filename (string)
- Returns:
-
the complete filename (string)
normabsjoinpath
normabsjoinpath(a, *p)
Function returning a normalized, absolute path of the joined parts passed into it.
- a
-
first path to be joined (string)
- p
-
variable number of path parts to be joind (string)
- Returns:
-
absolute, normalized path (string)
normabspath
normabspath(path)
Function returning a normalized, absolute path.
- path
-
file path (string)
- Returns:
-
absolute, normalized path (string)
normcasepath
normcasepath(path)
Function returning a path, that is normalized with respect to its case and references.
- path
-
file path (string)
- Returns:
-
case normalized path (string)
normjoinpath
normjoinpath(a, *p)
Function returning a normalized path of the joined parts passed into it.
- a
-
first path to be joined (string)
- p
-
variable number of path parts to be joind (string)
- Returns:
-
normalized path (string)
parseEnvironmentString
parseEnvironmentString(s)
Function used to convert an environment string into a list of environment settings.
- s
-
environment string (string or QString)
- Returns:
-
list of environment settings (list of strings)
parseOptionString
parseOptionString(s)
Function used to convert an option string into a list of options.
- s
-
option string (string or QString)
- Returns:
-
list of options (list of strings)
parseString
parseString(s, rx)
Function used to convert a string into a list.
- rx
-
regex defining the parse pattern (QRegExp)
- s
-
string to be parsed (string or QString)
- Returns:
-
list of parsed data (list of strings)
samepath
samepath(f1, f2)
Function to compare two paths.
- f1
-
first path for the compare (string)
- f2
-
second path for the compare (string)
- Returns:
-
flag indicating whether the two paths represent the
same path on disk.
splitPath
splitPath(name)
Function to split a pathname into a directory part and a file part.
- name
-
path name (string)
- Returns:
-
a tuple of 2 strings (dirname, filename).
toUnicode
toUnicode(s)
Private method to convert a string to unicode.
If the passed in string is of type QString, it is
simply returned unaltered, assuming, that it is already
a unicode string. For all other strings, various codes
are tried until one converts the string without an error.
If all codecs fail, the string is returned unaltered.
- s
-
string to be converted (string or QString)
- Returns:
-
converted string (unicode or QString)
win32_Kill
win32_Kill(pid)
Function to provide an os.kill equivalent for Win32.
- pid
-
process id