Add types for defusedxml

[solkaz]

Initial attempt at adding types for defusedxml.

Some notes:

• This library relies on modules that aren't typed; namely:
  • xml.sax.expatreader - undocumented
  • lxml - no types, and I would prefer to ignore it for now

[solkaz]

The original source code has the following imports:

XMLTreeBuilder as XMLTreeBuilder
XMLParse as XMLParse
XMLParser as XMLParser
XML as XML

They were removed as Flake8 complained that below, they were being redefined, or that XML could not be redefined because it's a constant. If this isn't right, let me know how I could improve this

[srittau]

FYI: The current version of this file looks good, although you should probably add the __all__ statements.

[solkaz]

@srittau added

[github-actions]

Diff from mypy_primer, showing the effect of this PR on open source code:

vision (https://github.com/pytorch/vision)
+ torchvision/datasets/voc.py:10: error: Incompatible import of "ET_parse" (imported name has type "Callable[[int | str | bytes | PathLike[str] | PathLike[bytes] | SupportsRead[bytes] | SupportsRead[str], XMLParser | None], ElementTree]", local name has type "Callable[[Any, DefusedXMLParser | None, bool, bool, bool], ElementTree]")  [assignment]

[srittau]

I'm sorry for the late review. This looks good to me, although I didn't compare it to the implementation.

[solkaz]

@srittau thank you for the review! I'll follow up with fixes once I implement this into my personal project

[jbethune]

@solkaz Thanks for putting this together!

I noticed that defusedxml.minidom.parse and defusedxml.minidom.parseString don't have return type annotations. The return type should be xml.dom.minidom.Document. See also: expatbuilder.parse()

I know this PR is already merged. I guess we need to create a new one?

[srittau]

I know this PR is already merged. I guess we need to create a new one?

Indeed. Any PRs to further improve the stubs are welcome!

[tyrossel]

Thanks for adding those types !

I got an error with the find function:

import xml.etree.ElementTree as ET
import defusedxml.ElementTree as DET

el = DET.fromstring(filecontent)
subEl = el.find("Document", ns)

Mypy gives the error: mypy: "Element" has no attribute "find" (i.e. xml.dom.minidom.Element)

I can cast el to ET.Element to solve this issue, but I had the understanding that defusedxml was a drop-in replacement to those functions.

I am not sure where I should report this, let me know if there is a better place.

[AlexWaygood]

@tyrossel, please open an issue on our tracker if there's a problem with these stubs; it's hard to keep track of comments on merged PRs :)