pyEDAA.ProjectModel

An abstract model of EDA tool projects.

Submodules

Classes

• Attribute: Undocumented.

• FileType: A meta-class to construct FileType classes.

• File: A File represents a file in a design. This base-class is used

• HumanReadableContent: A file type representing human-readable contents.

• XMLContent: A file type representing XML contents.

• YAMLContent: A file type representing YAML contents.

• JSONContent: A file type representing JSON contents.

• INIContent: A file type representing INI contents.

• TOMLContent: A file type representing TOML contents.

• TCLContent: A file type representing content in TCL code.

• SDCContent: A file type representing contents as Synopsys Design Constraints (SDC).

• PythonContent: A file type representing contents as Python source code.

• TextFile: A text file (*.txt).

• LogFile: A log file (*.log).

• XMLFile: An XML file (*.xml).

• SourceFile: Base-class of all source files.

• HDLSourceFile: Base-class of all HDL source files.

• RDLSourceFile: Base-class of all RDL source files.

• NetlistFile: Base-class of all netlist source files.

• EDIFNetlistFile: Netlist file in EDIF (Electronic Design Interchange Format).

• TCLSourceFile: A TCL source file.

• VHDLSourceFile: A VHDL source file (of any language version).

• VerilogBaseFile: Base-class of all HDL source files.

• VerilogSourceFile: A Verilog source file (of any language version).

• VerilogHeaderFile: A Verilog header file (of any language version).

• SystemVerilogBaseFile: Base-class of all HDL source files.

• SystemVerilogSourceFile: A SystemVerilog source file (of any language version).

• SystemVerilogHeaderFile: A SystemVerilog header file (of any language version).

• SystemRDLSourceFile: A SystemRDL source file (of any language version).

• PythonSourceFile: A Python source file.

• CocotbPythonFile: A Python source file used by Cocotb.

• ConstraintFile: Base-class of all constraint files.

• ProjectFile: Base-class of all tool-specific project files.

• CSourceFile: Base-class of all ANSI-C source files.

• CppSourceFile: Base-class of all ANSI-C++ source files.

• SettingFile: Base-class of all tool-specific setting files.

• SimulationAnalysisFile: Base-class of all tool-specific analysis files.

• SimulationElaborationFile: Base-class of all tool-specific elaboration files.

• SimulationStartFile: Base-class of all tool-specific simulation start-up files.

• SimulationRunFile: Base-class of all tool-specific simulation run (execution) files.

• WaveformConfigFile: Base-class of all tool-specific waveform configuration files.

• WaveformDatabaseFile: Base-class of all tool-specific waveform database files.

• WaveformExchangeFile: Base-class of all tool-independent waveform exchange files.

• FileSet: A FileSet represents a group of files. Filesets can have sub-filesets.

• VHDLLibrary: A VHDLLibrary represents a group of VHDL source files compiled into the same VHDL library.

• Design: A Design represents a group of filesets and the source files therein.

• Project: A Project represents a group of designs and the source files therein.

Classes

class pyEDAA.ProjectModel.Attribute[source]

Inheritance

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

class pyEDAA.ProjectModel.FileType(name, bases, dictionary, **kwargs)[source]

A meta-class to construct FileType classes.

Modifications done by this meta-class: * Register all classes of type FileType or derived variants in a class field FileType.FileTypes in this meta-class.

Inheritance

Parameters:

classMembers (Dict)

Return type:

Self

FileTypes: Dict[str, FileType] = {'CSourceFile': <class 'pyEDAA.ProjectModel.CSourceFile'>, 'CocotbPythonFile': <class 'pyEDAA.ProjectModel.CocotbPythonFile'>, 'ConstraintFile': <class 'pyEDAA.ProjectModel.Xilinx.Vivado.ConstraintFile'>, 'CppSourceFile': <class 'pyEDAA.ProjectModel.CppSourceFile'>, 'EDIFNetlistFile': <class 'pyEDAA.ProjectModel.EDIFNetlistFile'>, 'File': <class 'pyEDAA.ProjectModel.Xilinx.Vivado.File'>, 'GHDLWaveformFile': <class 'pyEDAA.ProjectModel.GHDL.GHDLWaveformFile'>, 'HDLSourceFile': <class 'pyEDAA.ProjectModel.HDLSourceFile'>, 'IPCoreDescriptionFile': <class 'pyEDAA.ProjectModel.Xilinx.Vivado.IPCoreDescriptionFile'>, 'IPCoreInstantiationFile': <class 'pyEDAA.ProjectModel.Xilinx.Vivado.IPCoreInstantiationFile'>, 'ISEProjectFile': <class 'pyEDAA.ProjectModel.Xilinx.ISE.ISEProjectFile'>, 'LogFile': <class 'pyEDAA.ProjectModel.LogFile'>, 'ModelSimINIFile': <class 'pyEDAA.ProjectModel.MentorGraphics.QuestaSim.ModelSimINIFile'>, 'ModelSimProjectFile': <class 'pyEDAA.ProjectModel.MentorGraphics.QuestaSim.ModelSimProjectFile'>, 'NetlistFile': <class 'pyEDAA.ProjectModel.NetlistFile'>, 'OSVVMProjectFile': <class 'pyEDAA.ProjectModel.OSVVM.OSVVMProjectFile'>, 'ProjectFile': <class 'pyEDAA.ProjectModel.ProjectFile'>, 'PythonSourceFile': <class 'pyEDAA.ProjectModel.PythonSourceFile'>, 'QuartusProjectFile': <class 'pyEDAA.ProjectModel.Intel.QuartusPrime.QuartusProjectFile'>, 'RDLSourceFile': <class 'pyEDAA.ProjectModel.RDLSourceFile'>, 'SDCConstraintFile': <class 'pyEDAA.ProjectModel.Intel.QuartusPrime.SDCConstraintFile'>, 'SettingFile': <class 'pyEDAA.ProjectModel.SettingFile'>, 'SimulationAnalysisFile': <class 'pyEDAA.ProjectModel.SimulationAnalysisFile'>, 'SimulationElaborationFile': <class 'pyEDAA.ProjectModel.SimulationElaborationFile'>, 'SimulationRunFile': <class 'pyEDAA.ProjectModel.SimulationRunFile'>, 'SimulationStartFile': <class 'pyEDAA.ProjectModel.SimulationStartFile'>, 'SourceFile': <class 'pyEDAA.ProjectModel.SourceFile'>, 'SystemRDLSourceFile': <class 'pyEDAA.ProjectModel.SystemRDLSourceFile'>, 'SystemVerilogBaseFile': <class 'pyEDAA.ProjectModel.SystemVerilogBaseFile'>, 'SystemVerilogHeaderFile': <class 'pyEDAA.ProjectModel.SystemVerilogHeaderFile'>, 'SystemVerilogSourceFile': <class 'pyEDAA.ProjectModel.SystemVerilogSourceFile'>, 'TCLSourceFile': <class 'pyEDAA.ProjectModel.TCLSourceFile'>, 'TextFile': <class 'pyEDAA.ProjectModel.TextFile'>, 'UCFConstraintFile': <class 'pyEDAA.ProjectModel.Xilinx.ISE.UCFConstraintFile'>, 'VHDLSourceFile': <class 'pyEDAA.ProjectModel.Xilinx.Vivado.VHDLSourceFile'>, 'ValueChangeDumpFile': <class 'pyEDAA.ProjectModel.Verilog.ValueChangeDumpFile'>, 'VerilogBaseFile': <class 'pyEDAA.ProjectModel.VerilogBaseFile'>, 'VerilogHeaderFile': <class 'pyEDAA.ProjectModel.VerilogHeaderFile'>, 'VerilogSourceFile': <class 'pyEDAA.ProjectModel.Xilinx.Vivado.VerilogSourceFile'>, 'VivadoProjectFile': <class 'pyEDAA.ProjectModel.Xilinx.Vivado.VivadoProjectFile'>, 'WaveDoFile': <class 'pyEDAA.ProjectModel.MentorGraphics.QuestaSim.WaveDoFile'>, 'WaveformConfigFile': <class 'pyEDAA.ProjectModel.WaveformConfigFile'>, 'WaveformDatabaseFile': <class 'pyEDAA.ProjectModel.WaveformDatabaseFile'>, 'WaveformExchangeFile': <class 'pyEDAA.ProjectModel.WaveformExchangeFile'>, 'XDCConstraintFile': <class 'pyEDAA.ProjectModel.Xilinx.Vivado.XDCConstraintFile'>, 'XMLFile': <class 'pyEDAA.ProjectModel.XMLFile'>}

Dictionary of all classes of type FileType or derived variants

__init__(name, bases, dictionary, **kwargs)[source]

Parameters:

• name (str)

• bases (Tuple[type, ...])

• dictionary (Dict[str, Any])

Return type:

None

static __new__(cls, className, baseClasses, classMembers, *args, **kwargs)[source]

Construct a new class using this meta-class.

Parameters:

• className – The name of the class to construct.

• baseClasses – The tuple of base-classes the class is derived from.

• members – The dictionary of members for the constructed class.

• slots – If true, store object attributes in __slots__ instead of __dict__.

• mixin – If true, make the class a Mixin-Class. If false, create slots if slots is true. If none, preserve behavior of primary base-class.

• singleton – If true, make the class a Singleton.

• classMembers (Dict)

Return type:

Self

Returns:

The new class.

Raises:

• AttributeError – If base-class has no ‘__slots__’ attribute.

• AttributeError – If slot already exists in base-class.

property HasClassAttributes: bool

Read-only property to check if the class has Attributes (__pyattr__).

Returns:

True, if the class has Attributes.

property HasMethodAttributes: bool

Read-only property to check if the class has methods with Attributes (__methodsWithAttributes__).

Returns:

True, if the class has any method with Attributes.

__base__

alias of ExtendedType

__call__(*args, **kwargs)

Call self as a function.

__delattr__(name, /)

Implement delattr(self, name).

__dir__()

Specialized __dir__ implementation for types.

__getattribute__(name, /)

Return getattr(self, name).

__instancecheck__(instance, /)

Check if an object is an instance.

__or__(value, /)

Return self|value.

classmethod __prepare__(name, bases, /, **kwds)

Create the namespace for the class statement

__repr__()

Return repr(self).

__ror__(value, /)

Return value|self.

__setattr__(name, value, /)

Implement setattr(self, name, value).

__sizeof__()

Return memory consumption of the type object.

__subclasscheck__(subclass, /)

Check if a class is a subclass.

__subclasses__()

Return a list of immediate subclasses.

classmethod _aggregateMixinSlots(className, baseClasses)

Aggregate slot names requested by mixin-base-classes.

Todo

Describe algorithm.

Parameters:

• className (str) – The name of the class to construct.

• baseClasses (Tuple[type]) – The tuple of base-classes the class is derived from.

Return type:

List[str]

Returns:

A list of slot names.

classmethod _checkForAbstractMethods(baseClasses, members)

Check if the current class contains abstract methods and return a tuple of them.

These abstract methods might be inherited from any base-class. If there are inherited abstract methods, check if they are now implemented (overridden) by the current class that’s right now constructed.

Parameters:

• baseClasses (Tuple[type]) – The tuple of base-classes the class is derived from.

• members (Dict[str, Any]) – The dictionary of members for the constructed class.

Return type:

Tuple[Dict[str, Callable], Dict[str, Any]]

Returns:

A tuple of abstract method’s names.

classmethod _computeSlots(className, baseClasses, members, slots, mixin)

Compute which field are listed in __slots__ and which need to be initialized in an instance or class.

Todo

Describe algorithm.

Parameters:

• className (str) – The name of the class to construct.

• baseClasses (Tuple[type]) – Tuple of base-classes.

• members (Dict[str, Any]) – Dictionary of class members.

• slots (bool) – True, if the class should setup __slots__.

• mixin (bool) – True, if the class should behave as a mixin-class.

Return type:

Tuple[Dict[str, Any], Dict[str, Any]]

Returns:

A 2-tuple with a dictionary of class members and object members.

classmethod _findMethods(newClass, baseClasses, members)

Find methods and methods with pyTooling.Attributes.

Todo

Describe algorithm.

Parameters:

• newClass (ExtendedType) – Newly created class instance.

• baseClasses (Tuple[type]) – The tuple of base-classes the class is derived from.

• members (Dict[str, Any]) – Members of the new class.

Return type:

Tuple[List[MethodType], List[MethodType]]

Returns:

classmethod _iterateBaseClassPaths(baseClasses)

Return a generator to iterate all possible inheritance paths for a given list of base-classes.

An inheritance path is expressed as a tuple of base-classes from current base-class (left-most item) to object (right-most item).

Parameters:

baseClasses (Tuple[type]) – The tuple of base-classes the class is derived from.

Return type:

Generator[Tuple[type, ...], None, None]

Returns:

Generator to iterate all inheritance paths.
An inheritance path is a tuple of types (base-classes).

classmethod _iterateBaseClasses(baseClasses)

Return a generator to iterate (visit) all base-classes …

Todo

Describe iteration order.

Parameters:

baseClasses (Tuple[type]) – The tuple of base-classes the class is derived from.

Return type:

Generator[type, None, None]

Returns:

Generator to iterate all base-classes.

classmethod _wrapNewMethodIfAbstract(newClass)

If the class has abstract methods, replace the _new__ method, so it raises an exception.

Parameters:

newClass – The newly constructed class for further modifications.

Return type:

bool

Returns:

True, if the class is abstract.

Raises:

AbstractClassError – If the class is abstract and can’t be instantiated.

classmethod _wrapNewMethodIfSingleton(newClass, singleton)

If a class is a singleton, wrap the _new__ method, so it returns a cached object, if a first object was created.

Only the first object creation initializes the object.

This implementation is threadsafe.

Parameters:

• newClass – The newly constructed class for further modifications.

• singleton (bool) – If True, the class allows only a single instance to exist.

Return type:

bool

Returns:

True, if the class is a singleton.

mro()

Return a type’s method resolution order.

class pyEDAA.ProjectModel.File(path, project=None, design=None, fileSet=None)[source]

A File represents a file in a design. This base-class is used for all derived file classes.

A file can be created standalone and later associated to a fileset, design and project. Or a fileset, design and/or project can be associated immediately while creating a file.

Parameters:

• path (Path) – Relative or absolute path to the file.

• project (Project | None) – Project the file is associated with.

• design (Design | None) – Design the file is associated with.

• fileSet (FileSet | None) – Fileset the file is associated with.

• path

• project

• design

• fileSet

Inheritance

__init__(path, project=None, design=None, fileSet=None)[source]

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Return type:

None

property FileType: FileType

Read-only property to return the file type of this file.

property Path: Path

Read-only property to access the path to the file.

Returns:

The file’s path.

property ResolvedPath: Path

Read-only property returning the resolved path of this file.

property Project: Project | None

Property setting or returning the project this file is used in.

property Design: Design | None

Property setting or returning the design this file is used in.

property FileSet: FileSet | None

Property setting or returning the fileset this file is used in.

Validate()[source]

Validate this file.

Return type:

None

__len__()[source]

Returns number of attributes set on this file.

Return type:

int

Returns:

The number of attributes set on this file.

__getitem__(key)[source]

Index access for returning attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

Any

Returns:

The attribute’s value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

__setitem__(key, value)[source]

Index access for adding or setting attributes on this file.

Parameters:

• key (Type[Attribute]) – The attribute type.

• value (Any) – The attributes value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

Return type:

None

__delitem__(key)[source]

Index access for deleting attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

None

__str__()[source]

Return str(self).

Return type:

str

Any

alias of File

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

class pyEDAA.ProjectModel.HumanReadableContent[source]

A file type representing human-readable contents.

Inheritance

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

class pyEDAA.ProjectModel.XMLContent[source]

A file type representing XML contents.

Inheritance

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

class pyEDAA.ProjectModel.YAMLContent[source]

A file type representing YAML contents.

Inheritance

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

class pyEDAA.ProjectModel.JSONContent[source]

A file type representing JSON contents.

Inheritance

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

class pyEDAA.ProjectModel.INIContent[source]

A file type representing INI contents.

Inheritance

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

class pyEDAA.ProjectModel.TOMLContent[source]

A file type representing TOML contents.

Inheritance

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

class pyEDAA.ProjectModel.TCLContent[source]

A file type representing content in TCL code.

Inheritance

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

class pyEDAA.ProjectModel.SDCContent[source]

A file type representing contents as Synopsys Design Constraints (SDC).

Inheritance

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

class pyEDAA.ProjectModel.PythonContent[source]

A file type representing contents as Python source code.

Inheritance

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

class pyEDAA.ProjectModel.TextFile(path, project=None, design=None, fileSet=None)[source]

A text file (*.txt).

Inheritance

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Any

alias of TextFile

property Design: Design | None

Property setting or returning the design this file is used in.

property FileSet: FileSet | None

Property setting or returning the fileset this file is used in.

property FileType: FileType

Read-only property to return the file type of this file.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

property Path: Path

Read-only property to access the path to the file.

Returns:

The file’s path.

property Project: Project | None

Property setting or returning the project this file is used in.

property ResolvedPath: Path

Read-only property returning the resolved path of this file.

Validate()

Validate this file.

Return type:

None

__delitem__(key)

Index access for deleting attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

None

__getitem__(key)

Index access for returning attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

Any

Returns:

The attribute’s value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

__init__(path, project=None, design=None, fileSet=None)

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Return type:

None

__len__()

Returns number of attributes set on this file.

Return type:

int

Returns:

The number of attributes set on this file.

__setitem__(key, value)

Index access for adding or setting attributes on this file.

Parameters:

• key (Type[Attribute]) – The attribute type.

• value (Any) – The attributes value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

Return type:

None

__str__()

Return str(self).

Return type:

str

class pyEDAA.ProjectModel.LogFile(path, project=None, design=None, fileSet=None)[source]

A log file (*.log).

Inheritance

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Any

alias of LogFile

property Design: Design | None

Property setting or returning the design this file is used in.

property FileSet: FileSet | None

Property setting or returning the fileset this file is used in.

property FileType: FileType

Read-only property to return the file type of this file.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

property Path: Path

Read-only property to access the path to the file.

Returns:

The file’s path.

property Project: Project | None

Property setting or returning the project this file is used in.

property ResolvedPath: Path

Read-only property returning the resolved path of this file.

Validate()

Validate this file.

Return type:

None

__delitem__(key)

Index access for deleting attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

None

__getitem__(key)

Index access for returning attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

Any

Returns:

The attribute’s value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

__init__(path, project=None, design=None, fileSet=None)

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Return type:

None

__len__()

Returns number of attributes set on this file.

Return type:

int

Returns:

The number of attributes set on this file.

__setitem__(key, value)

Index access for adding or setting attributes on this file.

Parameters:

• key (Type[Attribute]) – The attribute type.

• value (Any) – The attributes value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

Return type:

None

__str__()

Return str(self).

Return type:

str

class pyEDAA.ProjectModel.XMLFile(path, project=None, design=None, fileSet=None)[source]

An XML file (*.xml).

Inheritance

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Any

alias of XMLFile

property Design: Design | None

Property setting or returning the design this file is used in.

property FileSet: FileSet | None

Property setting or returning the fileset this file is used in.

property FileType: FileType

Read-only property to return the file type of this file.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

property Path: Path

Read-only property to access the path to the file.

Returns:

The file’s path.

property Project: Project | None

Property setting or returning the project this file is used in.

property ResolvedPath: Path

Read-only property returning the resolved path of this file.

Validate()

Validate this file.

Return type:

None

__delitem__(key)

Index access for deleting attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

None

__getitem__(key)

Index access for returning attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

Any

Returns:

The attribute’s value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

__init__(path, project=None, design=None, fileSet=None)

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Return type:

None

__len__()

Returns number of attributes set on this file.

Return type:

int

Returns:

The number of attributes set on this file.

__setitem__(key, value)

Index access for adding or setting attributes on this file.

Parameters:

• key (Type[Attribute]) – The attribute type.

• value (Any) – The attributes value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

Return type:

None

__str__()

Return str(self).

Return type:

str

class pyEDAA.ProjectModel.SourceFile(path, project=None, design=None, fileSet=None)[source]

Base-class of all source files.

Inheritance

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Any

alias of SourceFile

property Design: Design | None

Property setting or returning the design this file is used in.

property FileSet: FileSet | None

Property setting or returning the fileset this file is used in.

property FileType: FileType

Read-only property to return the file type of this file.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

property Path: Path

Read-only property to access the path to the file.

Returns:

The file’s path.

property Project: Project | None

Property setting or returning the project this file is used in.

property ResolvedPath: Path

Read-only property returning the resolved path of this file.

Validate()

Validate this file.

Return type:

None

__delitem__(key)

Index access for deleting attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

None

__getitem__(key)

Index access for returning attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

Any

Returns:

The attribute’s value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

__init__(path, project=None, design=None, fileSet=None)

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Return type:

None

__len__()

Returns number of attributes set on this file.

Return type:

int

Returns:

The number of attributes set on this file.

__setitem__(key, value)

Index access for adding or setting attributes on this file.

Parameters:

• key (Type[Attribute]) – The attribute type.

• value (Any) – The attributes value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

Return type:

None

__str__()

Return str(self).

Return type:

str

class pyEDAA.ProjectModel.HDLSourceFile(path, project=None, design=None, fileSet=None)[source]

Base-class of all HDL source files.

Inheritance

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Any

alias of HDLSourceFile

property Design: Design | None

Property setting or returning the design this file is used in.

property FileSet: FileSet | None

Property setting or returning the fileset this file is used in.

property FileType: FileType

Read-only property to return the file type of this file.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

property Path: Path

Read-only property to access the path to the file.

Returns:

The file’s path.

property Project: Project | None

Property setting or returning the project this file is used in.

property ResolvedPath: Path

Read-only property returning the resolved path of this file.

Validate()

Validate this file.

Return type:

None

__delitem__(key)

Index access for deleting attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

None

__getitem__(key)

Index access for returning attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

Any

Returns:

The attribute’s value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

__init__(path, project=None, design=None, fileSet=None)

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Return type:

None

__len__()

Returns number of attributes set on this file.

Return type:

int

Returns:

The number of attributes set on this file.

__setitem__(key, value)

Index access for adding or setting attributes on this file.

Parameters:

• key (Type[Attribute]) – The attribute type.

• value (Any) – The attributes value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

Return type:

None

__str__()

Return str(self).

Return type:

str

class pyEDAA.ProjectModel.RDLSourceFile(path, project=None, design=None, fileSet=None)[source]

Base-class of all RDL source files.

Inheritance

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Any

alias of RDLSourceFile

property Design: Design | None

Property setting or returning the design this file is used in.

property FileSet: FileSet | None

Property setting or returning the fileset this file is used in.

property FileType: FileType

Read-only property to return the file type of this file.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

property Path: Path

Read-only property to access the path to the file.

Returns:

The file’s path.

property Project: Project | None

Property setting or returning the project this file is used in.

property ResolvedPath: Path

Read-only property returning the resolved path of this file.

Validate()

Validate this file.

Return type:

None

__delitem__(key)

Index access for deleting attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

None

__getitem__(key)

Index access for returning attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

Any

Returns:

The attribute’s value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

__init__(path, project=None, design=None, fileSet=None)

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Return type:

None

__len__()

Returns number of attributes set on this file.

Return type:

int

Returns:

The number of attributes set on this file.

__setitem__(key, value)

Index access for adding or setting attributes on this file.

Parameters:

• key (Type[Attribute]) – The attribute type.

• value (Any) – The attributes value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

Return type:

None

__str__()

Return str(self).

Return type:

str

class pyEDAA.ProjectModel.NetlistFile(path, project=None, design=None, fileSet=None)[source]

Base-class of all netlist source files.

Inheritance

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Any

alias of NetlistFile

property Design: Design | None

Property setting or returning the design this file is used in.

property FileSet: FileSet | None

Property setting or returning the fileset this file is used in.

property FileType: FileType

Read-only property to return the file type of this file.

classmethod GetMethodsWithAttributes(predicate: TAttr | Iterable[TAttr] | None = None) → Dict[Callable, Tuple[Attribute, ...]]

Parameters:

predicate (TypeVar(TAttr) | Iterable[TypeVar(TAttr)] | None)

Return type:

Dict[Callable, Tuple[Attribute, ...]]

Returns:

Raises:

• ValueError –

• ValueError –

property Path: Path

Read-only property to access the path to the file.

Returns:

The file’s path.

property Project: Project | None

Property setting or returning the project this file is used in.

property ResolvedPath: Path

Read-only property returning the resolved path of this file.

Validate()

Validate this file.

Return type:

None

__delitem__(key)

Index access for deleting attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

None

__getitem__(key)

Index access for returning attributes on this file.

Parameters:

key (Type[Attribute]) – The attribute type.

Return type:

Any

Returns:

The attribute’s value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

__getstate__() → Dict[str, Any]

Helper for pickle.

Return type:

Dict[str, Any]

__init__(path, project=None, design=None, fileSet=None)

Parameters:

• path (Path)

• project (Project | None)

• design (Design | None)

• fileSet (FileSet | None)

Return type:

None

__len__()

Returns number of attributes set on this file.

Return type:

int

Returns:

The number of attributes set on this file.

__setitem__(key, value)

Index access for adding or setting attributes on this file.

Parameters:

• key (Type[Attribute]) – The attribute type.

• value (Any) – The attributes value.

Raises:

TypeError – When parameter ‘key’ is not a subclass of Attribute.

Return type:

None

__str__()

Return str(self).

Return type:

str