pyEDAA.ToolSetup

Summary

Doc-string:

documented

File

Expected

Covered

Uncovered

Coverage

__init__.py

43

4

39

9.3%

Overall (15 files)

222

24

198

10.8%

Packages

Package

Expected

Covered

Uncovered

Coverage

Aldec

11

0

11

0.0%

CLI

15

10

5

66.7%

IntelFPGA

7

0

7

0.0%

Lattice

7

0

7

0.0%

OpenSource

53

9

44

17.0%

SiemensEDA

8

0

8

0.0%

SystemTools

5

0

5

0.0%

Xilinx

11

0

11

0.0%

Modules

Module

Expected

Covered

Uncovered

Coverage

DataModel

53

1

52

1.9%

Interface

9

0

9

0.0%

Source

pyEDAA.ToolSetup/__init__.pydocumentedundocumentedignoredexcludednot counted
31"""Package to support configuring EDA tools for usage with pyEDAA.CLITool."""
32__author__ =            "Patrick Lehmann"
33__email__ =             "Paebbels@gmail.com"
34__copyright__ =         "2021-2026, Electronic Design Automation Abstraction (EDA²)"
35__license__ =           "Apache License, Version 2.0"
36__version__ =           "0.6.0"
37__keywords__ =          ["configuration", "eda", "installation", "selection"]
38__project_url__ =       "https://github.com/edaa-org/pyEDAA.ToolSetup"
39__documentation_url__ = "https://edaa-org.github.io/pyEDAA.ToolSetup"
40__issue_tracker_url__ = "https://GitHub.com/edaa-org/pyEDAA.ToolSetup/issues"
41
...
53
55class ToolChainException(ExceptionBase):
56	"""Base-class for all pyEDAA.ToolSetup specific exceptions."""
57
58class ConfigurationException(ExceptionBase):
59	"""``ConfigurationException`` is raise while running configuration or database
60	tasks in pyIPCMI
61	"""
62
63class SkipConfigurationException(ExceptionBase):
64	"""``SkipConfigurationException`` is a :py:exc:`ConfigurationException`,
65	which can be skipped.
66	"""
67
68class ConfigurationMixIn:
69	_config: Dictionary
70
71	def __init__(self, config: Dictionary) -> None:
		...
73
75@export
76class ToolInstance(DM_ToolInstance, ConfigurationMixIn):
77	def __init__(self, config: Dictionary, parent: "Tool") -> None:
		...
85
87@export
88class Tool(DM_Tool, ConfigurationMixIn):
89	def __init__(self, config: Dictionary, parent: "Vendor") -> None:
		...
94
95	@property
96	def Default(self) -> ToolInstance:
		...
98
99	def _LoadVariant(self, key: str) -> ToolInstance:
		...
107
108	def _LoadAllVariants(self) -> None:
		...
117
119@export
120class Vendor(DM_Vendor, ConfigurationMixIn):
121	_toolClasses: ClassVar[Dict[str, Tool]]
122
123	def __init__(self, config: Dictionary, parent: "Installations") -> None:
		...
129
130	def _LoadTool(self, key: str) -> Tool:
		...
139
140	def _LoadAllTools(self) -> None:
		...
150
152@export
153class Installations(DM_Installation):
	...
163
164	_config: Configuration
165	_vendorClasses: Dict[str, Vendor] = {
166		"Aldec": Aldec,
167		"Altera": Altera,
168		"IntelFPGA": IntelFPGA,
169		"Lattice": Lattice,
170		"MentorGraphics": MentorGraphics,
171		"Xilinx": Xilinx,
172		"SystemTools": SystemTools,
173		"OpenSource": OpenSource
174	}
175
176	def __init__(self, yamlFile: Path) -> None:
		...
179
180	def _LoadVendor(self, key: str) -> Vendor:
		...
186
187	def _LoadAllVendors(self) -> None:
		...
197
198	@property
199	def Aldec(self) -> Aldec:
		...
202
203	@property
204	def Altera(self) -> Altera:
		...
207
208	@property
209	def IntelFPGA(self) -> IntelFPGA:
		...
212
213	@property
214	def Lattice(self) -> Lattice:
		...
217
218	@property
219	def MentorGraphics(self) -> MentorGraphics:
		...
222
223	@property
224	def OpenSource(self) -> OpenSource:
		...
227
228	@property
229	def SiemensEDA(self) -> SiemensEDA:
		...
232
233	@property
234	def SystemTools(self) -> SystemTools:
		...
237
238	@property
239	def Xilinx(self) -> Xilinx:
		...
242
243	@property
244	def ActiveHDL(self) -> ActiveHDL:
		...
246
247	@property
248	def RivieraPRO(self) -> RivieraPRO:
		...
250
251	@property
252	def Diamond(self) -> Diamond:
		...
254
255	@property
256	def Quartus(self) -> Quartus:
		...
258
259	@property
260	def ModelSim(self) -> ModelSim:
		...
262
263	@property
264	def QuestaSim(self) -> QuestaSim:
		...
266
267	@property
268	def Vivado(self) -> Vivado:
		...
270
271	@property
272	def VivadoSDK(self) -> VivadoSDK:
		...
274
275	@property
276	def Vitis(self) -> Vitis:
		...