eric: comparison scripts/install.py

-:e075c8fe07fd
+:df7edc29cbfb
 """
 Installation script for the eric IDE and all eric related tools.
 """
+import argparse
 import compileall
 import contextlib
 import datetime
 import fnmatch
-import getopt
 import getpass
 import glob
 import importlib
 import io
 import json
 import time
 from functools import partial
 # Define the globals.
-progName = None
 currDir = os.getcwd()
 modDir = None
 pyModDir = None
 platBinDir = None
 distDir = None
 "sip": [],
 "PyQt6": [],
 "QScintilla2": [],
 }
 PlatformsBlackLists = {
-"windows": {
+"freebsd": {
 "sip": [],
 "PyQt6": [],
 "QScintilla2": [],
 },
 "linux": {
 "mac": {
 "sip": [],
 "PyQt6": [],
 "QScintilla2": [],
 },
+"windows": {
+"sip": [],
+"PyQt6": [],
+"QScintilla2": [],
+},
 }
 def exit(rcode=0):
 """
 input("Press enter to continue...")  # secok
 os.chdir(currDir)
 sys.exit(rcode)
-def usage(rcode=2):
-"""
-Display a usage message and exit.
-@param rcode the return code passed back to the calling process.
-"""
-global progName, modDir, distDir, apisDir
-global macAppBundleName, macAppBundlePath, macPythonExe
-print()
-print("Usage:")
-if sys.platform == "darwin":
-print(
-"    {0} [-chvxz] [-a dir] [-b dir] [-d dir] [-f file] [-i dir]"
-" [-m name] [-n path] [-p python] [--help] [--no-apis]"
-" [--no-info] [--with-tools] [--verbose] [--yes]".format(progName)
-)
-elif sys.platform.startswith(("win", "cygwin")):
-print(
-"    {0} [-chvxz] [-a dir] [-b dir] [-d dir] [-f file]"
-" [--clean-desktop] [--help] [--no-apis] [--no-info]"
-" [--with-tools] [--verbose] [--yes]".format(progName)
-)
-else:
-print(
-"    {0} [-chvxz] [-a dir] [-b dir] [-d dir] [-f file] [-i dir]"
-" [--help] [--no-apis] [--no-info] [--with-tools] [--verbose]"
-" [--yes]".format(progName)
-)
-print("where:")
-print("    -h, --help display this help message")
-print("    -a dir     where the API files will be installed")
-if apisDir:
-print("               (default: {0})".format(apisDir))
-else:
-print("               (no default value)")
-print("    --no-apis  don't install API files")
-print("    -b dir     where the binaries will be installed")
-print("               (default: {0})".format(platBinDir))
-print("    -d dir     where eric python files will be installed")
-print("               (default: {0})".format(modDir))
-print("    -f file    configuration file naming the various installation paths")
-if not sys.platform.startswith(("win", "cygwin")):
-print("    -i dir     temporary install prefix")
-print("               (default: {0})".format(distDir))
-if sys.platform == "darwin":
-print("    -m name    name of the Mac app bundle")
-print("               (default: {0})".format(macAppBundleName))
-print("    -n path    path of the directory the Mac app bundle will")
-print("               be created in")
-print("               (default: {0})".format(macAppBundlePath))
-print("    -p python  path of the python executable")
-print("               (default: {0})".format(macPythonExe))
-print("    -c         don't cleanup old installation first")
-print("    -v, --verbose print some more information")
-print("    -x         don't perform dependency checks (use on your own risk)")
-print("    -z         don't compile the installed python files")
-print("    --yes      answer 'yes' to all questions")
-print()
-if sys.platform.startswith(("win", "cygwin")):
-print("    --clean-desktop delete desktop links before installation")
-print("    --no-info  don't create the install info file")
-print("    --with-tools install qt6-applications")
-print()
-print("The file given to the -f option must be valid Python code defining a")
-print(
-"dictionary called 'cfg' with the keys 'ericDir', 'ericPixDir',"
-" 'ericIconDir',"
-)
-print("'ericDTDDir', 'ericCSSDir', 'ericStylesDir', 'ericThemesDir',")
-print(" 'ericDocDir', ericExamplesDir',")
-print("'ericTranslationsDir', 'ericTemplatesDir', 'ericCodeTemplatesDir',")
-print("'ericOthersDir','bindir', 'mdir' and 'apidir.")
-print(
-"These define the directories for the installation of the various"
-" parts of eric."
-)
-exit(rcode)
 def initGlobals():
 """
 Module function to set the values of globals that need more than a
 return
 global pyModDir, progLanguages
 # Remove the menu entry for Linux systems
-if sys.platform.startswith("linux"):
+if sys.platform.startswith(("linux", "freebsd")):
 cleanUpLinuxSpecifics()
 # Remove the Desktop and Start Menu entries for Windows systems
 elif sys.platform.startswith(("win", "cygwin")):
 cleanUpWindowsLinks()
 try:
 macAppBundlePath = getConfig("macAppBundlePath")
 macAppBundleName = getConfig("macAppBundleName")
 except AttributeError:
 macAppBundlePath = (
-defaultMacAppBundlePath
+defaultMacAppBundlePath if os.getpid() == 0 else defaultMacUserAppBundlePath
-if os.getpid() == 0
-else defaultMacUserAppBundlePath
 )
 macAppBundleName = defaultMacAppBundleName
 for bundlePath in [
 os.path.join(defaultMacAppBundlePath, macAppBundleName),
 os.path.join(defaultMacUserAppBundlePath, macAppBundleName),
 def cleanUpWindowsLinks():
 """
 Clean up the Desktop and Start Menu entries for Windows.
 """
-global doCleanDesktopLinks, forceCleanDesktopLinks
+if importlib.util.find_spec("pywintypes") is None:
-try:
-from pywintypes import com_error  # __IGNORE_WARNING__
-except ImportError:
 # links were not created by install.py
 return
+global doCleanDesktopLinks, forceCleanDesktopLinks
 regPath = (
 "Software\\Microsoft\\Windows\\CurrentVersion\\Explorer"
 + "\\User Shell Folders"
 )
 else:
 print("\nThe API directory '{0}' is not writable.".format(cfg["apidir"]))
 print("Use the API files provided by the 'API Files' plug-in.")
 # Create menu entry for Linux systems
-if sys.platform.startswith("linux"):
+if sys.platform.startswith(("linux", "freebsd")):
 createLinuxSpecifics()
 # Create Desktop and Start Menu entries for Windows systems
 elif sys.platform.startswith(("win", "cygwin")):
 createWindowsLinks()
 def createWindowsLinks():
 """
 Create Desktop and Start Menu links.
 """
-try:
+if importlib.util.find_spec("win32com") is None:
-# check, if pywin32 is available
-from win32com.client import Dispatch  # __IGNORE_WARNING__
-except (ImportError, ModuleNotFoundError):  # noqa: M514
 installed = pipInstall(
 "pywin32",
 "\nThe Python package 'pywin32' could not be imported.",
 force=False,
 )
 if sys.version_info < (3, 8, 0) or sys.version_info >= (3, 13, 0):
 print("Sorry, you must have Python 3.8.0 or higher, but less 3.13.0.")
 print("Yours is {0}.".format(".".join(str(v) for v in sys.version_info[:3])))
 exit(5)
-try:
+if (
-import xml.etree  # __IGNORE_WARNING__
+importlib.util.find_spec("xml") is None
-except ImportError:
+or importlib.util.find_spec("xml.etree") is None
+):
 print("Your Python installation is missing the XML module.")
 print("Please install it and try again.")
 exit(5)
 print("PyQt & Qt")
 print("Sorry, please install PyQt6.")
 print("Error: {0}".format(msg))
 exit(1)
 print("Found PyQt6")
-try:
+pyuic = "pyuic6"
-pyuic = "pyuic6"
+if importlib.util.find_spec("PyQt6.uic") is None:
-from PyQt6 import uic  # __IGNORE_WARNING__
-except ImportError as err:
 print("Sorry, {0} is not installed.".format(pyuic))
-if verbose:
-print("Error: {0}".format(err))
 exit(1)
 print("Found {0}".format(pyuic))
-try:
+if importlib.util.find_spec("PyQt6.QtWebEngineWidgets") is None:
-from PyQt6 import QtWebEngineWidgets  # __IGNORE_WARNING__
-except ImportError as err:
 if isSudo:
 print("Optional 'PyQt6-WebEngine' could not be detected.")
 else:
-msg = "Optional 'PyQt6-WebEngine' could not be detected.{0}".format(
+msg = "Optional 'PyQt6-WebEngine' could not be detected."
-"\nError: {0}".format(err) if verbose else ""
-)
 pipInstall(
 "PyQt6-WebEngine>={0}".format(
 versionToStr(requiredVersions["pyqt6-webengine"])
 ),
 msg,
 )
 print("Found PyQt6-WebEngine")
-try:
+if importlib.util.find_spec("PyQt6.QtCharts") is None:
-from PyQt6 import QtCharts  # __IGNORE_WARNING__
-except ImportError as err:
 if isSudo:
 print("Optional 'PyQt6-Charts' could not be detected.")
 else:
-msg = "Optional 'PyQt6-Charts' could not be detected.{0}".format(
+msg = "Optional 'PyQt6-Charts' could not be detected."
-"\nError: {0}".format(err) if verbose else ""
-)
 pipInstall(
 "PyQt6-Charts>={0}".format(
 versionToStr(requiredVersions["pyqt6-charts"])
 ),
 msg,
 )
 print("Found PyQt6-Charts")
-try:
+if importlib.util.find_spec("PyQt6.Qsci") is None:
-from PyQt6 import Qsci  # __IGNORE_WARNING__
+msg = "'PyQt6-QScintilla' could not be detected."
-except ImportError as err:
-msg = "'PyQt6-QScintilla' could not be detected.{0}".format(
-"\nError: {0}".format(err) if verbose else ""
-)
 installed = not isSudo and pipInstall(
 "PyQt6-QScintilla>={0}".format(
 versionToStr(requiredVersions["pyqt6-qscintilla"])
 ),
 msg,
 )
-if installed:
+message = None if installed else "PyQt6-QScintilla could not be installed."
-# try to import it again
-try:
-from PyQt6 import Qsci  # __IGNORE_WARNING__
-message = None
-except ImportError as msg:
-message = str(msg)
-else:
-message = "PyQt6-QScintilla could not be installed."
 if message:
 print("Sorry, please install QScintilla2 and")
 print("its PyQt6 wrapper.")
 print("Error: {0}".format(message))
 exit(1)
 "Markdown": ("markdown", ""),
 "pyyaml": ("yaml", ""),
 "chardet": ("chardet", ""),
 "pyenchant": ("enchant", ""),
 "wheel": ("wheel", ""),
+"esprima": ("esprima", ""),
 }
 if withPyqt6Tools:
 optionalModulesList["qt6-applications"] = ("qt6_applications", "")
 # check mandatory PyQt6 modules
 # determine the platform dependent black list
 if sys.platform.startswith(("win", "cygwin")):
 PlatformBlackLists = PlatformsBlackLists["windows"]
 elif sys.platform.startswith("linux"):
 PlatformBlackLists = PlatformsBlackLists["linux"]
+elif sys.platform.startswith("freebsd"):
+PlatformBlackLists = PlatformsBlackLists["freebsd"]
 else:
 PlatformBlackLists = PlatformsBlackLists["mac"]
 print("\nVersion Information")
 print("-------------------")
 print("Please install another version.")
 exit(5)
 # print version info for additional modules
 with contextlib.suppress(NameError, AttributeError):
-print("PyQt6-Charts:", QtCharts.PYQT_CHART_VERSION_STR)
+from PyQt6.QtCharts import PYQT_CHART_VERSION_STR  # noqa: I101, I102
+print("PyQt6-Charts:", PYQT_CHART_VERSION_STR)
 with contextlib.suppress(ImportError, AttributeError):
 from PyQt6 import QtWebEngineCore  # noqa: I101, I102
 print("PyQt6-WebEngine:", QtWebEngineCore.PYQT_WEBENGINE_VERSION_STR)
 ]
 ProcessPoolExecutor = None
 if workers != 1:
 try:
-from concurrent.futures import ProcessPoolExecutor  # __IGNORE_WARNING__
+from concurrent.futures import ProcessPoolExecutor  # noqa: I101, I103
 except NotImplementedError:
 workers = 1
 if workers != 1 and ProcessPoolExecutor is not None:
 # If workers == 0, let ProcessPoolExecutor determine worker count.
 """
 majorVersion, minorVersion = sys.version_info[:2]
 return "eric7 (Python {0}.{1})".format(majorVersion, minorVersion)
+def createArgumentParser():
+"""
+Function to create an argument parser.
+@return created argument parser object
+@rtype argparse.ArgumentParser
+"""
+parser = argparse.ArgumentParser(
+description="Install eric7 from the source code tree.",
+epilog="The file given to the -f option must be valid Python code defining a"
+"dictionary called 'cfg' with the keys 'ericDir', 'ericPixDir', ericIconDir',"
+" 'ericDTDDir', 'ericCSSDir', 'ericStylesDir', 'ericThemesDir', ericDocDir',"
+" ericExamplesDir', ericTranslationsDir', 'ericTemplatesDir',"
+" 'ericCodeTemplatesDir', ericOthersDir','bindir', 'mdir' and 'apidir."
+"These define the directories for the installation of the various parts of"
+" eric.",
+)
+parser.add_argument(
+"-a",
+metavar="dir",
+default=apisDir if apisDir else None,
+help="directory where the API files will be installed ({0})".format(
+"default: {0}".format(apisDir) if apisDir else "no default value"
+),
+)
+parser.add_argument(
+"--no-apis",
+action="store_true",
+help="don't install API files",
+)
+parser.add_argument(
+"-b",
+metavar="dir",
+default=platBinDir,
+help="directory where the binaries will be installed (default: {0})".format(
+platBinDir
+),
+)
+parser.add_argument(
+"-d",
+metavar="dir",
+default=modDir,
+help="directory where eric Python files will be installed"
+" (default: {0})".format(modDir),
+)
+parser.add_argument(
+"-f",
+metavar="file",
+help="configuration file naming the various installation paths",
+)
+if not sys.platform.startswith(("win", "cygwin")):
+parser.add_argument(
+"-i",
+metavar="dir",
+default=distDir,
+help="temporary install prefix (default: {0})".format(distDir),
+)
+if sys.platform == "darwin":
+parser.add_argument(
+"-m",
+metavar="name",
+default=macAppBundleName,
+help="name of the Mac app bundle (default: {0})".format(macAppBundleName),
+)
+parser.add_argument(
+"-n",
+metavar="path",
+default=macAppBundlePath,
+help="path of the directory the Mac app bundle will be created in"
+" (default: {0})".format(macAppBundlePath),
+)
+parser.add_argument(
+"-p",
+metavar="python",
+default=macPythonExe,
+help="path of the python executable (default: {0})".format(macPythonExe),
+)
+parser.add_argument(
+"-c",
+action="store_false",
+help="don't cleanup old installation first",
+)
+parser.add_argument(
+"-v",
+"--verbose",
+action="store_true",
+help="print some more information",
+)
+parser.add_argument(
+"-x",
+action="store_false",
+help="don't perform dependency checks (use on your own risk)",
+)
+parser.add_argument(
+"-z",
+action="store_false",
+help="don't compile the installed python files",
+)
+parser.add_argument(
+"--yes",
+action="store_true",
+help="answer 'yes' to all questions",
+)
+if sys.platform.startswith(("win", "cygwin")):
+parser.add_argument(
+"--clean-desktop",
+action="store_true",
+help="delete desktop links before installation",
+)
+parser.add_argument(
+"--no-info",
+action="store_true",
+help="don't create the install info file",
+)
+parser.add_argument(
+"--with-tools",
+action="store_true",
+help="install the 'qt6-applications' package",
+)
+return parser
 def main(argv):
 """
 The main function of the script.
 @param argv list of command line arguments
 @type list of str
 """
-# Parse the command line.
+global modDir, doCleanup, doCompile, distDir, cfg, apisDir
-global progName, modDir, doCleanup, doCompile, distDir, cfg, apisDir
+global sourceDir, eric7SourceDir, configName, platBinDir
-global sourceDir, eric7SourceDir, configName
 global macAppBundlePath, macAppBundleName, macPythonExe
 global installApis, doCleanDesktopLinks, yes2All
 global createInstallInfoFile, installCwd
 global withPyqt6Tools
 global verbose
 if sys.version_info < (3, 8, 0) or sys.version_info > (3, 99, 99):
 print("Sorry, eric requires at least Python 3.8 for running.")
 exit(5)
-progName = os.path.basename(argv[0])
 installCwd = os.getcwd()
 if os.path.dirname(argv[0]):
 os.chdir(os.path.dirname(argv[0]))
 initGlobals()
-try:
+parser = createArgumentParser()
-if sys.platform.startswith(("win", "cygwin")):
+args = parser.parse_args()
-optlist, args = getopt.getopt(
-argv[1:],
+apisDir = args.a
-"chvxza:b:d:f:",
+platBinDir = args.b
-[
+modDir = args.d
-"clean-desktop",
+depChecks = args.x
-"help",
+doCleanup = args.c
-"no-apis",
+doCompile = args.z
-"no-info",
+installApis = not args.no_apis
-"verbose",
+yes2All = args.yes
-"with-tools",
+withPyqt6Tools = args.with_tools
-"yes",
+createInstallInfoFile = not args.no_info
-],
+verbose = args.verbose
-)
+if sys.platform == "darwin":
-elif sys.platform == "darwin":
+macAppBundleName = args.m
-optlist, args = getopt.getopt(
+macAppBundlePath = args.n
-argv[1:],
+macPythonExe = args.p
-"chvxza:b:d:f:i:m:n:p:",
+if sys.platform.startswith(("win", "cygwin")):
-["help", "no-apis", "no-info", "with-tools", "verbose", "yes"],
+doCleanDesktopLinks = args.clean_desktop
-)
+else:
-else:
+if args.i:
-optlist, args = getopt.getopt(
+distDir = os.path.normpath(args.i)
-argv[1:],
+if args.f:
-"chvxza:b:d:f:i:",
+with open(args.f) as f:
-["help", "no-apis", "no-info", "with-tools", "verbose", "yes"],
+try:
-)
+exec(compile(f.read(), args.f, "exec"), globals())
-except getopt.GetoptError as err:
+# secok
-print(err)
+if len(cfg) != configLength:
-usage()
-global platBinDir
-depChecks = True
-for opt, arg in optlist:
-if opt in ["-h", "--help"]:
-usage(0)
-elif opt == "-a":
-apisDir = arg
-elif opt == "-b":
-platBinDir = arg
-elif opt == "-d":
-modDir = arg
-elif opt == "-i":
-distDir = os.path.normpath(arg)
-elif opt == "-x":
-depChecks = False
-elif opt == "-c":
-doCleanup = False
-elif opt == "-z":
-doCompile = False
-elif opt == "-f":
-with open(arg) as f:
-try:
-exec(compile(f.read(), arg, "exec"), globals())
-# secok
-if len(cfg) != configLength:
-print(
-"The configuration dictionary in '{0}' is"
-" incorrect. Aborting".format(arg)
-)
-exit(6)
-except Exception as exc:
 print(
-"The configuration file '{0}' is not valid Python source."
+"The configuration dictionary in '{0}' is"
-" It will be ignored. Installation will be performed with"
+" incorrect. Aborting".format(args.f)
-" defaults.".format(arg)
 )
-print("ERROR: {0}".format(str(exc)))
+exit(6)
-cfg = {}
+except Exception as exc:
-elif opt == "-m" and sys.platform == "darwin":
+print(
-macAppBundleName = arg
+"The configuration file '{0}' is not valid Python source."
-elif opt == "-n" and sys.platform == "darwin":
+" It will be ignored. Installation will be performed with"
-macAppBundlePath = arg
+" defaults.".format(args.f)
-elif opt == "-p" and sys.platform == "darwin":
+)
-macPythonExe = arg
+print("ERROR: {0}".format(str(exc)))
-elif opt == "--no-apis":
+cfg = {}
-installApis = False
-elif opt == "--clean-desktop":
-doCleanDesktopLinks = True
-elif opt == "--yes":
-yes2All = True
-elif opt == "--with-tools":
-withPyqt6Tools = True
-elif opt == "--no-info":
-createInstallInfoFile = False
-elif opt in ["-v", "--verbose"]:
-verbose = True
 infoName = ""
 installFromSource = not os.path.isdir(sourceDir)
 # check dependencies

Mercurial Repositories > eric / file comparison

comparison: scripts/install.py

scripts/install.py