aboutsummaryrefslogtreecommitdiffstats
path: root/pyGHDL/libghdl/libraries.py
diff options
context:
space:
mode:
authorXiretza <xiretza@xiretza.xyz>2021-02-10 19:17:23 +0100
committertgingold <tgingold@users.noreply.github.com>2021-02-10 21:36:22 +0100
commitd52693df5bc7480c3917b7248f8602f2942aeab7 (patch)
tree6404e02d6f053a6b53c561c6b60a6a54152a9e63 /pyGHDL/libghdl/libraries.py
parent8f563f9df8ad94e44f1bd8eecd91d5611e507cc7 (diff)
downloadghdl-d52693df5bc7480c3917b7248f8602f2942aeab7.tar.gz
ghdl-d52693df5bc7480c3917b7248f8602f2942aeab7.tar.bz2
ghdl-d52693df5bc7480c3917b7248f8602f2942aeab7.zip
pyGHDL: format using black
Diffstat (limited to 'pyGHDL/libghdl/libraries.py')
-rw-r--r--pyGHDL/libghdl/libraries.py103
1 files changed, 52 insertions, 51 deletions
diff --git a/pyGHDL/libghdl/libraries.py b/pyGHDL/libghdl/libraries.py
index 0c302ff47..5cc110c8f 100644
--- a/pyGHDL/libghdl/libraries.py
+++ b/pyGHDL/libghdl/libraries.py
@@ -38,90 +38,91 @@ from pydecor import export
from pyGHDL.libghdl import libghdl
-__all__ = [
- 'Library_Location',
- 'Work_Library'
-]
+__all__ = ["Library_Location", "Work_Library"]
from pyGHDL.libghdl._types import NameId
-Library_Location = c_int32.in_dll(libghdl, "libraries__library_location") #: A location for library declarations (such as library WORK). Type ``Location_Type``. Use ``.value`` to access this variable inside libghdl
-Work_Library = c_int32.in_dll(libghdl, "libraries__work_library") #: Library declaration for the work library. Note: the identifier of the work_library is ``work_library_name``, which may be different from 'WORK'. Type: ``Iir_Library_Declaration``. Use ``.value`` to access this variable inside libghdl
+Library_Location = c_int32.in_dll(
+ libghdl, "libraries__library_location"
+) #: A location for library declarations (such as library WORK). Type ``Location_Type``. Use ``.value`` to access this variable inside libghdl
+Work_Library = c_int32.in_dll(
+ libghdl, "libraries__work_library"
+) #: Library declaration for the work library. Note: the identifier of the work_library is ``work_library_name``, which may be different from 'WORK'. Type: ``Iir_Library_Declaration``. Use ``.value`` to access this variable inside libghdl
@export
def Get_Libraries_Chain():
- """
- Get the chain of libraries. Can be used only to read (it mustn't be modified).
+ """
+ Get the chain of libraries. Can be used only to read (it mustn't be modified).
- :return: Type ``Iir_Library_Declaration``
- """
- return libghdl.libraries__get_libraries_chain()
+ :return: Type ``Iir_Library_Declaration``
+ """
+ return libghdl.libraries__get_libraries_chain()
@export
def Add_Design_Unit_Into_Library(Unit, Keep_Obsolete: bool = False) -> None:
- """
- Add or replace an design unit in the work library. DECL must not have a chain
- (because it may be modified).
+ """
+ Add or replace an design unit in the work library. DECL must not have a chain
+ (because it may be modified).
- If the design_file of UNIT is not already in the library, a new one is created.
+ If the design_file of UNIT is not already in the library, a new one is created.
- Units are always appended to the design_file. Therefore, the order is kept.
+ Units are always appended to the design_file. Therefore, the order is kept.
- :param Unit: Type: ``Iir_Design_Unit``
- :param Keep_Obsolete: If :obj:`Keep_Obsolete` is True, obsoleted units are
- kept in the library.
+ :param Unit: Type: ``Iir_Design_Unit``
+ :param Keep_Obsolete: If :obj:`Keep_Obsolete` is True, obsoleted units are
+ kept in the library.
- This is used when a whole design file has to be added
- in the library and then processed (without that feature,
- redefined units would disappear).
- """
- libghdl.libraries__add_design_unit_into_library(Unit, Keep_Obsolete)
+ This is used when a whole design file has to be added
+ in the library and then processed (without that feature,
+ redefined units would disappear).
+ """
+ libghdl.libraries__add_design_unit_into_library(Unit, Keep_Obsolete)
@export
def Purge_Design_File(Design_File) -> None:
- """
- Remove the same file as DESIGN_FILE from work library and all of its units.
+ """
+ Remove the same file as DESIGN_FILE from work library and all of its units.
- :param Design_File: Type: ``Iir_Design_File``
- """
- libghdl.libraries__purge_design_file(Design_File)
+ :param Design_File: Type: ``Iir_Design_File``
+ """
+ libghdl.libraries__purge_design_file(Design_File)
@export
def Find_Entity_For_Component(Name: NameId):
- """
- Find an entity whose name is :obj:`Name` in any library. |br|
- If there is no such entity, return :attr:`~pyGHDL.libghdl.vhdl.nodes.Null_Iir`. |br|
- If there are several entities, return :attr:`~pyGHDL.libghdl.vhdl.nodes.Null_Iir`;
+ """
+ Find an entity whose name is :obj:`Name` in any library. |br|
+ If there is no such entity, return :attr:`~pyGHDL.libghdl.vhdl.nodes.Null_Iir`. |br|
+ If there are several entities, return :attr:`~pyGHDL.libghdl.vhdl.nodes.Null_Iir`;
- :param Name: Entity name to search for.
- :return: Type: ``Iir_Design_Unit``
- """
- return libghdl.libraries__find_entity_for_component(Name)
+ :param Name: Entity name to search for.
+ :return: Type: ``Iir_Design_Unit``
+ """
+ return libghdl.libraries__find_entity_for_component(Name)
@export
def Get_Library_No_Create(Ident: NameId):
- """
- Get the library named :obj:`Ident`.
+ """
+ Get the library named :obj:`Ident`.
- :param Ident: Libryr to look for.
- :return: Return :attr:`~pyGHDL.libghdl.vhdl.nodes.Null_Iir` if it doesn't exist. Type ``Iir_Library_Declaration``
- """
- return libghdl.libraries__get_library_no_create(Ident)
+ :param Ident: Libryr to look for.
+ :return: Return :attr:`~pyGHDL.libghdl.vhdl.nodes.Null_Iir` if it doesn't exist. Type ``Iir_Library_Declaration``
+ """
+ return libghdl.libraries__get_library_no_create(Ident)
@export
def Find_Primary_Unit(Library, Name: NameId):
- """
- Just return the design_unit for :obj:`Name`, or ``NULL`` if not found.
-
- :param Library: Library to look in. Type: ``Iir_Library_Declaration``
- :param Name: Primary unit to search for.
- :return: Type: ``Iir_Design_Unit``
- """
- return libghdl.libraries__find_primary_unit(Library, Name)
+ """
+ Just return the design_unit for :obj:`Name`, or ``NULL`` if not found.
+
+ :param Library: Library to look in. Type: ``Iir_Library_Declaration``
+ :param Name: Primary unit to search for.
+ :return: Type: ``Iir_Design_Unit``
+ """
+ return libghdl.libraries__find_primary_unit(Library, Name)