Modify nested suite expansion to preserve comments

[peverwhee]

Description

Not critical, but it would be nice if the expanded suite that's written out could include any comments found in the individual nested suites.

Solution

Use custom XML parser to include comments, and then ignore comment elements when adding new suite parts.

[climbfuji]

I do not like the idea of a custom XML parser. Unless the parser we use now can preserve comments, I'd say we should accept that these comments get removed.

[peverwhee]

To clarify, by "custom XML parser", I just meant:

tree = ET.parse(file_, ET.XMLParser(target=ET.TreeBuilder(insert_comments=True)))

instead of:

tree = ET.parse(file_)

[climbfuji]

Oh, that's of course no issue at all! Sorry for my misunderstanding.

[peverwhee]

no problem. I would've been alarmed by "custom XML parser" without any further context as well!