Merge branch 'runtime' into develop

* runtime:
  Add support for custom functions
  Rename decorator to signature
  Allow custom functions to be provided via Options
  Move interpreter to exprefs
  Update tox to run 3.5
  Syntax highlight python examples
  Update changelog with 0.9.0 features
  Raise LexerError on invalid numbers

Author: jamesls

CHANGELOG.rst

@@ -1,3 +1,16 @@
+0.9.0
+=====
+
+* Add support for new lines with tokens in an expression
+* Add support for `JEP 9 <http://jmespath.org/proposals/improved-filters.html>`__,
+  which introduces "and" expressions, "unary" expressions, "not" expressions,
+  and "paren" expressions
+* Fix issue with hardcoded path in ``jp.py`` executable
+  (`issue 90 <https://github.com/jmespath/jmespath.py/issues/90>`__,
+   `issue 88 <https://github.com/jmespath/jmespath.py/issues/88>`__,
+   `issue 82 <https://github.com/jmespath/jmespath.py/issues/82>`__)
+
+
 0.8.0
 =====
 

README.rst

@@ -48,15 +48,19 @@ API
 
 The ``jmespath.py`` library has two functions
 that operate on python data structures.  You can use ``search``
-and give it the jmespath expression and the data::
+and give it the jmespath expression and the data:
+
+.. code:: python
 
     >>> import jmespath
     >>> path = jmespath.search('foo.bar', {'foo': {'bar': 'baz'}})
     'baz'
 
 Similar to the ``re`` module, you can use the ``compile`` function
 to compile the JMESPath expression and use this parsed expression
-to perform repeated searches::
+to perform repeated searches:
+
+.. code:: python
 
     >>> import jmespath
     >>> expression = jmespath.compile('foo.bar')
@@ -75,7 +79,9 @@ Options
 You can provide an instance of ``jmespath.Options`` to control how
 a JMESPath expression is evaluated.  The most common scenario for
 using an ``Options`` instance is if you want to have ordered output
-of your dict keys.  To do this you can use either of these options::
+of your dict keys.  To do this you can use either of these options:
+
+.. code:: python
 
     >>> import jmespath
     >>> jmespath.search('{a: a, b: b},
@@ -90,6 +96,85 @@ of your dict keys.  To do this you can use either of these options::
     ...               jmespath.Options(dict_cls=collections.OrderedDict))
 
 
+Custom Functions
+~~~~~~~~~~~~~~~~
+
+The JMESPath language has numerous
+`built-in functions
+<http://jmespath.org/specification.html#built-in-functions>`__, but it is
+also possible to add your own custom functions.  Keep in mind that
+custom function support in jmespath.py is experimental and the API may
+change based on feedback.
+
+**If you have a custom function that you've found useful, consider submitting
+it to jmespath.site and propose that it be added to the JMESPath language.**
+You can submit proposals
+`here <https://github.com/jmespath/jmespath.site/issues>`__.
+
+To create custom functions:
+
+* Create a subclass of ``jmespath.functions.Functions``.
+* Create a method with the name ``_func_<your function name>``.
+* Apply the ``jmespath.functions.signature`` decorator that indicates
+  the expected types of the function arguments.
+* Provide an instance of your subclass in a ``jmespath.Options`` object.
+
+Below are a few examples:
+
+.. code:: python
+
+    import jmespath
+    from jmespath import functions
+
+    # 1. Create a subclass of functions.Functions.
+    #    The function.Functions base class has logic
+    #    that introspects all of its methods and automatically
+    #    registers your custom functions in its function table.
+    class CustomFunctions(functions.Functions):
+
+        # 2 and 3.  Create a function that starts with _func_
+        # and decorate it with @signature which indicates its
+        # expected types.
+        # In this example, we're creating a jmespath function
+        # called "unique_letters" that accepts a single argument
+        # with an expected type "string".
+        @functions.signature({'types': ['string']})
+        def _func_unique_letters(self, s):
+            # Given a string s, return a sorted
+            # string of unique letters: 'ccbbadd' ->  'abcd'
+            return ''.join(sorted(set(s)))
+
+        # Here's another example.  This is creating
+        # a jmespath function called "my_add" that expects
+        # two arguments, both of which should be of type number.
+        @functions.signature({'types': ['number']}, {'types': ['number']})
+        def _func_my_add(self, x, y):
+            return x + y
+
+    # 4. Provide an instance of your subclass in a Options object.
+    options = jmespath.Options(custom_functions=CustomFunctions())
+
+    # Provide this value to jmespath.search:
+    # This will print 3
+    print(
+        jmespath.search(
+            'my_add(`1`, `2`)', {}, options=options)
+    )
+
+    # This will print "abcd"
+    print(
+        jmespath.search(
+            'foo.bar | unique_letters(@)',
+            {'foo': {'bar': 'ccbbadd'}},
+            options=options)
+    )
+
+Again, if you come up with useful functions that you think make
+sense in the JMESPath language (and make sense to implement in all
+JMESPath libraries, not just python), please let us know at
+`jmespath.site <https://github.com/jmespath/jmespath.site/issues>`__.
+
+
 Specification
 =============
 

jmespath/compat.py

@@ -3,6 +3,15 @@
 
 PY2 = sys.version_info[0] == 2
 
+
+def with_metaclass(meta, *bases):
+    # Taken from flask/six.
+    class metaclass(meta):
+        def __new__(cls, name, this_bases, d):
+            return meta(name, bases, d)
+    return type.__new__(metaclass, 'temporary_class', (), {})
+
+
 if PY2:
     text_type = unicode
     string_type = basestring