grammar: Allow pipe character | in unquoted strings (#1850)

facebookresearch · Oct 22, 2021 · 949ad62 · 949ad62
1 parent ac1b6bf
commit 949ad62
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 6 deletions.
diff --git a/hydra/grammar/OverrideLexer.g4 b/hydra/grammar/OverrideLexer.g4
@@ -59,7 +59,7 @@ BOOL:
 
 NULL: [Nn][Uu][Ll][Ll];
 
-UNQUOTED_CHAR: [/\-\\+.$%*@?];  // other characters allowed in unquoted strings
+UNQUOTED_CHAR: [/\-\\+.$%*@?|];  // other characters allowed in unquoted strings
 ID: (CHAR|'_') (CHAR|DIGIT|'_')*;
 // Note: when adding more characters to the ESC rule below, also add them to
 // the `_ESC` string in `_internal/grammar/utils.py`.

diff --git a/hydra/grammar/OverrideParser.g4 b/hydra/grammar/OverrideParser.g4
@@ -59,7 +59,7 @@ primitive:
         | FLOAT                                  // 3.14, -20.0, 1e-1, -10e3
         | BOOL                                   // true, TrUe, false, False
         | INTERPOLATION                          // ${foo.bar}, ${oc.env:USER,me}
-        | UNQUOTED_CHAR                          // /, -, \, +, ., $, %, *, @, ?
+        | UNQUOTED_CHAR                          // /, -, \, +, ., $, %, *, @, ?, |
         | COLON                                  // :
         | ESC                                    // \\, \(, \), \[, \], \{, \}, \:, \=, \ , \\t, \,
         | WS                                     // whitespaces
@@ -72,7 +72,7 @@ dictKey:
       | INT                                    // 0, 10, -20, 1_000_000
       | FLOAT                                  // 3.14, -20.0, 1e-1, -10e3
       | BOOL                                   // true, TrUe, false, False
-      | UNQUOTED_CHAR                          // /, -, \, +, ., $, %, *, @, ?
+      | UNQUOTED_CHAR                          // /, -, \, +, ., $, %, *, @, ?, |
       | ESC                                    // \\, \(, \), \[, \], \{, \}, \:, \=, \ , \\t, \,
       | WS                                     // whitespaces
     )+;
diff --git a/news/1850.feature b/news/1850.feature
@@ -0,0 +1 @@
+Enable the use of the pipe symbol `|` in unquoted strings when parsing command-line overrides.
diff --git a/tests/test_overrides_parser.py b/tests/test_overrides_parser.py
@@ -31,7 +31,7 @@
 )
 from hydra.errors import HydraException
 
-UNQUOTED_SPECIAL = r"/-\+.$%*@?"  # special characters allowed in unquoted strings
+UNQUOTED_SPECIAL = r"/-\+.$%*@?|"  # special characters allowed in unquoted strings
 
 parser = OverridesParser(create_functions())
 

diff --git a/website/docs/advanced/override_grammar/basic.md b/website/docs/advanced/override_grammar/basic.md
@@ -84,7 +84,7 @@ primitive:
         | FLOAT                                  // 3.14, -20.0, 1e-1, -10e3
         | BOOL                                   // true, TrUe, false, False
         | INTERPOLATION                          // ${foo.bar}, ${oc.env:USER,me}
-        | UNQUOTED_CHAR                          // /, -, \, +, ., $, %, *, @, ?
+        | UNQUOTED_CHAR                          // /, -, \, +, ., $, %, *, @, ?, |
         | COLON                                  // :
         | ESC                                    // \\, \(, \), \[, \], \{, \}, \:, \=, \ , \\t, \,
         | WS                                     // whitespaces
@@ -97,7 +97,7 @@ dictKey:
       | INT                                    // 0, 10, -20, 1_000_000
       | FLOAT                                  // 3.14, -20.0, 1e-1, -10e3
       | BOOL                                   // true, TrUe, false, False
-      | UNQUOTED_CHAR                          // /, -, \, +, ., $, %, *, @, ?
+      | UNQUOTED_CHAR                          // /, -, \, +, ., $, %, *, @, ?, |
       | ESC                                    // \\, \(, \), \[, \], \{, \}, \:, \=, \ , \\t, \,
       | WS                                     // whitespaces
     )+;