{"id":13813414,"url":"https://github.com/cyberlis/dictquery","last_synced_at":"2025-05-15T00:33:06.793Z","repository":{"id":57418148,"uuid":"126088288","full_name":"cyberlis/dictquery","owner":"cyberlis","description":"Library to query python dicts","archived":false,"fork":false,"pushed_at":"2023-04-04T20:20:07.000Z","size":42,"stargazers_count":89,"open_issues_count":1,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-09T08:50:03.083Z","etag":null,"topics":["jql","jql-query","query-language"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cyberlis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-20T22:03:35.000Z","updated_at":"2024-10-09T09:58:31.000Z","dependencies_parsed_at":"2024-06-19T05:42:27.995Z","dependency_job_id":null,"html_url":"https://github.com/cyberlis/dictquery","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberlis%2Fdictquery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberlis%2Fdictquery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberlis%2Fdictquery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberlis%2Fdictquery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyberlis","download_url":"https://codeload.github.com/cyberlis/dictquery/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225046683,"owners_count":17412499,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jql","jql-query","query-language"],"created_at":"2024-08-04T04:01:17.017Z","updated_at":"2024-11-19T08:30:32.928Z","avatar_url":"https://github.com/cyberlis.png","language":"Python","readme":"DictQuery\n========================\n\nLibrary to query python dicts\n\n\nSeveral syntax examples:\n\n```\n\"age \u003e= 12\"\n\"`user.name` == 'cyberlis'\"\n\"`user.email` MATCH /\\w+@\\w+\\.com/ AND age != 11\"\n\"`user.friends.age` \u003e 12 AND `user.friends.name` LIKE 'Ra*ond'\"\n\"email LIKE 'mariondelgado?bleendot?com'\"\n\"eyeColor IN ['blue', 'green', 'black']\"\n\"isActive AND (gender == 'female' OR age == 27)\"\n\"latitude != longitude\"\n```\n\nSupported data types\n====================\n| type | example |\n|-----------|---------|\n| KEY       | name, age, \\`friends.name.firstname\\`, \\`friends.age\\` |\n| NUMBER    | 42, -12, 34.7 |\n| STRING    | 'hello', \"hellow\" |\n| BOOLEAN   | true, false |\n| NONE      | none, null |\n| NOW       | utc current datetime |\n| REGEXP    | /\\d+\\d+\\w+/ |\n| ARRAY     | list of any items and any types |\n\n\nKeys\n===========\nKey literals must start with a letter or an underscore, such as:\n  * `_underscore`\n  * `underscore_`\n\nThe remainder of your variable name may consist of letters, numbers and underscores.\n  * `password1`\n  * `n00b`\n  * `un_der_scores`\n\nIf you need a key with separator character (`.` or `/`) because you use nested keys, or need spaces or other punctuation characters in key, use back-ticks (\\`\\`)\n\nDictQuery supports nested dicts splited by dot `.` or any separator specified in `key_separator` param. Default `key_separator='.'`\n\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"`friends.age` \u003c= 26\")\nTrue\n\u003e\u003e\u003e compiled = dq.compile(\"`friends/age` \u003c= 26\", key_separator='/')\n\u003e\u003e\u003e compiled.match(data)\nTrue\n```\n\nif you don't need nested keys parsing and want get keys as is or if your keys contain separator char, you can disable nested keys behaviour by setting `use_nested_keys=False`\n\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"`user.address`\")\nFalse\n\u003e\u003e\u003e dq.match(data, \"age\")\nTrue\n\u003e\u003e\u003e compiled = dq.compile(\"`user.address`\", use_nested_keys=False)\n\u003e\u003e\u003e compiled.match(data)\nTrue\n```\n\nIn query you can use dict keys 'as is' without any binary operation. DictQuery will get value by the key and evaluate it to bool\n\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"isActive\")\nFalse\n\u003e\u003e\u003e dq.match(data, \"isActive == false\")\nTrue\n```\n\nif key is not found by default this situation evaluates to boolean `False` (no exception raised).\nYou can set `raise_keyerror=True` to raise keyerror if key would not be found.\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"favoriteFruit\")\nFalse\n\u003e\u003e\u003e compiled = dq.compile(\"`favoriteFruit`\", raise_keyerror=True)\n\u003e\u003e\u003e compiled.match(data)\nTraceback (most recent call last):\n  File \"\u003cstdin\u003e\", line 1, in \u003cmodule\u003e\n  File \".../dictquery/dictquery/visitors.py\", line 41, in match\n    return self.evaluate(data)\n  File \".../dictquery/dictquery/visitors.py\", line 35, in evaluate\n    result = bool(self.ast.accept(self))\n  File \".../dictquery/dictquery/parsers.py\", line 80, in accept\n    return visitor.visit_key(self)\n  File \".../dictquery/dictquery/visitors.py\", line 84, in visit_key\n    values=self._get_dict_value(expr.value),\n  File \".../dictquery/dictquery/visitors.py\", line 30, in _get_dict_value\n    self.key_separator, self.raise_keyerror)\n  File \".../dictquery/dictquery/datavalue.py\", line 112, in query_value\n    raise DQKeyError(\"Key '{}' not found\".format(data_key))\ndictquery.exceptions.DQKeyError: \"Key 'favoriteFruit' not found\"\n\n```\n\nComparisons\n===========\n\n\n| Operation | Meaning |\n|-----------|---------|\n| \u003c         | strictly less than |\n| \u003c=        | less than or equal |\n| \u003e         | strictly greater than |\n| \u003e=        | greater than or equal |\n| ==        | equal |\n| !=        | not equal |\n\n\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"age == 26\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"latitude \u003e 12\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"longitude \u003c 30\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"`friends.age` \u003c= 26\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"longitude \u003e= -130\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"id != 0\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"gender == 'male'\")\nFalse\n```\n\nString comparisons and matching\n===============================\n\nString literals are written in a variety of ways:\n* Single quotes: 'allows embedded \"double\" quotes'\n* Double quotes: \"allows embedded 'single' quotes\".\n\n| Operation | Meaning |\n|-----------|---------|\n| MATCH     | regexp matching |\n| LIKE      | glob like matching |\n| IN        | dict item substring in string |\n| CONTAINS   | dict item substring contains string |\n\n\u003c , \u003c= , \u003e , \u003e= , == , != works same way with strings as python\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"eyeColor == 'green'\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"`name.firstname` != 'Ratliff'\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"eyeColor IN 'string with green color'\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"email CONTAINS '.com'\")\nTrue\n\u003e\u003e\u003e dq.match(data, r\"email MATCH /\\w+@\\w+\\.\\w+/\")\nTrue\n\u003e\u003e\u003e dq.match(data, r\"email LIKE 'mariondelgado@*'\")\nTrue\n\u003e\u003e\u003e dq.match(data, r\"email LIKE 'mariondelgado?bleendot?com'\")\nTrue\n```\n\nBy default all string related operations are case sensitive. To change this behaviour you have to create instance of DictQuery with `case_sensitive=False`\n\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"`name.firstname` == 'marion'\")\nFalse\n\u003e\u003e\u003e compiled = dq.compile(\"`name.firstname` == 'marion'\", case_sensitive=False)\n\u003e\u003e\u003e compiled.match(data)\nTrue\n```\n\nArray comparisons\n=================\n| Operation | Meaning |\n|-----------|---------|\n| IN        | dict item in array |\n| CONTAINS   | dict item contains matching item |\n\n\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"tags CONTAINS 'dolor'\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"eyeColor IN ['blue', 'green', 'black']\")\nTrue\n```\n\nKey presence in dict\n=====================\n`CONTAINS` can be used with dict items to check if key in dict\n\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"name CONTAINS 'firstname'\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"name CONTAINS 'thirdname'\")\nFalse\n```\n\nDatetime comparisons with `NOW`\n===============================\n`NOW` returns current utc datetime\n\ndict item can be compared with `NOW` using standard operations (\u003c , \u003c= , \u003e , \u003e= , == , !=)\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"registered \u003c NOW\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"registered != NOW\")\nTrue\n```\n\nLogical operators\n=================\n|Operator|\tMeaning|\tExample|\n|--------|---------|---------|\n|and\t|True if both the operands are true|\tx and y|\n|or\t|True if either of the operands is true|\tx or y|\n|not\t|True if operand is false (complements the operand)|\tnot x |\n\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"isActive AND gender == 'female'\")\nFalse\n\u003e\u003e\u003e dq.match(data, \"isActive OR gender == 'female'\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"NOT isActive AND gender == 'female'\")\nTrue\n```\n\nYou can use parentheses to group statements or change evaluation order\n```\n\u003e\u003e\u003e import dictquery as dq\n\u003e\u003e\u003e dq.match(data, \"isActive AND gender == 'female' OR age == 27\")\nTrue\n\u003e\u003e\u003e dq.match(data, \"isActive AND (gender == 'female' OR age == 27)\")\nFalse\n```\n\n\nData for examples above:\n=================\n\n\n```\nfrom datetime import datetime\ndata = {\n  \"_id\": 10,\n  \"isActive\": False,\n  \"age\": 27,\n  \"eyeColor\": \"green\",\n  \"name\": {\n    \"firstname\": \"Marion\",\n    \"secondname\": \"Delgado\",\n  },\n  \"gender\": \"female\",\n  \"email\": \"mariondelgado@bleendot.com\",\n  \"registered\": datetime.strptime(\"2015-03-29T06:07:58\", \"%Y-%m-%dT%H:%M:%S\"),\n  \"latitude\": 74.785608,\n  \"longitude\": -112.366088,\n  \"tags\": [\n    \"voluptate\",\n    \"ex\",\n    \"dolor\",\n    \"aute\"\n  ],\n  \"user.address\": \"155 Village Road, Enetai, Puerto Rico, 2634\",\n  \"friends\": [\n    {\n      \"id\": 0,\n      \"name\": {\n        \"firstname\": \"Ratliff\",\n        \"secondname\": \"Becker\",\n      },\n      \"age\": 27,\n      \"eyeColor\": \"green\"\n    },\n    {\n      \"id\": 1,\n      \"name\": {\n        \"firstname\": \"Raymond\",\n        \"secondname\": \"Albert\",\n      },\n      \"age\": 19,\n      \"eyeColor\": \"brown\"\n    },\n    {\n      \"id\": 2,\n      \"name\": {\n        \"firstname\": \"Mavis\",\n        \"secondname\": \"Sheppard\",\n      },\n      \"age\": 34,\n      \"eyeColor\": \"blue\"\n    }\n  ]\n}\n```\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberlis%2Fdictquery","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyberlis%2Fdictquery","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberlis%2Fdictquery/lists"}