| | |
- enum.IntEnum(builtins.int, enum.ReprEnum)
-
- runtimepy.net.tcp.telnet.codes.TelnetCode
- runtimepy.net.tcp.telnet.codes.TelnetNvt
- runtimepy.net.tcp.connection.TcpConnection(runtimepy.net.connection.Connection, runtimepy.net.mixin.TransportMixin)
-
- Telnet
-
- BasicTelnet
class BasicTelnet(Telnet) |
| |
BasicTelnet(transport: asyncio.transports.Transport, protocol: runtimepy.net.tcp.protocol.QueueProtocol) -> None
A simple telnet implementation.
|
| |
- Method resolution order:
- BasicTelnet
- Telnet
- runtimepy.net.tcp.connection.TcpConnection
- runtimepy.net.connection.Connection
- runtimepy.mixins.logging.LoggerMixinLevelControl
- vcorelib.logging.LoggerMixin
- runtimepy.mixins.environment.ChannelEnvironmentMixin
- abc.ABC
- runtimepy.net.mixin.TransportMixin
- builtins.object
Methods defined here:
- async handle_nvt(self, action: runtimepy.net.tcp.telnet.codes.TelnetNvt) -> None
- Handle a signal for the network virtual-terminal.
- async process_command(self, code: runtimepy.net.tcp.telnet.codes.TelnetCode) -> None
- Process a telnet command.
- async process_option(self, code: runtimepy.net.tcp.telnet.codes.TelnetCode, option: int, _: <class 'BinaryIO'>) -> None
- Process a telnet option.
- async process_text(self, data: str) -> bool
- Process a text frame.
Data and other attributes defined here:
- __abstractmethods__ = frozenset()
- __annotations__ = {}
Methods inherited from Telnet:
- async process_binary(self, data: bytes) -> bool
- Process a binary frame.
- async process_telnet_message(self, data: bytes) -> bool
- By default, treat all incoming data bytes as text.
- send_command(self, code: runtimepy.net.tcp.telnet.codes.TelnetCode) -> None
- Send a telnet command.
- send_option(self, option: runtimepy.net.tcp.telnet.codes.TelnetCode, code: int) -> None
- Send a telnet option sequence. if the 'SB' is the desired code, the
additional data can be sent using the 'send_binary' method directly.
Data and other attributes inherited from Telnet:
- log_alias = 'TELNET'
Methods inherited from runtimepy.net.tcp.connection.TcpConnection:
- __init__(self, transport: asyncio.transports.Transport, protocol: runtimepy.net.tcp.protocol.QueueProtocol) -> None
- Initialize this TCP connection.
- async close(self) -> None
- Close this connection.
- async restart(self) -> bool
- Reset necessary underlying state for this connection to 'process'
again.
- send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None
- Enqueue a binary message tos end.
- send_text(self, data: str) -> None
- Enqueue a text message to send.
Class methods inherited from runtimepy.net.tcp.connection.TcpConnection:
- async app(stop_sig: asyncio.locks.Event, callback: Callable[[~T], NoneType] = None, serving_callback: Callable[[Any], NoneType] = None, manager: runtimepy.net.manager.ConnectionManager = None, **kwargs) -> None from abc.ABCMeta
- Run an application that serves new connections.
- async create_connection(backoff: runtimepy.net.backoff.ExponentialBackoff = None, **kwargs) -> ~T from abc.ABCMeta
- Create a TCP connection.
- create_pair() -> AsyncIterator[tuple[~T, ~T]] from abc.ABCMeta
- Create a connection pair.
- serve(callback: Callable[[~T], NoneType] = None, **kwargs) -> AsyncIterator[Any] from abc.ABCMeta
- Serve incoming connections.
Data and other attributes inherited from runtimepy.net.tcp.connection.TcpConnection:
- log_prefix = ''
- uses_binary_tx_queue = False
- uses_text_tx_queue = False
Methods inherited from runtimepy.net.connection.Connection:
- async async_init(self) -> bool
- A runtime initialization routine (executes during 'process').
- disable(self, reason: str) -> None
- Disable this connection.
- disable_extra(self) -> None
- Additional tasks to perform when disabling.
- async disable_in(self, time: float) -> None
- A method for disabling a connection after some delay.
- init(self) -> None
- Initialize this instance.
- log_metrics(self, label: str = 'conn') -> None
- Log connection metrics.
- async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None
- Process tasks for this connection while the connection is active.
Readonly properties inherited from runtimepy.net.connection.Connection:
- auto_restart
- Determine if this connection should be automatically restarted.
- disabled
- Determine if this connection is disabled.
Data and other attributes inherited from runtimepy.net.connection.Connection:
- byte_order = <ByteOrder.NETWORK: 4>
- connected = True
- default_auto_restart = False
Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:
- setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None
- Add a commandable log-level channel to the environment.
Methods inherited from vcorelib.logging.LoggerMixin:
- log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]
- A simple wrapper.
Data descriptors inherited from vcorelib.logging.LoggerMixin:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:
- register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None
- Register individual channel metrics.
- register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None
- Register connection metrics.
- register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None
- Register periodic task metrics.
Methods inherited from runtimepy.net.mixin.TransportMixin:
- logger_name(self, prefix: 'str' = '') -> 'str'
- Get a logger name for this connection.
- set_transport(self, transport: '_asyncio.BaseTransport') -> 'None'
- Set the transport for this instance.
Readonly properties inherited from runtimepy.net.mixin.TransportMixin:
- socket
- Get this instance's underlying socket.
|
class Telnet(runtimepy.net.tcp.connection.TcpConnection) |
| |
Telnet(transport: asyncio.transports.Transport, protocol: runtimepy.net.tcp.protocol.QueueProtocol) -> None
A class implementing a basic telnet interface.
|
| |
- Method resolution order:
- Telnet
- runtimepy.net.tcp.connection.TcpConnection
- runtimepy.net.connection.Connection
- runtimepy.mixins.logging.LoggerMixinLevelControl
- vcorelib.logging.LoggerMixin
- runtimepy.mixins.environment.ChannelEnvironmentMixin
- abc.ABC
- runtimepy.net.mixin.TransportMixin
- builtins.object
Methods defined here:
- async handle_nvt(self, action: runtimepy.net.tcp.telnet.codes.TelnetNvt) -> None
- Handle a signal for the network virtual-terminal.
- async process_binary(self, data: bytes) -> bool
- Process a binary frame.
- async process_command(self, code: runtimepy.net.tcp.telnet.codes.TelnetCode) -> None
- Process a telnet command.
- async process_option(self, code: runtimepy.net.tcp.telnet.codes.TelnetCode, option: int, stream: <class 'BinaryIO'>) -> None
- Process a telnet option.
- async process_telnet_message(self, data: bytes) -> bool
- By default, treat all incoming data bytes as text.
- send_command(self, code: runtimepy.net.tcp.telnet.codes.TelnetCode) -> None
- Send a telnet command.
- send_option(self, option: runtimepy.net.tcp.telnet.codes.TelnetCode, code: int) -> None
- Send a telnet option sequence. if the 'SB' is the desired code, the
additional data can be sent using the 'send_binary' method directly.
Data and other attributes defined here:
- __abstractmethods__ = frozenset({'handle_nvt', 'process_command', 'process_option'})
- __annotations__ = {}
- log_alias = 'TELNET'
Methods inherited from runtimepy.net.tcp.connection.TcpConnection:
- __init__(self, transport: asyncio.transports.Transport, protocol: runtimepy.net.tcp.protocol.QueueProtocol) -> None
- Initialize this TCP connection.
- async close(self) -> None
- Close this connection.
- async restart(self) -> bool
- Reset necessary underlying state for this connection to 'process'
again.
- send_binary(self, data: Union[bytes, bytearray, memoryview]) -> None
- Enqueue a binary message tos end.
- send_text(self, data: str) -> None
- Enqueue a text message to send.
Class methods inherited from runtimepy.net.tcp.connection.TcpConnection:
- async app(stop_sig: asyncio.locks.Event, callback: Callable[[~T], NoneType] = None, serving_callback: Callable[[Any], NoneType] = None, manager: runtimepy.net.manager.ConnectionManager = None, **kwargs) -> None from abc.ABCMeta
- Run an application that serves new connections.
- async create_connection(backoff: runtimepy.net.backoff.ExponentialBackoff = None, **kwargs) -> ~T from abc.ABCMeta
- Create a TCP connection.
- create_pair() -> AsyncIterator[tuple[~T, ~T]] from abc.ABCMeta
- Create a connection pair.
- serve(callback: Callable[[~T], NoneType] = None, **kwargs) -> AsyncIterator[Any] from abc.ABCMeta
- Serve incoming connections.
Data and other attributes inherited from runtimepy.net.tcp.connection.TcpConnection:
- log_prefix = ''
- uses_binary_tx_queue = False
- uses_text_tx_queue = False
Methods inherited from runtimepy.net.connection.Connection:
- async async_init(self) -> bool
- A runtime initialization routine (executes during 'process').
- disable(self, reason: str) -> None
- Disable this connection.
- disable_extra(self) -> None
- Additional tasks to perform when disabling.
- async disable_in(self, time: float) -> None
- A method for disabling a connection after some delay.
- init(self) -> None
- Initialize this instance.
- log_metrics(self, label: str = 'conn') -> None
- Log connection metrics.
- async process(self, stop_sig: asyncio.locks.Event = None, disable_time: float = None, backoff: runtimepy.net.backoff.ExponentialBackoff = None) -> None
- Process tasks for this connection while the connection is active.
- async process_text(self, data: str) -> bool
- Process a text frame.
Readonly properties inherited from runtimepy.net.connection.Connection:
- auto_restart
- Determine if this connection should be automatically restarted.
- disabled
- Determine if this connection is disabled.
Data and other attributes inherited from runtimepy.net.connection.Connection:
- byte_order = <ByteOrder.NETWORK: 4>
- connected = True
- default_auto_restart = False
Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:
- setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None
- Add a commandable log-level channel to the environment.
Methods inherited from vcorelib.logging.LoggerMixin:
- log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]
- A simple wrapper.
Data descriptors inherited from vcorelib.logging.LoggerMixin:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:
- register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None
- Register individual channel metrics.
- register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None
- Register connection metrics.
- register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None
- Register periodic task metrics.
Methods inherited from runtimepy.net.mixin.TransportMixin:
- logger_name(self, prefix: 'str' = '') -> 'str'
- Get a logger name for this connection.
- set_transport(self, transport: '_asyncio.BaseTransport') -> 'None'
- Set the transport for this instance.
Readonly properties inherited from runtimepy.net.mixin.TransportMixin:
- socket
- Get this instance's underlying socket.
|
class TelnetCode(enum.IntEnum) |
| |
TelnetCode(*values)
An enumeration of byte values important to the telnet protocol.
|
| |
- Method resolution order:
- TelnetCode
- enum.IntEnum
- builtins.int
- enum.ReprEnum
- enum.Enum
- builtins.object
Methods defined here:
- __format__(self, format_spec, /)
- Convert to a string according to format_spec.
- __new__(cls, value)
- Create and return a new object. See help(type) for accurate signature.
Data and other attributes defined here:
- AO = <TelnetCode.AO: 245>
- AYT = <TelnetCode.AYT: 246>
- BREAK = <TelnetCode.BREAK: 243>
- DATA_MARK = <TelnetCode.DATA_MARK: 242>
- DO = <TelnetCode.DO: 253>
- DONT = <TelnetCode.DONT: 254>
- EC = <TelnetCode.EC: 247>
- EL = <TelnetCode.EL: 248>
- GA = <TelnetCode.GA: 249>
- IAC = <TelnetCode.IAC: 255>
- IP = <TelnetCode.IP: 244>
- NOP = <TelnetCode.NOP: 241>
- SB = <TelnetCode.SB: 250>
- SE = <TelnetCode.SE: 240>
- WILL = <TelnetCode.WILL: 251>
- WONT = <TelnetCode.WONT: 252>
Methods inherited from enum.IntEnum:
- __repr__(self)
- Return repr(self).
- __str__ = __repr__(self, /)
- Return repr(self).
Methods inherited from builtins.int:
- __abs__(self, /)
- abs(self)
- __add__(self, value, /)
- Return self+value.
- __and__(self, value, /)
- Return self&value.
- __bool__(self, /)
- True if self else False
- __ceil__(...)
- Ceiling of an Integral returns itself.
- __divmod__(self, value, /)
- Return divmod(self, value).
- __eq__(self, value, /)
- Return self==value.
- __float__(self, /)
- float(self)
- __floor__(...)
- Flooring an Integral returns itself.
- __floordiv__(self, value, /)
- Return self//value.
- __ge__(self, value, /)
- Return self>=value.
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __getnewargs__(self, /)
- __gt__(self, value, /)
- Return self>value.
- __hash__(self, /)
- Return hash(self).
- __index__(self, /)
- Return self converted to an integer, if self is suitable for use as an index into a list.
- __int__(self, /)
- int(self)
- __invert__(self, /)
- ~self
- __le__(self, value, /)
- Return self<=value.
- __lshift__(self, value, /)
- Return self<<value.
- __lt__(self, value, /)
- Return self<value.
- __mod__(self, value, /)
- Return self%value.
- __mul__(self, value, /)
- Return self*value.
- __ne__(self, value, /)
- Return self!=value.
- __neg__(self, /)
- -self
- __or__(self, value, /)
- Return self|value.
- __pos__(self, /)
- +self
- __pow__(self, value, mod=None, /)
- Return pow(self, value, mod).
- __radd__(self, value, /)
- Return value+self.
- __rand__(self, value, /)
- Return value&self.
- __rdivmod__(self, value, /)
- Return divmod(value, self).
- __rfloordiv__(self, value, /)
- Return value//self.
- __rlshift__(self, value, /)
- Return value<<self.
- __rmod__(self, value, /)
- Return value%self.
- __rmul__(self, value, /)
- Return value*self.
- __ror__(self, value, /)
- Return value|self.
- __round__(...)
- Rounding an Integral returns itself.
Rounding with an ndigits argument also returns an integer.
- __rpow__(self, value, mod=None, /)
- Return pow(value, self, mod).
- __rrshift__(self, value, /)
- Return value>>self.
- __rshift__(self, value, /)
- Return self>>value.
- __rsub__(self, value, /)
- Return value-self.
- __rtruediv__(self, value, /)
- Return value/self.
- __rxor__(self, value, /)
- Return value^self.
- __sizeof__(self, /)
- Returns size in memory, in bytes.
- __sub__(self, value, /)
- Return self-value.
- __truediv__(self, value, /)
- Return self/value.
- __trunc__(...)
- Truncating an Integral returns itself.
- __xor__(self, value, /)
- Return self^value.
- as_integer_ratio(self, /)
- 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)
- bit_count(self, /)
- 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
- bit_length(self, /)
- Number of bits necessary to represent self in binary.
>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
- conjugate(...)
- Returns self, the complex conjugate of any int.
- is_integer(self, /)
- Returns True. Exists for duck type compatibility with float.is_integer.
- to_bytes(self, /, 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.
Class methods inherited from builtins.int:
- from_bytes(bytes, byteorder='big', *, signed=False) from enum.EnumType
- 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.
Data descriptors inherited from builtins.int:
- denominator
- the denominator of a rational number in lowest terms
- imag
- the imaginary part of a complex number
- numerator
- the numerator of a rational number in lowest terms
- real
- the real part of a complex number
Methods inherited from enum.Enum:
- __dir__(self)
- Returns public methods and other interesting attributes.
- __init__(self, *args, **kwds)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce_ex__(self, proto)
- Helper for pickle.
Data descriptors inherited from enum.Enum:
- name
- The name of the Enum member.
- value
- The value of the Enum member.
Methods inherited from enum.EnumType:
- __contains__(value) from enum.EnumType
- 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.
- __getitem__(name) from enum.EnumType
- Return the member matching `name`.
- __iter__() from enum.EnumType
- Return members in definition order.
- __len__() from enum.EnumType
- Return the number of members (no aliases)
Readonly properties inherited from enum.EnumType:
- __members__
- Returns a mapping of member name->value.
This mapping lists all enum members, including aliases. Note that this
is a read-only view of the internal mapping.
|
class TelnetNvt(enum.IntEnum) |
| |
TelnetNvt(*values)
Telnet data relevant to the NVT printer and keyboard.
|
| |
- Method resolution order:
- TelnetNvt
- enum.IntEnum
- builtins.int
- enum.ReprEnum
- enum.Enum
- builtins.object
Methods defined here:
- __format__(self, format_spec, /)
- Convert to a string according to format_spec.
- __new__(cls, value)
- Create and return a new object. See help(type) for accurate signature.
Data and other attributes defined here:
- BEL = <TelnetNvt.BEL: 7>
- BS = <TelnetNvt.BS: 8>
- CR = <TelnetNvt.CR: 13>
- FF = <TelnetNvt.FF: 12>
- HT = <TelnetNvt.HT: 9>
- LF = <TelnetNvt.LF: 10>
- NUL = <TelnetNvt.NUL: 0>
- VT = <TelnetNvt.VT: 11>
Methods inherited from enum.IntEnum:
- __repr__(self)
- Return repr(self).
- __str__ = __repr__(self, /)
- Return repr(self).
Methods inherited from builtins.int:
- __abs__(self, /)
- abs(self)
- __add__(self, value, /)
- Return self+value.
- __and__(self, value, /)
- Return self&value.
- __bool__(self, /)
- True if self else False
- __ceil__(...)
- Ceiling of an Integral returns itself.
- __divmod__(self, value, /)
- Return divmod(self, value).
- __eq__(self, value, /)
- Return self==value.
- __float__(self, /)
- float(self)
- __floor__(...)
- Flooring an Integral returns itself.
- __floordiv__(self, value, /)
- Return self//value.
- __ge__(self, value, /)
- Return self>=value.
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __getnewargs__(self, /)
- __gt__(self, value, /)
- Return self>value.
- __hash__(self, /)
- Return hash(self).
- __index__(self, /)
- Return self converted to an integer, if self is suitable for use as an index into a list.
- __int__(self, /)
- int(self)
- __invert__(self, /)
- ~self
- __le__(self, value, /)
- Return self<=value.
- __lshift__(self, value, /)
- Return self<<value.
- __lt__(self, value, /)
- Return self<value.
- __mod__(self, value, /)
- Return self%value.
- __mul__(self, value, /)
- Return self*value.
- __ne__(self, value, /)
- Return self!=value.
- __neg__(self, /)
- -self
- __or__(self, value, /)
- Return self|value.
- __pos__(self, /)
- +self
- __pow__(self, value, mod=None, /)
- Return pow(self, value, mod).
- __radd__(self, value, /)
- Return value+self.
- __rand__(self, value, /)
- Return value&self.
- __rdivmod__(self, value, /)
- Return divmod(value, self).
- __rfloordiv__(self, value, /)
- Return value//self.
- __rlshift__(self, value, /)
- Return value<<self.
- __rmod__(self, value, /)
- Return value%self.
- __rmul__(self, value, /)
- Return value*self.
- __ror__(self, value, /)
- Return value|self.
- __round__(...)
- Rounding an Integral returns itself.
Rounding with an ndigits argument also returns an integer.
- __rpow__(self, value, mod=None, /)
- Return pow(value, self, mod).
- __rrshift__(self, value, /)
- Return value>>self.
- __rshift__(self, value, /)
- Return self>>value.
- __rsub__(self, value, /)
- Return value-self.
- __rtruediv__(self, value, /)
- Return value/self.
- __rxor__(self, value, /)
- Return value^self.
- __sizeof__(self, /)
- Returns size in memory, in bytes.
- __sub__(self, value, /)
- Return self-value.
- __truediv__(self, value, /)
- Return self/value.
- __trunc__(...)
- Truncating an Integral returns itself.
- __xor__(self, value, /)
- Return self^value.
- as_integer_ratio(self, /)
- 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)
- bit_count(self, /)
- 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
- bit_length(self, /)
- Number of bits necessary to represent self in binary.
>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
- conjugate(...)
- Returns self, the complex conjugate of any int.
- is_integer(self, /)
- Returns True. Exists for duck type compatibility with float.is_integer.
- to_bytes(self, /, 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.
Class methods inherited from builtins.int:
- from_bytes(bytes, byteorder='big', *, signed=False) from enum.EnumType
- 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.
Data descriptors inherited from builtins.int:
- denominator
- the denominator of a rational number in lowest terms
- imag
- the imaginary part of a complex number
- numerator
- the numerator of a rational number in lowest terms
- real
- the real part of a complex number
Methods inherited from enum.Enum:
- __dir__(self)
- Returns public methods and other interesting attributes.
- __init__(self, *args, **kwds)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce_ex__(self, proto)
- Helper for pickle.
Data descriptors inherited from enum.Enum:
- name
- The name of the Enum member.
- value
- The value of the Enum member.
Methods inherited from enum.EnumType:
- __contains__(value) from enum.EnumType
- 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.
- __getitem__(name) from enum.EnumType
- Return the member matching `name`.
- __iter__() from enum.EnumType
- Return members in definition order.
- __len__() from enum.EnumType
- Return the number of members (no aliases)
Readonly properties inherited from enum.EnumType:
- __members__
- Returns a mapping of member name->value.
This mapping lists all enum members, including aliases. Note that this
is a read-only view of the internal mapping.
| |