pyGHDL.libghdl._types
Variables
Classes
TriStateType: Enum where members are also (and must be) intsDirectionType: Enum where members are also (and must be) ints
Variables
- pyGHDL.libghdl._types.ErrorIndex
Type variable.
The preferred way to construct a type variable is via the dedicated syntax for generic functions, classes, and type aliases:
class Sequence[T]: # T is a TypeVar ...
This syntax can also be used to create bound and constrained type variables:
# S is a TypeVar bound to str class StrSequence[S: str]: ... # A is a TypeVar constrained to str or bytes class StrOrBytesSequence[A: (str, bytes)]: ...
Type variables can also have defaults:
- class IntDefault[T = int]:
…
However, if desired, reusable type variables can also be constructed manually, like so:
T = TypeVar('T') # Can be anything S = TypeVar('S', bound=str) # Can be any subtype of str A = TypeVar('A', str, bytes) # Must be exactly str or bytes D = TypeVar('D', default=int) # Defaults to int
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 and type alias definitions.
The variance of type variables is inferred by type checkers when they are created through the type parameter syntax and when
infer_variance=Trueis passed. Manually created type variables may be explicitly marked covariant or contravariant by passingcovariant=Trueorcontravariant=True. By default, manually created type variables are invariant. See PEP 484 and PEP 695 for more details.~ErrorIndex
- pyGHDL.libghdl._types.MessageIdWarnings
Type variable.
The preferred way to construct a type variable is via the dedicated syntax for generic functions, classes, and type aliases:
class Sequence[T]: # T is a TypeVar ...
This syntax can also be used to create bound and constrained type variables:
# S is a TypeVar bound to str class StrSequence[S: str]: ... # A is a TypeVar constrained to str or bytes class StrOrBytesSequence[A: (str, bytes)]: ...
Type variables can also have defaults:
- class IntDefault[T = int]:
…
However, if desired, reusable type variables can also be constructed manually, like so:
T = TypeVar('T') # Can be anything S = TypeVar('S', bound=str) # Can be any subtype of str A = TypeVar('A', str, bytes) # Must be exactly str or bytes D = TypeVar('D', default=int) # Defaults to int
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 and type alias definitions.
The variance of type variables is inferred by type checkers when they are created through the type parameter syntax and when
infer_variance=Trueis passed. Manually created type variables may be explicitly marked covariant or contravariant by passingcovariant=Trueorcontravariant=True. By default, manually created type variables are invariant. See PEP 484 and PEP 695 for more details.~MessageIdWarnings
- pyGHDL.libghdl._types.NameId
Type variable.
The preferred way to construct a type variable is via the dedicated syntax for generic functions, classes, and type aliases:
class Sequence[T]: # T is a TypeVar ...
This syntax can also be used to create bound and constrained type variables:
# S is a TypeVar bound to str class StrSequence[S: str]: ... # A is a TypeVar constrained to str or bytes class StrOrBytesSequence[A: (str, bytes)]: ...
Type variables can also have defaults:
- class IntDefault[T = int]:
…
However, if desired, reusable type variables can also be constructed manually, like so:
T = TypeVar('T') # Can be anything S = TypeVar('S', bound=str) # Can be any subtype of str A = TypeVar('A', str, bytes) # Must be exactly str or bytes D = TypeVar('D', default=int) # Defaults to int
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 and type alias definitions.
The variance of type variables is inferred by type checkers when they are created through the type parameter syntax and when
infer_variance=Trueis passed. Manually created type variables may be explicitly marked covariant or contravariant by passingcovariant=Trueorcontravariant=True. By default, manually created type variables are invariant. See PEP 484 and PEP 695 for more details.~NameId
- pyGHDL.libghdl._types.SourceFileEntry
Type variable.
The preferred way to construct a type variable is via the dedicated syntax for generic functions, classes, and type aliases:
class Sequence[T]: # T is a TypeVar ...
This syntax can also be used to create bound and constrained type variables:
# S is a TypeVar bound to str class StrSequence[S: str]: ... # A is a TypeVar constrained to str or bytes class StrOrBytesSequence[A: (str, bytes)]: ...
Type variables can also have defaults:
- class IntDefault[T = int]:
…
However, if desired, reusable type variables can also be constructed manually, like so:
T = TypeVar('T') # Can be anything S = TypeVar('S', bound=str) # Can be any subtype of str A = TypeVar('A', str, bytes) # Must be exactly str or bytes D = TypeVar('D', default=int) # Defaults to int
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 and type alias definitions.
The variance of type variables is inferred by type checkers when they are created through the type parameter syntax and when
infer_variance=Trueis passed. Manually created type variables may be explicitly marked covariant or contravariant by passingcovariant=Trueorcontravariant=True. By default, manually created type variables are invariant. See PEP 484 and PEP 695 for more details.~SourceFileEntry
- pyGHDL.libghdl._types.Iir
Type variable.
The preferred way to construct a type variable is via the dedicated syntax for generic functions, classes, and type aliases:
class Sequence[T]: # T is a TypeVar ...
This syntax can also be used to create bound and constrained type variables:
# S is a TypeVar bound to str class StrSequence[S: str]: ... # A is a TypeVar constrained to str or bytes class StrOrBytesSequence[A: (str, bytes)]: ...
Type variables can also have defaults:
- class IntDefault[T = int]:
…
However, if desired, reusable type variables can also be constructed manually, like so:
T = TypeVar('T') # Can be anything S = TypeVar('S', bound=str) # Can be any subtype of str A = TypeVar('A', str, bytes) # Must be exactly str or bytes D = TypeVar('D', default=int) # Defaults to int
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 and type alias definitions.
The variance of type variables is inferred by type checkers when they are created through the type parameter syntax and when
infer_variance=Trueis passed. Manually created type variables may be explicitly marked covariant or contravariant by passingcovariant=Trueorcontravariant=True. By default, manually created type variables are invariant. See PEP 484 and PEP 695 for more details.~Iir
- pyGHDL.libghdl._types.IirKind
Type variable.
The preferred way to construct a type variable is via the dedicated syntax for generic functions, classes, and type aliases:
class Sequence[T]: # T is a TypeVar ...
This syntax can also be used to create bound and constrained type variables:
# S is a TypeVar bound to str class StrSequence[S: str]: ... # A is a TypeVar constrained to str or bytes class StrOrBytesSequence[A: (str, bytes)]: ...
Type variables can also have defaults:
- class IntDefault[T = int]:
…
However, if desired, reusable type variables can also be constructed manually, like so:
T = TypeVar('T') # Can be anything S = TypeVar('S', bound=str) # Can be any subtype of str A = TypeVar('A', str, bytes) # Must be exactly str or bytes D = TypeVar('D', default=int) # Defaults to int
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 and type alias definitions.
The variance of type variables is inferred by type checkers when they are created through the type parameter syntax and when
infer_variance=Trueis passed. Manually created type variables may be explicitly marked covariant or contravariant by passingcovariant=Trueorcontravariant=True. By default, manually created type variables are invariant. See PEP 484 and PEP 695 for more details.~IirKind
Classes
- class pyGHDL.libghdl._types.TriStateType(*values)[source]
Inheritance
- __format__(format_spec, /)
Convert to a string according to format_spec.
- __str__()
Return repr(self).
- __repr__()
Return repr(self).
- __new__(value)
- __hash__()
Return hash(self).
- __lt__(value, /)
Return self<value.
- __le__(value, /)
Return self<=value.
- __eq__(value, /)
Return self==value.
- __ne__(value, /)
Return self!=value.
- __gt__(value, /)
Return self>value.
- __ge__(value, /)
Return self>=value.
- __add__(value, /)
Return self+value.
- __radd__(value, /)
Return value+self.
- __sub__(value, /)
Return self-value.
- __rsub__(value, /)
Return value-self.
- __mul__(value, /)
Return self*value.
- __rmul__(value, /)
Return value*self.
- __mod__(value, /)
Return self%value.
- __rmod__(value, /)
Return value%self.
- __divmod__(value, /)
Return divmod(self, value).
- __rdivmod__(value, /)
Return divmod(value, self).
- __pow__(value, mod=None, /)
Return pow(self, value, mod).
- __rpow__(value, mod=None, /)
Return pow(value, self, mod).
- __neg__()
-self
- __pos__()
+self
- __abs__()
abs(self)
- __bool__()
True if self else False
- __invert__()
~self
- __lshift__(value, /)
Return self<<value.
- __rlshift__(value, /)
Return value<<self.
- __rshift__(value, /)
Return self>>value.
- __rrshift__(value, /)
Return value>>self.
- __and__(value, /)
Return self&value.
- __rand__(value, /)
Return value&self.
- __xor__(value, /)
Return self^value.
- __rxor__(value, /)
Return value^self.
- __or__(value, /)
Return self|value.
- __ror__(value, /)
Return value|self.
- __int__()
int(self)
- __float__()
float(self)
- __floordiv__(value, /)
Return self//value.
- __rfloordiv__(value, /)
Return value//self.
- __truediv__(value, /)
Return self/value.
- __rtruediv__(value, /)
Return value/self.
- __index__()
Return self converted to an integer, if self is suitable for use as an index into a list.
- conjugate()
Returns self, the complex conjugate of any int.
- bit_length()
Number of bits necessary to represent self in binary.
>>> bin(37) '0b100101' >>> (37).bit_length() 6
- bit_count()
Number of ones in the binary representation of the absolute value of self.
Also known as the population count.
>>> bin(13) '0b1101' >>> (13).bit_count() 3
- to_bytes(length=1, byteorder='big', *, signed=False)
Return an array of bytes representing an integer.
- length
Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
- byteorder
The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.
- signed
Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.
- classmethod from_bytes(bytes, byteorder='big', *, signed=False)
Return the integer represented by the given array of bytes.
- bytes
Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
- byteorder
The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.
- signed
Indicates whether two’s complement is used to represent the integer.
- as_integer_ratio()
Return a pair of integers, whose ratio is equal to the original int.
The ratio is in lowest terms and has a positive denominator.
>>> (10).as_integer_ratio() (10, 1) >>> (-10).as_integer_ratio() (-10, 1) >>> (0).as_integer_ratio() (0, 1)
- __trunc__()
Truncating an Integral returns itself.
- __floor__()
Flooring an Integral returns itself.
- __ceil__()
Ceiling of an Integral returns itself.
- __round__(ndigits=None, /)
Rounding an Integral returns itself.
Rounding with an ndigits argument also returns an integer.
- __sizeof__()
Returns size in memory, in bytes.
- is_integer()
Returns True. Exists for duck type compatibility with float.is_integer.
- real
the real part of a complex number
- imag
the imaginary part of a complex number
- numerator
the numerator of a rational number in lowest terms
- denominator
the denominator of a rational number in lowest terms
- classmethod __contains__(value)
Return True if value is in cls.
value is in cls if: 1) value is a member of cls, or 2) value is the value of one of the cls’s members. 3) value is a pseudo-member (flags)
- __dir__()
Returns public methods and other interesting attributes.
- classmethod __getitem__(name)
Return the member matching name.
- classmethod __iter__()
Return members in definition order.
- classmethod __len__()
Return the number of members (no aliases)
- __reduce_ex__(proto)
Helper for pickle.
- class pyGHDL.libghdl._types.DirectionType(*values)[source]
Inheritance
- __format__(format_spec, /)
Convert to a string according to format_spec.
- __str__()
Return repr(self).
- __repr__()
Return repr(self).
- __new__(value)
- __hash__()
Return hash(self).
- __lt__(value, /)
Return self<value.
- __le__(value, /)
Return self<=value.
- __eq__(value, /)
Return self==value.
- __ne__(value, /)
Return self!=value.
- __gt__(value, /)
Return self>value.
- __ge__(value, /)
Return self>=value.
- __add__(value, /)
Return self+value.
- __radd__(value, /)
Return value+self.
- __sub__(value, /)
Return self-value.
- __rsub__(value, /)
Return value-self.
- __mul__(value, /)
Return self*value.
- __rmul__(value, /)
Return value*self.
- __mod__(value, /)
Return self%value.
- __rmod__(value, /)
Return value%self.
- __divmod__(value, /)
Return divmod(self, value).
- __rdivmod__(value, /)
Return divmod(value, self).
- __pow__(value, mod=None, /)
Return pow(self, value, mod).
- __rpow__(value, mod=None, /)
Return pow(value, self, mod).
- __neg__()
-self
- __pos__()
+self
- __abs__()
abs(self)
- __bool__()
True if self else False
- __invert__()
~self
- __lshift__(value, /)
Return self<<value.
- __rlshift__(value, /)
Return value<<self.
- __rshift__(value, /)
Return self>>value.
- __rrshift__(value, /)
Return value>>self.
- __and__(value, /)
Return self&value.
- __rand__(value, /)
Return value&self.
- __xor__(value, /)
Return self^value.
- __rxor__(value, /)
Return value^self.
- __or__(value, /)
Return self|value.
- __ror__(value, /)
Return value|self.
- __int__()
int(self)
- __float__()
float(self)
- __floordiv__(value, /)
Return self//value.
- __rfloordiv__(value, /)
Return value//self.
- __truediv__(value, /)
Return self/value.
- __rtruediv__(value, /)
Return value/self.
- __index__()
Return self converted to an integer, if self is suitable for use as an index into a list.
- conjugate()
Returns self, the complex conjugate of any int.
- bit_length()
Number of bits necessary to represent self in binary.
>>> bin(37) '0b100101' >>> (37).bit_length() 6
- bit_count()
Number of ones in the binary representation of the absolute value of self.
Also known as the population count.
>>> bin(13) '0b1101' >>> (13).bit_count() 3
- to_bytes(length=1, byteorder='big', *, signed=False)
Return an array of bytes representing an integer.
- length
Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
- byteorder
The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.
- signed
Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.
- classmethod from_bytes(bytes, byteorder='big', *, signed=False)
Return the integer represented by the given array of bytes.
- bytes
Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
- byteorder
The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.
- signed
Indicates whether two’s complement is used to represent the integer.
- as_integer_ratio()
Return a pair of integers, whose ratio is equal to the original int.
The ratio is in lowest terms and has a positive denominator.
>>> (10).as_integer_ratio() (10, 1) >>> (-10).as_integer_ratio() (-10, 1) >>> (0).as_integer_ratio() (0, 1)
- __trunc__()
Truncating an Integral returns itself.
- __floor__()
Flooring an Integral returns itself.
- __ceil__()
Ceiling of an Integral returns itself.
- __round__(ndigits=None, /)
Rounding an Integral returns itself.
Rounding with an ndigits argument also returns an integer.
- __sizeof__()
Returns size in memory, in bytes.
- is_integer()
Returns True. Exists for duck type compatibility with float.is_integer.
- real
the real part of a complex number
- imag
the imaginary part of a complex number
- numerator
the numerator of a rational number in lowest terms
- denominator
the denominator of a rational number in lowest terms
- classmethod __contains__(value)
Return True if value is in cls.
value is in cls if: 1) value is a member of cls, or 2) value is the value of one of the cls’s members. 3) value is a pseudo-member (flags)
- __dir__()
Returns public methods and other interesting attributes.
- classmethod __getitem__(name)
Return the member matching name.
- classmethod __iter__()
Return members in definition order.
- classmethod __len__()
Return the number of members (no aliases)
- __reduce_ex__(proto)
Helper for pickle.