bindings Package

bindings Package

common Module

Bindings common module that contains common code for skeletons and stubs

class vmware.vapi.bindings.common.NameToTypeResolver(type_map)

Bases: object

Helper class that resolves a fully qualified canonical type name to a type descriptor. The type name can be a structure name or an error name.

Initialize NameToTypeResolver

Parameters:type_map (dict of str and VapiStruct) – Type map that contains the canonical names and the references to the binding classes for these types.

resolve(name)

Type name to be resolved

vmware.vapi.bindings.common.raise_core_exception(msg_list)

Create and raise a CoreException from a list of messages

Parameters:msg_list (vmware.vapi.message.Message) – List of messages Raise :CoreException if msg list is not empty

converter Module

Type converter to/from vAPI runtime data model to Python native data model

class vmware.vapi.bindings.converter.PythonToVapiVisitor(value)

Bases: vmware.vapi.bindings.type.BindingTypeVisitor

Visitor to convert from Python native value to vAPI DataValue

Initialize PythonToVapiVisitor

Parameters:value (object) – Native python value

get_out_value()

Returns the vAPI DataValue converted from the Python native value

Return type:vmware.vapi.data.value.DataValue Returns:vAPI DataValue

visit(typ)

visit_any_error(typ)

Visit any error value

Parameters:typ (vmware.vapi.binding.type.AnyErrorType) – Binding type of the value

visit_date_time(typ)

Visit a datetime value

Parameters:typ (vmware.vapi.binding.type.DateTimeType) – Binding type of the value

visit_dynamic_struct(typ)

Visit any struct value

Parameters:typ (vmware.vapi.binding.type.DynamicStructType) – Binding type of the value

visit_enum(typ)

Visit a enum type python value

Parameters:typ (vmware.vapi.binding.type.EnumType) – Binding type of the value

visit_error(typ)

Visit an error value

Parameters:typ (vmware.vapi.binding.type.ErrorType) – Binding type of the value

visit_list(typ)

Visit a list value

Parameters:typ (vmware.vapi.binding.type.ListType) – Binding type of the value

visit_map(typ)

Visit a python dict

Parameters:typ (vmware.vapi.binding.type.MapType) – Binding type of the value

visit_opaque(typ)

Visit an opaque value. Don’t do any conversion.

Parameters:typ (vmware.vapi.binding.type.OpaqueType) – Binding type of the value

visit_optional(typ)

Visit an optional value

Parameters:typ (vmware.vapi.binding.type.OptionalType) – Binding type of the value

visit_primitive(typ)

Visit a primitive type python value

Parameters:typ (vmware.vapi.binding.type.BindingType) – Binding type of the value

visit_reference(typ)

Visit a reference type

Parameters:typ (vmware.vapi.binding.type.ReferenceType) – Binding type of the value

visit_set(typ)

Visit a python set

Parameters:typ (vmware.vapi.binding.type.SetType) – Binding type of the value

visit_struct(typ)

Visit a struct value

Parameters:typ (vmware.vapi.binding.type.StructType) – Binding type of the value

visit_uri(typ)

Visit an URI value

Parameters:typ (vmware.vapi.binding.type.UriType) – Binding type of the value

visit_void(typ)

Visit a void value (i.e. None)

Parameters:typ (vmware.vapi.binding.type.VoidType) – Binding type of the value

class vmware.vapi.bindings.converter.TypeConverter

Bases: object

Converter class that converts values from vAPI data model to Python native data model

static convert_to_python(vapi_val, binding_type, resolver=None)

Converts vAPI DataValue to Python native value

Parameters:

• vapi_val (vmware.vapi.data.value.DataValue) – vAPI DataValue to be converted
• binding_type (vmware.vapi.bindings.type.BindingType) – BindingType for the value
• resolver (vmware.vapi.bindings.common.NameToTypeResolver or None) – Type resolver

Return type:

object

Returns:

Python native value

static convert_to_vapi(py_val, binding_type)

Converts Python native value to vAPI DataValue

Parameters:

• py_val (object) – Python native value to be converted
• binding_type (vmware.vapi.bindings.type.BindingType) – BindingType for the value

Return type:

vmware.vapi.data.value.DataValue

Returns:

vAPI DataValue

class vmware.vapi.bindings.converter.VapiToPythonVisitor(value, resolver)

Bases: vmware.vapi.bindings.type.BindingTypeVisitor

Visitor to convert from vAPI DataValue to Python native value

Initialize VapiToPythonVisitor

Parameters:

• value (vmware.vapi.data.value.DataValue) – vAPI DataValue to be converted
• resolver (vmware.vapi.bindings.common.NameToTypeResolver or None) – Type resolver

get_out_value()

Returns the Python native value converted from the vAPI DataValue

Return type:object Returns:Native python value

visit(typ)

visit_any_error(typ)

Visit ErrorValue to convert it into the base VapiError

Parameters:typ (vmware.vapi.binding.type.AnyErrorType) – Binding type of the value

visit_date_time(typ)

Visit a datetime value

Parameters:typ (vmware.vapi.binding.type.DateTimeType) – Binding type of the value

visit_dynamic_struct(typ)

Visit StructValue to convert it into the base VapiStruct

Parameters:typ (vmware.vapi.binding.type.DynamicStructType) – Binding type of the value

visit_enum(typ)

Visit an Enum value

Parameters:typ (vmware.vapi.binding.type.EnumType) – Binding type of the value

visit_error(typ)

Visit ErrorValue

Parameters:typ (vmware.vapi.binding.type.ErrorType) – Binding type of the value

visit_list(typ)

Visit a ListValue

Parameters:typ (vmware.vapi.binding.type.ListType) – Binding type of the value

visit_map(typ)

Visit a List Value. This ListValue must represent a map. Each element of the ListValue is a StructValue with two fields, namely ‘key’ and ‘value’. The ‘key’ field represents the key of the map and the ‘value’ field represents the value of the map. Also, since this represents a map, there should not be duplicate keys.

Parameters:typ (vmware.vapi.binding.type.MapType) – Binding type of the value

visit_opaque(typ)

Since there is no OpaqueValue, don’t do any conversion

Parameters:typ (vmware.vapi.binding.type.OpaqueType) – Binding type of the value

visit_optional(typ)

Visit OptionalValue

Parameters:typ (vmware.vapi.binding.type.OptionalType) – Binding type of the value

visit_primitive(typ)

Visit one of the primitive DataValues

Parameters:typ (vmware.vapi.binding.type.BindingType) – Binding type of the value

visit_reference(typ)

Visit a reference type

Parameters:typ (vmware.vapi.binding.type.ReferenceType) – Binding type of the value

visit_set(typ)

Visit a List Value. This ListValue must represent a set i.e. there must not be any duplicate elements

Parameters:typ (vmware.vapi.binding.type.SetType) – Binding type of the value

visit_string(typ)

Visit StringValue

Parameters:typ (vmware.vapi.binding.type.StringType) – Binding type of the value

visit_struct(typ)

Visit StructValue

Parameters:typ (vmware.vapi.binding.type.StructType) – Binding type of the value

visit_uri(typ)

Visit an URI value

Parameters:typ (vmware.vapi.binding.type.UriType) – Binding type of the value

visit_void(typ)

Since there is no VoidValue, just return None

Parameters:typ (vmware.vapi.binding.type.VoidType) – Binding type of the value

datetime_helper Module

Utility library for converting to/from datetime objects in Python Bindings

class vmware.vapi.bindings.datetime_helper.DateTimeConverter

Bases: object

Helper class to convert to/from Python datetime strings to datetime objects.

Datetime is represented as vmware.vapi.data.value.StringValue in the vAPI Runtime. Datetime is a primitive string that follows a subset of ISO 8601. DateTime string represents a complete date plus hours, minutes, seconds and a decimal fraction of a second:

YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.000Z) where:

YYYY = four-digit year (years BC are not supported;

0001 = 1 AD is the first valid year, 0000 = 1 BC is not allowed)

MM = two-digit month (01=January, ..., 12=December) DD = two-digit day of month (01 through 31) “T” = separator; appears literally in the string hh = two digits of hour (00 through 23; 24 NOT allowed;

am/pm NOT allowed)

mm = two digits of minute (00 through 59) ss = two digits of second (00 through 59) sss = exactly three digits representing milliseconds “Z” = UTC time zone designator; appears literally in the string

static convert_from_datetime(datetime_obj)

Convert from Python native datetime object to the datetime format in vAPI Runtime i.e. YYYY-MM-DDThh:mm:ss.sssZ.

datetime objects returned by datetime.now() or datetime.utcnow() does not contain any timezone information. The caller to this method should only pass datetime objects that have time in UTC timezone.

datetime objects have microsecond precision but the vAPI datetime string format has millisecond precision. The method will truncate the microsecond to millisecond and won’t do any rounding of the value.

Parameters:datetime_obj (datetime.datetime) – Datetime object with UTC time Return type:str Returns:String representation of the input datetime object

static convert_to_datetime(datetime_str)

Parse ISO 8601 date time from string.

Parameters:datetime_str (str) – Datetime in string representation that is in YYYY-MM-DDThh:mm:ss.sssZ format Return type:datetime.datetime Returns:Datetime object

class vmware.vapi.bindings.datetime_helper.UTC

Bases: datetime.tzinfo

tzinfo class for UTC timezone

dst(dt)

tzname(dt)

utcoffset(dt)

vmware.vapi.bindings.datetime_helper.convert_to_utc(dt)

Convert a given datetime object to UTC timezone

enum Module

Bindings data classes

class vmware.vapi.bindings.enum.Enum

Bases: str

Representation of IDL Enum in python language bindings

classmethod get_binding_type()

Returns the corresponding BindingType for the VapiStruct class

Return type:vmware.vapi.data.value.BindingType Returns:BindingType for this VapiStruct

error Module

Error classes and factory

exception vmware.vapi.bindings.error.UnresolvedError(mappings=None, error_value=None)

Bases: vmware.vapi.bindings.error.VapiError

VapiError which represents a VMODL2 error that was reported but couldn’t be resolved

Initialize VapiError

Parameters:

• mappings (dict or None) – A mapping for all field names whose IDL name does not match PEP8 standard name
• error_value (vmware.vapi.data.value.ErrorValue or None) – ErrorValue to be used for VapiError

exception vmware.vapi.bindings.error.VapiError(mappings=None, error_value=None)

Bases: vmware.vapi.bindings.struct.VapiStruct, exceptions.Exception

Representation of VMODL Error in python language bindings

Initialize VapiError

Parameters:

• mappings (dict or None) – A mapping for all field names whose IDL name does not match PEP8 standard name
• error_value (vmware.vapi.data.value.ErrorValue or None) – ErrorValue to be used for VapiError

get_error_value()

Returns the corresponding ErrorValue for the VapiError class

Return type:vmware.vapi.data.value.ErrorValue Returns:ErrorValue for this VapiError

message Module

Message Factory import for the bindings to use

skeleton Module

Skeleton helper classes

class vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton(iface_name, impl, operations, error_types)

Bases: vmware.vapi.core.ApiInterface

Skeleton class for ApiInterface. This class implements the ApiInterface interface.

Initialize the ApiInterface skeleton class

Parameters:

• iface_name (str) – Interface name
• impl (VapiInterface) – Class that implements this interface
• operations (dict) – Description of the operations in this service
• error_types (list of vmware.vapi.bindings.type.ErrorType) – error types to be registered in this configuration

classmethod check_for_unknown_fields(value_type, value)

Check if the StructValues inside the input DataValue has any unknown fields

Parameters:

• value_type (vmware.vapi.bindings.type.BindingType) – Binding Type
• value (vmware.vapi.data.value.DataValue) – DataValue

Return type:

vmware.vapi.data.value.ErrorValue or None

Returns:

ErrorValue describing the unknown fields or None if no unknown fields were found

get_definition()

get_identifier()

get_method_definition(method_id)

invoke(ctx, method_id, input_value)

Invokes the specified method using the execution context and the input provided

Parameters:

• ctx (vmware.vapi.core.ExecutionContext) – Execution context for this method
• input_value (vmware.vapi.data.value.StructValue) – Method input parameters

Return type:

vmware.vapi.core.MethodResult

Returns:

Result of the method invocation

class vmware.vapi.bindings.skeleton.VapiFilter(name='')

Bases: logging.Filter

This is a filter that injects request context into the log

Initialize a filter.

Initialize with the name of the logger which, together with its children, will have its events allowed through the filter. If no name is specified, allow every event.

filter(record)

class vmware.vapi.bindings.skeleton.VapiInterface(api_interface, error_types=None)

Bases: object

vAPI Interface class is used by the python server side bindings. This encapsulates the vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton class.

Initialize the VapiInterface class

Parameters:

• api_interface (vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton) – Api Interface skeleton class for this interface
• error_types (list of vmware.vapi.bindings.type.ErrorType) – error types to be registered in this configuration

api_interface

Returns the ApiInterfaceSkeleton instance. Local Provider uses this method to discover the ApiInterface so that it can route method calls for the methods implemented by this interface.

Return type:vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton Returns:Api Interface skeleton class for this interface

execution_context

Returns the execution context of a method invocation

Return type:vmware.vapi.core.ExecutionContext Returns:Execution context of a method invocation

struct Module

Bindings data classes

class vmware.vapi.bindings.struct.PrettyPrinter(stream=<open file '<stdout>', mode 'w' at 0xf65bd070>, indent=2)

Bases: object

Helper class to Pretty print VapiStruct objects

Initialize PrettyPrinter

Parameters:

• stream (object) – A stream object that implements File protocol’s write operation
• indent (int) – Indentation to be used for new lines

pprint(value, level=0)

Print a vAPI native struct value

Parameters:

• value (vmware.vapi.bindings.struct.VapiStruct) – VapiStruct to be pretty printed
• level (int) – Indentation level

class vmware.vapi.bindings.struct.VapiStruct(mappings=None, struct_value=None)

Bases: object

Representation of IDL Structure in python language bindings

Initialize VapiStruct

Parameters:

• mappings (dict or None) – A mapping for all field names whose IDL name does not match PEP8 standard name
• struct_value (vmware.vapi.data.value.StructValue) – StructValue to be used for VapiStruct or None

convert_to(cls)

Convert the underlying StructValue to an instance of the provided class if possible. Conversion will be possible if the StructValue contains all the fields expected by the provided class and the type of the value in each fields matches the type of the field expected by the provided class.

Parameters:cls (vmware.vapi.data.value.StructValue) – The type to convert to Return type::class:’vmware.vapi.bindings.struct.VapiStruct’ Returns:The converted value

classmethod get_binding_type()

Returns the corresponding BindingType for the VapiStruct class

Return type:vmware.vapi.bindings.type.BindingType Returns:BindingType for this VapiStruct

get_field(attr)

Returns the struct field value

Parameters:attr (str) – Field name as defined in IDL Return type:object Returns:Field value

get_struct_value()

Returns the corresponding StructValue for the VapiStruct class

Return type:vmware.vapi.data.value.StructValue Returns:StructValue for this VapiStruct

validate_constraints()

Validate if the current VapiStruct instance satisfies all the constraints of this VapiStruct type.

:raise vmware.vapi.exception.CoreException if a constraint is

not satisfied

classmethod validate_struct_value(struct_value)

Validate if the given struct value satisfies all the constraints of this VapiStruct.

Parameters:

• struct_value (vmware.vapi.data.value.StructValue) – StructValue to be validated
• validators (list of vmware.vapi.data.validator.Validator) – List of validators

:raise vmware.vapi.exception.CoreException if a constraint is

not satisfied

stub Module

Stub helper classes

class vmware.vapi.bindings.stub.ApiInterfaceStub(iface_name, config, operations)

Bases: vmware.vapi.core.ApiInterface

Stub class for Api Interface

Initialize the ApiMethod skeleton object

Parameters:

• iface_name (str) – Interface name
• config (StubConfiguration) – Configuration data for vAPI stubs
• operations (dict) – Dictionary of operation name to operation information

get_definition()

Returns interface definition

Return type:InterfaceDefinition Returns:Interface definition

get_identifier()

Returns interface identifier

Return type:InterfaceIdentifier Returns:Interface identifier

get_method_definition(method_id)

invoke(ctx, method_id, input_value)

Invokes the specified method using the execution context and the input provided

Parameters:

• ctx (vmware.vapi.core.ExecutionContext) – Execution context for this method
• method_id (vmware.vapi.core.MethodIdentifier) – Method identifier
• input_value (vmware.vapi.data.value.StructValue) – Method input parameters

Return type:

vmware.vapi.core.MethodResult

Returns:

Result of the method invocation

native_invoke(ctx, method_name, kwargs)

Invokes the method corresponding to the given method name with the kwargs.

In this method, python native values are converted to vAPI runtime values, operation is invoked and the result are converted back to python native values

Parameters:

• method_name (str) – Method name
• kwargs (dict) – arguments to be passed to the method

Return type:

object

Returns:

Method result

class vmware.vapi.bindings.stub.StubConfiguration(connector, *error_types)

Bases: object

Configuration data for vAPI stub classes

Variables:connector – Connection to be used to talk to the remote ApiProvider

Initialize the stub configuration

Parameters:

• connector (vmware.vapi.protocol.client.connector.Connector) – Connection to be used to talk to the remote ApiProvider
• error_types (list of vmware.vapi.bindings.type.ErrorType) – error types to be registered in this configuration

connector

Return type:vmware.vapi.protocol.client.connector.Connector Returns:Connection to be used to talk to the remote ApiProvider

resolver

Type resolver that can resolve canonical names to its binding types

Return type:vmware.vapi.bindings.common.NameToTypeResolver Returns:Type resolver

class vmware.vapi.bindings.stub.StubFactory(config)

Bases: object

Factory for client-side vAPI stubs

Initialize the stub factory

Parameters:config (StubConfiguration) – Configuration data for vAPI stubs

create_stub(service_name)

Create a stub corresponding to the specified service name

Parameters:service_name (str) – Name of the service Return type:VapiInterface Returns:The stub correspoding to the specified service name

class vmware.vapi.bindings.stub.VapiInterface(config, api_interface)

Bases: object

vAPI Interface class is used by the python client side bindings. This encapsulates the ApiInterfaceStub instance

Initialize VapiInterface object

Parameters:

• config (StubConfiguration) – Configuration data for vAPI stubs
• api_interface (ApiInterfaceStub) – Instance of ApiInterfaceStub class that can execute the ApiMethods

type Module

Representation of an IDL type for the use of the Python language bindings.

class vmware.vapi.bindings.type.AnyErrorType

Bases: vmware.vapi.bindings.type.BindingType

Representation of Exception type in Python Binding

Initialize AnyErrorType

class vmware.vapi.bindings.type.BindingType

Bases: object

Representation of an IDL type for the use of the Python language bindings

Parameters:definition (vmware.vapi.data.definition.DataDefinition) – Data definition corresponding to this binding type

accept(visitor)

Applies a visitor to this BindingType

Parameters:visitor (BindingTypeVisitor) – visitor operating on the BindingType

definition

Generate the data defintion corresponding to this binding type

class vmware.vapi.bindings.type.BindingTypeVisitor

Bases: vmware.vapi.lib.visitor.VapiVisitor

Base no-op implementation of a BindingType visitor

Initialize BindingTypeVisitor

visit_any_error(typ)

Visit an error value

Parameters:typ (AnyErrorType) – Binding type of the value

visit_blob(typ)

Visit a blob value

Parameters:typ (BlobType) – Binding type of the value

visit_boolean(typ)

Visit a boolean value

Parameters:typ (BooleanType) – Binding type of the value

visit_date_time(typ)

Visit a datetime value

Parameters:typ (DateTimeType) – Binding type of the value

visit_double(typ)

Visit a double value

Parameters:typ (DoubleType) – Binding type of the value

visit_dynamic_struct(typ)

Visit a struct value

Parameters:typ (DynamicStructType) – Binding type of the value

visit_enum(typ)

Visit a enum value

Parameters:typ (EnumType) – Binding type of the value

visit_error(typ)

Visit an error type

Parameters:typ (ErrorType) – Binding type of the value

visit_id(typ)

Visit a ID value

Parameters:typ (IdType) – Binding type of the value

visit_integer(typ)

Visit an integer value

Parameters:typ (IntegerType) – Binding type of the value

visit_list(typ)

Visit a list value

Parameters:typ (ListType) – Binding type of the value

visit_opaque(typ)

Visit an opaque value.

Parameters:typ (OpaqueType) – Binding type of the value

visit_optional(typ)

Visit an optional value

Parameters:typ (OptionalType) – Binding type of the value

visit_reference(typ)

Visit a reference type

Parameters:typ (ReferenceType) – Binding type of the value

visit_secret(typ)

Visit a secret value

Parameters:typ (SecretType) – Binding type of the value

visit_string(typ)

Visit a string value

Parameters:typ (StringType) – Binding type of the value

visit_struct(typ)

Visit a struct value

Parameters:typ (StructType) – Binding type of the value

visit_uri(typ)

Visit an URI value

Parameters:typ (URIType) – Binding type of the value

visit_void(typ)

Visit a void value (i.e. None)

Parameters:typ (VoidType) – Binding type of the value

class vmware.vapi.bindings.type.BlobType

Bases: vmware.vapi.bindings.type.BindingType

Representation of binary IDL Type in Python Binding

class vmware.vapi.bindings.type.BooleanType

Bases: vmware.vapi.bindings.type.BindingType

Representation of boolean IDL Type in Python Binding

class vmware.vapi.bindings.type.DataDefinitionBuilder(ctx, seen_structures)

Bases: vmware.vapi.bindings.type.BindingTypeVisitor

Builds DataDefinition by visiting a BindingType

Initialize DataDefinitionBuilder

Parameters:

• ctx (vmware.vapi.data.definition.ReferenceResolver) – Data definition reference resolver object
• seen_structures (list or str) – List of structures seen

get_out_value()

Returns the data definition

Return type:vmware.vapi.data.definition.DataDefinition Returns:Data definition

visit_any_error(typ)

Visit an error value

Parameters:typ (AnyErrorType) – Binding type of the value

visit_blob(typ)

Visit a blob value

Parameters:typ (BlobType) – Binding type of the value

visit_boolean(typ)

Visit a boolean value

Parameters:typ (BooleanType) – Binding type of the value

visit_date_time(typ)

Visit a datetime value

Parameters:typ (DateTimeType) – Binding type of the value

visit_double(typ)

Visit a double value

Parameters:typ (DoubleType) – Binding type of the value

visit_dynamic_struct(typ)

Visit a struct value

Parameters:typ (DynamicStructType) – Binding type of the value

visit_enum(typ)

Visit a enum value

Parameters:typ (EnumType) – Binding type of the value

visit_error(typ)

Visit an error type

Parameters:typ (ErrorType) – Binding type of the value

visit_id(typ)

Visit a ID value

Parameters:typ (IdType) – Binding type of the value

visit_integer(typ)

Visit an integer value

Parameters:typ (IntegerType) – Binding type of the value

visit_list(typ)

Visit a list value

Parameters:typ (ListType) – Binding type of the value

visit_map(typ)

Visit a map value

Parameters:typ (MapType) – Binding type of the value

visit_opaque(typ)

Visit an opaque value.

Parameters:typ (OpaqueType) – Binding type of the value

visit_optional(typ)

Visit an optional value

Parameters:typ (OptionalType) – Binding type of the value

visit_reference(typ)

Visit a reference type

Parameters:typ (ReferenceType) – Binding type of the value

visit_secret(typ)

Visit a secret value

Parameters:typ (SecretType) – Binding type of the value

visit_set(typ)

Visit a set value

Parameters:typ (SetType) – Binding type of the value

visit_string(typ)

Visit a string value

Parameters:typ (StringType) – Binding type of the value

visit_struct(typ)

Visit a struct value

Parameters:typ (StructType) – Binding type of the value

visit_uri(typ)

Visit an URI value

Parameters:typ (URIType) – Binding type of the value

visit_void(typ)

Visit a void value (i.e. None)

Parameters:typ (VoidType) – Binding type of the value

class vmware.vapi.bindings.type.DateTimeType

Bases: vmware.vapi.bindings.type.BindingType

Representation of datetime IDL Type in Python Binding

class vmware.vapi.bindings.type.DoubleType

Bases: vmware.vapi.bindings.type.BindingType

Representation of float IDL Type in Python Binding

class vmware.vapi.bindings.type.DynamicStructType(name, fields, binding_class=None, has_fields_of_type=None)

Bases: vmware.vapi.bindings.type.StructType

Representation of StructValue IDL annotation in Python Binding

Variables:has_fields_of_type – List of reference types whose fields need to be present in the StructValue for this DynamicStruct type

Initialize DynamicStructType

Parameters:

• name (str) – Name of the Structure
• fields (dict of str and BindingType) – Map of field name and field binding type
• binding_class (vmware.vapi.data.definition.DataDefinition) – Data definition for this type
• has_fields_of_type (ReferenceType) – List of reference types whose fields need to be present in the StructValue for this DynamicStruct type

has_fields_of_type

Returns the has_fields_of_type

:rtype ReferenceType :return List of reference types whose fields need to be present in the

StructValue for this DynamicStruct type

class vmware.vapi.bindings.type.EnumType(name, binding_class)

Bases: vmware.vapi.bindings.type.BindingType

Representation of enum IDL Type in Python Binding

Variables:

• name – Name of the enum
• binding_class – Reference to the Python native class corresponding to this structure

binding_class

Returns the reference to the Python native class corresponding to this structure

name

Returns the name of the EnumType

Return type:str Returns:Name of the EnumType

class vmware.vapi.bindings.type.ErrorType(name, fields, binding_class=None)

Bases: vmware.vapi.bindings.type.StructType

Representation of Error IDL type in Python Binding

Variables:

• definition – type representation in the API runtime
• name – Name of the structure
• binding_class – Reference to the Python native class corresponding to this error

class vmware.vapi.bindings.type.IdType(resource_types=None, resource_type_field_name=None)

Bases: vmware.vapi.bindings.type.BindingType

Representation of ID IDL type in Python Binding

Variables:

• resolved_types – Resource type(s) for the ID
• resource_type_field_name – Name of the field specifying the resource type

resource_type_field_name

Returns the name of the field specifying the resource type

Return type:str Returns:Name of the field specifying the resource type

resource_types

Returns the Resource type(s) for the ID field

Return type:list of str or str or None Returns:Resource type(s) for the ID

class vmware.vapi.bindings.type.IntegerType

Bases: vmware.vapi.bindings.type.BindingType

Representation of integer IDL Type in Python Binding

class vmware.vapi.bindings.type.ListType(element_type)

Bases: vmware.vapi.bindings.type.BindingType

Representation of List IDL type in Python Binding

Variables:element_type – element type

element_type

Return the element type of this ListType

Return type:BindingType Returns:element type

class vmware.vapi.bindings.type.MapType(key_type, value_type)

Bases: vmware.vapi.bindings.type.BindingType

Representation of Map IDL type in Python Binding

Variables:

• key_type – map key type
• value_type – map value type

key_type

Return the key type of this MapType

Return type:BindingType Returns:key type

value_type

Return the value type of this MapType

Return type:BindingType Returns:value type

class vmware.vapi.bindings.type.OpaqueType

Bases: vmware.vapi.bindings.type.BindingType

Representation of Opaque IDL annotation in Python Binding

class vmware.vapi.bindings.type.OptionalType(element_type)

Bases: vmware.vapi.bindings.type.BindingType

Representation of optional IDL annotation in Python Binding

Variables:element_type – element type

element_type

Return the element type of this ListType

Return type:BindingType Returns:element type

class vmware.vapi.bindings.type.ReferenceType(context, type_name)

Bases: vmware.vapi.bindings.type.BindingType

Reference type to resolve references lazily.

Variables:resolved_type – Resolved reference type

Initialize ReferenceType

Parameters:

• context (module) – Module reference that has the type
• type_name (str) – Fully qualified name of the type reference. i.e. if the type Bar is nested inside type Foo, it would be Foo.Bar

resolved_type

Returns the resolved struct type or enum type

Return type:StructType or EnumType Returns:Resolved struct type or enum type

class vmware.vapi.bindings.type.SecretType

Bases: vmware.vapi.bindings.type.BindingType

Representation of @secret IDL annotation in Python Binding. @secret annotation can only be applied to strings.

class vmware.vapi.bindings.type.SetType(element_type)

Bases: vmware.vapi.bindings.type.BindingType

Representation of Set IDL type in Python Binding

Variables:element_type – element type

element_type

Return the element type of this SetType

Return type:BindingType Returns:element type

class vmware.vapi.bindings.type.StringType

Bases: vmware.vapi.bindings.type.BindingType

Representation of string IDL Type in Python Binding

class vmware.vapi.bindings.type.StructType(name, fields, binding_class=None, is_model=False, model_keys=None)

Bases: vmware.vapi.bindings.type.BindingType

Representation of Structure IDL type in Python Binding

Variables:

• name – Name of the structure
• binding_class – Reference to the Python native class corresponding to this structure
• is_model – True if the structure is marked as Model, False otherwise
• model_keys – List of model keys for the structure if it is marked as Model

binding_class

Returns the reference to the Python native class corresponding to this structure

Return type:vmware.vapi.bindings.struct.VapiStruct Returns:Reference to the python native class

get_field(field_name)

Returns the BindingType of the argument

Parameters:field_name (str) – Field name Return type:BindingType Returns:BindingType of the field specified

get_field_names()

Returns the list of field names present in this StructType

Return type:list of str Returns:List of field names

is_model

Check if the Struct is marked as model

Return type:bool Returns:True if the Struct is marked as model, False otherwise

model_keys

Returns list of model keys for the Struct if it is marked as model

Return type:list of str or None Returns:List of model keys for the Struct if it is marked as model

name

Returns the name of the StructType

Return type:str Returns:Name of the StructType

class vmware.vapi.bindings.type.TypeUtil

Bases: object

Converts a BindingType object to DataDefinition object

static convert_to_data_definition(binding_type)

Converts a BindingType object to DataDefinition object

Parameters:binding_type (BindingType) – Binding type Return type:vmware.vapi.data.definition.DataDefinition Returns:DataDefinition

class vmware.vapi.bindings.type.URIType

Bases: vmware.vapi.bindings.type.BindingType

Representation of URI IDL Type in Python Binding

class vmware.vapi.bindings.type.VoidType

Bases: vmware.vapi.bindings.type.BindingType

Representation of void IDL type in Python Binding

uri_helper Module

Utility library for validating IRI that conform to RFC 3987

class vmware.vapi.bindings.uri_helper.URIValidator

Bases: object

Helper class for validation of IRI’s

compiled_regex = {'IRI': <_sre.SRE_Pattern object at 0x992f4b0>, 'IRI_reference': <_sre.SRE_Pattern object at 0x9941e78>}

final_regex = {'IPv4address': '(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)', 'ireg_name': "(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*", 'sub_delims': "[!$&'()*+,;=]", 'reserved': "(?:[:/?#[\\]@]|[!$&'()*+,;=])", 'ucschar': '[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF]', 'isegment_nz_nc': "(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|@)+", 'IRI_reference': "(?:[a-zA-Z][a-zA-Z0-9+.-]*:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)(?:\\?(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|[\\uE000-\\uF8FF]|/|\\?)*)?(?:\\#(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|/|\\?)*)?|(?:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)(?:\\?(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|[\\uE000-\\uF8FF]|/|\\?)*)?(?:\\#(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|/|\\?)*)?))", 'ipath_absolute': "/(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?", 'iauthority': "(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?", 'unreserved': '[a-zA-Z0-9_.~-]', 'port': '[0-9]*', 'irelative_part': "(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)", 'ihost': "(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)", 'iunreserved': '(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])', 'iprivate': '[\\uE000-\\uF8FF]', 'IPvFuture': "v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+", 'pct_encoded': '%[0-9A-Fa-f][0-9A-Fa-f]', 'irelative_ref': "(?:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)(?:\\?(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|[\\uE000-\\uF8FF]|/|\\?)*)?(?:\\#(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|/|\\?)*)?)", 'ipath': "(?:(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)", 'ls32': '(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))', 'ipchar': "(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)", 'dec_octet': '(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)', 'scheme': '[a-zA-Z][a-zA-Z0-9+.-]*', 'ipath_rootless': "(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*", 'iuserinfo': "(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*", 'IPv6address': '(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)', 'ipath_abempty': "(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*", 'ipath_empty': '', 'absolute_IRI': "[a-zA-Z][a-zA-Z0-9+.-]*:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)(?:\\?(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|[\\uE000-\\uF8FF]|/|\\?)*)?", 'IRI': "[a-zA-Z][a-zA-Z0-9+.-]*:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)(?:\\?(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|[\\uE000-\\uF8FF]|/|\\?)*)?(?:\\#(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|/|\\?)*)?", 'isegment': "(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*", 'ipath_noscheme': "(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*", 'isegment_nz': "(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+", 'ihier_part': "(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)", 'ifragment': "(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|/|\\?)*", 'iquery': "(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|[\\uE000-\\uF8FF]|/|\\?)*", 'h16': '[0-9A-Fa-f]{1,4}', 'IP_literal': "\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]", 'gen_delims': '[:/?#[\\]@]'}

key = 'IRI_reference'

regex = <_sre.SRE_Pattern object at 0x9941e78>

regex_str = u"^(?:[a-zA-Z][a-zA-Z0-9+.-]*:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)(?:\\?(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|[\ue000-\uf8ff]|/|\\?)*)?(?:\\#(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|/|\\?)*)?|(?:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)(?:\\?(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|[\ue000-\uf8ff]|/|\\?)*)?(?:\\#(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|/|\\?)*)?))$"

rule_type = 'IRI_reference'

unicode_wrap = 'u"""{0}"""'

static validate(iri)

Validate the given IRI string

Parameters:iri (str) – IRI string to be validated

value = '(?:{IRI}|{irelative_ref})'

value Module

Convenient libraries for DynamicValue

class vmware.vapi.bindings.value.BaseDataValueConverter

Bases: object

Class to convert DataValue <-> DynamicValue

Note: This is an internal helper class for supporting this functionality in client and provider standard libraries. This class should be derived and the derived class should initialize dynamic_value_class and optional_dynamic_value_class with the appropriate class references.

Variables:

• dynamic_value_class – Dynamic value class reference
• optional_dynamic_value_class – Optional dynamic value class reference

dynamic_value_class = None

optional_dynamic_value_class = None

classmethod to_data_value(dynamic_value)

Convert a given DynamicValue to DataValue

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be converted Return type:vmware.vapi.data.value.DataValue Returns:DataValue generated from DynamicValue

classmethod to_dynamic_value(data_value)

Convert a given DataValue to DynamicValue

Parameters:data_value (vmware.vapi.data.value.DataValue) – DataValue to be converted Return type:vmware.vapi.bindings.struct.VapiStruct Returns:DynamicValue generated from DataValue

class vmware.vapi.bindings.value.BaseNativeValueConverter

Bases: object

class to convert Native value <-> DynamicValue.

Note: This is an internal helper class for supporting this functionality in client and provider standard libraries. This class should be derived and the derived class should initialize dynamic_value_class and optional_dynamic_value_class with the appropriate class references.

Variables:

• dynamic_value_class – Dynamic value class reference
• optional_dynamic_value_class – Optional dynamic value class reference

dynamic_value_class = None

optional_dynamic_value_class = None

classmethod to_dynamic_value(native_value, is_optional=False, is_secret=False, is_binary=False)

Convert a given native value to DynamicValue

Parameters:

• native_value (object) – Native value to be converted
• is_optional (bool) – If true, after conversion of native value to dynamic value, the output is wrapped in an dynamic value whose type is OPTIONAL.
• is_secret (bool) – If true, and the native value is a string, the type of the dynamic value returned will be secret. This boolean option, is also passed to the elements of generic types such as List and Set.
• is_binary (bool) – If true, and the native value is a string, the type of the dynamic value returned will be binary. This boolean option, is also passed to the elements of generic types such as List and Set.

Return type:

vmware.vapi.bindings.struct.VapiStruct

Returns:

DynamicValue generated from DataValue

classmethod to_native_value(dynamic_value, is_set=False, is_datetime=False, user_defined_class_reference=None)

Convert a given DynamicValue to native value

Parameters:

• dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be converted
• is_set (bool) – If true, and the dynamic value is a list, the type of the native value returned will be a set. This boolean option, is also passed to the elements of generic types such as List and Optional. If the dynamic value represents a Map, this option is used only for the conversion of values of the Map.
• is_datetime (bool) – If true, and the dynamic value is a string, the type of the native value returned will be a datetime. This boolean option, is also passed to the elements of generic types such as List and Optional. If the dynamic value represents a Map, this option is used only for the conversion of values of the Map.
• user_defined_class_reference (vmware.vapi.bindings.struct.VapiStruct or vmware.vapi.bindings.error.VapiError or vmware.vapi.bindings.enum.Enum) – This class reference is used to create native instances of user defined types (structures, errors and enumerations). If the dynamic value is a Structure, instead of returning VapiStruct, an instance of this class is returned. If the dynamic value is an Error, instead of returning VapiError, an instance of this class is returned. If the dynamic value is String, instead of returning a string, an instance of this class is returned.

Return type:

object

Returns:

Native value generated

class vmware.vapi.bindings.value.DataValueToDynamicValueVisitor(dynamic_value_class, optional_dynamic_value_class)

Bases: vmware.vapi.data.value.SimpleValueVisitor

Visitor to convert DataValue to DynamicValue

Initialize DataValueToDynamicValueVisitor

Parameters:

• dynamic_value_class (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue class reference
• optional_dynamic_value_class (vmware.vapi.bindings.struct.VapiStruct) – OptionalDynamicValue class reference

get_out_value()

Returns the output value

Return type:vmware.vapi.bindings.struct.VapiStruct Returns:DynamicValue generated from DataValue

visit_blob(value)

visit_boolean(value)

visit_double(value)

visit_error(value)

visit_integer(value)

visit_list(value)

visit_optional(value)

visit_secret(value)

visit_string(value)

visit_struct(value)

visit_void(value)

class vmware.vapi.bindings.value.DynamicValueToDataValueVisitor(dynamic_value_class)

Bases: object

Visitor to convert DynamicValue to DataValue

Initialize DynamicValueToDataValueVisitor

Parameters:dynamic_value_class (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue class reference

get_out_value()

Returns the DataValue

Return type:vmware.vapi.data.value.DataValue Returns:DataValue generated from DynamicValue

visit(dynamic_value)

Visit a DynamicValue

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_binary(dynamic_value)

Visit a DynamicValue whose type is BINARY

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_boolean(dynamic_value)

Visit a DynamicValue whose type is BOOLEAN

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_double(dynamic_value)

Visit a DynamicValue whose type is DOUBLE

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_error(dynamic_value)

Visit a DynamicValue whose type is ERROR

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_list(dynamic_value)

Visit a DynamicValue whose type is LIST

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_long(dynamic_value)

Visit a DynamicValue whose type is LONG

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_optional(dynamic_value)

Visit a DynamicValue whose type is OPTIONAL

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_secret(dynamic_value)

Visit a DynamicValue whose type is SECRET

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_string(dynamic_value)

Visit a DynamicValue whose type is STRING

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_structure(dynamic_value)

Visit a DynamicValue whose type is STRUCTURE

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_void(dynamic_value)

Visit a DynamicValue whose type is VOID

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

class vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor(dynamic_value_class, optional_dynamic_value_class, is_set=False, is_datetime=False, user_defined_class_reference=None)

Bases: object

Visitor to convert DynamicValue to python native value

Initialize DynamicValueToDataValueVisitor

Parameters:

• dynamic_value_class (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue class reference
• optional_dynamic_value_class (vmware.vapi.bindings.struct.VapiStruct) – OptionalDynamicValue class reference
• is_set (bool) – If true, and the dynamic value is a list, the type of the native value returned will be a set. This boolean option, is also passed to the elements of generic types such as List and Optional. If the dynamic value represents a Map, this option is used only for the conversion of values of the Map.
• is_datetime (bool) – If true, and the dynamic value is a string, the type of the native value returned will be a datetime. This boolean option, is also passed to the elements of generic types such as List and Optional. If the dynamic value represents a Map, this option is used only for the conversion of values of the Map.
• user_defined_class_reference (vmware.vapi.bindings.struct.VapiStruct or vmware.vapi.bindings.error.VapiError or vmware.vapi.bindings.enum.Enum) – This class reference is used to create native instances of user defined types (structures, errors and enumerations). If the dynamic value is a Structure, instead of returning VapiStruct, an instance of this class is returned. If the dynamic value is an Error, instead of returning VapiError, an instance of this class is returned. If the dynamic value is String, instead of returning a string, an instance of this class is returned.

get_out_value()

Returns the DataValue

Return type:vmware.vapi.data.value.DataValue Returns:DataValue generated from DynamicValue

visit(dynamic_value)

Visit a DynamicValue

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_binary(dynamic_value)

Visit a DynamicValue whose type is BINARY

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_boolean(dynamic_value)

Visit a DynamicValue whose type is BOOLEAN

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_double(dynamic_value)

Visit a DynamicValue whose type is DOUBLE

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_error(dynamic_value)

Visit a DynamicValue whose type is ERROR

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_list(dynamic_value)

Visit a DynamicValue whose type is LIST

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_long(dynamic_value)

Visit a DynamicValue whose type is LONG

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_optional(dynamic_value)

Visit a DynamicValue whose type is OPTIONAL

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_secret(dynamic_value)

Visit a DynamicValue whose type is SECRET

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_string(dynamic_value)

Visit a DynamicValue whose type is STRING

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_structure(dynamic_value)

Visit a DynamicValue whose type is STRUCTURE

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

visit_void(dynamic_value)

Visit a DynamicValue whose type is VOID

Parameters:dynamic_value (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue to be visited

class vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor(dynamic_value_class, optional_dynamic_value_class, is_optional=False, is_secret=False, is_binary=False)

Bases: object

Visitor to convert Native value to Dynamic value

Initialize DynamicValueToDataValueVisitor

Parameters:

• dynamic_value_class (vmware.vapi.bindings.struct.VapiStruct) – DynamicValue class reference
• optional_dynamic_value_class (vmware.vapi.bindings.struct.VapiStruct) – OptionalDynamicValue class reference
• is_optional (bool) – If true, after conversion of native value to dynamic value, the output is wrapped in an dynamic value whose type is OPTIONAL.
• is_secret (bool) – If true, and the native value is a string, the type of the dynamic value returned will be secret. This boolean option, is also passed to the elements of generic types such as List and Set.
• is_binary (bool) – If true, and the native value is a string, the type of the dynamic value returned will be binary. This boolean option, is also passed to the elements of generic types such as List and Set.

get_out_value()

Returns the DataValue

Return type:vmware.vapi.data.value.DataValue Returns:DataValue generated from DynamicValue

visit(native_value)

Visit a native value

Parameters:native_value (object) – Native value to be converted

visit_boolean(native_value)

visit a native value whose value is bool type

Parameters:native_value (bool) – Native value to be converted

visit_datetime(native_value)

visit a native value whose value is datetime type

Parameters:native_value (datetime.datetime) – Native value to be converted

visit_double(native_value)

visit a native value whose value is double type

Parameters:native_value (double or decimal.Decimal) – Native value to be converted

visit_enumeration(native_value)

visit a native value whose value is vAPI enumeration type

Parameters:native_value (vmware.vapi.bindings.enum.Enum) – Native value to be converted

visit_error(native_value)

visit a native value whose value is vAPI error type

Parameters:native_value (vmware.vapi.bindings.error.VapiError) – Native value to be converted

visit_list(native_value)

visit a native value whose value is list or set type

Parameters:native_value (list or set) – Native value to be converted

visit_long(native_value)

visit a native value whose value is long type

Parameters:native_value (int or long) – Native value to be converted

visit_string(native_value)

visit a native value whose value is string type

Parameters:native_value (str) – Native value to be converted

visit_structure(native_value)

visit a native value whose value is vAPI structure type

Parameters:native_value (vmware.vapi.bindings.struct.VapiStruct) – Native value to be converted

visit_void(native_value)

visit a native value whose value is None type

Parameters:native_value (None) – Native value to be converted