Changeset 47979 in vbox for trunk/src/VBox/Frontends

Timestamp:

Aug 21, 2013 6:44:35 PM (11 years ago)

Author:

vboxsync

Message:

vboxapi.py: Some cleaning up. New features: Documentation. ;-) Dropped the session manager class as it served no purpose I could fathom.

File:

• trunk/src/VBox/Frontends/VBoxShell/vboxshell.py (modified) (12 diffs)

trunk/src/VBox/Frontends/VBoxShell/vboxshell.py

@@ -1 @@
-#!/usr/bin/python
-
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# $Id$
+"""
+VirtualBox Python Shell.
+
+This program is a simple interactive shell for VirtualBox. You can query
+information and issue commands from a simple command line.
+
+It also provides you with examples on how to use VirtualBox's Python API.
+This shell is even somewhat documented, supports TAB-completion and
+history if you have Python readline installed.
+
+Finally, shell allows arbitrary custom extensions, just create
+.VirtualBox/shexts/ and drop your extensions there.
+                                               Enjoy.
+
+P.S. Our apologies for the code quality.
+"""
+
+__copyright__ = \
 """
 Copyright (C) 2009-2013 Oracle Corporation
@@ -12 +31 @@
 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 """
-
-#################################################################################
-# This program is a simple interactive shell for VirtualBox. You can query      #
-# information and issue commands from a simple command line.                    #
-#                                                                               #
-# It also provides you with examples on how to use VirtualBox's Python API.     #
-# This shell is even somewhat documented, supports TAB-completion and           #
-# history if you have Python readline installed.                                #
-#                                                                               #
-# Finally, shell allows arbitrary custom extensions, just create                #
-# .VirtualBox/shexts/ and drop your extensions there.                           #
-#                                                Enjoy.                         #
-################################################################################
+__version__ = "$Revision$"
+
 
 import os, sys
@@ -35 +43 @@
 from pprint import pprint
 
+
+
+#
+# Global Variables
+#
 g_fBatchMode = False
 g_sScriptFile = None
@@ -47 +60 @@
 g_sPrompt = "vbox> "
 
-g_fHasColors = True
-g_aTermColors = {
-    'red':'\033[31m',
-    'blue':'\033[94m',
-    'green':'\033[92m',
-    'yellow':'\033[93m',
-    'magenta':'\033[35m',
-    'cyan':'\033[36m'
-    }
+g_fHasColors  = True
+g_dTermColors = {
+    'red':      '\033[31m',
+    'blue':     '\033[94m',
+    'green':    '\033[92m',
+    'yellow':   '\033[93m',
+    'magenta':  '\033[35m',
+    'cyan':     '\033[36m'
+}
+
+
+
 def colored(strg, color):
     """
@@ -62 +78 @@
     if not g_fHasColors:
         return strg
-    col = g_aTermColors.get(color, None)
+    col = g_dTermColors.get(color, None)
     if col:
         return col+str(strg)+'\033[0m'
-    else:
-        return strg
+    return strg
 
 if g_fHasReadline:
@@ -238 +253 @@
 
 def startVm(ctx, mach, vmtype):
-    mgr = ctx['mgr']
     vbox = ctx['vb']
     perf = ctx['perf']
-    session = mgr.getSessionObject(vbox)
+    session = ctx['global'].getSessionObject(vbox)
     progress = mach.launchVMProcess(session, vmtype, "")
     if progressBar(ctx, progress, 100) and int(progress.resultCode) == 0:
@@ -670 +684 @@
     try:
         vbox = ctx['vb']
-        session = ctx['mgr'].getSessionObject(vbox)
+        session = ctx['global'].getSessionObject(vbox)
         mach.lockMachine(session, ctx['global'].constants.LockType_Shared)
     except Exception, e:
@@ -3471 +3485 @@
 
 def main(argv):
-    style = None
-    params = None
-    autopath = False
-    script_file = None
+
+    #
+    # Parse command line arguments.
+    #
     parse = OptionParser()
     parse.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False, help = "switch on verbose")
@@ -3495 +3509 @@
         g_fHasReadline = False
         g_sCmd = options.command_line
+
+    params = None
     if options.opt_line is not None:
         params = {}
@@ -3502 +3518 @@
             (key, value) = strparam.split('=')
             params[key] = value
-    else:
-        params = None
 
     if options.autopath:
         cwd = os.getcwd()
         vpp = os.environ.get("VBOX_PROGRAM_PATH")
-        if vpp is None and (os.path.isfile(os.path.join(cwd, "VirtualBox")) or os.path.isfile(os.path.join(cwd, "VirtualBox.exe"))) :
+        if    vpp is None \
+          and (   os.path.isfile(os.path.join(cwd, "VirtualBox")) \
+               or os.path.isfile(os.path.join(cwd, "VirtualBox.exe")) ):
             vpp = cwd
             print "Autodetected VBOX_PROGRAM_PATH as", vpp
@@ -3516 +3532 @@
         if vsp is None and os.path.isfile(os.path.join(cwd, "sdk", "bindings", "VirtualBox.xidl")) :
             vsp = os.path.join(cwd, "sdk")
-        if vsp is None and os.path.isfile(os.path.join(vpp, "sdk", "bindings", "VirtualBox.xidl")) :
+        if vsp is None and vpp is not None and os.path.isfile(os.path.join(vpp, "sdk", "bindings", "VirtualBox.xidl")) :
             vsp = os.path.join(vpp, "sdk")
         if vsp is not None :
@@ -3522 +3538 @@
             os.environ["VBOX_SDK_PATH"] = vsp
 
+    #
+    # Set up the shell interpreter context and
+    #
     from vboxapi import VirtualBoxManager
-    virtualBoxManager = VirtualBoxManager(style, params)
-    ctx = {'global':virtualBoxManager,
-           'mgr':virtualBoxManager.mgr,
-           'vb':virtualBoxManager.vbox,
-           'const':virtualBoxManager.constants,
-           'remote':virtualBoxManager.remote,
-           'type':virtualBoxManager.type,
-           'run': lambda cmd, args: runCommandCb(ctx, cmd, args),
-           'guestlambda': lambda uuid, guestLambda, args: runGuestCommandCb(ctx, uuid, guestLambda, args),
-           'machById': lambda uuid: machById(ctx, uuid),
-           'argsToMach': lambda args: argsToMach(ctx, args),
-           'progressBar': lambda p: progressBar(ctx, p),
-           'typeInGuest': typeInGuest,
-           '_machlist': None,
-           'prompt': g_sPrompt,
-           'scriptLine': 0,
-           'interrupt': False
-           }
+    oVBoxMgr = VirtualBoxManager(style, params)
+    ctx = {
+        'global':       oVBoxMgr,
+        'vb':           oVBoxMgr.vbox,
+        'const':        oVBoxMgr.constants,
+        'remote':       oVBoxMgr.remote,
+        'type':         oVBoxMgr.type,
+        'run':          lambda cmd, args: runCommandCb(ctx, cmd, args),
+        'guestlambda':  lambda uuid, guestLambda, args: runGuestCommandCb(ctx, uuid, guestLambda, args),
+        'machById':     lambda uuid: machById(ctx, uuid),
+        'argsToMach':   lambda args: argsToMach(ctx, args),
+        'progressBar':  lambda p: progressBar(ctx, p),
+        'typeInGuest':  typeInGuest,
+        '_machlist':    None,
+        'prompt':       g_sPrompt,
+        'scriptLine':   0,
+        'interrupt':    False,
+    }
     interpret(ctx)
-    virtualBoxManager.deinit()
-    del virtualBoxManager
+    oVBoxMgr.deinit()
+    del oVBoxMgr
 
 if __name__ == '__main__':
     main(sys.argv)
+