python-rapidjson/python-rapidjsonPublic

NotificationsYou must be signed in to change notification settings
Fork53
Star530

Use environment variables to use std::regex#222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

hkxs wants to merge7 commits intopython-rapidjson:master

base:master

Choose a base branch

fromhkxs:feature/schema_use_stdregex

Open

Use environment variables to use std::regex#222

hkxs wants to merge7 commits intopython-rapidjson:masterfromhkxs:feature/schema_use_stdregex

Conversation

Copy link

hkxs commentedDec 30, 2024

RapidJson uses an in-houseregex enginethat has limited syntax, we can usestd::regex by defining

RAPIDJSON_SCHEMA_USE_INTERNALREGEX=0
RAPIDJSON_SCHEMA_USE_STDREGEX=1

This patch extends that functionality to python-rapidjson by using the environmental variableRAPIDJSON_SCHEMA_USE_STDREGEX

For example, the following schema uses negative-lookahead (not supported by default engine):

{    "$schema": "https://json-schema.org/draft/2020-12/schema",    "$id": "some_id",    "type": "object",    "additionalProperties": False,    "required": ["metadata"],    "patternProperties": {        "^(?!metadata$).+": {            "type": "string"        }    },    "properties": {        "metadata": {            "type": "integer"        }    }}

Using this schema leads to a ValidationError using this json{"a": "a", "metadata": 1}:

>>> import rapidjson   >>> schema_dict = {       "$schema": "https://json-schema.org/draft/2020-12/schema",       "$id": "some_id",       "type": "object",       "additionalProperties": False,       "required": ["metadata"],       "patternProperties": {           "^(?!metadata$).+": {               "type": "string"           }       },       "properties": {           "metadata": {               "type": "integer"           }       }   }   >>> validator = rapidjson.Validator(rapidjson.dumps(schema_dict))>>> validator(rapidjson.dumps({"a": "a", "metadata": 1}))Traceback (most recent call last):  File "<python-input-2>", line 1, in <module>    validator(rapidjson.dumps({"a": "a", "metadata": 1}))    ~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^rapidjson.ValidationError: ('additionalProperties', '#', '#/a')

Expected behavior:

>>> import rapidjson   >>> schema_dict = {       "$schema": "https://json-schema.org/draft/2020-12/schema",       "$id": "some_id",       "type": "object",       "additionalProperties": False,       "required": ["metadata"],       "patternProperties": {           "^(?!metadata$).+": {               "type": "string"           }       },       "properties": {           "metadata": {               "type": "integer"           }       }   }   >>> validator = rapidjson.Validator(rapidjson.dumps(schema_dict))>>> validator(rapidjson.dumps({"a": "a", "metadata": 1}))  # no error raised by the validator

Use environment variables to use std::regex

34802fb

Copy link

Contributor

Ideally we should have a test case for the functionality, even just what you wrote above, but at a minimum I'd say we should expose the availability of StdRegex on the module, sayRAPIDJSON_SCHEMA_USES_STDREGEX or something like that, similar to theRAPIDJSON_VERSION attribute.

What do you think?

hkxs added3 commits

January 2, 2025 10:13

Expose RAPIDJSON_SCHEMA_USE_STDREGEX on the module

abf2d6b

Add test case that checks if RAPIDJSON_SCHEMA_USE_STDREGEX is set

933e0d0

Update README to set environmental variable to 1

Check for the actual error and not only for the exception

97c3f8e

Copy link

Author

hkxs commentedJan 2, 2025

Thanks for the improvement.
Ideally we should have a test case for the functionality, even just what you wrote above, but at a minimum I'd say we should expose the availability of StdRegex on the module, sayRAPIDJSON_SCHEMA_USES_STDREGEX or something like that, similar to theRAPIDJSON_VERSION attribute.
What do you think?

You're right it is good to have it exposed on the module, I added it (but I'm not sure if I should add something on typings/rapidjson/init.pyi, let me know if I'm missing something there). I also added an small test case to validate that we can use other regex when the variable is set

hkxs added3 commits

January 7, 2025 17:21

Add missing typing

fba16a1

Update json schema url on README.rst

c1869cd

Document regex engine on validator.rst

263c6c2

Labels

None yet

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Use environment variables to use std::regex#222

Are you sure you want to change the base?

Use environment variables to use std::regex#222

Uh oh!

Conversation

hkxs commentedDec 30, 2024

Uh oh!

lelit commentedDec 31, 2024

Uh oh!

hkxs commentedJan 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants