FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-128302: fix apparent bug in `xml.dom.xmlbuilder.DOMBuilder.parse()` by tungol · Pull Request #128284 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-128302: fix apparent bug in xml.dom.xmlbuilder.DOMBuilder.parse() - #128284

Merged
serhiy-storchaka merged 7 commits into
python:mainfrom
tungol:xml
Jan 7, 2025
ConversationCommits (7)ChecksFiles changed
Merged

gh-128302: fix apparent bug in xml.dom.xmlbuilder.DOMBuilder.parse()#128284
serhiy-storchaka merged 7 commits into
python:mainfrom
tungol:xml

Conversation

tungol commented Dec 27, 2024 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Contributor

This looks like a bug. The Options class has no systemId attribute, but the input parameter, which seems to be an instance of DOMInputSource, does.

I don't really know how this is meant to be used, but given this code:

from xml.dom.xmlbuilder import DOMBuilder, DOMInputSource

db = DOMBuilder()
source = DOMInputSource()
source.systemId = "http://www.w3.org/2000/svg"
print(db.parse(source))

As-is this raises an error:

  File "test.py", line 6, in <module>
    print(db.parse(source))
          ~~~~~~~~^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/xml/dom/xmlbuilder.py", line 192, in parse
    if fp is None and options.systemId:
                      ^^^^^^^^^^^^^^^^
AttributeError: 'Options' object has no attribute 'systemId'

With this change:

<xml.dom.minidom.Document object at 0x105438f50>

I'd consider adding a test, but there's no tests right now for any of this.

picnixz commented Dec 27, 2024

Copy link
Copy Markdown
Member

Considering the fact that we use input.systemId just after, I don't know if the options class is meant to indicate "hey, you can use systemId", I think we need an issue as well and a NEWS entry.

tungol marked this pull request as draft December 27, 2024 18:55

tungol commented Dec 27, 2024

Copy link
Copy Markdown
Contributor Author

I'll put together a more thorough analysis.

tungol changed the title fix apparent bug in xml.dom.xmlbuilder.DOMBuilder.parse() gh-128302: fix apparent bug in xml.dom.xmlbuilder.DOMBuilder.parse() Dec 28, 2024
bedevere-app Bot mentioned this pull request Dec 28, 2024
Closed
tungol marked this pull request as ready for review December 28, 2024 00:35

tungol commented Dec 28, 2024

Copy link
Copy Markdown
Contributor Author

Please see issue #128302 for a full write-up and analysis of what's going on here.

picnixz self-requested a review December 29, 2024 08:44
picnixz reviewed Dec 29, 2024
View reviewed changes
Comment thread Misc/NEWS.d/next/Library/2024-12-27-16-28-57.gh-issue-128302.2GMvyl.rst
Comment thread Lib/xml/dom/xmlbuilder.py Outdated
serhiy-storchaka reviewed Dec 30, 2024
View reviewed changes

serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM in general, but it would be nice to have tests.

You can also consider splitting this PR on two PRs, as it fixes two unrelated bugs.

tungol commented Jan 5, 2025

Copy link
Copy Markdown
Contributor Author

I'll look at adding some tests. There's no existing tests for this module, but you have to start somewhere I suppose.

Would it be better if this was two MRs? I'm happy to split it if so.

picnixz commented Jan 5, 2025

Copy link
Copy Markdown
Member

Yes better to do it in another PR for the tests

serhiy-storchaka reviewed Jan 6, 2025
View reviewed changes

serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I see now that it is difficult to add new tests, because there are no any tests for xmlbuilder at all. And adding meaningful tests is a larger issue, much larger than this bug fix. But we need any test, just to check that the new code works and the old code does not work. Even if they are only two test in a new file.

Comment thread Lib/xml/dom/xmlbuilder.py Outdated
tungol marked this pull request as draft January 6, 2025 18:17
tungol and others added 2 commits January 6, 2025 15:14
use Message.get_param
b0cfb6a 
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
add a few tests for xml.dom.xmlbuilder
737f856

tungol commented Jan 7, 2025

Copy link
Copy Markdown
Contributor Author

Here are some tests for the changed behavior. test.test_xml_dom_xmlbuilder.XMLBuilderTest.test_builder is basic and passes without these changes, but the other three all fail if run against main.

I'm a little reluctant to split this MR in two now that I've added tests/test_xml_dom_xmlbuilder.py because it'd be a bit of a pain to manage the merge conflicts that would occur for that file.

tungol marked this pull request as ready for review January 7, 2025 00:51

picnixz commented Jan 7, 2025

Copy link
Copy Markdown
Member

If it's too hard, let's do it in one PR if Serhiy agrees. I don't think there will be conflicts though but the file looks smalle enough.

serhiy-storchaka approved these changes Jan 7, 2025
View reviewed changes

serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM! 👍

serhiy-storchaka merged commit 6ea04da into python:main Jan 7, 2025
serhiy-storchaka added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels Jan 7, 2025

miss-islington-app Bot commented Jan 7, 2025

Copy link
Copy Markdown

Thanks @tungol for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington-app Bot commented Jan 7, 2025

Copy link
Copy Markdown

Thanks @tungol for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 7, 2025
pythongh-128302: Fix bugs in xml.dom.xmlbuilder (pythonGH-128284)
9159ce4 
* Allow DOMParser.parse() to correctly handle DOMInputSource instances
  that only have a systemId attribute set.
* Fix DOMEntityResolver.resolveEntity(), which was broken by the
  Python 3.0 transition.
* Add Lib/test/test_xml_dom_xmlbuilder.py with few tests.
(cherry picked from commit 6ea04da)

Co-authored-by: Stephen Morton <git@tungol.org>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 7, 2025
pythongh-128302: Fix bugs in xml.dom.xmlbuilder (pythonGH-128284)
b9eee83 
* Allow DOMParser.parse() to correctly handle DOMInputSource instances
  that only have a systemId attribute set.
* Fix DOMEntityResolver.resolveEntity(), which was broken by the
  Python 3.0 transition.
* Add Lib/test/test_xml_dom_xmlbuilder.py with few tests.
(cherry picked from commit 6ea04da)

Co-authored-by: Stephen Morton <git@tungol.org>

bedevere-app Bot commented Jan 7, 2025

Copy link
Copy Markdown

GH-128582 is a backport of this pull request to the 3.13 branch.

bedevere-app Bot removed the needs backport to 3.13 only security fixes label Jan 7, 2025

bedevere-app Bot commented Jan 7, 2025

Copy link
Copy Markdown

GH-128583 is a backport of this pull request to the 3.12 branch.

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Jan 7, 2025
tungol deleted the xml branch January 7, 2025 19:03
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Jan 8, 2025
pythongh-128302: Fix bugs in xml.dom.xmlbuilder (pythonGH-128284)
465ac67 
* Allow DOMParser.parse() to correctly handle DOMInputSource instances
  that only have a systemId attribute set.
* Fix DOMEntityResolver.resolveEntity(), which was broken by the
  Python 3.0 transition.
* Add Lib/test/test_xml_dom_xmlbuilder.py with few tests.
hugovk pushed a commit that referenced this pull request Jan 11, 2025
[3.12] gh-128302: Fix bugs in xml.dom.xmlbuilder (GH-128284) (#128583)
07a65cd 
gh-128302: Fix bugs in xml.dom.xmlbuilder (GH-128284)

* Allow DOMParser.parse() to correctly handle DOMInputSource instances
  that only have a systemId attribute set.
* Fix DOMEntityResolver.resolveEntity(), which was broken by the
  Python 3.0 transition.
* Add Lib/test/test_xml_dom_xmlbuilder.py with few tests.
(cherry picked from commit 6ea04da)

Co-authored-by: Stephen Morton <git@tungol.org>
hugovk pushed a commit that referenced this pull request Jan 11, 2025
[3.13] gh-128302: Fix bugs in xml.dom.xmlbuilder (GH-128284) (#128582)
3714fd0 
gh-128302: Fix bugs in xml.dom.xmlbuilder (GH-128284)

* Allow DOMParser.parse() to correctly handle DOMInputSource instances
  that only have a systemId attribute set.
* Fix DOMEntityResolver.resolveEntity(), which was broken by the
  Python 3.0 transition.
* Add Lib/test/test_xml_dom_xmlbuilder.py with few tests.
(cherry picked from commit 6ea04da)

Co-authored-by: Stephen Morton <git@tungol.org>

bedevere-bot commented Jan 11, 2025

Copy link
Copy Markdown

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot PPC64LE Fedora Stable Refleaks 3.12 has failed when building commit 07a65cd.

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1210/builds/711) and take a look at the build logs.
  4. Check if the failure is related to this commit (07a65cd) or if it is a false positive.
  5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1210/builds/711

Failed tests:

  • test_glob

Failed subtests:

  • test_selflink - test.test_glob.SymlinkLoopGlobTests.test_selflink

Summary of the results of the build (if available):

==

Click to see traceback logs 
Traceback (most recent call last):
  File "/home/buildbot/buildarea/3.12.cstratak-fedora-stable-ppc64le.refleak/build/Lib/test/test_glob.py", line 418, in test_selflink
    self.assertIn(path, results)
AssertionError: 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file' not found in {'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file', 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file', 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file', 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file', 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file', 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file', 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file', 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file'}


Traceback (most recent call last):
  File "/home/buildbot/buildarea/3.12.cstratak-fedora-stable-ppc64le.refleak/build/Lib/test/test_glob.py", line 418, in test_selflink
    self.assertIn(path, results)
AssertionError: 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file' not found in {'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file', 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file', 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file', 'dir/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/link/file'}

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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

picnixz picnixz left review comments
serhiy-storchaka serhiy-storchaka approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL