Skip to content

Commit 4b3d166

Browse files
committed
Renamed IpxactSchema to IPXACTSchema.
1 parent f4593a6 commit 4b3d166

File tree

6 files changed

+31
-30
lines changed

6 files changed

+31
-30
lines changed

doc/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
pyEDAA.IPXACT Documentation
4242
###########################
4343

44-
pyEDAA.IPXACT - An IP-XACT DOM (Document Object Model) for `IEEE 1685-2014 <https://standards.ieee.org/findstds/standard/1685-2014.html>`__
44+
pyEDAA.IPXACT - An IP-XACT DOM (Document Object Model) for `IEEE 1685-2022 <https://standards.ieee.org/findstds/standard/1685-2022.html>`__
4545
in Python.
4646

4747

@@ -84,6 +84,7 @@ IP-XACT Resources
8484

8585
* `IEEE 1685-2009 <https://standards.ieee.org/findstds/standard/1685-2009.html>`__
8686
* `IEEE 1685-2014 <https://standards.ieee.org/findstds/standard/1685-2014.html>`__
87+
* `IEEE 1685-2022 <https://standards.ieee.org/findstds/standard/1685-2022.html>`__
8788

8889
* Schema files:
8990

pyEDAA/IPXACT/Catalog.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
from pyTooling.Decorators import export, readonly
4040
from pyTooling.Common import getFullyQualifiedName
4141

42-
from pyEDAA.IPXACT import RootElement, VLNV, IPXACTException, __URI_MAP__, __DEFAULT_SCHEMA__, IpxactSchema, Element
42+
from pyEDAA.IPXACT import RootElement, VLNV, IPXACTException, __URI_MAP__, __DEFAULT_SCHEMA__, IPXACTSchema, Element
4343
from pyEDAA.IPXACT.Component import Component
4444

4545

@@ -115,7 +115,7 @@ def FromXml(cls, ipxactFileElement):
115115
ipxactFile = cls(vlnv, name, description)
116116
return ipxactFile
117117

118-
def ToXml(self, indent: int = 0, schema: IpxactSchema = __DEFAULT_SCHEMA__):
118+
def ToXml(self, indent: int = 0, schema: IPXACTSchema = __DEFAULT_SCHEMA__):
119119
"""Converts the object's data into XML format."""
120120
# WORKAROUND:
121121
# Python <=3.11:
@@ -237,7 +237,7 @@ def AddItem(self, item) -> None:
237237
ex.add_note(f"Got type '{getFullyQualifiedName(item)}'.")
238238
raise ex
239239

240-
def ToXml(self, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
240+
def ToXml(self, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
241241
"""Converts the object's data into XML format."""
242242

243243
xmlns = schema.NamespacePrefix

pyEDAA/IPXACT/Component.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
from pyTooling.Common import getFullyQualifiedName
3737
from pyTooling.Decorators import export
3838

39-
from pyEDAA.IPXACT import __DEFAULT_SCHEMA__, RootElement, VLNV, IpxactSchema, Element
39+
from pyEDAA.IPXACT import __DEFAULT_SCHEMA__, RootElement, VLNV, IPXACTSchema, Element
4040

4141

4242
@export
@@ -124,7 +124,7 @@ def AddItem(self, item) -> None:
124124
ex.add_note(f"Got type '{getFullyQualifiedName(item)}'.")
125125
raise ex
126126

127-
def ToXml(self, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
127+
def ToXml(self, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
128128
"""Converts the object's data into XML format."""
129129

130130
xmlns = schema.NamespacePrefix

pyEDAA/IPXACT/Design.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
from pyTooling.Decorators import export
3737
from pyTooling.Common import getFullyQualifiedName
3838

39-
from pyEDAA.IPXACT import RootElement, __DEFAULT_SCHEMA__, VLNV, IpxactSchema, Element
39+
from pyEDAA.IPXACT import RootElement, __DEFAULT_SCHEMA__, VLNV, IPXACTSchema, Element
4040

4141

4242
@export
@@ -80,7 +80,7 @@ def AddItem(self, item) -> None:
8080
else:
8181
raise ValueError()
8282

83-
def ToXml(self, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
83+
def ToXml(self, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
8484
"""Converts the object's data into XML format."""
8585

8686
xmlns = schema.NamespacePrefix
@@ -160,7 +160,7 @@ def __init__(self, vlnv, name, description):
160160
self._name = name
161161
self._description = description
162162

163-
def ToXml(self, indent: int = 0, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
163+
def ToXml(self, indent: int = 0, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
164164
"""Converts the object's data into XML format."""
165165

166166
# WORKAROUND:
@@ -184,7 +184,7 @@ class ComponentInstance(Element):
184184
def __init__(self, vlnv: VLNV) -> None:
185185
super().__init__(vlnv)
186186

187-
def ToXml(self, indent: int = 0, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
187+
def ToXml(self, indent: int = 0, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
188188
"""Converts the object's data into XML format."""
189189

190190
return ""
@@ -197,7 +197,7 @@ class Interconnection(Element):
197197
def __init__(self, vlnv: VLNV) -> None:
198198
super().__init__(vlnv)
199199

200-
def ToXml(self, indent: int = 0, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
200+
def ToXml(self, indent: int = 0, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
201201
"""Converts the object's data into XML format."""
202202

203203
return ""
@@ -210,7 +210,7 @@ class AdHocConnection(Element):
210210
def __init__(self, vlnv: VLNV) -> None:
211211
super().__init__(vlnv)
212212

213-
def ToXml(self, indent: int = 0, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
213+
def ToXml(self, indent: int = 0, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
214214
"""Converts the object's data into XML format."""
215215

216216
return ""

pyEDAA/IPXACT/DesignConfiguration.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
from pyTooling.Decorators import export
3636

37-
from pyEDAA.IPXACT import RootElement, __DEFAULT_SCHEMA__, VLNV, IpxactSchema
37+
from pyEDAA.IPXACT import RootElement, __DEFAULT_SCHEMA__, VLNV, IPXACTSchema
3838

3939

4040
@export
@@ -64,7 +64,7 @@ def SetItem(self, item):
6464
else:
6565
raise ValueError()
6666

67-
def ToXml(self, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
67+
def ToXml(self, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
6868
"""Converts the object's data into XML format."""
6969

7070
xmlns = schema.NamespacePrefix
@@ -107,7 +107,7 @@ class GeneratorChainConfiguration:
107107
def __init__(self) -> None:
108108
pass
109109

110-
def ToXml(self, indent: int = 0, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
110+
def ToXml(self, indent: int = 0, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
111111
"""Converts the object's data into XML format."""
112112

113113
return ""
@@ -120,7 +120,7 @@ class InterconnectionConfiguration:
120120
def __init__(self) -> None:
121121
pass
122122

123-
def ToXml(self, indent: int = 0, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
123+
def ToXml(self, indent: int = 0, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
124124
"""Converts the object's data into XML format."""
125125

126126
return ""
@@ -133,7 +133,7 @@ class ViewConfiguration:
133133
def __init__(self) -> None:
134134
pass
135135

136-
def ToXml(self, indent: int = 0, schema: IpxactSchema = __DEFAULT_SCHEMA__) -> str:
136+
def ToXml(self, indent: int = 0, schema: IPXACTSchema = __DEFAULT_SCHEMA__) -> str:
137137
"""Converts the object's data into XML format."""
138138

139139
return ""

pyEDAA/IPXACT/__init__.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151

5252

5353
@export
54-
class IpxactSchema(metaclass=ExtendedType, slots=True):
54+
class IPXACTSchema(metaclass=ExtendedType, slots=True):
5555
"""Schema descriptor made of version, namespace prefix, URI, URL and local path."""
5656

5757
_version: Union[SemanticVersion, CalendarVersion] #: Schema version
@@ -158,16 +158,16 @@ def __str__(self) -> str:
158158

159159

160160
# version, xmlns, URI URL, Local Path
161-
_IPXACT_10 = IpxactSchema("1.0", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.0", "", _IPXACT_10_INDEX)
162-
_IPXACT_11 = IpxactSchema("1.1", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.1", "", _IPXACT_11_INDEX)
163-
_IPXACT_12 = IpxactSchema("1.2", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.2", "", _IPXACT_12_INDEX)
164-
_IPXACT_14 = IpxactSchema("1.4", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.4", "", _IPXACT_14_INDEX)
165-
_IPXACT_15 = IpxactSchema("1.5", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5", "", _IPXACT_15_INDEX)
166-
_IPXACT_2009 = IpxactSchema("2009", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1685-2009", "", _IPXACT_2009_INDEX)
167-
_IPXACT_2014 = IpxactSchema("2014", "ipxact", "http://www.accellera.org/XMLSchema/IPXACT/1685-2014", "http://www.accellera.org/XMLSchema/IPXACT/1685-2014/index.xsd", _IPXACT_2014_INDEX)
168-
_IPXACT_2022 = IpxactSchema("2022", "ipxact", "http://www.accellera.org/XMLSchema/IPXACT/1685-2022", "http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd", _IPXACT_2022_INDEX)
169-
170-
__VERSION_TABLE__: Dict[str, IpxactSchema] = {
161+
_IPXACT_10 = IPXACTSchema("1.0", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.0", "", _IPXACT_10_INDEX)
162+
_IPXACT_11 = IPXACTSchema("1.1", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.1", "", _IPXACT_11_INDEX)
163+
_IPXACT_12 = IPXACTSchema("1.2", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.2", "", _IPXACT_12_INDEX)
164+
_IPXACT_14 = IPXACTSchema("1.4", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.4", "", _IPXACT_14_INDEX)
165+
_IPXACT_15 = IPXACTSchema("1.5", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5", "", _IPXACT_15_INDEX)
166+
_IPXACT_2009 = IPXACTSchema("2009", "spirit", "http://www.spiritconsortium.org/XMLSchema/SPIRIT/1685-2009", "", _IPXACT_2009_INDEX)
167+
_IPXACT_2014 = IPXACTSchema("2014", "ipxact", "http://www.accellera.org/XMLSchema/IPXACT/1685-2014", "http://www.accellera.org/XMLSchema/IPXACT/1685-2014/index.xsd", _IPXACT_2014_INDEX)
168+
_IPXACT_2022 = IPXACTSchema("2022", "ipxact", "http://www.accellera.org/XMLSchema/IPXACT/1685-2022", "http://www.accellera.org/XMLSchema/IPXACT/1685-2022/index.xsd", _IPXACT_2022_INDEX)
169+
170+
__VERSION_TABLE__: Dict[str, IPXACTSchema] = {
171171
'1.0': _IPXACT_10,
172172
'1.1': _IPXACT_11,
173173
'1.4': _IPXACT_14,
@@ -177,7 +177,7 @@ def __str__(self) -> str:
177177
'2022': _IPXACT_2022
178178
} #: Dictionary of all IP-XACT versions mapping to :class:`IpxactSchema` instances.
179179

180-
__URI_MAP__: Dict[str, IpxactSchema] = {value.SchemaUri: value for key, value in __VERSION_TABLE__.items()} #: Mapping from schema URIs to :class:`IpxactSchema` instances.
180+
__URI_MAP__: Dict[str, IPXACTSchema] = {value.SchemaUri: value for key, value in __VERSION_TABLE__.items()} #: Mapping from schema URIs to :class:`IpxactSchema` instances.
181181

182182
__DEFAULT_VERSION__ = "2022" #: IP-XACT default version
183183
__DEFAULT_SCHEMA__ = __VERSION_TABLE__[__DEFAULT_VERSION__] #: IP-XACT default Schema
@@ -258,7 +258,7 @@ def Name(self) -> str:
258258
def Version(self) -> SemanticVersion:
259259
return self._version
260260

261-
def ToXml(self, indent=1, schema: IpxactSchema = __DEFAULT_SCHEMA__, isVersionedIdentifier=False) -> str:
261+
def ToXml(self, indent=1, schema: IPXACTSchema = __DEFAULT_SCHEMA__, isVersionedIdentifier=False) -> str:
262262
"""
263263
Converts the object's data into XML format.
264264

0 commit comments

Comments
 (0)