Mercurial Repositories > eric / file diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Globals/AppInfo.py	Tue Oct 02 19:53:31 2012 +0200
@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2012 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=[]):
+    """
+    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": options
+        }