v0.21.0

[Paebbels]

New Features

• Added method GetAncestor to ModelEntity.
• Added property DependencyGraph to Design.
• Added _compileOrderGraph and _hierarchyGraph fields as well as matching properties CompileOrderGraph and HierarchyGraph to Design.
• Added method AddLibrary to register a VHDL library in the design.
• Added method CreateCompilerOrderGraph on Design.
• Added key-value-pair "kind" : DependencyGraphEdgeKind on edges in the dependency graph.
• Implemented referencing library, package and context references in topological order to design units referencing a context.
• Added method LinkInstanziations on Design:
  • Handle EntityInstantiation statements.
• Added dummy methods for:
  • ComputeHierarchy
  • GetCompileOrder
  • GetTopLevel
  • GetUnusedDesignUnits
• Added field _compileOrderVertex and property CompileOrderVertex to Document.
• Added property DependencyVertex to Library.
• Added generator IterateDesignUnits to Document.
• Added __repr__ for design units.
• Added field _blocks to ConcurrentStatements.
• Added generator IterateInstantiations to ConcurrentStatements, IfGenerateStatement and CaseGenerateStatement.
• Added field _hierarchyVertex and property HierarchyVertex to DesignUnit.
• Added new "analyze" test cases to unit tests.

Changes

• Moved implementation of DesignUnitWithContextMixin to DesignUnit. The fields _contextItems, _libraryReferences, _packageReferences and _contextReferences as well as matching properties and initializer codes are now in DesignUnit.
• LoadStdLibrary and LoadIeeeLibrary now return the created VHDL library object.
• When calling AddDocument on Design, check if used library is part of the design.
• Bumped dependencies.
• Updated shield URL for GitHub Actions.
• Removed fields _declaredItems and _statements from Entity.
  (This is covered by ConcurrentDeclarations and ConcurrentStatements.)
• Change list of architectures for an entity to a dictionary for named lookups.
• Reworked ComponentInstantiation, ConfigurationInstantiation and EntityInstantiation.
• Extended flag members of DependencyGraphEdgeKind by references, instances and implementations.
• Improved instantiation test cases.

Bug Fixes

• Added missing "backward pointers" by setting _parent to appropriate values.
  This was missing in the entire model. (As this was a complete code walk-through, TODO and FIXME comments for potential problematic regions were added.)
• Fixed parameter names _leftOperand and _rightOperand, by removing the _.
• Added missing Nullable to type hints.
• Implemented missing field initialization code for Package.
• Fixed super call in PackageBody.__init__, Configuration.__init__, Entity.__init__ and Architecture.__init__.
• Fixed Package.Index, now using NormalizedLabel.
• Removed property DeclaredItems from Architecture.
  (This is covered by ConcurrentDeclarations.)
• Renamed parameters using range to rng to avoid overlap with Python builtins.

[codecov[bot]]

Codecov Report

Base: 60.48% // Head: 71.83% // Increases project coverage by +11.34% :tada:

Coverage data is based on head (ae14287) compared to base (b3c3d8e). Patch coverage: 48.74% of modified lines in pull request are covered.

:exclamation: Current head ae14287 differs from pull request most recent head 1884489. Consider uploading reports for the commit 1884489 to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #59 +/- ## =========================================== + Coverage 60.48% 71.83% +11.34% =========================================== Files 8 7 -1 Lines 3209 3511 +302 Branches 750 833 +83 =========================================== + Hits 1941 2522 +581 + Misses 1257 933 -324 - Partials 11 56 +45 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `71.83% <48.74%> (+11.34%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VHDL#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/VHDL/pyVHDLModel/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VHDL) | Coverage Δ | | |---|---|---| | [pyVHDLModel/SyntaxModel.py](https://codecov.io/gh/VHDL/pyVHDLModel/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VHDL#diff-cHlWSERMTW9kZWwvU3ludGF4TW9kZWwucHk=) | `68.47% <43.96%> (+8.23%)` | :arrow_up: | | [pyVHDLModel/\_\_init\_\_.py](https://codecov.io/gh/VHDL/pyVHDLModel/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VHDL#diff-cHlWSERMTW9kZWwvX19pbml0X18ucHk=) | `84.56% <86.56%> (+5.58%)` | :arrow_up: | | [tests/unit/Instantiate.py](https://codecov.io/gh/VHDL/pyVHDLModel/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VHDL#diff-dGVzdHMvdW5pdC9JbnN0YW50aWF0ZS5weQ==) | | | | [pyVHDLModel/std.py](https://codecov.io/gh/VHDL/pyVHDLModel/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VHDL#diff-cHlWSERMTW9kZWwvc3RkLnB5) | `97.10% <0.00%> (+97.10%)` | :arrow_up: | | [pyVHDLModel/ieee.py](https://codecov.io/gh/VHDL/pyVHDLModel/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VHDL#diff-cHlWSERMTW9kZWwvaWVlZS5weQ==) | `100.00% <0.00%> (+100.00%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VHDL). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VHDL)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.