Escaping single quote in json path string

[ashek-simeon]

Documentation

• I have consulted the documentation, and my question isn't answered there.

Nuget Package

JsonPath.Net

Package Version

0.6.7

How can I help? Please provide as much context as possible.

Is there a way to escape a single quote within a string like this one?

$[?(@.Name == 'how do I escape a single' quote here?')]

I've tried putting a backslash before the single quote, which I believe should be valid based on the JsonPath specifications, unless I'm misinterpreting them

Code of Conduct

• I agree to follow this project's Code of Conduct

[gregsdennis]

Hey there. You can use double quotes for the string.

$[?(@.Name == "how do I escape a single' quote here?")]

Then you don't need to escape it.

Otherwise, you'll use a backslash \ to escape.

[ashek-simeon]

Thank you so much for responding, and for all the work you do on this amazing library!

I think the escaping may not be working for single quotes in strings surrounded by single quotes, since this fails to parse

$[?(@.Name == 'how do I escape a single\' quote here?')]

Also, the string I am working with may contain single quotes or double quotes (it is dynamic), so I may still have to use escaping if I use double quotes to surround the string. Good news is -- escaping seems to be working as expected for double quote strings.

Do you think I should open a new issue with a type of "bug" for parsing failing with the escaped single quotes?

[gregsdennis]

I'll use this issue, thanks.

[He-Pin]

This is a bug and the parser need to do an escaping, I'm currently parse strings to a seq[String] and then call a mkString to get the final result string.

I think this issue can be added to the test suite too.

        final JsonPathAST.JsonPathQuery query = JsonPath.parseQuery("$['how do I escape a single\\' quote here?']");
        Assertions.assertEquals("how do I escape a single' quote here?",
            ((Selector.NameSelector) query.segments().get(0).selection().selectors().get(0)).name());

[gregsdennis]

This is a bug

Yes, as labeled.

[gregsdennis]

The test suite has these two tests which seem to confirm I do handle them. I wonder what the difference is between being able to handle these and not being able to handle your case:

{
  "name": "name selector, single quotes, escaped single quote",
  "selector": "$['\\'']",
  "document": {
    "'": "A"
  },
  "result": [
    "A"
  ]
},
{
  "name": "name selector, single quotes, escaped reverse solidus",
  "selector": "$['\\\\']",
  "document": {
    "\\": "A"
  },
  "result": [
    "A"
  ]
}

Might be that yours is in an expression and these tests are in selectors, but I'd expect that uses the same parsing code...

[gregsdennis]

It doesn't! I'm going to add this to the test suite and then fix it here.

[ashek-simeon]

It doesn't! I'm going to add this to the test suite and then fix it here.

Thank you so much!