src/eric7/Globals/AppInfo.py

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8881
54e42bc2437a
child 9221
bf71ee032bb4
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Globals/AppInfo.py	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2012 - 2022 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a function to generate an application info.
+"""
+
+from UI.Info import Version
+
+
+def makeAppInfo(argv, name, arg, description, options=None):
+    """
+    Module function to generate a dictionary describing the application.
+    
+    @param argv list of commandline parameters (list of strings)
+    @param name name of the application (string)
+    @param arg commandline arguments (string)
+    @param description text describing the application (string)
+    @param options list of additional commandline options
+        (list of tuples of two strings (commandline option,
+        option description)). The options --version, --help and -h are
+        always present and must not be repeated in this list.
+    @return dictionary describing the application
+    """
+    return {
+        "bin": argv[0],
+        "arg": arg,
+        "name": name,
+        "description": description,
+        "version": Version,
+        "options": [] if options is None else options[:]
+    }

eric ide

mercurial