Merge lp:~vlewis/boots/vdev into lp:boots

[Victoria Lewis]

[Victoria Lewis (vlewis)]

Here is my code. I need to add a sort.

[lp:~vlewis/boots/vdev]

23. By Victoria Lewis <email address hidden> on 2010-01-29

Add sort to helptopics.py

[Max Goodhart (chromakode)]

> Here is my code. I need to add a sort.

The code sorted(lines) does not sort the lines list in place. Instead, it will return an iterator that traverses the sorted list. Instead, use lines.sort().

The files help.py and helpinfo.py are no longer needed in this merge. Use "bzr rm --keep <file>" to remove them.

Finally, instead of:

leng = len(max(str.split(topic.see_also))) + 2

You can find the topic with the longest name using:

max_name_len = max((subtopic for subtopic in self.subtopics.itervalues), key=len)

-M

review: Needs Fixing

[Victoria Lewis (vlewis)]

Thanks.
Don't I still need to add some space to the end of the longest name?
Victoria

>>> Chromakode 01/28/10 8:10 PM >>>
Review: Needs Fixing
> Here is my code. I need to add a sort.

The code sorted(lines) does not sort the lines list in place. Instead, it will return an iterator that traverses the sorted list. Instead, use lines.sort().

The files help.py and helpinfo.py are no longer needed in this merge. Use "bzr rm --keep " to remove them.

Finally, instead of:

leng = len(max(str.split(topic.see_also))) + 2

You can find the topic with the longest name using:

max_name_len = max((subtopic for subtopic in self.subtopics.itervalues), key=len)

-M
--
https://code.launchpad.net/~vlewis/boots/vdev/+merge/18176
You are the owner of lp:~vlewis/boots/vdev.

[David Rosenbaum (davidjrosenbaum)]

In addition to the above comments (which I agree with) there are a couple of other issues:
First, the local function maxword that you added in the issubseq function I wrote is dead code and should be removed. Another problem is that the code does not use proper indentation which will cause the interpreter to crash. Lines 51-53 mix tabs and spaces and use indentation of width 8. This is incorrect in Python and the indentation width must be 4. Please use only spaces for indentation.

review: Needs Fixing

[lp:~vlewis/boots/vdev]

24. By Victoria Lewis <email address hidden> on 2010-02-01

I corrected errors in format_index.

25. By Victoria Lewis <email address hidden> on 2010-02-04

Implemented readline history

[Max Goodhart (chromakode)]

Merged.

A couple comments:

* The default config options disabled this feature! I've modified them so the user gets 100 lines of persistent history by default, saved at ~/.boots_history.

* Whenever possible, try to keep UI-specific code out of the Console. I moved the save/load calls to inside the Plain UI class, and created a general "unload" method which, when called by the quitting Console, calls save_history.

review: Approve

=== modified file 'src/boots/app/client_config.py'
--- src/boots/app/client_config.py	2010-01-22 05:58:25 +0000
+++ src/boots/app/client_config.py	2010-02-04 01:10:27 +0000
@@ -51,7 +51,9 @@
                           "port" : 9306,
                           "username" : os.getenv("USER"),
                           "password" : False,
-                          "prompt" : "> "}
+                          "prompt" : "> ",
+                          "history_length": 0,
+                          "history_file": None}
         self._dict = self._defaults.copy()
 
         # Use default rc location in info if no argument is passed in.
@@ -111,7 +113,17 @@
                                     type = "string",
                                     dest = "password",
                                     help = "Connect using password. If none is given, query for password")
-
+        self._cli_parser.add_option("-F", "--historyfile",
+                                    action = "store",
+                                    type = "string",
+                                    dest = "history_file",
+                                    help = "Specify file to save history to")
+        self._cli_parser.add_option("-L", "--historylength",
+                                    action = "store",
+                                    type = "int",
+                                    dest = "history_length",
+                                    help = "Specify max history file length")
+ 
     def __getitem__(self, key):
         return self._dict[key]
 
 
=== modified file 'src/boots/lib/console.py'
--- src/boots/lib/console.py	2010-02-01 20:46:55 +0000
+++ src/boots/lib/console.py	2010-02-04 01:10:27 +0000
@@ -30,6 +30,7 @@
 
 from boots.api import api
 from boots.lib.ui.plain import PlainUI
+<<<<<<< TREE
 from boots.lib.metacommands import metacommands
 from boots.lib.lingos import lingo
 from boots.lib.lingos.lisp import lisp
@@ -44,10 +45,15 @@
         return True
     except TypeError:
         return False
+=======
+import os
+import atexit
+>>>>>>> MERGE-SOURCE
 
 class Console(object):
     def __init__(self, config):
         self.config = config
+<<<<<<< TREE
         # FIXME: Once metacommands are supported it should be possible to change the lingo at runtime using a metacommand.
         self.lingo = self.config['lingo']
         self.servers = [api.Server(self.config["host"], self.config["port"],
@@ -102,7 +108,15 @@
         lingo.register('lisp', lisp.LispInterpreter(self))
         lingo.register('python', python.PythonInterpreter(self))
         lingo.register('sql', sql.SQLInterpreter(self))
+=======
+        self.server = api.Server(self.config["host"], self.config["port"],
+                                 {"database": self.config["database"]})
+        self.ui = PlainUI(self.config["prompt"], self.config["history_length"],
+                          self.config["history_file"])
+        atexit.register(self.ui.save_history)
+>>>>>>> MERGE-SOURCE
         
+<<<<<<< TREE
         for command in self.ui.get_input(input_complete = lingo.get(self.lingo).input_complete):
             if not self.metacommands.execute(metacommands.parse(command)):
                 result = self.run(command, self.lingo)
@@ -114,7 +128,23 @@
                 # Don't print None; a return value of None means there was no result.
                 elif result != None:
                     self.ui.present(result)
-
+=======
+
+    def run(self, command, language):
+        result = self.server.execute(command)
+        return result
+>>>>>>> MERGE-SOURCE
+
+<<<<<<< TREE
         # Print a trailing newline.
         self.ui.present('')
         self.disconnect()
+=======
+    def main(self):
+        self.ui.read_history()
+        self.server.connect()
+        for command in self.ui.get_input():
+            for row in self.run(command, "sql"):
+                self.ui.present(row)
+        self.server.disconnect()
+>>>>>>> MERGE-SOURCE
 
=== removed file 'src/boots/lib/ui/components/help.py'
=== added file 'src/boots/lib/ui/components/helptopics.py'
--- src/boots/lib/ui/components/helptopics.py	1970-01-01 00:00:00 +0000
+++ src/boots/lib/ui/components/helptopics.py	2010-02-04 01:10:27 +0000
@@ -0,0 +1,137 @@
+# Utility function
+def issubseq(seq, seq2):
+    """Determines if the elements the sequence seq form a subsequence of the sequence seq2."""
+    if len(seq) == 0:
+        return True
+    else:
+        i = 0
+ 
+        while i < len(seq2) and seq[0] != seq2[i]:
+            i += 1
+ 
+        if i == len(seq2):
+            return False
+ 
+        return list(seq[1:]) == list(seq2[:i + 1:len(seq)])
+
+ 
+class Topic(object):
+    """A topic in the help system which may contain other topics."""
+    def __init__(self, name, title = None, description = None, short_description = None, see_also = None):
+        """Creates a new a help topic.  The fields are as described above."""
+        self.subtopics = dict()  
+        self.title = title
+        self.name = name
+        self.description = description
+        self.short_description = short_description
+        self.see_also = see_also
+	
+    def format(self):
+        """Returns a string that represents this topic in human readable form as
+        described in detail above."""
+        text = "{0.title}\n\n{0.description}\n\nSee also: {0.see_also}".format(self)
+        return text
+ 
+    def format_index(self):
+        """Returns a string that lists the subtopics of this topic in human
+        readable form as described above."""
+        lines = list()
+
+        for name, topic in self.subtopics.iteritems():   
+            max_name_len = max(len(subtopic.name) for subtopic in self.subtopics.itervalues())
+            subtext = "{0:{2}}--{1:30}".format(topic.name, topic.short_description, max_name_len +3)
+            lines.append(subtext)
+        lines.sort()
+        return "\n".join(lines)
+
+    # Queries:
+    #
+    # A query is used to refer to a topic in the help system.  A query is either
+    # a string or a non-empty tuple of strings.  Using a string is equivalent to
+    # using a tuple of length one containing that string.  As an example, the
+    # tuple ('python', 'syntax', 'csv') refers to the csv subtopic in the syntax
+    # topic which is itself a subtopic of the python topic.
+ 
+    def _translate_query(self, query):
+        """Converts a query into a tuple.  If query is not a valid query an
+        exception is raised."""
+        if isinstance(query, str):
+            return (query,)
+        elif isinstance(query, (tuple, list)):
+            assert len(query) != 0
+            for item in query:
+                assert isinstance(item, str)
+            return query
+        else:
+            raise TypeError('query object {0} is not a string or tuple of strings'.format(query))
+ 
+    def _ensure_key(self, key):
+        """Creates a new subtopic that key maps to if none exists."""
+        if key not in self.subtopics:
+            self.subtopics[key] = Topic(key)
+ 
+    def _walk(self, path = ()):
+        """Returns an iterable of all absolute paths."""
+        if len(self.subtopics) == 0:
+            yield path
+        else:
+            for subtopic in self.subtopics:
+                for path2 in subtopic._walk(path + self.name):
+                    yield path2
+ 
+    # The intention is for these methods to be implemented recursively
+    # by calling these methods on topics contained in the current
+    # topic (ie. this Help object).  Queries are represented as a
+    # tuple denoting the topics.  For example, "python syntax csv"
+    # would be represented as ('python', 'syntax', 'csv').
+ 
+    def __contains__(self, query):
+        """Return True if query refers to a help topic.  OTherwise,
+        False is returned."""
+        t = self._translate_query(query)
+ 
+        if len(t) == 1:
+            return t[0] in self.subtopics
+        else:
+            return t[0] in self.subtopics and t[1:] in self.subtopics[t[0]]
+ 
+    def __getitem__(self, query):
+        """Returns the help topic denoted by query; topics in query
+        that do not exist should be created automatically.  query may
+        refer to topic with subtopics."""
+        t = self._translate_query(query)
+        self._ensure_key(t[0])
+ 
+        if len(t) == 1:
+            return self.subtopics[t[0]]
+        else:
+            return self.subtopics[t[0]][t[1:]]
+ 
+    def __setitem__(self, query, value):
+        """Sets the help topic denoted by query to value.  topics in
+        query that do not exist should be created automatically.
+        query may refer to topic with subtopics."""
+        t = self._translate_query(query)
+ 
+        if len(t) == 1:
+            self.subtopics[t[0]] = value
+        else:
+            self._ensure_key(t[0])
+            self.subtopics[t[0]][t[1:]] = value
+ 
+    def __delitem__(self, query):
+        """Deletes the reference to help topic denoted by query.
+        query may refer to topic with subtopics."""
+        t = self._translate_query(query)
+        if len(t) == 1:
+            del self.subtopics[t[0]]
+        else:
+            del self.subtopics[t[0]][t[1:]]
+ 
+    def search(self, query):
+        """Returns an iterable of the absolute paths to topics that
+        partially match query."""
+        t = self._translate_query(query)
+        return (path for path in self._walk() if issubseq(t, path))
+
+
 
=== modified file 'src/boots/lib/ui/generic.py'
--- src/boots/lib/ui/generic.py	2010-01-31 00:00:49 +0000
+++ src/boots/lib/ui/generic.py	2010-02-04 01:10:27 +0000
@@ -51,3 +51,5 @@
     """Prints row information in a "raw" format"""
     def present(self, row):
         print(row)
+
+
 
=== modified file 'src/boots/lib/ui/plain.py'
--- src/boots/lib/ui/plain.py	2010-02-02 02:48:04 +0000
+++ src/boots/lib/ui/plain.py	2010-02-04 01:10:27 +0000
@@ -34,17 +34,44 @@
 from boots.lib.ui.generic import StdinDriver, StdoutPresenter
 
 class PlainUI(StdinDriver, StdoutPresenter):
+<<<<<<< TREE
     def __init__(self, prompt):
         self.metacommands = metacommands.MetaCommands({}, self)
+=======
+    def __init__(self, prompt, hist_length, hist_file):
+        readline.set_history_length(hist_length)
+        self.hist_file = hist_file
+>>>>>>> MERGE-SOURCE
         self.prompt = prompt
+<<<<<<< TREE
         self.current_widths = None
         self.buffer = []
 
     def get_input(self, input_complete = lambda command: True):
         return super(PlainUI, self).get_input(self.prompt, input_complete)
+=======
+    
+    def read_history(self):
+        try:
+            readline.read_history_file(self.hist_file)
+        except IOError:
+            pass
+
+    def save_history(self):
+        readline.write_history_file(self.hist_file)
+
+    def get_input(self):
+        while True:
+            var = raw_input(self.prompt)
+            yield var
+
+    def present(self, row):
+        print(row)
+>>>>>>> MERGE-SOURCE
 
     def set_prompt(self, prompt):
         self.prompt = prompt
+<<<<<<< TREE
 
     def present(self, result):
         def get_dashes(x):
@@ -79,3 +106,6 @@
         except:
             # Reset values for next result set.
             self.current_widths = None
+=======
+
+>>>>>>> MERGE-SOURCE