safely wrap title: contents using json dumps
#23
Closed
Conversation
This file contains 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
This should handle any arbitrary punctuation marks which may happen to be in the Title - `",',\,*,...etc`. I don't undersand why this works, since we're not doing anything with json. I just know that everything I've thrown at it comes out safely. I left the change from pelican-plugins#15 intact, though json.dumps makes it unnecessary.
for more information, see https://pre-commit.ci
maphew
commented
Feb 8, 2023
...by removing manual title cleaning of nested quotes. Linting test is successful: commit was blocked until the now unused `title` variable was removed. My earlier statement was incorrect: processing `title` with the manual quote handling AND dumps *does* result in double escaping of quotes.
|
Status: contrary to opening comment #15 was removed in the end since the changes did conflict. IMO this PR is better than 15 in that it handles many special characters in |
1 task
2 tasks
justinmayer
approved these changes
Feb 9, 2023
|
I manually merged this change and released it in version 1.0.2. Many thanks for the improvement, Matt. 🏅 |
This was referenced Apr 12, 2023
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 should handle any arbitrary punctuation marks which may happen to be in the Title -
",',\,*,...etc.I don't undersand why this works, since we're not doing anything with json. I just know that everything I've thrown at it comes out safely.
I left the change from #15 intact, though json.dumps makes it unnecessary. Using them both at the same time doesn't seem to change results. I've tested and verified that"don't become double escapedPull Request Checklist
Resolves: #20
Note: as mentioned in closed PR #22 I can't run the linting during commit since my system hates it. For this PR I edited and tested and linted
search.pyon my local machine and then manually copied the changes via Github website editor. However I can't guarantee some mistake did not happen in the middle.Doc updates believed unnecessary.