[PHP/Dart/Python] Correctly escape strings in single quotes (Fixes #17582) - #19529
Merged
wing328 merged 2 commits intoNov 9, 2024
Merged
Conversation
wing328
reviewed
Sep 7, 2024
wing328
reviewed
Sep 9, 2024
| return escapeText(input).replace("'", "\\'"); | ||
| } | ||
|
|
||
|
|
Member
There was a problem hiding this comment.
in abstract typescript codegen, it overrides escapeText to replace ' with \\'
what about follow the same without introducing escapeTextInSingleQuotes?
Contributor
Author
There was a problem hiding this comment.
There are several issues with escaping single quotes by default that would also affect other generators:
- Some languages (e.g., PHP) treat
'\"'as a string containing a backslash and a double quote 'is often used in text like parameter descriptions and would be escaped in comments, which leads to doc blocks like this:

- Escaping a single quote is illegal in some formats (e.g., JSON)
Ideally, the context a text is used in (e.g., JSON, single-quoted string, double-quoted string or comment) could be taken into account when a string is escaped, either by making them individual methods or by adding a parameter for that.
Member
There was a problem hiding this comment.
thanks for the explanation. let me think about it and review accordingly
Member
|
thanks again for the PR let's give it a try |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes #17582 by correctly escaping strings inside the single quotes for the PHP, Dart and Python generators.
For the PHP generator, double quotes escaped by the default generator are unescaped because PHP treats
'\"'as a string containing a backslash and a double quote.I have verified that python and dart treat
'\"'as a string containing just a double quote character.PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming 7.6.0 minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)Dart: @jaumard @josh-burton @amondnet @sbu-WBT @kuhnroyal @agilob @ahmednfwela
PHP: @jebentier, @dkarlovi, @mandrean, @jfastnacht, @ybelenko, @renepardon
Python: @cbornet @tomplus @krjakbrjak @fa0311 @multani