pyEDAA.OSVVM.Project

Submodules

• pyEDAA.OSVVM.Project.Procedures
• pyEDAA.OSVVM.Project.TCL

Variables

• osvvmContext

Classes

• Base: Abstract base class for generic types.

• Named: Abstract base class for generic types.

• Option: Undocumented.

• NoNullRangeWarning: Undocumented.

• SourceFile: A base-class describing any source file (VHDL, Verilog, …) supported by OSVVM Scripts.

• XDCConstraintFile: A base-class describing any source file (VHDL, Verilog, …) supported by OSVVM Scripts.

• VHDLSourceFile: A base-class describing any source file (VHDL, Verilog, …) supported by OSVVM Scripts.

• VHDLLibrary: A VHDL library collecting multiple VHDL files containing VHDL design units.

• GenericValue: Undocumented.

• ConstraintFile: Undocumented.

• ScopeToRef: Undocumented.

• ScopeToCell: Undocumented.

• Testcase: Abstract base class for generic types.

• Testsuite: Abstract base class for generic types.

• BuildName: Undocumented.

• Build: Abstract base class for generic types.

• Project: Abstract base class for generic types.

• Context: Abstract base class for generic types.

---

Variables

pyEDAA.OSVVM.Project.osvvmContext

Global OSVVM processing context.

Type:

Context

<pyEDAA.OSVVM.Project.Context object at 0x7f4ba7ef3060>

---

Classes

class pyEDAA.OSVVM.Project.Base(parent=None)

Inheritance

Parameters:

parent (_ParentType | None)

__init__(parent=None)

Parameters:

parent (_ParentType | None)

Return type:

None

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class pyEDAA.OSVVM.Project.Named(name, parent=None)

Inheritance

Parameters:

• name (str)

• parent (_ParentType | None)

__init__(name, parent=None)

Parameters:

• name (str)

• parent (_ParentType | None)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class pyEDAA.OSVVM.Project.Option

Inheritance

class pyEDAA.OSVVM.Project.NoNullRangeWarning

Inheritance

__init__()

Return type:

None

__repr__()

Return repr(self).

Return type:

str

class pyEDAA.OSVVM.Project.SourceFile(path, parent=None)

A base-class describing any source file (VHDL, Verilog, …) supported by OSVVM Scripts.

Inheritance

Parameters:

• path (Path)

• parent (Base | None)

__init__(path, parent=None)

Parameters:

• path (Path)

• parent (Base | None)

Return type:

None

property Path: Path

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

Returns:

The sourcefile’s path.

__repr__()

Return repr(self).

Return type:

str

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class pyEDAA.OSVVM.Project.XDCConstraintFile(path, scopeToRef, scopeToCell)

Inheritance

Parameters:

• path (Path)

• scopeToRef (str | None)

• scopeToCell (str | None)

__init__(path, scopeToRef, scopeToCell)

Parameters:

• path (Path)

• scopeToRef (str | None)

• scopeToCell (str | None)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

property Path: Path

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

Returns:

The sourcefile’s path.

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class pyEDAA.OSVVM.Project.VHDLSourceFile(path, vhdlVersion=2008, vhdlLibrary=None, noNullRangeWarning=None, associatedFiles=None)

Inheritance

Parameters:

• path (Path)

• vhdlVersion (VHDLVersion)

• vhdlLibrary (VHDLLibrary | None)

• noNullRangeWarning (bool | None)

• associatedFiles (Iterable[SourceFile] | None)

__init__(path, vhdlVersion=2008, vhdlLibrary=None, noNullRangeWarning=None, associatedFiles=None)

Parameters:

• path (Path)

• vhdlVersion (VHDLVersion)

• vhdlLibrary (VHDLLibrary | None)

• noNullRangeWarning (bool | None)

• associatedFiles (Iterable[SourceFile] | None)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

property Path: Path

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

Returns:

The sourcefile’s path.

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class pyEDAA.OSVVM.Project.VHDLLibrary(name, vhdlFiles=None, build=None)

A VHDL library collecting multiple VHDL files containing VHDL design units.

Inheritance

Parameters:

• name (str)

• vhdlFiles (Iterable[VHDLSourceFile] | None)

• build (Build | None)

__init__(name, vhdlFiles=None, build=None)

Parameters:

• name (str)

• vhdlFiles (Iterable[VHDLSourceFile] | None)

• build (Build | None)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class pyEDAA.OSVVM.Project.GenericValue(name, value)

Inheritance

Parameters:

• name (str)

• value (str)

__init__(name, value)

Parameters:

• name (str)

• value (str)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

class pyEDAA.OSVVM.Project.ConstraintFile(path, scopeToRef=None, scopeToCell=None)

Inheritance

Parameters:

• path (Path)

• scopeToRef (str | None)

• scopeToCell (str | None)

__init__(path, scopeToRef=None, scopeToCell=None)

Parameters:

• path (Path)

• scopeToRef (str | None)

• scopeToCell (str | None)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

class pyEDAA.OSVVM.Project.ScopeToRef(reference)

Inheritance

Parameters:

reference (str)

__init__(reference)

Parameters:

reference (str)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

class pyEDAA.OSVVM.Project.ScopeToCell(cell)

Inheritance

Parameters:

cell (str)

__init__(cell)

Parameters:

cell (str)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

class pyEDAA.OSVVM.Project.Testcase(name, toplevelName=None, generics=None, testsuite=None)

Inheritance

Parameters:

• name (str)

• toplevelName (str | None)

• generics (Iterable[GenericValue] | Mapping[str, str] | None)

• testsuite (Testsuite | None)

__init__(name, toplevelName=None, generics=None, testsuite=None)

Parameters:

• name (str)

• toplevelName (str | None)

• generics (Iterable[GenericValue] | Mapping[str, str] | None)

• testsuite (Testsuite | None)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class pyEDAA.OSVVM.Project.Testsuite(name, testcases=None, build=None)

Inheritance

Parameters:

• name (str)

• testcases (Iterable[Testcase] | Mapping[str, Testcase] | None)

• build (Build | None)

__init__(name, testcases=None, build=None)

Parameters:

• name (str)

• testcases (Iterable[Testcase] | Mapping[str, Testcase] | None)

• build (Build | None)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class pyEDAA.OSVVM.Project.BuildName(name)

Inheritance

Parameters:

name (str)

__init__(name)

Parameters:

name (str)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

class pyEDAA.OSVVM.Project.Build(name, vhdlLibraries=None, testsuites=None, project=None)

Inheritance

Parameters:

• name (str)

• vhdlLibraries (Iterable[VHDLLibrary] | Mapping[str, VHDLLibrary] | None)

• testsuites (Iterable[Testsuite] | Mapping[str, Testsuite] | None)

• project (Base | None)

__init__(name, vhdlLibraries=None, testsuites=None, project=None)

Parameters:

• name (str)

• vhdlLibraries (Iterable[VHDLLibrary] | Mapping[str, VHDLLibrary] | None)

• testsuites (Iterable[Testsuite] | Mapping[str, Testsuite] | None)

• project (Base | None)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class pyEDAA.OSVVM.Project.Project(name, builds=None)

Inheritance

Parameters:

• name (str)

• builds (Iterable[Build] | Mapping[str, Build] | None)

__init__(name, builds=None)

Parameters:

• name (str)

• builds (Iterable[Build] | Mapping[str, Build] | None)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class pyEDAA.OSVVM.Project.Context

Inheritance

__init__()

Return type:

None

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.