{"author":"James Saryerwinnie","author_email":"js@jamesls.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Natural Language :: English","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy"],"description":"JMESPath\n========\n\n\n.. image:: https://badges.gitter.im/Join Chat.svg\n :target: https://gitter.im/jmespath/chat\n\n\nJMESPath (pronounced \"james path\") allows you to declaratively specify how to\nextract elements from a JSON document.\n\nFor example, given this document::\n\n {\"foo\": {\"bar\": \"baz\"}}\n\nThe jmespath expression ``foo.bar`` will return \"baz\".\n\nJMESPath also supports:\n\nReferencing elements in a list. Given the data::\n\n {\"foo\": {\"bar\": [\"one\", \"two\"]}}\n\nThe expression: ``foo.bar[0]`` will return \"one\".\nYou can also reference all the items in a list using the ``*``\nsyntax::\n\n {\"foo\": {\"bar\": [{\"name\": \"one\"}, {\"name\": \"two\"}]}}\n\nThe expression: ``foo.bar[*].name`` will return [\"one\", \"two\"].\nNegative indexing is also supported (-1 refers to the last element\nin the list). Given the data above, the expression\n``foo.bar[-1].name`` will return \"two\".\n\nThe ``*`` can also be used for hash types::\n\n {\"foo\": {\"bar\": {\"name\": \"one\"}, \"baz\": {\"name\": \"two\"}}}\n\nThe expression: ``foo.*.name`` will return [\"one\", \"two\"].\n\n\nInstallation\n============\n\nYou can install JMESPath from pypi with:\n\n.. code:: bash\n\n pip install jmespath\n\n\nAPI\n===\n\nThe ``jmespath.py`` library has two functions\nthat operate on python data structures. You can use ``search``\nand give it the jmespath expression and the data:\n\n.. code:: python\n\n >>> import jmespath\n >>> path = jmespath.search('foo.bar', {'foo': {'bar': 'baz'}})\n 'baz'\n\nSimilar to the ``re`` module, you can use the ``compile`` function\nto compile the JMESPath expression and use this parsed expression\nto perform repeated searches:\n\n.. code:: python\n\n >>> import jmespath\n >>> expression = jmespath.compile('foo.bar')\n >>> expression.search({'foo': {'bar': 'baz'}})\n 'baz'\n >>> expression.search({'foo': {'bar': 'other'}})\n 'other'\n\nThis is useful if you're going to use the same jmespath expression to\nsearch multiple documents. This avoids having to reparse the\nJMESPath expression each time you search a new document.\n\nOptions\n-------\n\nYou can provide an instance of ``jmespath.Options`` to control how\na JMESPath expression is evaluated. The most common scenario for\nusing an ``Options`` instance is if you want to have ordered output\nof your dict keys. To do this you can use either of these options:\n\n.. code:: python\n\n >>> import jmespath\n >>> jmespath.search('{a: a, b: b}',\n ... mydata,\n ... jmespath.Options(dict_cls=collections.OrderedDict))\n\n\n >>> import jmespath\n >>> parsed = jmespath.compile('{a: a, b: b}')\n >>> parsed.search(mydata,\n ... jmespath.Options(dict_cls=collections.OrderedDict))\n\n\nCustom Functions\n~~~~~~~~~~~~~~~~\n\nThe JMESPath language has numerous\n`built-in functions\n`__, but it is\nalso possible to add your own custom functions. Keep in mind that\ncustom function support in jmespath.py is experimental and the API may\nchange based on feedback.\n\n**If you have a custom function that you've found useful, consider submitting\nit to jmespath.site and propose that it be added to the JMESPath language.**\nYou can submit proposals\n`here `__.\n\nTo create custom functions:\n\n* Create a subclass of ``jmespath.functions.Functions``.\n* Create a method with the name ``_func_``.\n* Apply the ``jmespath.functions.signature`` decorator that indicates\n the expected types of the function arguments.\n* Provide an instance of your subclass in a ``jmespath.Options`` object.\n\nBelow are a few examples:\n\n.. code:: python\n\n import jmespath\n from jmespath import functions\n\n # 1. Create a subclass of functions.Functions.\n # The function.Functions base class has logic\n # that introspects all of its methods and automatically\n # registers your custom functions in its function table.\n class CustomFunctions(functions.Functions):\n\n # 2 and 3. Create a function that starts with _func_\n # and decorate it with @signature which indicates its\n # expected types.\n # In this example, we're creating a jmespath function\n # called \"unique_letters\" that accepts a single argument\n # with an expected type \"string\".\n @functions.signature({'types': ['string']})\n def _func_unique_letters(self, s):\n # Given a string s, return a sorted\n # string of unique letters: 'ccbbadd' -> 'abcd'\n return ''.join(sorted(set(s)))\n\n # Here's another example. This is creating\n # a jmespath function called \"my_add\" that expects\n # two arguments, both of which should be of type number.\n @functions.signature({'types': ['number']}, {'types': ['number']})\n def _func_my_add(self, x, y):\n return x + y\n\n # 4. Provide an instance of your subclass in a Options object.\n options = jmespath.Options(custom_functions=CustomFunctions())\n\n # Provide this value to jmespath.search:\n # This will print 3\n print(\n jmespath.search(\n 'my_add(`1`, `2`)', {}, options=options)\n )\n\n # This will print \"abcd\"\n print(\n jmespath.search(\n 'foo.bar | unique_letters(@)',\n {'foo': {'bar': 'ccbbadd'}},\n options=options)\n )\n\nAgain, if you come up with useful functions that you think make\nsense in the JMESPath language (and make sense to implement in all\nJMESPath libraries, not just python), please let us know at\n`jmespath.site `__.\n\n\nSpecification\n=============\n\nIf you'd like to learn more about the JMESPath language, you can check out\nthe `JMESPath tutorial `__. Also check\nout the `JMESPath examples page `__ for\nexamples of more complex jmespath queries.\n\nThe grammar is specified using ABNF, as described in\n`RFC4234 `_.\nYou can find the most up to date\n`grammar for JMESPath here `__.\n\nYou can read the full\n`JMESPath specification here `__.\n\n\nTesting\n=======\n\nIn addition to the unit tests for the jmespath modules,\nthere is a ``tests/compliance`` directory that contains\n.json files with test cases. This allows other implementations\nto verify they are producing the correct output. Each json\nfile is grouped by feature.\n\n\nDiscuss\n=======\n\nJoin us on our `Gitter channel `__\nif you want to chat or if you have any questions.\n\n\n","description_content_type":"","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/jmespath/jmespath.py","keywords":"","license":"MIT","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"jmespath","package_url":"https://pypi.org/project/jmespath/","platform":null,"project_url":"https://pypi.org/project/jmespath/","project_urls":{"Homepage":"https://github.com/jmespath/jmespath.py"},"provides_extra":null,"release_url":"https://pypi.org/project/jmespath/1.0.1/","requires_dist":null,"requires_python":">=3.7","summary":"JSON Matching Expressions","version":"1.0.1","yanked":false,"yanked_reason":null}

Package search

jmespath

project_urls

Dependencies

All package metadata

Releases