Add handy shortcut to match string path

[dangra]

[WIP] Opened to measure acceptance by maintainers.
Tests and docs will be updated once API is agreed (if any)

Description

This change aims to avoid the boilerplate of applying a JsonPath to a document

>>> import jsonpath2 as jsonpath
>>> doc = {'hello': 'Hello, world!'}
>>> [m.current_value for m in jsonpath.match('$["hello"]', doc)]

It resembles the use of re module in re.match(pattern, string) vs re.compile(pattern).match(string)

Issues Resolved

None.

Check List

• All tests pass.
• New functionality includes testing.
• New functionality has been documented in the README if applicable

[dmlb2000]

@dangra I think the thought behind this is fine, please make sure the pipeline passes.

[dmlb2000]

@dangra can you make a test to cover the code? either add the call to

python-jsonpath2/jsonpath2/test/jsonpath2_test.py

Line 712 in 2d74af2

def test_example(self):

or make another method and call your match function?

[dangra]

Yes, I will once I have a free minute in front of the keyboard. Wait for it this week. Thanks for the heads up

…

On Sun, Jun 9, 2019, 00:00 David Brown ***@***.***> wrote: @dangra <https://github.com/dangra> can you make a test to cover the code? either add the call to https://github.com/pacifica/python-jsonpath2/blob/2d74af236c86b51256d5f4d8686183ebcf33252e/jsonpath2/test/jsonpath2_test.py#L712 or make another method and call your match function? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#25?email_source=notifications&email_token=AAAJD6K2CDEJF7YISXSKJETPZRW4JA5CNFSM4HTOSHYKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODXICOWA#issuecomment-500180824>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAAJD6JQFQSKGE2X7XTVF4TPZRW4JANCNFSM4HTOSHYA> .

[dmlb2000]

Looks good to me.

[dmlb2000]

@dangra Forgot to add a bit to the README to document the new method. Could you add that?

[dangra]

@dmlb2000 I think I broke your accepted review by force pushing a rebase to cleanup commit history. Feel free to review again and merge. thanks

[dmlb2000]

@dangra looks good to me, should be able to merge and pull a release out of it soon. I'll want to setup the readthedocs integration and move some files around before that but this will be cut as a release soon.