Merge lp:~openerp-dev/openerp-command/trunk-better_help-cto into lp:openerp-command

[Samus CTO (OpenERP)]

Try to get a nicer help message for the standalone command --help

[lp:~openerp-dev/openerp-command/trunk-better_help-cto]

183. By Samus CTO (OpenERP) on 2012-11-05

[FIX] Line wrap to 80

184. By Samus CTO (OpenERP) on 2012-11-05

[IMP] Description in a list var instead of a string + added a __doc__ for module run_tests

=== modified file 'openerpcommand/__init__.py'
--- openerpcommand/__init__.py	2012-08-23 09:25:05 +0000
+++ openerpcommand/__init__.py	2012-11-05 11:33:19 +0000
@@ -1,4 +1,5 @@
 import argparse
+import textwrap
 
 from .call import Call
 from .client import Open, Show, ConsumeNothing, ConsumeMemory, LeakMemory, ConsumeCPU
@@ -17,15 +18,44 @@
 from . import uninstall
 from . import update
 
+command_list_server = (conf, drop, initialize, model, module, read, run_tests,
+                       scaffold, uninstall, update, )
+
+command_list_client = (Call, Open, Show, ConsumeNothing, ConsumeMemory,
+                       LeakMemory, ConsumeCPU, Bench, BenchRead,
+                       BenchFieldsViewGet, BenchDummy, BenchLogin,
+                       BenchSaleMrp, )
+
 def main_parser():
-    parser = argparse.ArgumentParser()
-    subparsers = parser.add_subparsers()
+    parser = argparse.ArgumentParser(
+        usage=argparse.SUPPRESS,
+        description=textwrap.fill(textwrap.dedent("""\
+                    OpenERP Command provides a set of command-line tools around
+                    the OpenERP framework: openobject-server. All the tools are
+                    sub-commands of a single oe executable.""")),
+        epilog="""Use <command> --help to get information about the command.""",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    description = []
+    for x in command_list_server:
+        description.append(x.__name__[len(__package__)+1:])
+        if x.__doc__:
+            description.extend([
+                ":\n",
+                textwrap.fill(str(x.__doc__).strip(),
+                              subsequent_indent='  ',
+                              initial_indent='  '),
+            ])
+        description.append("\n\n")
+    subparsers = parser.add_subparsers(
+        title="Available commands",
+        help=argparse.SUPPRESS,
+        description="".join(description[:-1]),
+    )
     # Server-side commands.
-    for x in (conf, drop, initialize, model, module, read, run_tests, scaffold, uninstall, update,):
+    for x in command_list_server:
         x.add_parser(subparsers)
     # Client-side commands. TODO one per .py file.
-    for x in (Call, Open, Show, ConsumeNothing, ConsumeMemory, LeakMemory, ConsumeCPU,
-        Bench, BenchRead, BenchFieldsViewGet, BenchDummy, BenchLogin,
-        BenchSaleMrp):
+    for x in command_list_client:
         x(subparsers)
     return parser

=== modified file 'openerpcommand/run_tests.py'
--- openerpcommand/run_tests.py	2012-10-09 12:34:39 +0000
+++ openerpcommand/run_tests.py	2012-11-05 11:33:19 +0000
@@ -1,3 +1,7 @@
+"""
+Execute the unittest2 tests available in OpenERP addons.
+"""
+
 import os
 import sys
 import types