fix: move RenameDuplicateAttributes to before SanitizeAttributesDefaultValue in Steps.SANITIZE

[tlambert03]

📒 Description

This fixes #805, an issue with enums with conflicting slugs

🔗 What I've Done

Write a description of the steps taken to resolve the issue

💬 Comments

While this fixes the problem i described... i have no idea what else it will break, so letting the tests run, and we can discuss

🛫 Checklist

• Updated docs
• Added unit-tests
• Sample tests pass
• W3C tests pass

[tlambert03]

yeah... breaks the expectations set in RenameDuplicateAttributesTests.test_process ... So, I guess my question would be whether this is an issue with the enum naming itself, or in the referencing of the enum in the class default?

for example (from #805):

from dataclasses import dataclass, field
from enum import Enum

class UnitsPower(Enum):
    MW = "MW"
    M_W_1 = "mW"


@dataclass
class LightSource:
    power_unit: UnitsPower = field(
        default=UnitsPower.M_W,
        metadata={
            "name": "PowerUnit",
            "type": "Attribute",
        }
    )

should I be trying to convert the enum UnitsPower.M_W_1 -> UnitsPower.M_W, or LightSource.power_unit default from UnitsPower.M_W -> UnitsPower.M_W_1?

[tlambert03]

a little more debugging...

after transformer.py has called classes = self.analyze_classes(self.classes) The attrs for the class defining the enum have been deduped:

[
    Class(
        qname='UnitsPower',
        attrs=[
            Attr(
                tag='Enumeration',
                name='MW',
                local_name='MW',
                ...
            ),
            Attr(
                tag='Enumeration',
                name='mW_1',
                local_name='mW',

but the @enum value in the default of the referring attribute doesn't seem to have gotten the memo:

    Class(
        qname='LightSource',
        attrs=[
            Attr(
                tag='Attribute',
                name='PowerUnit',
                local_name='PowerUnit',
                default='@enum@UnitsPower::mW',

... edit
and this is because in the order of processing:

xsdata/xsdata/codegen/container.py

Lines 117 to 126 in 11dbca8

	def process(self):
	"""The hidden naive recipe of processing xsd models."""
	self.process_classes(Steps.UNGROUP)
	self.remove_groups()
	self.process_classes(Steps.FLATTEN)
	self.filter_classes()
	self.process_classes(Steps.SANITIZE)
	self.process_classes(Steps.RESOLVE)
	self.process_classes(Steps.FINALIZE)
	self.designate_classes()

the field defaults get applied during step Steps.SANITIZE, but the enum field renaming doesn't happen until the next step: Steps.RESOLVE

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[tlambert03]

moving RenameDuplicateAttributes to right before SanitizeAttributesDefaultValue seems to have fixed it!

tests are all passing but let me know if maybe I'm missing some unexpected side effect here.
(note @tefra that I had to change the expectation in the test to match the new order).

The code output by my test case is now correct:

class UnitsPower(Enum):
    MW = "MW"
    M_W_1 = "mW"


@dataclass
class LightSource:
    power_unit: UnitsPower = field(
        default=UnitsPower.M_W_1,
        metadata={
            "name": "PowerUnit",
            "type": "Attribute",
        }
    )

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (11dbca8) 99.96% compared to head (041fa3b) 99.96%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #806   +/-   ##
=======================================
  Coverage   99.96%   99.96%           
=======================================
  Files         104      104           
  Lines        9244     9244           
  Branches     2067     2067           
=======================================
  Hits         9241     9241           
  Partials        3        3           

Impacted Files	Coverage Δ
xsdata/codegen/container.py	100.00% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[tlambert03]

happy to add a test for this if you tell me at what level it should be tested (i.e. full fixture or low level unit)

[tefra]

Excellent troubleshoot!!!

[tefra]

12k w3c tests and the sample suite all checked out.