pyGHDL.libghdl.file_comments#
Variables
Functions
Find_First_Comment(): Get the first comment associated to a node.Get_Comment_Start(): Get the start of commentGet_Comment_Last(): Get the end of commentGet_Next_Comment(): Get the next comment
Variables
- pyGHDL.libghdl.file_comments.Comment_Index#
Type variable.
Usage:
T = TypeVar('T') # Can be anything A = TypeVar('A', str, bytes) # Must be str or bytes
Type variables exist primarily for the benefit of static type checkers. They serve as the parameters for generic types as well as for generic function definitions. See class Generic for more information on generic types. Generic functions work as follows:
- def repeat(x: T, n: int) -> List[T]:
‘’’Return a list containing n references to x.’’’ return [x]*n
- def longest(x: A, y: A) -> A:
‘’’Return the longest of two strings.’’’ return x if len(x) >= len(y) else y
The latter example’s signature is essentially the overloading of (str, str) -> str and (bytes, bytes) -> bytes. Also note that if the arguments are instances of some subclass of str, the return type is still plain str.
At runtime, isinstance(x, T) and issubclass(C, T) will raise TypeError.
Type variables defined with covariant=True or contravariant=True can be used to declare covariant or contravariant generic types. See PEP 484 for more details. By default generic types are invariant in all type variables.
Type variables can be introspected. e.g.:
T.__name__ == ‘T’ T.__constraints__ == () T.__covariant__ == False T.__contravariant__ = False A.__constraints__ == (str, bytes)
Note that only type variables defined in global scope can be pickled.
~Comment_Index
- pyGHDL.libghdl.file_comments.No_Comment_Index#
int([x]) -> integer int(x, base=10) -> integer
Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.__int__(). For floating point numbers, this truncates towards zero.
If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by ‘+’ or ‘-’ and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal. >>> int(‘0b100’, base=0) 4
0
Functions
- pyGHDL.libghdl.file_comments.Find_First_Comment(File, N)[source]#
Get the first comment associated to a node. :type N:
c_uint:param N: Node :type File:TypeVar(SourceFileEntry, bound=c_uint) :param File: Source file for node :rtype:TypeVar(Comment_Index, bound=c_uint) :return: The first comment index, or No_Comment_Index if none.- Parameters:
File (SourceFileEntry) –
N (c_uint) –
- Return type:
Comment_Index