为何Python文档不建议调用Element.makeelement()却未标记其废弃？

核心结论 #

Element.makeelement()本身可以正常工作，不会引发功能层面的问题，官方文档的提示只是出于API设计的引导，而非因为方法本身存在缺陷。

为什么文档仅给出提示而非废弃/移除？ #

• 向后兼容优先：Python官方极度重视现有代码的兼容性，makeelement()在早期版本的代码中被广泛使用，如果标记废弃或直接移除，会导致大量旧代码无法正常运行，这不符合Python的版本迭代原则。
• API设计优化引导：SubElement()是官方推出的更友好的工厂函数，它封装了makeelement()的逻辑，还自动完成了新元素向父节点的添加操作，写法更简洁直观（对比示例见下文）。官方希望引导开发者使用更高效的新API，而非强制禁用旧方法。
• 无致命缺陷无需废弃：废弃流程通常针对存在安全隐患、功能bug，或者被完全替代且使用会带来风险的接口。makeelement()只是API设计略显生硬，功能上完全正常，因此没有必要纳入废弃流程。

新旧API写法对比 #

使用makeelement()的写法 #

import xml.etree.ElementTree as ET

parent = ET.Element("parent")
child = parent.makeelement("child", {})
parent.append(child)

使用SubElement()的写法 #

import xml.etree.ElementTree as ET

parent = ET.Element("parent")
child = ET.SubElement(parent, "child")

可以看到，SubElement()直接省去了手动添加子节点的步骤，代码更简洁易读。

内容的提问来源于stack exchange，提问作者thomasrutter