Merge lp:~lifeless/bzr/command-help-bug-177500 into lp:bzr

[Robert Collins]

Fail to construct commands that have no help, rather than failing when help is first requested.

fix bug 177500 by erroring earlier, so that users won't encounter broken plugins etc (from new code).

[lp:~lifeless/bzr/command-help-bug-177500]

5223. By Canonical.com Patch Queue Manager <email address hidden> on 2010-05-11

(lifeless) Provide a consistent interface to Tree, Branch,
 Repository where lock methods return an object with an unlock method to
 unlock the lock. This breaks the API for Branch,
 Repository on their lock_write methods. (Robert Collins)

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Robert Collins wrote:
> Robert Collins has proposed merging lp:~lifeless/bzr/command-help-bug-177500 into lp:bzr.
>
> Requested reviews:
> bzr-core (bzr-core)
>
>
> fix bug 177500 by erroring earlier, so that users won't encounter broken plugins etc (from new code).
>

 merge: approve

John
=:->
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkvpVi8ACgkQJdeBCYSNAAM6XQCg05ARutbkufuzYek3lJzxmY/J
pjAAn2SxRURkS3dyIs8h0Zt/CrDdNgbn
=bHWi
-----END PGP SIGNATURE-----

review: Approve

[Robert Collins (lifeless)]

submitted to PQM by hand.

[lp:~lifeless/bzr/command-help-bug-177500]

5224. By Canonical.com Patch Queue Manager <email address hidden> on 2010-05-11

(lifeless) Fail to construct commands that have no help,
 rather than failing when help is first requested. (Robert Collins)

=== modified file 'NEWS'
--- NEWS	2010-05-10 18:43:19 +0000
+++ NEWS	2010-05-11 11:08:26 +0000
@@ -18,6 +18,9 @@
   whoami``.
   (Parth Malwankar, #549310)
 
+* ``bzrlib.commands.Command`` will now raise ValueError during
+  construction if there is no __doc__ set. (Robert Collins)
+
 New Features
 ************
 

=== modified file 'bzrlib/commands.py'
--- bzrlib/commands.py	2010-04-28 13:03:47 +0000
+++ bzrlib/commands.py	2010-05-11 11:08:26 +0000
@@ -407,8 +407,8 @@
 
     def __init__(self):
         """Construct an instance of this command."""
-        if self.__doc__ == Command.__doc__:
-            warn("No help message set for %r" % self)
+        if self.__doc__ == Command.__doc__ or not self.__doc__:
+            raise ValueError("No help message set for %r" % self)
         # List of standard options directly supported
         self.supported_std_options = []
         self._setup_run()
@@ -483,7 +483,9 @@
         """
         doc = self.help()
         if doc is None:
-            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
+            raise NotImplementedError(
+                "self.help() returned None -  no detailed help yet for %r" %
+                self.name())
 
         # Extract the summary (purpose) and sections out from the text
         purpose,sections,order = self._get_help_parts(doc)

=== modified file 'bzrlib/tests/test_commands.py'
--- bzrlib/tests/test_commands.py	2010-04-22 18:36:13 +0000
+++ bzrlib/tests/test_commands.py	2010-05-11 11:08:26 +0000
@@ -79,6 +79,11 @@
         c = self.get_command([option.Option('foo', hidden=False)])
         self.assertContainsRe(c.get_help_text(), '--foo')
 
+    def test_no_help_init_failure(self):
+        class cmd_foo(commands.Command):
+            pass
+        self.assertRaises(ValueError, cmd_foo)
+
 
 class TestGetAlias(tests.TestCase):