bpo-39337: Add a test case for normalizing of codec names #19069
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3415,5 +3415,28 @@ def test_rot13_func(self): | |
| 'To be, or not to be, that is the question') | ||
|
|
||
|
|
||
| class CodecNameNormalizationTest(unittest.TestCase): | ||
| """Test the normalizestring function via codecs module""" | ||
| def test_normalized_encoding(self): | ||
shihai1991 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| FOUND = (1, 2, 3, 4) | ||
| NOT_FOUND = (None, None, None, None) | ||
| def search_function(encoding): | ||
| if encoding == "aaa_8": | ||
| return FOUND | ||
| else: | ||
| return NOT_FOUND | ||
|
|
||
| codecs.register(search_function) | ||
| self.assertEqual(FOUND, codecs.lookup('AAA-8')) | ||
shihai1991 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| self.assertEqual(FOUND, codecs.lookup('AAA---8')) | ||
| self.assertEqual(FOUND, codecs.lookup('AAA 8')) | ||
| self.assertEqual(NOT_FOUND, codecs.lookup('AAA.8')) | ||
| self.assertEqual(NOT_FOUND, codecs.lookup('AAA...8')) | ||
| self.assertEqual(NOT_FOUND, codecs.lookup('BBB-8')) | ||
| self.assertEqual(NOT_FOUND, codecs.lookup('BBB.8')) | ||
| self.assertEqual(NOT_FOUND, codecs.lookup('a\xe9\u20ac-8')) | ||
|
There was a problem hiding this comment. The whole point of https://bugs.python.org/issue39337 is to test that non-ASCII characters are ignored. Your test doesn't check that. You should also test that codecs.lookup('aaa\xe9\u20ac-8') returns FOUND, no? There was a problem hiding this comment. Oh, tal have mentioned this detail too. |
||
| codecs.unregister(search_function) | ||
shihai1991 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| unittest.main() |
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.
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.
The fact that the codec names are normalized via the
normalizestringfunction is an implementation detail, so the test should be written ignoring that detail, to the extent possible. This includes its documentation, so...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.
Hm, I considered this details before. Why I am still leave this detail?
IMHO, leave enough details can help developers to maintain.
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.
You're welcome to add a comment after the doc-string. I wouldn't want the doc-string to mention normalizestring, though, unless we change the test to call
normalizestring()directly instead ofcodecs.lookup(), which I don't recommend.From my experience, however, such comments often become outdated when the implementation changes. And outdated comments causing confusion are usually worse than no comments.
Also, if someone needs to see the details, they'll likely need to go through the code starting at
codecs.lookup()anyways. It's relatively straightforward to follow:codecsimportslookupfrom_codecs, implemented inModules/_codecsmodule.c.lookup()is a simple wrapper for_PyCodec_LookupfromPython/codecs.c. With the imports and wrappers out of the way,_PyCodec_Lookupcallsnormalizestring()near the top of the function, immediately after a bit of initialization.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 your share, Tal. It's make sense :)