-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
[PHP/Dart/Python] Correctly escape strings in single quotes (Fixes #17582) #19529
[PHP/Dart/Python] Correctly escape strings in single quotes (Fixes #17582) #19529
Conversation
.../openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractDartCodegen.java
Outdated
Show resolved
Hide resolved
return escapeText(input).replace("'", "\\'"); | ||
} | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in abstract typescript codegen, it overrides escapeText to replace '
with \\'
Line 1068 in e914c40
public String escapeText(String input) { |
what about follow the same without introducing escapeTextInSingleQuotes
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the explanation. let me think about it and review accordingly
thanks again for the PR let's give it a try |
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