Merge lp:~syleam/openobject-server/trunk-interactive_mode into lp:openobject-server

[Sylvain Garancher]

Add two command line arguments for openerp-server :
"--execute=path/script.py" : Executes a custom python script.
"--interactive" : Turns on python interactive console just after server initialization.

These two arguments can be used together. The interactive console is activated after script execution, so we can use a script to initialize some variables for interactive use.

Using one or both of them implies --stop-after-init : Services are not initialized, to allows using these modes without stopping a running instance, and the process stops when we quit the interactive console or when the script ends if interactive console was not started.

If the "--database" argument is supplied, a database is loaded (only the first is used for comma separated list of databases names) and some variables are initialized :
- db : Connection to the database.
- pool : Pooler on the database.
- cr : Cursor on the database. Automatically closed at end of execution, but no commit is done. You have to commit manually if needed.
- uid : integer 1 (admin user's id).

[Vo Minh Thu (thu)]

I don't want to add feature the `openerp-server` anymore. The startup script is already difficult to read and future-proof.

Instead I prefer you create your own startup script. If you want to share it, you can propose a similar feature in the openerp-command project: https://launchpad.net/openerp-command. It is not yet officially supported but was done to accept things like this one.

That being said, I think I would prefer to make your 'execute' option the other way around: instead of passing a script to be executed, the script is importing the `openerp` library and do whatever it wants (and thus be no longer an option).

Unmerged revisions

4020. By Sylvain Garancher on 2012-02-08

[IMP] Add '--execute' and '--interactive' command line arguments

=== modified file 'openerp-server'
--- openerp-server	2012-02-06 20:31:51 +0000
+++ openerp-server	2012-02-08 22:02:18 +0000
@@ -38,6 +38,7 @@
 import threading
 import traceback
 import time
+import code
 
 import openerp
 __author__ = openerp.release.author
@@ -234,7 +235,7 @@
         import_translation()
         sys.exit(0)
 
-    if not config["stop_after_init"]:
+    if not (config["stop_after_init"] or config['execute'] or config['interactive_mode']):
         # Some module register themselves when they are loaded so we need the
         # services to be running before loading any registry.
         openerp.service.start_services()
@@ -258,7 +259,22 @@
         for dbname in config['db_name'].split(','):
             preload_registry(dbname)
 
-    if config["stop_after_init"]:
+    if config['execute'] or config['interactive_mode']:
+        if config['db_name']:
+            db, pool = openerp.pooler.get_db_and_pool(config['db_name'].split(',')[0])
+            cr = db.cursor()
+            uid = 1
+
+        if config['execute']:
+            execfile(config['execute'], globals(), locals())
+        if config['interactive_mode']:
+            code.interact(local=locals())
+
+        if config['db_name']:
+            cr.close()
+
+        sys.exit(0)
+    elif config["stop_after_init"]:
         sys.exit(0)
 
     setup_pid_file()

=== modified file 'openerp/tools/config.py'
--- openerp/tools/config.py	2012-02-06 23:02:15 +0000
+++ openerp/tools/config.py	2012-02-08 22:02:18 +0000
@@ -73,7 +73,7 @@
         # Not exposed in the configuration file.
         self.blacklist_for_save = set(
             ['publisher_warranty_url', 'load_language', 'root_path',
-            'init', 'save', 'config', 'update', 'stop_after_init'])
+            'init', 'save', 'config', 'update', 'execute', 'interactive_mode', 'stop_after_init'])
 
         # dictionary mapping option destination (keys in self.options) to MyOptions.
         self.casts = {}
@@ -258,6 +258,8 @@
         group.add_option('--debug', dest='debug_mode', action='store_true', my_default=False, help='enable debug mode')
         group.add_option("--stop-after-init", action="store_true", dest="stop_after_init", my_default=False,
                           help="stop the server after its initialization")
+        group.add_option('--execute', dest='execute', help='allows to execute a script on the selected database')
+        group.add_option('--interactive', dest='interactive_mode', action='store_true', default=False, help='enable interactive mode')
         group.add_option("-t", "--timezone", dest="timezone", my_default=False,
                          help="specify reference timezone for the server (e.g. Europe/Brussels")
         group.add_option("--osv-memory-count-limit", dest="osv_memory_count_limit", my_default=False,
@@ -389,7 +391,7 @@
         # if defined but None take the configfile value
         keys = [
             'language', 'translate_out', 'translate_in', 'overwrite_existing_translations',
-            'debug_mode', 'smtp_ssl', 'load_language',
+            'debug_mode', 'execute', 'interactive_mode', 'smtp_ssl', 'load_language',
             'stop_after_init', 'logrotate', 'without_demo', 'netrpc', 'xmlrpc', 'syslog',
             'list_db', 'xmlrpcs',
             'test_file', 'test_disable', 'test_commit', 'test_report_directory',