Merge lp:~mvo/click/lp1294659-list-frameworks into lp:click/devel

[Michael Vogt]

This branch adds a command to list the available frameworks.

Its almost too simple so feedback welcome, we might use "click frameworks list" if you prefer a subcommand instead.

[Colin Watson (cjwatson)]

I'd prefer all the .py file names to be importable, to make future test code easier; so if we're going to have "click list-frameworks" then I'd like there to be something in the top-level command machinery that figures out that it needs to do s/-/_/g.

I think I have a slight preference for "click framework list" (singular "framework", by analogy with "click hook"), though. I can imagine other useful subcommands there, for example something to print a single field from an installed framework declaration.

review: Needs Fixing

[lp:~mvo/click/lp1294659-list-frameworks]

426. By Michael Vogt on 2014-05-20

use click framework list instead of click list-frameworks

[Michael Vogt (mvo)]

Thanks for your review.I changed the code to use the "click framework list" syntax now.

[Colin Watson (cjwatson)]

Thanks. I'll fix up the documentation :-)

review: Approve

=== modified file 'click/commands/__init__.py'
--- click/commands/__init__.py	2013-10-31 20:17:19 +0000
+++ click/commands/__init__.py	2014-05-20 07:02:57 +0000
@@ -28,6 +28,7 @@
     "info",
     "install",
     "list",
+    "framework",
     "pkgdir",
     "register",
     "unregister",

=== added file 'click/commands/framework.py'
--- click/commands/framework.py	1970-01-01 00:00:00 +0000
+++ click/commands/framework.py	2014-05-20 07:02:57 +0000
@@ -0,0 +1,42 @@
+# Copyright (C) 2014 Canonical Ltd.
+# Author: Michael Vogt <[e-mail]>
+
+# 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; version 3 of the License.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+
+"""List available frameworks."""
+
+from __future__ import print_function
+
+from argparse import ArgumentParser
+
+from gi.repository import Click
+
+
+def list(parser, args):
+    for framework in Click.Framework.get_frameworks():
+        print("%s" % framework.props.name)
+    return 0
+
+
+def run(argv):
+    parser = ArgumentParser("click framework")
+    subparsers = parser.add_subparsers()
+    list_parser = subparsers.add_parser(
+        "list",
+        help="list available frameworks")
+    list_parser.set_defaults(func=list)
+    args = parser.parse_args(argv)
+    if not hasattr(args, "func"):
+        parser.print_help()
+        return 1
+    return args.func(parser, args)

=== modified file 'doc/manpage.rst'
--- doc/manpage.rst	2014-03-18 11:47:21 +0000
+++ doc/manpage.rst	2014-05-20 07:02:57 +0000
@@ -42,6 +42,7 @@
     click info PATH
     click install PACKAGE-FILE
     click list
+    click list-frameworks
     click pkgdir {PACKAGE-NAME|PATH}
     click register PACKAGE-NAME VERSION
     click unregister PACKAGE-NAME [VERSION]
@@ -263,6 +264,11 @@
                             permission).
 --manifest                  Format output as a JSON array of manifests.
 
+click list-frameworks
+---------------------
+
+Display a list of available frameworks as one framework per line.
+
 click pkgdir {PACKAGE-NAME|PATH}
 --------------------------------