Changeset 425

Timestamp:

05/18/07 11:47:29 (2 years ago)

Author:

athomas

Message:

cly:

• Renamed cly.variables to cly.types.
  
• Node now has some dictionary-like operators allowing manipulation of the
  Grammar after construction.
  
• Made Interact somewhat extensible via subclassing.
  
• Interact messages are now more contextual, displaying at the cursor
  location.
  
• Added example code from video.
  
• Added cly.Context.parsed which contains the text successfully parsed in
  the context.
  
• Console error/fatal/warning/info functions no longer prefix their output.
  

Files:

• cly/trunk/cly/console.py (modified) (2 diffs)
• cly/trunk/cly/__init__.py (modified) (6 diffs)
• cly/trunk/cly/interactive.py (modified) (4 diffs)
• cly/trunk/cly/types.py (moved) (moved from cly/trunk/cly/variables.py)
• cly/trunk/doc/tutorial.py (modified) (1 diff)
• cly/trunk/doc/video1.py (added)
• cly/trunk/.todo (modified) (2 diffs)

cly/trunk/cly/console.py

@@ -45 +45 @@
-
-
-[^^]+|\^([N0-7BU])
+\^([N0-7BU])|.
-_encode_re = re.compile(r'''\033(?:[^[]|$)|\033\[(.*?)m''')
-_cprint_strip = re.compile(r'''\^([N0-7BU])''')
-
+|(.)
-_colour_terminal = 0
-
@@ -240 +240 @@
-
-def error(*args):
-red error message prefixed by ERR
-ERR 
+message in red to stderr
+
-
-
-def fatal(*args):
-red error message prefixed by FTL, then exit with status -1
-FTL 
+message in red to stderr then exit with status -1.
+
-    sys.exit(-1)
-
-
-def warning(*args):
-prefixed by WRN
-WRN 
+to stderr.
+
-
-
-def info(*args):
- prefixed by INF
-^BINF ^B
+
+
-
-

cly/trunk/cly/__init__.py

@@ -247 +247 @@
-        """Iterate over child nodes, ignoring context.
-
-
-
+
+
+
-        <Node:/two>
-        """
@@ -256 +257 @@
-            yield child
-
+    def __setitem__(self, key, child):
+        """Emulate dictionary set.
+
+        >>> node = Node('One')
+        >>> node['two'] = Node('Two')
+        >>> for i in node.walk(): print i
+        <Node:/>
+        <Node:/two>
+        """
+        self(**{key: child})
+
+    def __getitem__(self, key):
+        """Emulate dictionary get.
+
+        >>> node = Node('One')(two=Node('Two'))
+        >>> node['two']
+        <Node:/two>
+        """
+        return self._children[key]
+
+    def __delitem__(self, key):
+        """Emulate dictionary delete.
+
+        >>> node = Node('One')(two=Node('Two'), three=Node('Three'))
+        >>> for i in node.walk(): print i
+        <Node:/>
+        <Node:/three>
+        <Node:/two>
+        >>> del node['two']
+        >>> for i in node.walk(): print i
+        <Node:/>
+        <Node:/three>
+        """
+        child = self._children.pop(key)
+        child.parent = None
+
+    def __contains__(self, key):
+        """Emulate dictionary key existence test.
+
+        >>> node = Node('One')(two=Node('Two'), three=Node('Three'))
+        >>> 'two' in node
+        True
+        """
+        return key in self._children
+
-    def walk(self):
-        """Perform a recursive walk of the grammar tree.
-
-
-
-
+
+
+
+
-        <Node:/two>
+        <Node:/two/four>
-        <Node:/two/three>
-        <Node:/one>
-        """
-        def walk(root):
@@ -468 +515 @@
-        return alias.valid(context)
-
+    def visible(self, context):
+        alias = self.parser.find(self.alias)
+        return alias.visible(context)
+
-    def selected(self, context, match):
-        """This node was selected by the parser."""
@@ -523 +574 @@
-
-    def help(self, context):
-
+(context)
-            return
-        if isinstance(self.doc, basestring):
@@ -698 +749 @@
-
-        for child in node.children(context, follow=True):
-
+
+
-
-        self.help.sort()
@@ -762 +814 @@
-    remaining = property(_get_remaining_input)
-
+    def _get_parsed(self):
+        """Return command text that has been successfully parsed."""
+        return self.command[:self.cursor]
+    parsed = property(_get_parsed)
+
-    def _last_node(self):
-        """Return the last node parsed."""

cly/trunk/cly/interactive.py

@@ -23 +23 @@
-import cly
-import cly.rlext
-
+
-
-
@@ -78 +78 @@
-        Interact.history_length = history_length
-        Interact.completion_delimiters = completion_delimiters
+        Interact.completion_key = completion_key
-
-        try:
@@ -115 +116 @@
-                context.execute()
-            except cly.ParseError, e:
-print_error(
+self.print_error(context, 
-            return context
-
+    def print_error(self, context, e):
+        """Called by `interact_once()` to print a ParseError."""
+        candidates = [help[1] for help in context.help()]
+        if len(candidates) > 1:
+            message = '%s (candidates are %s)'
+        else:
+            message = '%s (expected %s)'
+        message = message % (str(e), ', '.join(candidates))
+        self.error_at_cursor(context, message)
+
+    def error_at_cursor(self, context, text):
+        """Attempt to intelligently print an error at the current cursor
+        offset."""
+        text = str(text)
+        term_width = console.termwidth()
+        indent = ' ' * (context.cursor % term_width
+                        + len(Interact.prompt))
+        if len(indent + text) > term_width:
+            console.error(indent + '^')
+            console.error(text)
+        else:
+            console.error(indent + '^ ' + text)
-
-    def interact_loop(self):
@@ -180 +203 @@
-                       (' ' * (context.cursor + len(Interact.prompt)),
-                        ', '.join(candidates))
-print_
+console.
-                cly.rlext.force_redisplay()
-                return

cly/trunk/doc/tutorial.py

@@ -13 +13 @@
-
-grammar = Grammar(
-
+
+
+
+
+
-        Action('Quit', do_quit),
-    ),
-    cat=Node('Concatenate files')(
-
+
+
+
+
-            Action('Concatenate files', do_cat),
+            # This jumps back to the parent (files) node
-            Alias('..'),
+            # Now let's see it in action...
-        ),
-    ),

cly/trunk/.todo

@@ -1 @@
-19
+20
-    <title>
-        CLY
@@ -9 +9 @@
-        Add XPath support: eg. grammar.find_all('//action')
-    </note>
+    <note priority="medium" time="1179508609">
+        console.textwrap() has issues
+    </note>
+    <note priority="medium" time="1179509575">
+        Allow with_context to be specified per-parser.
+    </note>
-</todo>