eric: comparison scripts/install.py

-:2fda68a9168d
+:5ac83a87954d
 def exit(rcode=0):
 """
 Exit the install script.
-@param rcode result code to report back (integer)
+@param rcode result code to report back
+@type int
 """
 global currDir
 print()
 def copyToFile(name, text):
 """
 Copy a string to a file.
-@param name the name of the file.
+@param name name of the file
-@param text the contents to copy to the file.
+@type str
+@param text contents to copy to the file
+@type str
 """
 with open(name, "w") as f:
 f.write(text)
 def copyDesktopFile(src, dst):
 """
 Modify a desktop file and write it to its destination.
-@param src source file name (string)
+@param src source file name
-@param dst destination file name (string)
+@type str
+@param dst destination file name
+@type str
 """
 global cfg, platBinDir
 with open(src, "r", encoding="utf-8") as f:
 text = f.read()
 def copyAppStreamFile(src, dst):
 """
 Modify an appstream file and write it to its destination.
-@param src source file name (string)
+@param src source file name
-@param dst destination file name (string)
+@type str
+@param dst destination file name
+@type str
 """
 if os.path.exists(os.path.join("eric", "src", "eric7", "UI", "Info.py")):
 # Installing from installer archive
 from eric.src.eric7.UI.Info import Version  # noqa: I101, I102
 elif os.path.exists(os.path.join("src", "eric7", "UI", "Info.py")):
 def wrapperNames(dname, wfile):
 """
 Create the platform specific names for the wrapper script.
 @param dname name of the directory to place the wrapper into
+@type str
 @param wfile basename (without extension) of the wrapper script
-@return the names of the wrapper scripts
+@type str
+@return list containing the names of the wrapper scripts
+@rtype list of str
 """
 wnames = (
-(dname + "\\" + wfile + ".cmd", dname + "\\" + wfile + ".bat")
+[dname + "\\" + wfile + ".cmd", dname + "\\" + wfile + ".bat"]
 if sys.platform.startswith(("win", "cygwin"))
-else (dname + "/" + wfile,)
+else [dname + "/" + wfile]
 )
 return wnames
 def createPyWrapper(pydir, wfile, saveDir, isGuiScript=True):
 """
 Create an executable wrapper for a Python script.
-@param pydir the name of the directory where the Python script will
+@param pydir name of the directory where the Python script will
-eventually be installed (string)
+eventually be installed
-@param wfile the basename of the wrapper (string)
+@type str
-@param saveDir directory to save the file into (string)
+@param wfile basename of the wrapper
-@param isGuiScript flag indicating a wrapper script for a GUI
+@type str
-application (boolean)
+@param saveDir directory to save the file into
-@return the platform specific name of the wrapper (string)
+@type str
+@param isGuiScript flag indicating a wrapper script for a GUI application
+@type bool
+@return the platform specific name of the wrapper
+@rtype str
 """
 # all kinds of Windows systems
 if sys.platform.startswith(("win", "cygwin")):
 wname = wfile + ".cmd"
 if isGuiScript:
 """
 Copy Python, translation, documentation, wizards configuration,
 designer template files and DTDs of a directory tree.
 @param src name of the source directory
+@type str
 @param dst name of the destination directory
+@type str
 @param filters list of filter pattern determining the files to be copied
+@type list of str
 @param excludeDirs list of (sub)directories to exclude from copying
+@type list of str
 @param excludePatterns list of filter pattern determining the files to
 be skipped
+@type list of str
 """
 if excludeDirs is None:
 excludeDirs = []
 if excludePatterns is None:
 excludePatterns = []
 def cleanupSource(dirName):
 """
 Cleanup the sources directory to get rid of leftover files
 and directories.
-@param dirName name of the directory to prune (string)
+@param dirName name of the directory to prune
+@type str
 """
 # step 1: delete all Ui_*.py files without a corresponding
 #         *.ui file
 dirListing = os.listdir(dirName)
 for formName, sourceName in [
 def shutilCopy(src, dst, perm=0o644):
 """
 Wrapper function around shutil.copy() to ensure the permissions.
-@param src source file name (string)
+@param src source file name
-@param dst destination file name or directory name (string)
+@type str
-@param perm permissions to be set (integer)
+@param dst destination file name or directory name
+@type str
+@param perm permissions to be set
+@type int
 """
 shutil.copy(src, dst)
 if os.path.isdir(dst):
 dst = os.path.join(dst, os.path.basename(src))
 os.chmod(dst, perm)
 def installEric():
 """
 Actually perform the installation steps.
-@return result code (integer)
+@return result code
+@rtype int
 """
 global distDir, doCleanup, cfg, progLanguages, sourceDir, configName
 global installApis
 # Create the platform specific wrappers.
 def __pyName(py_dir, py_file):
 """
 Local function to create the Python source file name for the compiled
 .ui file.
-@param py_dir suggested name of the directory (string)
+@param py_dir suggested name of the directory
-@param py_file suggested name for the compile source file (string)
+@type str
-@return tuple of directory name (string) and source file name (string)
+@param py_file suggested name for the compile source file
+@type str
+@return tuple of directory name and source file name
+@rtype tuple of (str, str)
 """
 return py_dir, "Ui_{0}".format(py_file)
 def __compileOneUi(ui_path, mapFunc=None):
 def prepareInfoFile(fileName):
 """
 Function to prepare an Info.py file when installing from source.
-@param fileName name of the Python file containing the info (string)
+@param fileName name of the Python file containing the info
+@type str
 """
 if not fileName:
 return
 with contextlib.suppress(OSError):

Mercurial Repositories > eric / file comparison

comparison: scripts/install.py

scripts/install.py