原始字符串文本¶

摘要¶

为了提高语言的可用性并简化解析器的实现，JEP建议对JMESPath进行以下修改：

• 添加 原始字符串文本 允许表达式包含未被JSON转义序列（例如“\n”、“\r”、“\u005C”）改变的原始字符串的JMESPath。

• 不赞成当前的文本解析行为，该行为允许将未加引号的JSON字符串解析为JSON字符串，从而消除JMESPath语法中的歧义，并有助于确保实现之间的一致性。

此建议旨在为JMESPath添加以下语法：

'foobar'
'foo\'bar'
`bar` -> Parse error/warning (implementation specific)

动机¶

中提供了原始字符串文本 various programming languages 为了防止特定于语言的解释（即JSON解析）并消除转义的需要，避免了一个称为 leaning toothpick syndrome (LTS) . 倾斜牙签综合症是一个问题，在这种情况下，为了避免分隔符冲突，字符串由于过度使用转义字符而变得不可读（例如。， \\\\\\ ）

在计算JMESPath表达式时，通常需要使用不是从被计算的数据中提取的字符串文字，而是静态地使用编译的JMESPath表达式的一部分。字符串文字在许多领域都很有用，但在调用函数或建立多选列表和散列时最为明显。

以下表达式返回在字符串中找到的字符数 foo . 解析此表达式时， `"foo" 被解析为JSON值，该值生成 ``foo` ：：

`"foo"`

下面的表达式在功能上是等价的。注意，JSON文本中省略了引号：

`foo`

这些字符串文本使用JSON解析器进行解析，根据 RFC 4627 ，它将扩展unicode转义序列、换行符和rfc4627第2.5节中记录的其他几个转义序列。

例如，使用转义的unicode值 \u002B 扩展为 + 在以下JMESPath表达式中：：

`"foo\u002B"` -> "foo+"

您可以在JSON文本中转义转义序列，以防止转义序列被展开：

`"foo\\u002B"` -> "foo\u002B"
`foo\\u002B` -> "foo\u002B"

虽然这允许您提供文本字符串，但它存在以下问题：

1. 导致额外的JSON解析惩罚。

2. 如果您确实希望数据按字面上提供的方式表示（这可能导致LTS），则需要转义转义字符的认知开销。如果要转义的数据要与另一种使用 \ 作为转义符，反斜杠字符的数量将加倍。

3. 向JMESPath语法引入了一个模糊规则，该规则需要基于散文的规范来解决解析器实现中的歧义。

   目前相关的字面语法规则定义如下：

   literal = "`" json-value "`"
   literal =/ "`" 1*(unescaped-literal / escaped-literal) "`"
   unescaped-literal = %x20-21 /       ; space !
                           %x23-5B /   ; # - [
                           %x5D-5F /   ; ] ^ _
                           %x61-7A     ; a-z
                           %x7C-10FFFF ; |}~ ...
   escaped-literal   = escaped-char / (escape %x60)
   json-value = false / null / true / json-object / json-array /
                json-number / json-quoted-string
   false = %x66.61.6c.73.65   ; false
   null  = %x6e.75.6c.6c      ; null
   true  = %x74.72.75.65      ; true
   json-quoted-string = %x22 1*(unescaped-literal / escaped-literal) %x22
   begin-array     = ws %x5B ws  ; [ left square bracket
   begin-object    = ws %x7B ws  ; { left curly bracket
   end-array       = ws %x5D ws  ; ] right square bracket
   end-object      = ws %x7D ws  ; } right curly bracket
   name-separator  = ws %x3A ws  ; : colon
   value-separator = ws %x2C ws  ; , comma
   ws              = *(%x20 /              ; Space
                       %x09 /              ; Horizontal tab
                       %x0A /              ; Line feed or New line
                       %x0D                ; Carriage return
                      )
   json-object = begin-object [ member *( value-separator member ) ] end-object
   member = quoted-string name-separator json-value
   json-array = begin-array [ json-value *( value-separator json-value ) ] end-array
   json-number = [ minus ] int [ frac ] [ exp ]
   decimal-point = %x2E       ; .
   digit1-9 = %x31-39         ; 1-9
   e = %x65 / %x45            ; e E
   exp = e [ minus / plus ] 1*DIGIT
   frac = decimal-point 1*DIGIT
   int = zero / ( digit1-9 *DIGIT )
   minus = %x2D               ; -
   plus = %x2B                ; +
   zero = %x30                ; 0
   

   这个 literal 模棱两可的规则是因为 unescaped-literal 包括所有相同的字符 json-value 匹配，允许任何有效的JSON值在 unescaped-literal 或 json-value .

规范¶

原始字符串文字是以单引号开头和结尾的值，不解释转义字符，并且可以包含转义单引号以避免分隔符冲突。

raw-string        = "'" *raw-string-char "'"
; The first grouping matches any character other than "\"
raw-string-char   = (%x20-26 / %x28-5B / %x5D-10FFFF) / raw-string-escape
raw-string-escape = escape ["'"]

literal = "`" json-value "`"

影响¶

对JMESPath现有用户的影响是，删除引号的JSON文本的使用应该转换为使用语法的字符串文本规则。这种转换是否绝对必要，将取决于具体的JMESPath实现。

实现可以选择支持在JSON文本表达式中允许省略引号的旧语法。如果一个实现选择了这种方法，那么该实现应该向用户发出某种警告，让他们知道这是不可取的，以及可能与其他JMESPath实现不兼容的情况。

为了支持JMESPath实现中的这种差异，必须删除所有涉及省略引号的JSON文本符合性测试用例，并且除非放在JEP 12特定的测试套件中，否则不允许在符合性测试中使用无效的未加引号的JSON值的测试用例，允许支持JSON文本中省略引号的实现过滤掉jep12特定的测试用例。

替代方法¶

有几种可供选择的方法。

`[1`

[==[foo=bar]==] -- parsed as "foo=bar"