Change scripts into loadable modules.

This prepares NEO's initial eggification.
Credit: Leonardo Rochael Almeida


git-svn-id: https://svn.erp5.org/repos/neo/trunk@2263 71dcc9de-d417-0410-9af5-da40c76e7ee4

neo/scripts/neoadmin.py

+# neoadmin - run an administrator  node of NEO
+#
+# Copyright (C) 2009  Nexedi SA
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+from optparse import OptionParser
+from neo import setupLog
+from neo.config import ConfigurationManager
+
+parser = OptionParser()
+parser.add_option('-u', '--uuid', help='specify an UUID to use for this ' \
+                  'process')
+parser.add_option('-v', '--verbose', action = 'store_true', 
+                  help = 'print verbose messages')
+parser.add_option('-f', '--file', help = 'specify a configuration file') 
+parser.add_option('-s', '--section', help = 'specify a configuration section') 
+parser.add_option('-l', '--logfile', help = 'specify a logging file')
+parser.add_option('-c', '--cluster', help = 'the cluster name')
+parser.add_option('-m', '--masters', help = 'master node list')
+parser.add_option('-b', '--bind', help = 'the local address to bind to')
+parser.add_option('-n', '--name', help = 'the node name (improve logging)')
+
+defaults = dict(
+    name = 'admin',
+    bind = '127.0.0.1:9999',
+    masters = '127.0.0.1:10000',
+)
+
+def main(args=None):
+    # build configuration dict from command line options
+    (options, args) = parser.parse_args(args=args)
+    arguments = dict(
+        uuid = options.uuid,
+        name = options.name or options.section,
+        cluster = options.cluster,
+        masters = options.masters,
+        bind = options.bind,
+    )
+
+    config = ConfigurationManager(
+            defaults,
+            options.file,
+            options.section or 'admin',
+            arguments,
+    )
+
+    # setup custom logging
+    setupLog(config.getName(), options.logfile or None, options.verbose)
+
+    # and then, load and run the application
+    from neo.admin.app import Application
+    app = Application(config)
+    app.run()
+

neo/scripts/neoctl.py

+# neoadmin - run an administrator node of NEO
+#
+# Copyright (C) 2009  Nexedi SA
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+import sys
+from optparse import OptionParser
+from neo import setupLog
+
+parser = OptionParser()
+parser.add_option('-v', '--verbose', action = 'store_true', 
+                  help = 'print verbose messages')
+parser.add_option('-a', '--address', help = 'specify the address (ip:port) ' \
+    'of an admin node', default = '127.0.0.1:9999')
+parser.add_option('--handler', help = 'specify the connection handler')
+
+def main(args=None):
+    (options, args) = parser.parse_args(args=args)
+    address = options.address
+    if ':' in address:
+        address, port = address.split(':', 1)
+        port = int(port)
+    else:
+        port = 9999
+    handler = options.handler or "SocketConnector"
+
+    setupLog('NEOCTL', options.verbose)
+    from neo.neoctl.app import Application
+
+    print Application(address, port, handler).execute(args)
+

neo/scripts/neomaster.py

+# neomaster - run a master node of NEO
+#
+# Copyright (C) 2006  Nexedi SA
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+from optparse import OptionParser
+from neo import setupLog
+from neo.config import ConfigurationManager
+
+parser = OptionParser()
+parser.add_option('-v', '--verbose', action = 'store_true', 
+                  help = 'print verbose messages')
+parser.add_option('-f', '--file', help = 'specify a configuration file') 
+parser.add_option('-s', '--section', help = 'specify a configuration section') 
+parser.add_option('-u', '--uuid', help='the node UUID (testing purpose)')
+parser.add_option('-n', '--name', help = 'the node name (impove logging)')
+parser.add_option('-b', '--bind', help = 'the local address to bind to')
+parser.add_option('-c', '--cluster', help = 'the cluster name')
+parser.add_option('-m', '--masters', help = 'master node list')
+parser.add_option('-r', '--replicas', help = 'replicas number')
+parser.add_option('-p', '--partitions', help = 'partitions number')
+parser.add_option('-l', '--logfile', help = 'specify a logging file')
+
+defaults = dict(
+    name = 'master',
+    bind = '127.0.0.1:10000',
+    masters = '',
+    replicas = 0,
+    partitions = 100,
+)
+
+def main(args=None):
+    # build configuration dict from command line options
+    (options, args) = parser.parse_args(args=args)
+    arguments = dict(
+        uuid = options.uuid or None,
+        bind = options.bind,
+        name = options.name or options.section,
+        cluster = options.cluster,
+        masters = options.masters,
+        replicas = options.replicas,
+        partitions = options.partitions,
+    )
+    config = ConfigurationManager(
+            defaults,
+            options.file,
+            options.section or 'master',
+            arguments,
+    )
+
+    # setup custom logging
+    setupLog(config.getName(), options.logfile or None, options.verbose)
+
+    # and then, load and run the application
+    from neo.master.app import Application
+    app = Application(config)
+    app.run()
+

neo/scripts/neomigrate.py

+#! /usr/bin/env python2.4
+#
+# neomaster - run a master node of NEO
+#
+# Copyright (C) 2006  Nexedi SA
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+from optparse import OptionParser
+import logging
+import time
+import os
+
+from neo import setupLog
+
+# register options
+parser = OptionParser()
+parser.add_option('-v', '--verbose', action = 'store_true', 
+                  help = 'print verbose messages')
+parser.add_option('-s', '--source', help = 'the source database')
+parser.add_option('-d', '--destination', help = 'the destination database')
+parser.add_option('-c', '--cluster', help = 'the NEO cluster name')
+
+def main(args=None):
+    # parse options
+    (options, args) = parser.parse_args(args=args)
+    source = options.source or None
+    destination = options.destination or None
+    cluster = options.cluster or None
+
+    # check options
+    if source is None or destination is None:
+        raise RuntimeError('Source and destination databases must be supplied')
+    if cluster is None:
+        raise RuntimeError('The NEO cluster name must be supplied')
+
+    # set up logging
+    setupLog('neomigrate', None, options.verbose or False)
+
+    # open storages
+    from ZODB.FileStorage import FileStorage
+    #from ZEO.ClientStorage import ClientStorage as ZEOStorage
+    from neo.client.Storage import Storage as NEOStorage
+    if os.path.exists(source):
+        src = FileStorage(file_name=source)
+        dst = NEOStorage(master_nodes=destination, name=cluster)
+    else:
+        src = NEOStorage(master_nodes=source, name=cluster)
+        dst = FileStorage(file_name=destination)
+
+    # do the job
+    print "Migrating from %s to %s" % (source, destination)
+    start = time.time()
+    dst.copyTransactionsFrom(src, verbose=0)
+    elapsed = time.time() - start
+    print "Migration done in %3.5f" % (elapsed, )
+

neo/scripts/neostorage.py

+#! /usr/bin/env python2.4
+#
+# neostorage - run a storage node of NEO
+#
+# Copyright (C) 2006  Nexedi SA
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+from optparse import OptionParser
+from neo import setupLog
+from neo.config import ConfigurationManager
+
+
+parser = OptionParser()
+parser.add_option('-v', '--verbose', action = 'store_true', 
+                  help = 'print verbose messages')
+parser.add_option('-u', '--uuid', help='specify an UUID to use for this ' \
+                  'process. Previously assigned UUID takes precedence (ie ' \
+                  'you should always use -R with this switch)')
+parser.add_option('-f', '--file', help = 'specify a configuration file') 
+parser.add_option('-s', '--section', help = 'specify a configuration section') 
+parser.add_option('-l', '--logfile', help = 'specify a logging file')
+parser.add_option('-R', '--reset', action = 'store_true',
+                  help = 'remove an existing database if any')
+parser.add_option('-n', '--name', help = 'the node name (impove logging)')
+parser.add_option('-b', '--bind', help = 'the local address to bind to')
+parser.add_option('-c', '--cluster', help = 'the cluster name')
+parser.add_option('-m', '--masters', help = 'master node list')
+parser.add_option('-a', '--adapter', help = 'database adapter to use')
+parser.add_option('-d', '--database', help = 'database connections string')
+
+defaults = dict(
+    name = 'storage',
+    bind = '127.0.0.1:20000',
+    masters = '127.0.0.1:10000',
+    adapter = 'MySQL',
+)
+
+def main(args=None):
+    (options, args) = parser.parse_args(args=args)
+    arguments = dict(
+        uuid = options.uuid,
+        bind = options.bind,
+        name = options.name or options.section,
+        cluster = options.cluster,
+        masters = options.masters,
+        database = options.database,
+        reset = options.reset,
+        adapter = options.adapter,
+    )
+    config = ConfigurationManager(
+            defaults, 
+            options.file, 
+            options.section or 'storage', 
+            arguments,
+    )
+
+    # setup custom logging
+    setupLog(config.getName(), options.logfile or None, options.verbose)
+
+    # and then, load and run the application
+    from neo.storage.app import Application
+    app = Application(config)
+    app.run()
+

neoadmin

@@ -18,48 +18,6 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
-from optparse import OptionParser
-from neo import setupLog
-from neo.config import ConfigurationManager
+from neo.scripts.neoadmin import main
+main()
 
-parser = OptionParser()
-parser.add_option('-u', '--uuid', help='specify an UUID to use for this ' \
-                  'process')
-parser.add_option('-v', '--verbose', action = 'store_true', 
-                  help = 'print verbose messages')
-parser.add_option('-f', '--file', help = 'specify a configuration file') 
-parser.add_option('-s', '--section', help = 'specify a configuration section') 
-parser.add_option('-l', '--logfile', help = 'specify a logging file')
-parser.add_option('-c', '--cluster', help = 'the cluster name')
-parser.add_option('-m', '--masters', help = 'master node list')
-parser.add_option('-b', '--bind', help = 'the local address to bind to')
-parser.add_option('-n', '--name', help = 'the node name (improve logging)')
-
-# build configuration dict from command line options
-(options, args) = parser.parse_args()
-arguments = dict(
-    uuid = options.uuid,
-    name = options.name or options.section,
-    cluster = options.cluster,
-    masters = options.masters,
-    bind = options.bind,
-)
-defaults = dict(
-    name = 'admin',
-    bind = '127.0.0.1:9999',
-    masters = '127.0.0.1:10000',
-)
-config = ConfigurationManager(
-        defaults,
-        options.file,
-        options.section or 'admin',
-        arguments,
-)
-
-# setup custom logging
-setupLog(config.getName(), options.logfile or None, options.verbose)
-
-# and then, load and run the application
-from neo.admin.app import Application
-app = Application(config)
-app.run()

neoctl

@@ -18,28 +18,6 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
-import sys
-from optparse import OptionParser
-from neo import setupLog
-
-parser = OptionParser()
-parser.add_option('-v', '--verbose', action = 'store_true', 
-                  help = 'print verbose messages')
-parser.add_option('-a', '--address', help = 'specify the address (ip:port) ' \
-    'of an admin node', default = '127.0.0.1:9999')
-parser.add_option('--handler', help = 'specify the connection handler')
-
-(options, args) = parser.parse_args()
-address = options.address
-if ':' in address:
-    address, port = address.split(':', 1)
-    port = int(port)
-else:
-    port = 9999
-handler = options.handler or "SocketConnector"
-
-setupLog('NEOCTL', options.verbose)
-from neo.neoctl.app import Application
-
-print Application(address, port, handler).execute(args)
+from neo.scripts.neoctl import main
+main()
 

neomaster

@@ -18,53 +18,6 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
-from optparse import OptionParser
-from neo import setupLog
-from neo.config import ConfigurationManager
+from neo.scripts.neomaster import main
+main()
 
-parser = OptionParser()
-parser.add_option('-v', '--verbose', action = 'store_true', 
-                  help = 'print verbose messages')
-parser.add_option('-f', '--file', help = 'specify a configuration file') 
-parser.add_option('-s', '--section', help = 'specify a configuration section') 
-parser.add_option('-u', '--uuid', help='the node UUID (testing purpose)')
-parser.add_option('-n', '--name', help = 'the node name (impove logging)')
-parser.add_option('-b', '--bind', help = 'the local address to bind to')
-parser.add_option('-c', '--cluster', help = 'the cluster name')
-parser.add_option('-m', '--masters', help = 'master node list')
-parser.add_option('-r', '--replicas', help = 'replicas number')
-parser.add_option('-p', '--partitions', help = 'partitions number')
-parser.add_option('-l', '--logfile', help = 'specify a logging file')
-
-# build configuration dict from command line options
-(options, args) = parser.parse_args()
-arguments = dict(
-    uuid = options.uuid or None,
-    bind = options.bind,
-    name = options.name or options.section,
-    cluster = options.cluster,
-    masters = options.masters,
-    replicas = options.replicas,
-    partitions = options.partitions,
-)
-defaults = dict(
-    name = 'master',
-    bind = '127.0.0.1:10000',
-    masters = '',
-    replicas = 0,
-    partitions = 100,
-)
-config = ConfigurationManager(
-        defaults,
-        options.file,
-        options.section or 'master',
-        arguments,
-)
-
-# setup custom logging
-setupLog(config.getName(), options.logfile or None, options.verbose)
-
-# and then, load and run the application
-from neo.master.app import Application
-app = Application(config)
-app.run()

neomigrate

@@ -18,51 +18,6 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
-from optparse import OptionParser
-import logging
-import time
-import os
-
-from neo import setupLog
-
-# register options
-parser = OptionParser()
-parser.add_option('-v', '--verbose', action = 'store_true', 
-                  help = 'print verbose messages')
-parser.add_option('-s', '--source', help = 'the source database')
-parser.add_option('-d', '--destination', help = 'the destination database')
-parser.add_option('-c', '--cluster', help = 'the NEO cluster name')
-
-# parse options
-(options, args) = parser.parse_args()
-source = options.source or None
-destination = options.destination or None
-cluster = options.cluster or None
-
-# check options
-if source is None or destination is None:
-    raise RuntimeError('Source and destination databases must be supplied')
-if cluster is None:
-    raise RuntimeError('The NEO cluster name must be supplied')
-
-# set up logging
-setupLog('neomigrate', None, options.verbose or False)
-
-# open storages
-from ZODB.FileStorage import FileStorage
-#from ZEO.ClientStorage import ClientStorage as ZEOStorage
-from neo.client.Storage import Storage as NEOStorage
-if os.path.exists(source):
-    src = FileStorage(file_name=source)
-    dst = NEOStorage(master_nodes=destination, name=cluster)
-else:
-    src = NEOStorage(master_nodes=source, name=cluster)
-    dst = FileStorage(file_name=destination)
-
-# do the job
-print "Migrating from %s to %s" % (source, destination)
-start = time.time()
-dst.copyTransactionsFrom(src, verbose=0)
-elapsed = time.time() - start
-print "Migration done in %3.5f" % (elapsed, )
+from neo.scripts.neomigrate import main
+main()
 

neostorage

@@ -18,57 +18,6 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
-from optparse import OptionParser
-from neo import setupLog
-from neo.config import ConfigurationManager
+from neo.scripts.neostorage import main
+main()
 
-
-parser = OptionParser()
-parser.add_option('-v', '--verbose', action = 'store_true', 
-                  help = 'print verbose messages')
-parser.add_option('-u', '--uuid', help='specify an UUID to use for this ' \
-                  'process. Previously assigned UUID takes precedence (ie ' \
-                  'you should always use -R with this switch)')
-parser.add_option('-f', '--file', help = 'specify a configuration file') 
-parser.add_option('-s', '--section', help = 'specify a configuration section') 
-parser.add_option('-l', '--logfile', help = 'specify a logging file')
-parser.add_option('-R', '--reset', action = 'store_true',
-                  help = 'remove an existing database if any')
-parser.add_option('-n', '--name', help = 'the node name (impove logging)')
-parser.add_option('-b', '--bind', help = 'the local address to bind to')
-parser.add_option('-c', '--cluster', help = 'the cluster name')
-parser.add_option('-m', '--masters', help = 'master node list')
-parser.add_option('-a', '--adapter', help = 'database adapter to use')
-parser.add_option('-d', '--database', help = 'database connections string')
-
-(options, args) = parser.parse_args()
-arguments = dict(
-    uuid = options.uuid,
-    bind = options.bind,
-    name = options.name or options.section,
-    cluster = options.cluster,
-    masters = options.masters,
-    database = options.database,
-    reset = options.reset,
-    adapter = options.adapter,
-)
-defaults = dict(
-    name = 'storage',
-    bind = '127.0.0.1:20000',
-    masters = '127.0.0.1:10000',
-    adapter = 'MySQL',
-)
-config = ConfigurationManager(
-        defaults, 
-        options.file, 
-        options.section or 'storage', 
-        arguments,
-)
-
-# setup custom logging
-setupLog(config.getName(), options.logfile or None, options.verbose)
-
-# and then, load and run the application
-from neo.storage.app import Application
-app = Application(config)
-app.run()