Public Member Functions | Properties | List of all members
uuid.UUID Class Reference
Inheritance diagram for uuid.UUID:
Inheritance graph
[legend]

Public Member Functions

def __cmp__ (self, other)
 
def __cmp__ (self, other)
 
def __hash__ (self)
 
def __hash__ (self)
 
def __init__ (self, hex=None, bytes=None, fields=None, int=None, version=None)
 
def __init__ (self, hex=None, bytes=None, fields=None, int=None, version=None)
 
def __int__ (self)
 
def __int__ (self)
 
def __repr__ (self)
 
def __repr__ (self)
 
def __setattr__ (self, name, value)
 
def __setattr__ (self, name, value)
 
def __str__ (self)
 
def __str__ (self)
 
def get_bytes (self)
 
def get_bytes (self)
 
def get_clock_seq (self)
 
def get_clock_seq (self)
 
def get_clock_seq_hi_variant (self)
 
def get_clock_seq_hi_variant (self)
 
def get_clock_seq_low (self)
 
def get_clock_seq_low (self)
 
def get_fields (self)
 
def get_fields (self)
 
def get_hex (self)
 
def get_hex (self)
 
def get_node (self)
 
def get_node (self)
 
def get_time (self)
 
def get_time (self)
 
def get_time_hi_version (self)
 
def get_time_hi_version (self)
 
def get_time_low (self)
 
def get_time_low (self)
 
def get_time_mid (self)
 
def get_time_mid (self)
 
def get_urn (self)
 
def get_urn (self)
 
def get_variant (self)
 
def get_variant (self)
 
def get_version (self)
 
def get_version (self)
 

Properties

 bytes = property(get_bytes)
 
 clock_seq = property(get_clock_seq)
 
 clock_seq_hi_variant = property(get_clock_seq_hi_variant)
 
 clock_seq_low = property(get_clock_seq_low)
 
 fields = property(get_fields)
 
 hex = property(get_hex)
 
 node = property(get_node)
 
 time = property(get_time)
 
 time_hi_version = property(get_time_hi_version)
 
 time_low = property(get_time_low)
 
 time_mid = property(get_time_mid)
 
 urn = property(get_urn)
 
 variant = property(get_variant)
 
 version = property(get_version)
 

Detailed Description

Instances of the UUID class represent UUIDs as specified in RFC 4122.
UUID objects are immutable, hashable, and usable as dictionary keys.
Converting a UUID to a string with str() yields something in the form
'12345678-1234-1234-1234-123456789abc'.  The UUID constructor accepts
four possible forms: a similar string of hexadecimal digits, or a
string of 16 raw bytes as an argument named 'bytes', or a tuple of
six integer fields (with 32-bit, 16-bit, 16-bit, 8-bit, 8-bit, and
48-bit values respectively) as an argument named 'fields', or a single
128-bit integer as an argument named 'int'.

UUIDs have these read-only attributes:

    bytes       the UUID as a 16-byte string

    fields      a tuple of the six integer fields of the UUID,
                which are also available as six individual attributes
                and two derived attributes:

        time_low                the first 32 bits of the UUID
        time_mid                the next 16 bits of the UUID
        time_hi_version         the next 16 bits of the UUID
        clock_seq_hi_variant    the next 8 bits of the UUID
        clock_seq_low           the next 8 bits of the UUID
        node                    the last 48 bits of the UUID

        time                    the 60-bit timestamp
        clock_seq               the 14-bit sequence number

    hex         the UUID as a 32-character hexadecimal string

    int         the UUID as a 128-bit integer

    urn         the UUID as a URN as specified in RFC 4122

    variant     the UUID variant (one of the constants RESERVED_NCS,
                RFC_4122, RESERVED_MICROSOFT, or RESERVED_FUTURE)

    version     the UUID version number (1 through 5, meaningful only
                when the variant is RFC_4122)

Definition at line 58 of file installer/uuid.py.

Constructor & Destructor Documentation

◆ __init__() [1/2]

def uuid.UUID.__init__ (   self,
  hex = None,
  bytes = None,
  fields = None,
  int = None,
  version = None 
) 
Create a UUID from either a string of 32 hexadecimal digits,
a string of 16 bytes as the 'bytes' argument, a tuple of six
integers (32-bit time_low, 16-bit time_mid, 16-bit time_hi_version,
8-bit clock_seq_hi_variant, 8-bit clock_seq_low, 48-bit node) as
the 'fields' argument, or a single 128-bit integer as the 'int'
argument.  When a string of hex digits is given, curly braces,
hyphens, and a URN prefix are all optional.  For example, these
expressions all yield the same UUID:

UUID('{12345678-1234-5678-1234-567812345678}')
UUID('12345678123456781234567812345678')
UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
UUID(bytes='\x12\x34\x56\x78'*4)
UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678))
UUID(int=0x12345678123456781234567812345678)

Exactly one of 'hex', 'bytes', 'fields', or 'int' must be given.
The 'version' argument is optional; if given, the resulting UUID
will have its variant and version number set according to RFC 4122,
overriding bits in the given 'hex', 'bytes', 'fields', or 'int'.

Definition at line 101 of file installer/uuid.py.

◆ __init__() [2/2]

def uuid.UUID.__init__ (   self,
  hex = None,
  bytes = None,
  fields = None,
  int = None,
  version = None 
) 
Create a UUID from either a string of 32 hexadecimal digits,
a string of 16 bytes as the 'bytes' argument, a tuple of six
integers (32-bit time_low, 16-bit time_mid, 16-bit time_hi_version,
8-bit clock_seq_hi_variant, 8-bit clock_seq_low, 48-bit node) as
the 'fields' argument, or a single 128-bit integer as the 'int'
argument.  When a string of hex digits is given, curly braces,
hyphens, and a URN prefix are all optional.  For example, these
expressions all yield the same UUID:

UUID('{12345678-1234-5678-1234-567812345678}')
UUID('12345678123456781234567812345678')
UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
UUID(bytes='\x12\x34\x56\x78'*4)
UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678))
UUID(int=0x12345678123456781234567812345678)

Exactly one of 'hex', 'bytes', 'fields', or 'int' must be given.
The 'version' argument is optional; if given, the resulting UUID
will have its variant and version number set according to RFC 4122,
overriding bits in the given 'hex', 'bytes', 'fields', or 'int'.

Definition at line 99 of file OpenRTM_aist/test/uuid.py.

Member Function Documentation

◆ __cmp__() [1/2]

def uuid.UUID.__cmp__ (   self,
  other 
)

Definition at line 168 of file OpenRTM_aist/test/uuid.py.

◆ __cmp__() [2/2]

def uuid.UUID.__cmp__ (   self,
  other 
)

Definition at line 170 of file installer/uuid.py.

◆ __hash__() [1/2]

def uuid.UUID.__hash__ (   self)

Definition at line 173 of file OpenRTM_aist/test/uuid.py.

◆ __hash__() [2/2]

def uuid.UUID.__hash__ (   self)

Definition at line 175 of file installer/uuid.py.

◆ __int__() [1/2]

def uuid.UUID.__int__ (   self)

Definition at line 176 of file OpenRTM_aist/test/uuid.py.

◆ __int__() [2/2]

def uuid.UUID.__int__ (   self)

Definition at line 178 of file installer/uuid.py.

◆ __repr__() [1/2]

def uuid.UUID.__repr__ (   self)

Definition at line 179 of file OpenRTM_aist/test/uuid.py.

◆ __repr__() [2/2]

def uuid.UUID.__repr__ (   self)

Definition at line 181 of file installer/uuid.py.

◆ __setattr__() [1/2]

def uuid.UUID.__setattr__ (   self,
  name,
  value 
)

Definition at line 182 of file OpenRTM_aist/test/uuid.py.

◆ __setattr__() [2/2]

def uuid.UUID.__setattr__ (   self,
  name,
  value 
)

Definition at line 184 of file installer/uuid.py.

◆ __str__() [1/2]

def uuid.UUID.__str__ (   self)

Definition at line 185 of file OpenRTM_aist/test/uuid.py.

◆ __str__() [2/2]

def uuid.UUID.__str__ (   self)

Definition at line 187 of file installer/uuid.py.

◆ get_bytes() [1/2]

def uuid.UUID.get_bytes (   self)

Definition at line 190 of file OpenRTM_aist/test/uuid.py.

◆ get_bytes() [2/2]

def uuid.UUID.get_bytes (   self)

Definition at line 192 of file installer/uuid.py.

◆ get_clock_seq() [1/2]

def uuid.UUID.get_clock_seq (   self)

Definition at line 235 of file OpenRTM_aist/test/uuid.py.

◆ get_clock_seq() [2/2]

def uuid.UUID.get_clock_seq (   self)

Definition at line 237 of file installer/uuid.py.

◆ get_clock_seq_hi_variant() [1/2]

def uuid.UUID.get_clock_seq_hi_variant (   self)

Definition at line 219 of file OpenRTM_aist/test/uuid.py.

◆ get_clock_seq_hi_variant() [2/2]

def uuid.UUID.get_clock_seq_hi_variant (   self)

Definition at line 221 of file installer/uuid.py.

◆ get_clock_seq_low() [1/2]

def uuid.UUID.get_clock_seq_low (   self)

Definition at line 224 of file OpenRTM_aist/test/uuid.py.

◆ get_clock_seq_low() [2/2]

def uuid.UUID.get_clock_seq_low (   self)

Definition at line 226 of file installer/uuid.py.

◆ get_fields() [1/2]

def uuid.UUID.get_fields (   self)

Definition at line 198 of file OpenRTM_aist/test/uuid.py.

◆ get_fields() [2/2]

def uuid.UUID.get_fields (   self)

Definition at line 200 of file installer/uuid.py.

◆ get_hex() [1/2]

def uuid.UUID.get_hex (   self)

Definition at line 246 of file OpenRTM_aist/test/uuid.py.

◆ get_hex() [2/2]

def uuid.UUID.get_hex (   self)

Definition at line 248 of file installer/uuid.py.

◆ get_node() [1/2]

def uuid.UUID.get_node (   self)

Definition at line 241 of file OpenRTM_aist/test/uuid.py.

◆ get_node() [2/2]

def uuid.UUID.get_node (   self)

Definition at line 243 of file installer/uuid.py.

◆ get_time() [1/2]

def uuid.UUID.get_time (   self)

Definition at line 229 of file OpenRTM_aist/test/uuid.py.

◆ get_time() [2/2]

def uuid.UUID.get_time (   self)

Definition at line 231 of file installer/uuid.py.

◆ get_time_hi_version() [1/2]

def uuid.UUID.get_time_hi_version (   self)

Definition at line 214 of file OpenRTM_aist/test/uuid.py.

◆ get_time_hi_version() [2/2]

def uuid.UUID.get_time_hi_version (   self)

Definition at line 216 of file installer/uuid.py.

◆ get_time_low() [1/2]

def uuid.UUID.get_time_low (   self)

Definition at line 204 of file OpenRTM_aist/test/uuid.py.

◆ get_time_low() [2/2]

def uuid.UUID.get_time_low (   self)

Definition at line 206 of file installer/uuid.py.

◆ get_time_mid() [1/2]

def uuid.UUID.get_time_mid (   self)

Definition at line 209 of file OpenRTM_aist/test/uuid.py.

◆ get_time_mid() [2/2]

def uuid.UUID.get_time_mid (   self)

Definition at line 211 of file installer/uuid.py.

◆ get_urn() [1/2]

def uuid.UUID.get_urn (   self)

Definition at line 251 of file OpenRTM_aist/test/uuid.py.

◆ get_urn() [2/2]

def uuid.UUID.get_urn (   self)

Definition at line 253 of file installer/uuid.py.

◆ get_variant() [1/2]

def uuid.UUID.get_variant (   self)

Definition at line 256 of file OpenRTM_aist/test/uuid.py.

◆ get_variant() [2/2]

def uuid.UUID.get_variant (   self)

Definition at line 258 of file installer/uuid.py.

◆ get_version() [1/2]

def uuid.UUID.get_version (   self)

Definition at line 268 of file OpenRTM_aist/test/uuid.py.

◆ get_version() [2/2]

def uuid.UUID.get_version (   self)

Definition at line 270 of file installer/uuid.py.

Property Documentation

◆ bytes

uuid.UUID.bytes = property(get_bytes)
static

Definition at line 198 of file installer/uuid.py.

◆ clock_seq

uuid.UUID.clock_seq = property(get_clock_seq)
static

Definition at line 241 of file installer/uuid.py.

◆ clock_seq_hi_variant

uuid.UUID.clock_seq_hi_variant = property(get_clock_seq_hi_variant)
static

Definition at line 224 of file installer/uuid.py.

◆ clock_seq_low

uuid.UUID.clock_seq_low = property(get_clock_seq_low)
static

Definition at line 229 of file installer/uuid.py.

◆ fields

uuid.UUID.fields = property(get_fields)
static

Definition at line 204 of file installer/uuid.py.

◆ hex

uuid.UUID.hex = property(get_hex)
static

Definition at line 251 of file installer/uuid.py.

◆ node

uuid.UUID.node = property(get_node)
static

Definition at line 246 of file installer/uuid.py.

◆ time

uuid.UUID.time = property(get_time)
static

Definition at line 235 of file installer/uuid.py.

◆ time_hi_version

uuid.UUID.time_hi_version = property(get_time_hi_version)
static

Definition at line 219 of file installer/uuid.py.

◆ time_low

uuid.UUID.time_low = property(get_time_low)
static

Definition at line 209 of file installer/uuid.py.

◆ time_mid

uuid.UUID.time_mid = property(get_time_mid)
static

Definition at line 214 of file installer/uuid.py.

◆ urn

uuid.UUID.urn = property(get_urn)
static

Definition at line 256 of file installer/uuid.py.

◆ variant

uuid.UUID.variant = property(get_variant)
static

Definition at line 268 of file installer/uuid.py.

◆ version

uuid.UUID.version = property(get_version)
static

Definition at line 275 of file installer/uuid.py.

The documentation for this class was generated from the following file:

openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Mon Feb 28 2022 23:01:10