Merge lp:~reynolds.chin/glance/adaptive_index_listing into lp:glance/diablo

[Reynolds Chin]

the "glance index" provides a more style of listing images.
1. the number of image indexes is "adapted" to the size of the console, while you still can customize the number of output per page through the parameter --limit
2. users "need not" to press the "enter key" to confirm YES or NO.
3. seamless output, you will never see the prompt message by scrolling the console's bar upward.

usage: glance index (for adaptive listing)
        glance index --limit 15 (for customized listing)

[lp:~reynolds.chin/glance/adaptive_index_listing]

212. By Reynolds Chin on 2011-09-06

improvement:
1. you never see prompt message by scrolling the screen upward
2. fully use of rows in listing

213. By Reynolds Chin on 2011-09-06

remove wrong if-statement

214. By Reynolds Chin on 2011-09-06

compensation for row while the header is false

[Kevin L. Mitchell (klmitch)]

First, you should be aware that merging is now done through Gerrit; you should review the workflow at http://wiki.openstack.org/GerritWorkflow for information on that.

Now, on to your patch. My first major concern is that the constructs you use may not be 100% portable. I see that, in most places, you've used try/except blocks to try to mitigate that, but you use termios in getch() without a try/except, and termios is UNIX-specific. I also see some style problems—for instance, you removed a blank line (line 8), so there is only one line between the DEFAULT_COL_LIMIT assignment and the def catch_error(). Also, I think you assign to the wrong variable on line 34 of the patch, and your indentation in the blocks starting at line 40 seems off. The space before the comma on line 72 should probably be removed, and you don't have enough blank lines between def getch() and def user_response().

Have you run this through PEP8? That will highlight certain style problems I may not be seeing here. You should also run the test suite and make sure all the tests pass, particularly the functional tests that hit "glance index". (The test suite also, incidentally, runs PEP8; your patch has to get a clean bill of health from PEP8 before the automated system will allow it to be merged.)

[lp:~reynolds.chin/glance/adaptive_index_listing]

215. By Reynolds Chin on 2011-09-07

bin/glance get a clean bill of health from PEP8

Unmerged revisions

215. By Reynolds Chin on 2011-09-07

bin/glance get a clean bill of health from PEP8

214. By Reynolds Chin on 2011-09-06

compensation for row while the header is false

213. By Reynolds Chin on 2011-09-06

remove wrong if-statement

212. By Reynolds Chin on 2011-09-06

improvement:
1. you never see prompt message by scrolling the screen upward
2. fully use of rows in listing

211. By Reynolds Chin on 2011-09-05

the "glance index" provides a more style of listing images.
1. the number of image indexes is "adapted" to the size of the console,
   while you still can customize the number of output per page through the parameter --limit
2. users need not to press the "enter key" to confirm YES or NO.
3. the prompt "Fetch next page?" wouldn't be concatenated to the output

=== modified file 'bin/glance'
--- bin/glance	2011-08-30 21:48:11 +0000
+++ bin/glance	2011-09-07 03:29:23 +0000
@@ -48,6 +48,8 @@
 
 SUCCESS = 0
 FAILURE = 1
+DEFAULT_ROW_LIMIT = 128
+DEFAULT_COL_LIMIT = 128
 
 
 #TODO(sirp): make more of the actions use this decorator
@@ -70,6 +72,77 @@
     return wrap
 
 
+def getTerminalSize():
+    """
+    determine the number of Rows and Cols of a console
+    code inpired by Johannes WeiB (http://tux4u.de/)
+    """
+    def ioctl_GWINSZ(fd):
+        try:
+            import fcntl
+            import termios
+            import struct
+            import os
+            ncol_nrow = struct.unpack('hh', \
+                        fcntl.ioctl(fd, termios.TIOCGWINSZ, '1234'))
+        except:
+            return None
+        return ncol_nrow
+    nrow_ncol = ioctl_GWINSZ(0) or ioctl_GWINSZ(1) or ioctl_GWINSZ(2)
+    if not nrow_ncol:
+        try:
+            fd = os.open(os.ctermid(), os.O_RDONLY)
+            nrow_ncol = ioctl_GWINSZ(fd)
+            os.close(fd)
+        except:
+            pass
+    if not nrow_ncol:
+        try:
+            import subprocess
+            cmd = "stty size"
+            p = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)
+            p.wait()
+            if p.returncode == 0:
+                return tuple(int(x) for x in p.stdout.read().split())
+        except:
+            nrow_ncol = (DEFAULT_COL_LIMIT, DEFAULT_ROW_LIMIT)
+    return int(nrow_ncol[0]), int(nrow_ncol[1])
+
+
+def getch():
+    """
+    getchar
+    """
+    import sys
+    import tty
+    import termios
+    fd = sys.stdin.fileno()
+    old = termios.tcgetattr(fd)
+    try:
+        tty.setraw(fd)
+        return sys.stdin.read(1)
+    finally:
+        termios.tcsetattr(fd, termios.TCSADRAIN, old)
+
+
+def user_response(prompt, quit='q'):
+    """
+    interactie question dialog with user without pressing the return.
+    Press any to confirm, while you can map a key for "no"
+
+    :param prompt: question/statement to present to user (string)
+    :param quit:   it is the key mapped to NO. The key 'q' is defaultly mapped.
+    """
+    print prompt,
+    key = getch()
+    if key == quit:
+        return False
+    else:
+        sys.stdout.write('\b' * len(prompt))
+        sys.stdout.flush()
+        return True
+
+
 def get_percent_done(image):
     try:
         pct_done = image['size'] * 100 / int(image['expected_size'])
@@ -423,7 +496,7 @@
     """Driver function for images_index"""
     parameters = {
         "filters": filters,
-        "limit": limit,
+        "limit": limit or getTerminalSize()[0],
     }
 
     optional_kwargs = ['marker', 'sort_key', 'sort_dir']
@@ -454,7 +527,7 @@
                                     image['size'])
 
     if not options.force and len(images) == limit and \
-       not user_confirm("Fetch next page?", True):
+       not user_response("press any key to continue, or press 'q' to quit"):
         return SUCCESS
 
     parameters['marker'] = images[-1]['id']
@@ -474,7 +547,7 @@
 fields are treated as image metadata properties"""
     client = get_client(options)
     filters = get_image_filters_from_args(args)
-    limit = options.limit
+    limit = options.limit or getTerminalSize()[0] - 3
     marker = options.marker
     sort_key = options.sort_key
     sort_dir = options.sort_dir
@@ -990,7 +1063,7 @@
                       metavar="TOKEN", default=None,
                       help="Authentication token to use to identify the "
                            "client to the glance server")
-    parser.add_option('--limit', dest="limit", metavar="LIMIT", default=10,
+    parser.add_option('--limit', dest="limit", metavar="LIMIT", default=None,
                       type="int", help="Page size to use while "
                                        "requesting image metadata")
     parser.add_option('--marker', dest="marker", metavar="MARKER",