Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make escaping strings more consistent. #7059

Merged
merged 10 commits into from
Mar 20, 2024
22 changes: 15 additions & 7 deletions edb/edgeql/quote.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,25 @@
''')


def escape_string(s: str) -> str:
split = re.split(r"(\n|\\\\|\\')", s)
def quote_literal(string: str) -> str:

if len(split) == 1:
return s.replace(r"'", r"\'")
def escape_string(s: str) -> str:
# characters escaped according to
# https://www.edgedb.com/docs/reference/edgeql/lexical#strings
result = s

return ''.join((r if i % 2 else r.replace(r"'", r"\'"))
for i, r in enumerate(split))
# escape backslash first
result = result.replace('\\', '\\\\')

result = result.replace('\'', '\\\'')
result = result.replace('\b', '\\b')
result = result.replace('\f', '\\f')
result = result.replace('\n', '\\n')
result = result.replace('\r', '\\r')
result = result.replace('\t', '\\t')
Comment on lines +49 to +53
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we make this table driven?
(Or maybe just not bother)


return result

def quote_literal(string: str) -> str:
return "'" + escape_string(string) + "'"


Expand Down
2 changes: 0 additions & 2 deletions edb/server/compiler/ddl.py
Original file line number Diff line number Diff line change
Expand Up @@ -721,8 +721,6 @@ def _describe_current_migration(
**extra,
}
)
.encode('unicode_escape')
.decode('utf-8')
)

desc_ql = edgeql.parse_query(
Expand Down
26 changes: 26 additions & 0 deletions tests/edgeql/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#
# This source file is part of the EdgeDB open source project.
#
# Copyright 2016-present MagicStack Inc. and the EdgeDB authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#


import unittest


def suite():
test_loader = unittest.TestLoader()
test_suite = test_loader.discover('.', pattern='test_*.py')
return test_suite
45 changes: 45 additions & 0 deletions tests/edgeql/test_quote.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
#
# This source file is part of the EdgeDB open source project.
#
# Copyright 2018-present MagicStack Inc. and the EdgeDB authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

import unittest

import edb.edgeql.quote as qlquote

class QuoteTests(unittest.TestCase):

def test_quote_string(self):
self.assertEqual(qlquote.quote_literal(""), "''"),
self.assertEqual(qlquote.quote_literal("abc"), "'abc'")
self.assertEqual(qlquote.quote_literal("\""), "'\"'")
self.assertEqual(qlquote.quote_literal("\b"), "'\\b'")
self.assertEqual(qlquote.quote_literal("\f"), "'\\f'")
self.assertEqual(qlquote.quote_literal("\n"), "'\\n'")
self.assertEqual(qlquote.quote_literal("\r"), "'\\r'")
self.assertEqual(qlquote.quote_literal("\t"), "'\\t'")
self.assertEqual(qlquote.quote_literal("\'"), "'\\\''")
self.assertEqual(qlquote.quote_literal("\\"), "'\\\\'")
self.assertEqual(qlquote.quote_literal("\\b"), "'\\\\b'")
self.assertEqual(qlquote.quote_literal("\\f"), "'\\\\f'")
self.assertEqual(qlquote.quote_literal("\\n"), "'\\\\n'")
self.assertEqual(qlquote.quote_literal("\\r"), "'\\\\r'")
self.assertEqual(qlquote.quote_literal("\\t"), "'\\\\t'")
self.assertEqual(qlquote.quote_literal("\\\'"), "'\\\\\\\''")
self.assertEqual(qlquote.quote_literal("\\\\"), "'\\\\\\\\'")
self.assertEqual(qlquote.quote_literal(
"abc\"efg\nhij\'klm\\nop"),
"'abc\"efg\\nhij\\\'klm\\\\nop'")
Loading