-
-
Notifications
You must be signed in to change notification settings - Fork 34.5k
gh-139489: Add xml.utils.is_valid_name() #139768
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
base: main
Are you sure you want to change the base?
Changes from all commits
c7cbb61
4f37eed
6ac604e
e814cfa
bc26874
b631754
8db41b9
7e96492
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| import xml | ||
| import unittest | ||
|
|
||
|
|
||
| class TestUtils(unittest.TestCase): | ||
|
|
||
| def test_is_valid_name(self): | ||
| is_valid_name = xml.is_valid_name | ||
| self.assertFalse(is_valid_name('')) | ||
| self.assertTrue(is_valid_name('name')) | ||
| self.assertTrue(is_valid_name('NAME')) | ||
| self.assertTrue(is_valid_name('name0:-._·')) | ||
| self.assertTrue(is_valid_name('_')) | ||
| self.assertTrue(is_valid_name(':')) | ||
| self.assertTrue(is_valid_name('Ñàḿĕ')) | ||
| self.assertTrue(is_valid_name('\U000EFFFF')) | ||
| self.assertFalse(is_valid_name('0')) | ||
| self.assertFalse(is_valid_name('-')) | ||
| self.assertFalse(is_valid_name('.')) | ||
| self.assertFalse(is_valid_name('·')) | ||
| self.assertFalse(is_valid_name('na me')) | ||
| for c in '<>/!?=\x00\x01\x7f\ud800\udfff\ufffe\uffff\U000F0000': | ||
| self.assertFalse(is_valid_name('name' + c)) | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| unittest.main() |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| lazy import re | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we worried about the stability of xml.utils? Maybe we could have xml._utils first and then promote it to a public module later?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm also in favor of making this sub-module private (rename to
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
|
|
||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd suggest adding an
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's needed. Currently, the $ ./python
>>> import xml
>>> xml.re
<module 're' from '/home/vstinner/python/main/Lib/re/__init__.py'> |
||
| def is_valid_name(name): | ||
| """Test whether a string is a valid element or attribute name.""" | ||
| # https://www.w3.org/TR/xml/#NT-Name | ||
| return re.fullmatch( | ||
| # NameStartChar | ||
| '[' | ||
| ':A-Z_a-z' | ||
| '\xC0-\xD6\xD8-\xF6\xF8-\u02FF\u0370-\u037D\u037F-\u1FFF' | ||
| '\u200C\u200D' | ||
| '\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF' | ||
| '\uF900-\uFDCF\uFDF0-\uFFFD\U00010000-\U000EFFFF' | ||
| ']' | ||
| # NameChar | ||
| '[' | ||
| r'\-.0-9:A-Z_a-z' | ||
| '\xB7' | ||
| '\xC0-\xD6\xD8-\xF6\xF8-\u037D\u037F-\u1FFF' | ||
| '\u200C\u200D\u203F\u2040' | ||
| '\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF' | ||
| '\uF900-\uFDCF\uFDF0-\uFFFD\U00010000-\U000EFFFF' | ||
| ']*+', | ||
| name) is not None | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Add the :func:`xml.is_valid_name` function, which allows to check | ||
| whether a string can be used as an element or attribute name in XML. |
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.
Maybe add a link to the specs if any?
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.
Link found in the implementation:
https://www.w3.org/TR/xml/#NT-Name.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.
I think it would be good to add it in the online docs as well. It'll be more accessible.
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.
I am going to add several more functions. Some functions will need several links, and some links will be repeated for different functions. If we want to add links, it is better to add root links to the XML specifications at the top of the module documentation.
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.
That's also ok. As long as the online docs contain some links to some specifications, it's ok.