+from __future__ import annotations + +import sys +from threading import Lock +from types import TracebackType +from typing import ( + Dict, + Literal, + Optional, + Type, + TYPE_CHECKING, +) + +import grpc + +from ni_measurementlink_service._loggers import ClientLogger + +if TYPE_CHECKING: + if sys.version_info >= (3, 11): + from typing import Self + else: + from typing_extensions import Self + + +[docs]class GrpcChannelPool(object): + """Class that manages gRPC channel lifetimes.""" + + def __init__(self) -> None: + """Initialize the GrpcChannelPool object.""" + self._lock: Lock = Lock() + self._channel_cache: Dict[str, grpc.Channel] = {} + +[docs] def __enter__(self: Self) -> Self: + """Enter the runtime context of the GrpcChannelPool.""" + return self + +[docs] def __exit__( + self, + exc_type: Optional[Type[BaseException]], + exc_val: Optional[BaseException], + traceback: Optional[TracebackType], + ) -> Literal[False]: + """Exit the runtime context of the GrpcChannelPool.""" + self.close() + return False + +[docs] def get_channel(self, target: str) -> grpc.Channel: + """Return a gRPC channel. + + Args: + target (str): The server address + + """ + new_channel = None + with self._lock: + if target not in self._channel_cache: + self._lock.release() + new_channel = grpc.insecure_channel(target) + if ClientLogger.is_enabled(): + new_channel = grpc.intercept_channel(new_channel, ClientLogger()) + self._lock.acquire() + if target not in self._channel_cache: + self._channel_cache[target] = new_channel + new_channel = None + channel = self._channel_cache[target] + + # Close new_channel if it was not stored in _channel_cache. + if new_channel is not None: + new_channel.close() + + return channel + +[docs] def close(self) -> None: + """Close channels opened by get_channel().""" + with self._lock: + for channel in self._channel_cache.values(): + channel.close() + self._channel_cache.clear() +
"""Serialization Strategy.""" +from __future__ import annotations -from typing import Any, Callable +from typing import Any, Optional, cast from google.protobuf import type_pb2 -from google.protobuf.internal import decoder -from google.protobuf.internal import encoder +from google.protobuf.internal import decoder, encoder +from google.protobuf.message import Message +from ni_measurementlink_service._internal.parameter import _message +from ni_measurementlink_service._internal.parameter._serializer_types import ( + Decoder, + DecoderConstructor, + Encoder, + EncoderConstructor, + Key, + PartialDecoderConstructor, + PartialEncoderConstructor, +) +from ni_measurementlink_service._internal.stubs.ni.protobuf.types import xydata_pb2 -def _scalar_encoder(encoder) -> Callable[[int], Callable]: - """Abstract Specific Encoder(Callable) as Scalar Encoder Callable that takes in field index. - Args - ---- - encoder (Callable[[int, bool, bool], Callable]): Specific encoder that takes in - field_index, is_repeated, is_packed and returns the Low-level Encode Callable. +def _scalar_encoder(encoder: EncoderConstructor) -> PartialEncoderConstructor: + """Constructs a scalar encoder constructor. - Returns - ------- - Callable[[int],Callable]: Callable Encoder for scalar types that takes - in field_index and returns the Low-level Encode Callable. + Takes a field index and returns an Encoder. + This class returns the Encoder with is_repeated set to False + and is_packed set to False. """ - def scalar_encoder(field_index): + def scalar_encoder(field_index: int) -> Encoder: is_repeated = False is_packed = False return encoder(field_index, is_repeated, is_packed) @@ -105,231 +112,210 @@ Source code for ni_measurementlink_service._internal.parameter.serialization return scalar_encoder -def _vector_encoder(encoder, is_packed=True) -> Callable[[int], Callable]: - """Abstract Specific Encoder(Callable) as Vector Encoder Callable that takes in field index. +def _vector_encoder( + encoder: EncoderConstructor, is_packed: bool = True +) -> PartialEncoderConstructor: + """Constructs a vector (array) encoder constructor. - Args - ---- - encoder (Callable[[int, bool, bool], Callable]): Specific encoder(Callable) that takes in - field_index, is_repeated, is_packed and returns the Low-level Encode Callable. - - is_packed (bool, optional): Represents if the encoder supports packed type. Defaults to True. - - Returns - ------- - Callable[[int],Callable]: Callable Encoder for 1D Array types that takes in - field_index and returns the Low-level Encode Callable. + Takes a field index and returns an Encoder. + This class returns the Encoder with is_repeated set to True + and is_packed defaulting to True. """ - def vector_encoder(field_index): + def vector_encoder(field_index: int) -> Encoder: is_repeated = True return encoder(field_index, is_repeated, is_packed) return vector_encoder -def _scalar_decoder(decoder) -> Callable[[int, str], Callable]: - """Abstract Specific Decoder(Callable) as Scalar Decoder Callable that takes in field index,key. +def _unsupported_encoder(field_index: int, is_repeated: bool, is_packed: bool) -> Encoder: + raise NotImplementedError(f"Unsupported data type for field {field_index}") - Args - ---- - decoder (Callable[[int, bool, bool], Callable]): Specific decoder(Callable) that takes in - field_index, is_repeated, is_packed, key, new_default and - returns the Low-level Decode Callable. - Returns - ------- - Callable[[int,str],Callable]: Callable Decoder for scalar types that takes in - field_index, key and returns the Low-level Decode Callable. +def _scalar_decoder(decoder: DecoderConstructor) -> PartialDecoderConstructor: + """Constructs a scalar decoder constructor. + Takes a field index and a key and returns a Decoder. + + This class returns the Decoder with is_repeated set to False + and is_packed set to False. """ - def scalar_decoder(field_index, key): + def _unsupported_new_default(message: Optional[Message]) -> Any: + raise NotImplementedError( + "This function should not be called. Verify that you are using up-to-date and compatible versions of the ni-measurementlink-service and protobuf packages." + ) + + def scalar_decoder(field_index: int, key: Key) -> Decoder: is_repeated = False is_packed = False - return decoder(field_index, is_repeated, is_packed, key, None) + return decoder(field_index, is_repeated, is_packed, key, _unsupported_new_default) return scalar_decoder -def _vector_decoder(decoder, is_packed=True) -> Callable[[int, str], Callable]: - """Abstract Specific Decoder(Callable) as Vector Decoder Callable that takes in field index,key. +def _vector_decoder( + decoder: DecoderConstructor, is_packed: bool = True +) -> PartialDecoderConstructor: + """Constructs a vector (array) decoder constructor. - Args - ---- - decoder (Callable[[int, bool, bool], Callable]): Specific decoder(Callable) that takes in - field_index, is_repeated, is_packed, key, new_default and - returns the Low-level Decode Callable. - - is_packed (bool, optional): Represents if the decoder supports packed type. - Defaults to True. - - Returns - ------- - Callable[[int,str],Callable]: Callable Decoder for 1D Array types that takes in - field_index , key and returns the Low-level Decode Callable. + Takes a field index and a key and returns a Decoder. + This class returns the Decoder with is_repeated set to True + and is_packed defaulting to True. """ - def _new_default(unused_message=None): + def _new_default(unused_message: Optional[Message] = None) -> Any: return [] - def vector_decoder(field_index, key): + def vector_decoder(field_index: int, key: Key) -> Decoder: is_repeated = True return decoder(field_index, is_repeated, is_packed, key, _new_default) return vector_decoder -FloatEncoder = _scalar_encoder(encoder.FloatEncoder) -DoubleEncoder = _scalar_encoder(encoder.DoubleEncoder) -IntEncoder = _scalar_encoder(encoder.Int32Encoder) -UIntEncoder = _scalar_encoder(encoder.UInt32Encoder) -BoolEncoder = _scalar_encoder(encoder.BoolEncoder) -StringEncoder = _scalar_encoder(encoder.StringEncoder) - -FloatArrayEncoder = _vector_encoder(encoder.FloatEncoder) -DoubleArrayEncoder = _vector_encoder(encoder.DoubleEncoder) -IntArrayEncoder = _vector_encoder(encoder.Int32Encoder) -UIntArrayEncoder = _vector_encoder(encoder.UInt32Encoder) -BoolArrayEncoder = _vector_encoder(encoder.BoolEncoder) -StringArrayEncoder = _vector_encoder(encoder.StringEncoder, is_packed=False) - - -FloatDecoder = _scalar_decoder(decoder.FloatDecoder) -DoubleDecoder = _scalar_decoder(decoder.DoubleDecoder) -Int32Decoder = _scalar_decoder(decoder.Int32Decoder) -UInt32Decoder = _scalar_decoder(decoder.UInt32Decoder) -Int64Decoder = _scalar_decoder(decoder.Int64Decoder) -UInt64Decoder = _scalar_decoder(decoder.UInt64Decoder) -BoolDecoder = _scalar_decoder(decoder.BoolDecoder) -StringDecoder = _scalar_decoder(decoder.StringDecoder) - -FloatArrayDecoder = _vector_decoder(decoder.FloatDecoder) -DoubleArrayDecoder = _vector_decoder(decoder.DoubleDecoder) -Int32ArrayDecoder = _vector_decoder(decoder.Int32Decoder) -UInt32ArrayDecoder = _vector_decoder(decoder.UInt32Decoder) -Int64ArrayDecoder = _vector_decoder(decoder.Int64Decoder) -UInt64ArrayDecoder = _vector_decoder(decoder.UInt64Decoder) -BoolArrayDecoder = _vector_decoder(decoder.BoolDecoder) -StringArrayDecoder = _vector_decoder(decoder.StringDecoder, is_packed=False) - - -[docs]class Context: - """Strategy context.""" - - _FIELD_TYPE_TO_ENCODER_MAPPING = { - type_pb2.Field.TYPE_FLOAT: (FloatEncoder, FloatArrayEncoder), - type_pb2.Field.TYPE_DOUBLE: (DoubleEncoder, DoubleArrayEncoder), - type_pb2.Field.TYPE_INT32: (IntEncoder, IntArrayEncoder), - type_pb2.Field.TYPE_INT64: (IntEncoder, IntArrayEncoder), - type_pb2.Field.TYPE_UINT32: (UIntEncoder, UIntArrayEncoder), - type_pb2.Field.TYPE_UINT64: (UIntEncoder, UIntArrayEncoder), - type_pb2.Field.TYPE_BOOL: (BoolEncoder, BoolArrayEncoder), - type_pb2.Field.TYPE_STRING: (StringEncoder, StringArrayEncoder), - type_pb2.Field.TYPE_ENUM: (IntEncoder, IntArrayEncoder), - } - - _FIELD_TYPE_TO_DECODER_MAPPING = { - type_pb2.Field.TYPE_FLOAT: (FloatDecoder, FloatArrayDecoder), - type_pb2.Field.TYPE_DOUBLE: (DoubleDecoder, DoubleArrayDecoder), - type_pb2.Field.TYPE_INT32: (Int32Decoder, Int32ArrayDecoder), - type_pb2.Field.TYPE_INT64: (Int64Decoder, Int64ArrayDecoder), - type_pb2.Field.TYPE_UINT32: (UInt32Decoder, UInt32ArrayDecoder), - type_pb2.Field.TYPE_UINT64: (UInt64Decoder, UInt64ArrayDecoder), - type_pb2.Field.TYPE_BOOL: (BoolDecoder, BoolArrayDecoder), - type_pb2.Field.TYPE_STRING: (StringDecoder, StringArrayDecoder), - type_pb2.Field.TYPE_ENUM: (Int32Decoder, Int32ArrayDecoder), - } - - _TYPE_DEFAULT_MAPPING = { - type_pb2.Field.TYPE_FLOAT: float(), - type_pb2.Field.TYPE_DOUBLE: float(), - type_pb2.Field.TYPE_INT32: int(), - type_pb2.Field.TYPE_INT64: int(), - type_pb2.Field.TYPE_UINT32: int(), - type_pb2.Field.TYPE_UINT64: int(), - type_pb2.Field.TYPE_BOOL: bool(), - type_pb2.Field.TYPE_STRING: str(), - type_pb2.Field.TYPE_ENUM: int(), - } - -[docs] @staticmethod - def get_encoder( - type: type_pb2.Field.Kind.ValueType, repeated: bool - ) -> Callable[[int], Callable]: - """Get the Scalar Encoder or Vector Encoder for the specified type based on repeated bool. - - Args - ---- - type (type_pb2.Field.Kind.ValueType): Type of the Parameter. - - repeated (bool): Boolean that represents if the Parameter is repeated or not. - - Raises - ------ - Exception: If the specified type is not supported. - - Returns - ------- - Callable[[int], Callable]: ScalarEncoder or VectorEncoder. - - """ - if type not in Context._FIELD_TYPE_TO_ENCODER_MAPPING: - raise Exception(f"Error can not encode type '{type}'") - scalar, array = Context._FIELD_TYPE_TO_ENCODER_MAPPING[type] - if repeated: - return array - return scalar +def _double_xy_data_decoder(decoder: DecoderConstructor) -> PartialDecoderConstructor: + """Constructs a DoubleXYData decoder constructor. -[docs] @staticmethod - def get_decoder( - type: type_pb2.Field.Kind.ValueType, repeated: bool - ) -> Callable[[int, str], Callable]: - """Get the Scalar Decoder or Vector Decoder for the specified type based on repeated bool. - - Args - ---- - type (type_pb2.Field.Kind.ValueType): Type of the Parameter. - - repeated (bool): Boolean that represents if the Parameter is repeated or not. - - Raises - ------ - Exception: If the specified type is not supported. - - Returns - ------- - Callable[[int], Callable]: ScalarDecoder or VectorDecoder. + Takes a field index and a key and returns a Decoder for DoubleXYData. + """ - """ - if type not in Context._FIELD_TYPE_TO_DECODER_MAPPING: - raise Exception(f"Error can not decode type '{type}'") - scalar, array = Context._FIELD_TYPE_TO_DECODER_MAPPING[type] - if repeated: - return array - return scalar + def _new_default(unused_message: Optional[Message] = None) -> Any: + return xydata_pb2.DoubleXYData() -[docs] @staticmethod - def get_type_default(type: type_pb2.Field.Kind.ValueType, repeated: bool) -> Any: - """Get the Type default. + def message_decoder(field_index: int, key: Key) -> Decoder: + is_repeated = True + is_packed = True + return decoder(field_index, is_repeated, is_packed, key, _new_default) - Args - ---- - type (type_pb2.Field.Kind.ValueType): Type of the Parameter. + return message_decoder - repeated (bool): Boolean that represents if the Parameter is repeated or not. - Returns - ------- - Any: Default value. +# Cast works around this issue in typeshed +# https://github.com/python/typeshed/issues/10695 +FloatEncoder = _scalar_encoder(cast(EncoderConstructor, encoder.FloatEncoder)) +DoubleEncoder = _scalar_encoder(cast(EncoderConstructor, encoder.DoubleEncoder)) +IntEncoder = _scalar_encoder(cast(EncoderConstructor, encoder.Int32Encoder)) +UIntEncoder = _scalar_encoder(cast(EncoderConstructor, encoder.UInt32Encoder)) +BoolEncoder = _scalar_encoder(encoder.BoolEncoder) +StringEncoder = _scalar_encoder(encoder.StringEncoder) +MessageEncoder = _scalar_encoder(cast(EncoderConstructor, _message._message_encoder_constructor)) - """ +FloatArrayEncoder = _vector_encoder(cast(EncoderConstructor, encoder.FloatEncoder)) +DoubleArrayEncoder = _vector_encoder(cast(EncoderConstructor, encoder.DoubleEncoder)) +IntArrayEncoder = _vector_encoder(cast(EncoderConstructor, encoder.Int32Encoder)) +UIntArrayEncoder = _vector_encoder(cast(EncoderConstructor, encoder.UInt32Encoder)) +BoolArrayEncoder = _vector_encoder(encoder.BoolEncoder) +StringArrayEncoder = _vector_encoder(encoder.StringEncoder, is_packed=False) +UnsupportedMessageArrayEncoder = _vector_encoder(_unsupported_encoder) + +# Cast works around this issue in typeshed +# https://github.com/python/typeshed/issues/10697 +FloatDecoder = _scalar_decoder(cast(DecoderConstructor, decoder.FloatDecoder)) +DoubleDecoder = _scalar_decoder(cast(DecoderConstructor, decoder.DoubleDecoder)) +Int32Decoder = _scalar_decoder(cast(DecoderConstructor, decoder.Int32Decoder)) +UInt32Decoder = _scalar_decoder(cast(DecoderConstructor, decoder.UInt32Decoder)) +Int64Decoder = _scalar_decoder(cast(DecoderConstructor, decoder.Int64Decoder)) +UInt64Decoder = _scalar_decoder(cast(DecoderConstructor, decoder.UInt64Decoder)) +BoolDecoder = _scalar_decoder(cast(DecoderConstructor, decoder.BoolDecoder)) +StringDecoder = _scalar_decoder(cast(DecoderConstructor, decoder.StringDecoder)) +XYDataDecoder = _double_xy_data_decoder(_message._message_decoder_constructor) + +FloatArrayDecoder = _vector_decoder(cast(DecoderConstructor, decoder.FloatDecoder)) +DoubleArrayDecoder = _vector_decoder(cast(DecoderConstructor, decoder.DoubleDecoder)) +Int32ArrayDecoder = _vector_decoder(cast(DecoderConstructor, decoder.Int32Decoder)) +UInt32ArrayDecoder = _vector_decoder(cast(DecoderConstructor, decoder.UInt32Decoder)) +Int64ArrayDecoder = _vector_decoder(cast(DecoderConstructor, decoder.Int64Decoder)) +UInt64ArrayDecoder = _vector_decoder(cast(DecoderConstructor, decoder.UInt64Decoder)) +BoolArrayDecoder = _vector_decoder(cast(DecoderConstructor, decoder.BoolDecoder)) +StringArrayDecoder = _vector_decoder( + cast(DecoderConstructor, decoder.StringDecoder), is_packed=False +) + + +_FIELD_TYPE_TO_ENCODER_MAPPING = { + type_pb2.Field.TYPE_FLOAT: (FloatEncoder, FloatArrayEncoder), + type_pb2.Field.TYPE_DOUBLE: (DoubleEncoder, DoubleArrayEncoder), + type_pb2.Field.TYPE_INT32: (IntEncoder, IntArrayEncoder), + type_pb2.Field.TYPE_INT64: (IntEncoder, IntArrayEncoder), + type_pb2.Field.TYPE_UINT32: (UIntEncoder, UIntArrayEncoder), + type_pb2.Field.TYPE_UINT64: (UIntEncoder, UIntArrayEncoder), + type_pb2.Field.TYPE_BOOL: (BoolEncoder, BoolArrayEncoder), + type_pb2.Field.TYPE_STRING: (StringEncoder, StringArrayEncoder), + type_pb2.Field.TYPE_ENUM: (IntEncoder, IntArrayEncoder), + type_pb2.Field.TYPE_MESSAGE: (MessageEncoder, UnsupportedMessageArrayEncoder), +} + +_FIELD_TYPE_TO_DECODER_MAPPING = { + type_pb2.Field.TYPE_FLOAT: (FloatDecoder, FloatArrayDecoder), + type_pb2.Field.TYPE_DOUBLE: (DoubleDecoder, DoubleArrayDecoder), + type_pb2.Field.TYPE_INT32: (Int32Decoder, Int32ArrayDecoder), + type_pb2.Field.TYPE_INT64: (Int64Decoder, Int64ArrayDecoder), + type_pb2.Field.TYPE_UINT32: (UInt32Decoder, UInt32ArrayDecoder), + type_pb2.Field.TYPE_UINT64: (UInt64Decoder, UInt64ArrayDecoder), + type_pb2.Field.TYPE_BOOL: (BoolDecoder, BoolArrayDecoder), + type_pb2.Field.TYPE_STRING: (StringDecoder, StringArrayDecoder), + type_pb2.Field.TYPE_ENUM: (Int32Decoder, Int32ArrayDecoder), +} + +_TYPE_DEFAULT_MAPPING = { + type_pb2.Field.TYPE_FLOAT: float(), + type_pb2.Field.TYPE_DOUBLE: float(), + type_pb2.Field.TYPE_INT32: int(), + type_pb2.Field.TYPE_INT64: int(), + type_pb2.Field.TYPE_UINT32: int(), + type_pb2.Field.TYPE_UINT64: int(), + type_pb2.Field.TYPE_BOOL: bool(), + type_pb2.Field.TYPE_STRING: str(), + type_pb2.Field.TYPE_ENUM: int(), +} + +_MESSAGE_TYPE_TO_DECODER = { + xydata_pb2.DoubleXYData.DESCRIPTOR.full_name: XYDataDecoder, +} + + +[docs]def get_encoder(type: type_pb2.Field.Kind.ValueType, repeated: bool) -> PartialEncoderConstructor: + """Get the appropriate partial encoder constructor for the specified type. + + A scalar or vector constructor is returned based on the 'repeated' parameter. + """ + if type not in _FIELD_TYPE_TO_ENCODER_MAPPING: + raise ValueError(f"Error can not encode type '{type}'") + scalar, array = _FIELD_TYPE_TO_ENCODER_MAPPING[type] + if repeated: + return array + return scalar + + +[docs]def get_decoder( + type: type_pb2.Field.Kind.ValueType, repeated: bool, message_type: str = "" +) -> PartialDecoderConstructor: + """Get the appropriate partial decoder constructor for the specified type.""" + decoder_mapping = _FIELD_TYPE_TO_DECODER_MAPPING.get(type) + if decoder_mapping is not None: + scalar_decoder, array_decoder = decoder_mapping + return array_decoder if repeated else scalar_decoder + elif type == type_pb2.Field.Kind.TYPE_MESSAGE: if repeated: - return list() - type_default_value = Context._TYPE_DEFAULT_MAPPING.get(type) - return type_default_value + raise ValueError(f"Repeated message types are not supported '{message_type}'") + decoder = _MESSAGE_TYPE_TO_DECODER.get(message_type) + if decoder is None: + raise ValueError(f"Unknown message type '{message_type}'") + return decoder + else: + raise ValueError(f"Error can not decode type '{type}'") + + +[docs]def get_type_default(type: type_pb2.Field.Kind.ValueType, repeated: bool) -> Any: + """Get the default value for the give type.""" + if repeated: + return list() + type_default_value = _TYPE_DEFAULT_MAPPING.get(type) + return type_default_value
-"""Contains classes and enums to represent measurement metadata.""" +"""Measurement service metadata classes and enums.""" from __future__ import annotations import enum @@ -82,50 +82,56 @@ Source code for ni_measurementlink_service.measurement.info[docs]class MeasurementInfo(NamedTuple): - """Class that represents the measurement information. - - Attributes - ---------- - display_name (str): The measurement display name for client to display to user. - - version (str): The measurement version that helps to - maintain versions of a measurement in future. - - ui_file_paths (list): Absolute paths of the UI file(s) linked to the measurement. - - """ + """A named tuple providing information about a measurement.""" display_name: str - version: str - ui_file_paths: List[Path] - - -[docs]class ServiceInfo(NamedTuple): - """Class that represents the service information. - - Attributes - ---------- - service_class (str): Service class that the measurement belongs to. - Measurements under same service class expected to perform same logic. - For e.g., different version of measurement can come under same service class. + """The user visible name of the measurement.""" + version: str + """The current version of the measurement.""" - description_url (str): Description URL of the measurement. + ui_file_paths: List[Path] + """Absolute paths to user interface files for the measurement (e.g. ``.measui`` or ``.vi`` + files).""" - provided_interfaces (List[str]): List of interfaces the service provides. - For e.g., ni.measurementlink.measurement.v2.MeasurementService. - Defaults to ["ni.measurementlink.measurement.v1.MeasurementService"]. - annotations (Dict[str,str]): Dict that contains extra information of the measurement. - As default we added a (str) description, (str) collection and a (List[str]) list of tags. - Feel free to add your own Annotations as needed. +[docs]class ServiceInfo(NamedTuple): + """A named tuple providing information about a registered service. + This class is used with the MeasurementLink discovery service when registering and enumerating + services. """ service_class: str + """"The "class" of a service. The value of this field should be unique for a given interface + in ``provided_interfaces``. In effect, the ``.proto`` service declaration defines the + interface, and this field defines a class or concrete type of the interface.""" + description_url: str + """The URL of a web page that provides a description of the service.""" + provided_interfaces: List[str] = ["ni.measurementlink.measurement.v1.MeasurementService"] - annotations: Dict[str, str] = {} + """The service interfaces provided by the service. These are gRPC full names for the service.""" + + annotations: Dict[str, str] = {} + """Represents a set of annotations on the service. + + Well-known annotations: + + - Description + - Key: "ni/service.description" + - Expected format: string + - Example: "Measure inrush current with a shorted load and validate results against + configured limits." + - Collection + - Key: "ni/service.collection" + - Expected format: "." delimited namespace/hierarchy case-insensitive string + - Example: "CurrentTests.Inrush" + - Tags + - Key: "ni/service.tags" + - Expected format: serialized JSON string of an array of strings + - Example: "[\"powerup\", \"current\"]" + """
ni_measurementlink_service._channelpool
GrpcChannelPool
Class that manages gRPC channel lifetimes.
Bases: object
object
Enter the runtime context of the GrpcChannelPool.
Exit the runtime context of the GrpcChannelPool.
Return a gRPC channel.
target (str) – The server address
Close channels opened by get_channel().
ni_measurementlink_service._internal.parameter._message
ni_measurementlink_service._internal.parameter._serializer_types
Serialization Strategy.
Context
Strategy context.
get_encoder(type, repeated)
get_encoder
Get the appropriate partial encoder constructor for the specified type.
get_decoder(type, repeated[, message_type])
get_decoder
Get the appropriate partial decoder constructor for the specified type.
get_type_default(type, repeated)
get_type_default
Get the default value for the give type.
StringEncoder
FloatArrayEncoder
MessageEncoder
DoubleArrayEncoder
IntArrayEncoder
UIntArrayEncoder
BoolArrayEncoder
StringArrayEncoder
UnsupportedMessageArrayEncoder
FloatDecoder
StringDecoder
FloatArrayDecoder
XYDataDecoder
DoubleArrayDecoder
Int32ArrayDecoder
UInt32ArrayDecoder
Int64ArrayDecoder
UInt64ArrayDecoder
BoolArrayDecoder
StringArrayDecoder
Get the Scalar Encoder or Vector Encoder for the specified type based on repeated bool.
-type (type_pb2.Field.Kind.ValueType): Type of the Parameter. -repeated (bool): Boolean that represents if the Parameter is repeated or not. -
type (type_pb2.Field.Kind.ValueType): Type of the Parameter.
repeated (bool): Boolean that represents if the Parameter is repeated or not.
-Exception: If the specified type is not supported. -
Exception: If the specified type is not supported.
-Callable[[int], Callable]: ScalarEncoder or VectorEncoder. -
Callable[[int], Callable]: ScalarEncoder or VectorEncoder.
A scalar or vector constructor is returned based on the ‘repeated’ parameter.
Get the Scalar Decoder or Vector Decoder for the specified type based on repeated bool.
-Callable[[int], Callable]: ScalarDecoder or VectorDecoder. -
Callable[[int], Callable]: ScalarDecoder or VectorDecoder.
Get the Type default.
-Any: Default value. -
Any: Default value.
MeasurementInfo
Class that represents the measurement information.
A named tuple providing information about a measurement.
ServiceInfo
Class that represents the service information.
A named tuple providing information about a registered service.
MeasurementService
Class that supports registering and hosting a python function as a gRPC service.
Bases: NamedTuple
NamedTuple
-display_name (str): The measurement display name for client to display to user. -version (str): The measurement version that helps to -maintain versions of a measurement in future. -ui_file_paths (list): Absolute paths of the UI file(s) linked to the measurement. -
display_name (str): The measurement display name for client to display to user.
version (str): The measurement version that helps to -maintain versions of a measurement in future.
ui_file_paths (list): Absolute paths of the UI file(s) linked to the measurement.
The user visible name of the measurement.
The current version of the measurement.
Absolute paths to user interface files for the measurement (e.g. .measui or .vi +files).
.measui
.vi
-service_class (str): Service class that the measurement belongs to. -Measurements under same service class expected to perform same logic. -For e.g., different version of measurement can come under same service class. -description_url (str): Description URL of the measurement. -provided_interfaces (List[str]): List of interfaces the service provides. -For e.g., ni.measurementlink.measurement.v2.MeasurementService. -Defaults to [“ni.measurementlink.measurement.v1.MeasurementService”]. -annotations (Dict[str,str]): Dict that contains extra information of the measurement. -As default we added a (str) description, (str) collection and a (List[str]) list of tags. -Feel free to add your own Annotations as needed. -
service_class (str): Service class that the measurement belongs to. -Measurements under same service class expected to perform same logic. -For e.g., different version of measurement can come under same service class.
description_url (str): Description URL of the measurement.
provided_interfaces (List[str]): List of interfaces the service provides. -For e.g., ni.measurementlink.measurement.v2.MeasurementService. -Defaults to [“ni.measurementlink.measurement.v1.MeasurementService”].
annotations (Dict[str,str]): Dict that contains extra information of the measurement. -As default we added a (str) description, (str) collection and a (List[str]) list of tags. -Feel free to add your own Annotations as needed.
This class is used with the MeasurementLink discovery service when registering and enumerating +services.
“The “class” of a service. The value of this field should be unique for a given interface +in provided_interfaces. In effect, the .proto service declaration defines the +interface, and this field defines a class or concrete type of the interface.
provided_interfaces
.proto
The URL of a web page that provides a description of the service.
The service interfaces provided by the service. These are gRPC full names for the service.
Represents a set of annotations on the service.
Well-known annotations:
Expected format: string
Example: “Measure inrush current with a shorted load and validate results against +configured limits.”
Expected format: “.” delimited namespace/hierarchy case-insensitive string
Example: “CurrentTests.Inrush”
Expected format: serialized JSON string of an array of strings
Example: “[“powerup”, “current”]”
measurement_info (info.MeasurementInfo): Measurement info service_info(info.ServiceInfo) : Service Info @@ -436,7 +481,7 @@ Attributesregister_measurement(measurement_function)[source] Register a function as the measurement function for a measurement service. To declare a measurement function, use this idiom: -``` +``` @measurement_service.register_measurement @measurement_service.configuration(“Configuration 1”, …) @measurement_service.configuration(“Configuration 2”, …) @@ -447,7 +492,7 @@ Attributes``` +``` See also: configuration(), output() @@ -499,8 +544,8 @@ Returnsregister_measurement() - -Args + +Args display_name (str): Display name of the output. type (DataType): Data type of the output. @@ -509,8 +554,8 @@ Args< supported when configuration type is DataType.Enum or DataType.EnumArray1D. - -Returns + +Returns Callable: Callable that takes in Any Python Function and returns the same python function. @@ -522,8 +567,8 @@ Returns host_service()[source] Host the registered measurement method as gRPC measurement service. - -Returns + +Returns MeasurementService: Context manager that can be used with a with-statement to close the service. @@ -559,21 +604,21 @@ Raises get_channel(provided_interface, service_class='')[source] Return gRPC channel to specified service. - -Args + +Args provided_interface (str): The gRPC Full Name of the service. service_class (str): The service “class” that should be matched. - -Returns + +Returns grpc.Channel: A channel to the gRPC service. - -Raises + +Raises Exception: If service_class is not specified and there is more than one matching serviceregistered. diff --git a/docs/autoapi/ni_measurementlink_service/measurement/index.html b/docs/autoapi/ni_measurementlink_service/measurement/index.html index eea31b5fd..2f7c36bbd 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 diff --git a/docs/autoapi/ni_measurementlink_service/measurement/info/index.html b/docs/autoapi/ni_measurementlink_service/measurement/info/index.html index 947ad3430..012f59dbf 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/info/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/info/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -102,8 +102,19 @@ DataType.EnumArray1D -MeasurementInfo -ServiceInfo +MeasurementInfo +display_name +version +ui_file_paths + + +ServiceInfo +service_class +description_url +provided_interfaces +annotations + + TypeSpecialization NoType Pin @@ -187,7 +198,7 @@ ni_measurementlink_service.measurement.info -Contains classes and enums to represent measurement metadata. +Measurement service metadata classes and enums. Module Contents @@ -195,10 +206,10 @@ Classes MeasurementInfo -Class that represents the measurement information. +A named tuple providing information about a measurement. ServiceInfo -Class that represents the service information. +A named tuple providing information about a registered service. TypeSpecialization Enum that represents the type specializations for measurement parameters. @@ -212,73 +223,107 @@ Classes class ni_measurementlink_service.measurement.info.MeasurementInfo[source] Bases: NamedTuple -Class that represents the measurement information. - -Attributes - -display_name (str): The measurement display name for client to display to user. -version (str): The measurement version that helps to -maintain versions of a measurement in future. -ui_file_paths (list): Absolute paths of the UI file(s) linked to the measurement. - +A named tuple providing information about a measurement. display_name :str - +The user visible name of the measurement. + version :str - +The current version of the measurement. + ui_file_paths :List[pathlib.Path] - +Absolute paths to user interface files for the measurement (e.g. .measui or .vi +files). + - class ni_measurementlink_service.measurement.info.ServiceInfo[source] Bases: NamedTuple -Class that represents the service information. - -Attributes - -service_class (str): Service class that the measurement belongs to. -Measurements under same service class expected to perform same logic. -For e.g., different version of measurement can come under same service class. -description_url (str): Description URL of the measurement. -provided_interfaces (List[str]): List of interfaces the service provides. -For e.g., ni.measurementlink.measurement.v2.MeasurementService. -Defaults to [“ni.measurementlink.measurement.v1.MeasurementService”]. -annotations (Dict[str,str]): Dict that contains extra information of the measurement. -As default we added a (str) description, (str) collection and a (List[str]) list of tags. -Feel free to add your own Annotations as needed. - +A named tuple providing information about a registered service. +This class is used with the MeasurementLink discovery service when registering and enumerating +services. service_class :str - +“The “class” of a service. The value of this field should be unique for a given interface +in provided_interfaces. In effect, the .proto service declaration defines the +interface, and this field defines a class or concrete type of the interface. + description_url :str - +The URL of a web page that provides a description of the service. + provided_interfaces :List[str] = ['ni.measurementlink.measurement.v1.MeasurementService'] - +The service interfaces provided by the service. These are gRPC full names for the service. + annotations :Dict[str, str] - +Represents a set of annotations on the service. +Well-known annotations: + + +Description + +Key: “ni/service.description” +Expected format: string +Example: “Measure inrush current with a shorted load and validate results against +configured limits.” + + + + + + + + + +Collection + +Key: “ni/service.collection” +Expected format: “.” delimited namespace/hierarchy case-insensitive string +Example: “CurrentTests.Inrush” + + + + + + + + + +Tags + +Key: “ni/service.tags” +Expected format: serialized JSON string of an array of strings +Example: “[“powerup”, “current”]” + + + + + + + + + + - diff --git a/docs/autoapi/ni_measurementlink_service/measurement/service/index.html b/docs/autoapi/ni_measurementlink_service/measurement/service/index.html index 228487099..95f669087 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/service/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/service/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -68,13 +68,6 @@ MeasurementContext.abort() -GrpcChannelPool -GrpcChannelPool.__enter__() -GrpcChannelPool.__exit__() -GrpcChannelPool.get_channel() -GrpcChannelPool.close() - - MeasurementService MeasurementService.register_measurement() MeasurementService.configuration() @@ -96,13 +89,6 @@ abort -GrpcChannelPool -__enter__ -__exit__ -get_channel -close - - MeasurementService @@ -163,10 +149,7 @@ ClassesMeasurementContext Proxy for the Measurement Service's context-local state. -GrpcChannelPool -Class that manages gRPC channel lifetimes. - -MeasurementService +MeasurementService Class that supports registering and hosting a python function as a gRPC service. @@ -228,42 +211,6 @@ Attributes - -class ni_measurementlink_service.measurement.service.GrpcChannelPool[source] -Bases: object -Class that manages gRPC channel lifetimes. - - -__enter__()[source] -Enter the runtime context of the GrpcChannelPool. - - - - -__exit__(exc_type, exc_val, traceback)[source] -Exit the runtime context of the GrpcChannelPool. - - - - -get_channel(target)[source] -Return a gRPC channel. - -Parameters: -target (str) – The server address - - - - - - -close()[source] -Close channels opened by get_channel(). - - - - class ni_measurementlink_service.measurement.service.MeasurementService(service_config_path, version, ui_file_paths, service_class=None)[source] diff --git a/docs/autoapi/ni_measurementlink_service/session_management/index.html b/docs/autoapi/ni_measurementlink_service/session_management/index.html index 4539c6977..8487f73c2 100644 --- a/docs/autoapi/ni_measurementlink_service/session_management/index.html +++ b/docs/autoapi/ni_measurementlink_service/session_management/index.html @@ -36,7 +36,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -108,14 +108,15 @@ __getattr__() -Client -Client.reserve_session() -Client.reserve_sessions() -Client.register_sessions() -Client.unregister_sessions() -Client.reserve_all_registered_sessions() +SessionManagementClient +SessionManagementClient.reserve_session() +SessionManagementClient.reserve_sessions() +SessionManagementClient.register_sessions() +SessionManagementClient.unregister_sessions() +SessionManagementClient.reserve_all_registered_sessions() +Client GRPC_SERVICE_INTERFACE_NAME GRPC_SERVICE_CLASS INSTRUMENT_TYPE_NONE @@ -151,14 +152,15 @@ __getattr__ -Client -reserve_session -reserve_sessions -register_sessions -unregister_sessions -reserve_all_registered_sessions +SessionManagementClient +reserve_session +reserve_sessions +register_sessions +unregister_sessions +reserve_all_registered_sessions +Client @@ -227,7 +229,7 @@ ClassesMultiSessionReservation Manages reservation for multiple sessions.
measurement_info (info.MeasurementInfo): Measurement info
service_info(info.ServiceInfo) : Service Info
Register a function as the measurement function for a measurement service.
To declare a measurement function, use this idiom:
``` +
``` @measurement_service.register_measurement @measurement_service.configuration(“Configuration 1”, …) @measurement_service.configuration(“Configuration 2”, …) @@ -447,7 +492,7 @@
```
See also: configuration(), output()
configuration()
output()
display_name (str): Display name of the output. type (DataType): Data type of the output. @@ -509,8 +554,8 @@ Args< supported when configuration type is DataType.Enum or DataType.EnumArray1D.
display_name (str): Display name of the output.
type (DataType): Data type of the output.
Callable: Callable that takes in Any Python Function and returns the same python function. @@ -522,8 +567,8 @@ Returns host_service()[source] Host the registered measurement method as gRPC measurement service. - -Returns + +Returns MeasurementService: Context manager that can be used with a with-statement to close the service. @@ -559,21 +604,21 @@ Raises get_channel(provided_interface, service_class='')[source] Return gRPC channel to specified service. - -Args + +Args provided_interface (str): The gRPC Full Name of the service. service_class (str): The service “class” that should be matched. - -Returns + +Returns grpc.Channel: A channel to the gRPC service. - -Raises + +Raises Exception: If service_class is not specified and there is more than one matching serviceregistered. diff --git a/docs/autoapi/ni_measurementlink_service/measurement/index.html b/docs/autoapi/ni_measurementlink_service/measurement/index.html index eea31b5fd..2f7c36bbd 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 diff --git a/docs/autoapi/ni_measurementlink_service/measurement/info/index.html b/docs/autoapi/ni_measurementlink_service/measurement/info/index.html index 947ad3430..012f59dbf 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/info/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/info/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -102,8 +102,19 @@ DataType.EnumArray1D -MeasurementInfo -ServiceInfo +MeasurementInfo +display_name +version +ui_file_paths + + +ServiceInfo +service_class +description_url +provided_interfaces +annotations + + TypeSpecialization NoType Pin @@ -187,7 +198,7 @@ ni_measurementlink_service.measurement.info -Contains classes and enums to represent measurement metadata. +Measurement service metadata classes and enums. Module Contents @@ -195,10 +206,10 @@ Classes MeasurementInfo -Class that represents the measurement information. +A named tuple providing information about a measurement. ServiceInfo -Class that represents the service information. +A named tuple providing information about a registered service. TypeSpecialization Enum that represents the type specializations for measurement parameters. @@ -212,73 +223,107 @@ Classes class ni_measurementlink_service.measurement.info.MeasurementInfo[source] Bases: NamedTuple -Class that represents the measurement information. - -Attributes - -display_name (str): The measurement display name for client to display to user. -version (str): The measurement version that helps to -maintain versions of a measurement in future. -ui_file_paths (list): Absolute paths of the UI file(s) linked to the measurement. - +A named tuple providing information about a measurement. display_name :str - +The user visible name of the measurement. + version :str - +The current version of the measurement. + ui_file_paths :List[pathlib.Path] - +Absolute paths to user interface files for the measurement (e.g. .measui or .vi +files). + - class ni_measurementlink_service.measurement.info.ServiceInfo[source] Bases: NamedTuple -Class that represents the service information. - -Attributes - -service_class (str): Service class that the measurement belongs to. -Measurements under same service class expected to perform same logic. -For e.g., different version of measurement can come under same service class. -description_url (str): Description URL of the measurement. -provided_interfaces (List[str]): List of interfaces the service provides. -For e.g., ni.measurementlink.measurement.v2.MeasurementService. -Defaults to [“ni.measurementlink.measurement.v1.MeasurementService”]. -annotations (Dict[str,str]): Dict that contains extra information of the measurement. -As default we added a (str) description, (str) collection and a (List[str]) list of tags. -Feel free to add your own Annotations as needed. - +A named tuple providing information about a registered service. +This class is used with the MeasurementLink discovery service when registering and enumerating +services. service_class :str - +“The “class” of a service. The value of this field should be unique for a given interface +in provided_interfaces. In effect, the .proto service declaration defines the +interface, and this field defines a class or concrete type of the interface. + description_url :str - +The URL of a web page that provides a description of the service. + provided_interfaces :List[str] = ['ni.measurementlink.measurement.v1.MeasurementService'] - +The service interfaces provided by the service. These are gRPC full names for the service. + annotations :Dict[str, str] - +Represents a set of annotations on the service. +Well-known annotations: + + +Description + +Key: “ni/service.description” +Expected format: string +Example: “Measure inrush current with a shorted load and validate results against +configured limits.” + + + + + + + + + +Collection + +Key: “ni/service.collection” +Expected format: “.” delimited namespace/hierarchy case-insensitive string +Example: “CurrentTests.Inrush” + + + + + + + + + +Tags + +Key: “ni/service.tags” +Expected format: serialized JSON string of an array of strings +Example: “[“powerup”, “current”]” + + + + + + + + + + - diff --git a/docs/autoapi/ni_measurementlink_service/measurement/service/index.html b/docs/autoapi/ni_measurementlink_service/measurement/service/index.html index 228487099..95f669087 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/service/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/service/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -68,13 +68,6 @@ MeasurementContext.abort() -GrpcChannelPool -GrpcChannelPool.__enter__() -GrpcChannelPool.__exit__() -GrpcChannelPool.get_channel() -GrpcChannelPool.close() - - MeasurementService MeasurementService.register_measurement() MeasurementService.configuration() @@ -96,13 +89,6 @@ abort -GrpcChannelPool -__enter__ -__exit__ -get_channel -close - - MeasurementService @@ -163,10 +149,7 @@ ClassesMeasurementContext Proxy for the Measurement Service's context-local state. -GrpcChannelPool -Class that manages gRPC channel lifetimes. - -MeasurementService +MeasurementService Class that supports registering and hosting a python function as a gRPC service. @@ -228,42 +211,6 @@ Attributes - -class ni_measurementlink_service.measurement.service.GrpcChannelPool[source] -Bases: object -Class that manages gRPC channel lifetimes. - - -__enter__()[source] -Enter the runtime context of the GrpcChannelPool. - - - - -__exit__(exc_type, exc_val, traceback)[source] -Exit the runtime context of the GrpcChannelPool. - - - - -get_channel(target)[source] -Return a gRPC channel. - -Parameters: -target (str) – The server address - - - - - - -close()[source] -Close channels opened by get_channel(). - - - - class ni_measurementlink_service.measurement.service.MeasurementService(service_config_path, version, ui_file_paths, service_class=None)[source] diff --git a/docs/autoapi/ni_measurementlink_service/session_management/index.html b/docs/autoapi/ni_measurementlink_service/session_management/index.html index 4539c6977..8487f73c2 100644 --- a/docs/autoapi/ni_measurementlink_service/session_management/index.html +++ b/docs/autoapi/ni_measurementlink_service/session_management/index.html @@ -36,7 +36,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -108,14 +108,15 @@ __getattr__() -Client -Client.reserve_session() -Client.reserve_sessions() -Client.register_sessions() -Client.unregister_sessions() -Client.reserve_all_registered_sessions() +SessionManagementClient +SessionManagementClient.reserve_session() +SessionManagementClient.reserve_sessions() +SessionManagementClient.register_sessions() +SessionManagementClient.unregister_sessions() +SessionManagementClient.reserve_all_registered_sessions() +Client GRPC_SERVICE_INTERFACE_NAME GRPC_SERVICE_CLASS INSTRUMENT_TYPE_NONE @@ -151,14 +152,15 @@ __getattr__ -Client -reserve_session -reserve_sessions -register_sessions -unregister_sessions -reserve_all_registered_sessions +SessionManagementClient +reserve_session +reserve_sessions +register_sessions +unregister_sessions +reserve_all_registered_sessions +Client @@ -227,7 +229,7 @@ ClassesMultiSessionReservation Manages reservation for multiple sessions.
Callable: Callable that takes in Any Python Function and returns the same python function.
Host the registered measurement method as gRPC measurement service.
MeasurementService: Context manager that can be used with a with-statement to close the service. @@ -559,21 +604,21 @@ Raises get_channel(provided_interface, service_class='')[source] Return gRPC channel to specified service. - -Args + +Args provided_interface (str): The gRPC Full Name of the service. service_class (str): The service “class” that should be matched. - -Returns + +Returns grpc.Channel: A channel to the gRPC service. - -Raises + +Raises Exception: If service_class is not specified and there is more than one matching serviceregistered. diff --git a/docs/autoapi/ni_measurementlink_service/measurement/index.html b/docs/autoapi/ni_measurementlink_service/measurement/index.html index eea31b5fd..2f7c36bbd 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 diff --git a/docs/autoapi/ni_measurementlink_service/measurement/info/index.html b/docs/autoapi/ni_measurementlink_service/measurement/info/index.html index 947ad3430..012f59dbf 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/info/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/info/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -102,8 +102,19 @@ DataType.EnumArray1D -MeasurementInfo -ServiceInfo +MeasurementInfo +display_name +version +ui_file_paths + + +ServiceInfo +service_class +description_url +provided_interfaces +annotations + + TypeSpecialization NoType Pin @@ -187,7 +198,7 @@ ni_measurementlink_service.measurement.info -Contains classes and enums to represent measurement metadata. +Measurement service metadata classes and enums. Module Contents @@ -195,10 +206,10 @@ Classes MeasurementInfo -Class that represents the measurement information. +A named tuple providing information about a measurement. ServiceInfo -Class that represents the service information. +A named tuple providing information about a registered service. TypeSpecialization Enum that represents the type specializations for measurement parameters. @@ -212,73 +223,107 @@ Classes class ni_measurementlink_service.measurement.info.MeasurementInfo[source] Bases: NamedTuple -Class that represents the measurement information. - -Attributes - -display_name (str): The measurement display name for client to display to user. -version (str): The measurement version that helps to -maintain versions of a measurement in future. -ui_file_paths (list): Absolute paths of the UI file(s) linked to the measurement. - +A named tuple providing information about a measurement. display_name :str - +The user visible name of the measurement. + version :str - +The current version of the measurement. + ui_file_paths :List[pathlib.Path] - +Absolute paths to user interface files for the measurement (e.g. .measui or .vi +files). + - class ni_measurementlink_service.measurement.info.ServiceInfo[source] Bases: NamedTuple -Class that represents the service information. - -Attributes - -service_class (str): Service class that the measurement belongs to. -Measurements under same service class expected to perform same logic. -For e.g., different version of measurement can come under same service class. -description_url (str): Description URL of the measurement. -provided_interfaces (List[str]): List of interfaces the service provides. -For e.g., ni.measurementlink.measurement.v2.MeasurementService. -Defaults to [“ni.measurementlink.measurement.v1.MeasurementService”]. -annotations (Dict[str,str]): Dict that contains extra information of the measurement. -As default we added a (str) description, (str) collection and a (List[str]) list of tags. -Feel free to add your own Annotations as needed. - +A named tuple providing information about a registered service. +This class is used with the MeasurementLink discovery service when registering and enumerating +services. service_class :str - +“The “class” of a service. The value of this field should be unique for a given interface +in provided_interfaces. In effect, the .proto service declaration defines the +interface, and this field defines a class or concrete type of the interface. + description_url :str - +The URL of a web page that provides a description of the service. + provided_interfaces :List[str] = ['ni.measurementlink.measurement.v1.MeasurementService'] - +The service interfaces provided by the service. These are gRPC full names for the service. + annotations :Dict[str, str] - +Represents a set of annotations on the service. +Well-known annotations: + + +Description + +Key: “ni/service.description” +Expected format: string +Example: “Measure inrush current with a shorted load and validate results against +configured limits.” + + + + + + + + + +Collection + +Key: “ni/service.collection” +Expected format: “.” delimited namespace/hierarchy case-insensitive string +Example: “CurrentTests.Inrush” + + + + + + + + + +Tags + +Key: “ni/service.tags” +Expected format: serialized JSON string of an array of strings +Example: “[“powerup”, “current”]” + + + + + + + + + + - diff --git a/docs/autoapi/ni_measurementlink_service/measurement/service/index.html b/docs/autoapi/ni_measurementlink_service/measurement/service/index.html index 228487099..95f669087 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/service/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/service/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -68,13 +68,6 @@ MeasurementContext.abort() -GrpcChannelPool -GrpcChannelPool.__enter__() -GrpcChannelPool.__exit__() -GrpcChannelPool.get_channel() -GrpcChannelPool.close() - - MeasurementService MeasurementService.register_measurement() MeasurementService.configuration() @@ -96,13 +89,6 @@ abort -GrpcChannelPool -__enter__ -__exit__ -get_channel -close - - MeasurementService @@ -163,10 +149,7 @@ ClassesMeasurementContext Proxy for the Measurement Service's context-local state. -GrpcChannelPool -Class that manages gRPC channel lifetimes. - -MeasurementService +MeasurementService Class that supports registering and hosting a python function as a gRPC service. @@ -228,42 +211,6 @@ Attributes - -class ni_measurementlink_service.measurement.service.GrpcChannelPool[source] -Bases: object -Class that manages gRPC channel lifetimes. - - -__enter__()[source] -Enter the runtime context of the GrpcChannelPool. - - - - -__exit__(exc_type, exc_val, traceback)[source] -Exit the runtime context of the GrpcChannelPool. - - - - -get_channel(target)[source] -Return a gRPC channel. - -Parameters: -target (str) – The server address - - - - - - -close()[source] -Close channels opened by get_channel(). - - - - class ni_measurementlink_service.measurement.service.MeasurementService(service_config_path, version, ui_file_paths, service_class=None)[source] diff --git a/docs/autoapi/ni_measurementlink_service/session_management/index.html b/docs/autoapi/ni_measurementlink_service/session_management/index.html index 4539c6977..8487f73c2 100644 --- a/docs/autoapi/ni_measurementlink_service/session_management/index.html +++ b/docs/autoapi/ni_measurementlink_service/session_management/index.html @@ -36,7 +36,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -108,14 +108,15 @@ __getattr__() -Client -Client.reserve_session() -Client.reserve_sessions() -Client.register_sessions() -Client.unregister_sessions() -Client.reserve_all_registered_sessions() +SessionManagementClient +SessionManagementClient.reserve_session() +SessionManagementClient.reserve_sessions() +SessionManagementClient.register_sessions() +SessionManagementClient.unregister_sessions() +SessionManagementClient.reserve_all_registered_sessions() +Client GRPC_SERVICE_INTERFACE_NAME GRPC_SERVICE_CLASS INSTRUMENT_TYPE_NONE @@ -151,14 +152,15 @@ __getattr__ -Client -reserve_session -reserve_sessions -register_sessions -unregister_sessions -reserve_all_registered_sessions +SessionManagementClient +reserve_session +reserve_sessions +register_sessions +unregister_sessions +reserve_all_registered_sessions +Client @@ -227,7 +229,7 @@ ClassesMultiSessionReservation Manages reservation for multiple sessions.
MeasurementService: Context manager that can be used with a with-statement to close the service.
Return gRPC channel to specified service.
provided_interface (str): The gRPC Full Name of the service. service_class (str): The service “class” that should be matched.
provided_interface (str): The gRPC Full Name of the service.
service_class (str): The service “class” that should be matched.
grpc.Channel: A channel to the gRPC service.
Exception: If service_class is not specified and there is more than one matching serviceregistered. diff --git a/docs/autoapi/ni_measurementlink_service/measurement/index.html b/docs/autoapi/ni_measurementlink_service/measurement/index.html index eea31b5fd..2f7c36bbd 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 diff --git a/docs/autoapi/ni_measurementlink_service/measurement/info/index.html b/docs/autoapi/ni_measurementlink_service/measurement/info/index.html index 947ad3430..012f59dbf 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/info/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/info/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -102,8 +102,19 @@ DataType.EnumArray1D -MeasurementInfo -ServiceInfo +MeasurementInfo +display_name +version +ui_file_paths + + +ServiceInfo +service_class +description_url +provided_interfaces +annotations + + TypeSpecialization NoType Pin @@ -187,7 +198,7 @@ ni_measurementlink_service.measurement.info -Contains classes and enums to represent measurement metadata. +Measurement service metadata classes and enums. Module Contents @@ -195,10 +206,10 @@ Classes MeasurementInfo -Class that represents the measurement information. +A named tuple providing information about a measurement. ServiceInfo -Class that represents the service information. +A named tuple providing information about a registered service. TypeSpecialization Enum that represents the type specializations for measurement parameters. @@ -212,73 +223,107 @@ Classes class ni_measurementlink_service.measurement.info.MeasurementInfo[source] Bases: NamedTuple -Class that represents the measurement information. - -Attributes - -display_name (str): The measurement display name for client to display to user. -version (str): The measurement version that helps to -maintain versions of a measurement in future. -ui_file_paths (list): Absolute paths of the UI file(s) linked to the measurement. - +A named tuple providing information about a measurement. display_name :str - +The user visible name of the measurement. + version :str - +The current version of the measurement. + ui_file_paths :List[pathlib.Path] - +Absolute paths to user interface files for the measurement (e.g. .measui or .vi +files). + - class ni_measurementlink_service.measurement.info.ServiceInfo[source] Bases: NamedTuple -Class that represents the service information. - -Attributes - -service_class (str): Service class that the measurement belongs to. -Measurements under same service class expected to perform same logic. -For e.g., different version of measurement can come under same service class. -description_url (str): Description URL of the measurement. -provided_interfaces (List[str]): List of interfaces the service provides. -For e.g., ni.measurementlink.measurement.v2.MeasurementService. -Defaults to [“ni.measurementlink.measurement.v1.MeasurementService”]. -annotations (Dict[str,str]): Dict that contains extra information of the measurement. -As default we added a (str) description, (str) collection and a (List[str]) list of tags. -Feel free to add your own Annotations as needed. - +A named tuple providing information about a registered service. +This class is used with the MeasurementLink discovery service when registering and enumerating +services. service_class :str - +“The “class” of a service. The value of this field should be unique for a given interface +in provided_interfaces. In effect, the .proto service declaration defines the +interface, and this field defines a class or concrete type of the interface. + description_url :str - +The URL of a web page that provides a description of the service. + provided_interfaces :List[str] = ['ni.measurementlink.measurement.v1.MeasurementService'] - +The service interfaces provided by the service. These are gRPC full names for the service. + annotations :Dict[str, str] - +Represents a set of annotations on the service. +Well-known annotations: + + +Description + +Key: “ni/service.description” +Expected format: string +Example: “Measure inrush current with a shorted load and validate results against +configured limits.” + + + + + + + + + +Collection + +Key: “ni/service.collection” +Expected format: “.” delimited namespace/hierarchy case-insensitive string +Example: “CurrentTests.Inrush” + + + + + + + + + +Tags + +Key: “ni/service.tags” +Expected format: serialized JSON string of an array of strings +Example: “[“powerup”, “current”]” + + + + + + + + + + - diff --git a/docs/autoapi/ni_measurementlink_service/measurement/service/index.html b/docs/autoapi/ni_measurementlink_service/measurement/service/index.html index 228487099..95f669087 100644 --- a/docs/autoapi/ni_measurementlink_service/measurement/service/index.html +++ b/docs/autoapi/ni_measurementlink_service/measurement/service/index.html @@ -37,7 +37,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -68,13 +68,6 @@ MeasurementContext.abort() -GrpcChannelPool -GrpcChannelPool.__enter__() -GrpcChannelPool.__exit__() -GrpcChannelPool.get_channel() -GrpcChannelPool.close() - - MeasurementService MeasurementService.register_measurement() MeasurementService.configuration() @@ -96,13 +89,6 @@ abort -GrpcChannelPool -__enter__ -__exit__ -get_channel -close - - MeasurementService @@ -163,10 +149,7 @@ ClassesMeasurementContext Proxy for the Measurement Service's context-local state. -GrpcChannelPool -Class that manages gRPC channel lifetimes. - -MeasurementService +MeasurementService Class that supports registering and hosting a python function as a gRPC service. @@ -228,42 +211,6 @@ Attributes - -class ni_measurementlink_service.measurement.service.GrpcChannelPool[source] -Bases: object -Class that manages gRPC channel lifetimes. - - -__enter__()[source] -Enter the runtime context of the GrpcChannelPool. - - - - -__exit__(exc_type, exc_val, traceback)[source] -Exit the runtime context of the GrpcChannelPool. - - - - -get_channel(target)[source] -Return a gRPC channel. - -Parameters: -target (str) – The server address - - - - - - -close()[source] -Close channels opened by get_channel(). - - - - class ni_measurementlink_service.measurement.service.MeasurementService(service_config_path, version, ui_file_paths, service_class=None)[source] diff --git a/docs/autoapi/ni_measurementlink_service/session_management/index.html b/docs/autoapi/ni_measurementlink_service/session_management/index.html index 4539c6977..8487f73c2 100644 --- a/docs/autoapi/ni_measurementlink_service/session_management/index.html +++ b/docs/autoapi/ni_measurementlink_service/session_management/index.html @@ -36,7 +36,7 @@ ni_measurementlink_service - 1.2.0-dev1 + 1.2.0-dev2 @@ -108,14 +108,15 @@ __getattr__() -Client -Client.reserve_session() -Client.reserve_sessions() -Client.register_sessions() -Client.unregister_sessions() -Client.reserve_all_registered_sessions() +SessionManagementClient +SessionManagementClient.reserve_session() +SessionManagementClient.reserve_sessions() +SessionManagementClient.register_sessions() +SessionManagementClient.unregister_sessions() +SessionManagementClient.reserve_all_registered_sessions() +Client GRPC_SERVICE_INTERFACE_NAME GRPC_SERVICE_CLASS INSTRUMENT_TYPE_NONE @@ -151,14 +152,15 @@ __getattr__ -Client -reserve_session -reserve_sessions -register_sessions -unregister_sessions -reserve_all_registered_sessions +SessionManagementClient +reserve_session +reserve_sessions +register_sessions +unregister_sessions +reserve_all_registered_sessions +Client @@ -227,7 +229,7 @@ ClassesMultiSessionReservation Manages reservation for multiple sessions.
registered.
DataType.EnumArray1D
ni_measurementlink_service.measurement.info
Contains classes and enums to represent measurement metadata.
Measurement service metadata classes and enums.
TypeSpecialization
Enum that represents the type specializations for measurement parameters.
MeasurementContext.abort()
GrpcChannelPool.__enter__()
GrpcChannelPool.__exit__()
GrpcChannelPool.get_channel()
GrpcChannelPool.close()
MeasurementService.register_measurement()
MeasurementService.configuration()
MeasurementContext
Proxy for the Measurement Service's context-local state.
__getattr__()
Client
Client.reserve_session()
Client.reserve_sessions()
Client.register_sessions()
Client.unregister_sessions()
Client.reserve_all_registered_sessions()
SessionManagementClient
SessionManagementClient.reserve_session()
SessionManagementClient.reserve_sessions()
SessionManagementClient.register_sessions()
SessionManagementClient.unregister_sessions()
SessionManagementClient.reserve_all_registered_sessions()
MultiSessionReservation
Manages reservation for multiple sessions.
Class that manages driver sessions.
INSTRUMENT_TYPE_NI_SWITCH_EXECUTIVE_VIRTUAL_DEVICE
Alias for compatibility with code that uses session_management.Client.
Reserve a single session.
Reserve the session matching the given pins, sites, and instrument type ID and return the information needed to create or access the session.
Reserve multiple sessions.
Reserve sessions matching the given pins, sites, and instrument type ID and return the information needed to create or access the sessions.
Register the sessions with the Session Manager.
Indicates that the sessions are open and will need to be closed later.
Unregisters the sessions from the Session Manager.
Indicates that the sessions have been closed and will need to be reopened before they can be used again.
Reserves and gets all sessions currently registered in the Session Manager.
ni_measurementlink_service
ni_measurementlink_service._internal.parameter
ni_measurementlink_service._datatypeinfo
ni_measurementlink_service._internal.discovery_client
ni_measurementlink_service._internal.grpc_servicer
ni_measurementlink_service._internal
ni_measurementlink_service._internal.parameter.metadata
ni_measurementlink_service._internal.parameter.serialization_strategy
ni_measurementlink_service._internal.parameter.serializer
ni_measurementlink_service._internal.service_manager
ni_measurementlink_service._internal.stubs
ni_measurementlink_service._internal.stubs.ni
ni_measurementlink_service._internal.stubs.ni.measurementlink.discovery
ni_measurementlink_service._internal.stubs.ni.measurementlink.discovery.v1.discovery_service_pb2
ni_measurementlink_service._internal.stubs.ni.measurementlink.discovery.v1.discovery_service_pb2_grpc
ni_measurementlink_service._internal.stubs.ni.measurementlink.discovery.v1
ni_measurementlink_service._internal.stubs.ni.measurementlink
ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement
ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1
ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1.measurement_service_pb2
ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1.measurement_service_pb2_grpc
ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v2
ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v2.measurement_service_pb2
ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v2.measurement_service_pb2_grpc
ni_measurementlink_service._internal.stubs.ni.measurementlink.pin_map_context_pb2
ni_measurementlink_service._internal.stubs.ni.measurementlink.pin_map_context_pb2_grpc
ni_measurementlink_service._internal.stubs.ni.measurementlink.pinmap
ni_measurementlink_service._internal.stubs.ni.measurementlink.pinmap.v1
ni_measurementlink_service._internal.stubs.ni.measurementlink.pinmap.v1.pin_map_service_pb2
ni_measurementlink_service._internal.stubs.ni.measurementlink.pinmap.v1.pin_map_service_pb2_grpc
ni_measurementlink_service._internal.stubs.ni.measurementlink.sessionmanagement
ni_measurementlink_service._internal.stubs.ni.measurementlink.sessionmanagement.v1
ni_measurementlink_service._internal.stubs.ni.measurementlink.sessionmanagement.v1.session_management_service_pb2
ni_measurementlink_service._internal.stubs.ni.measurementlink.sessionmanagement.v1.session_management_service_pb2_grpc
ni_measurementlink_service._internal.stubs.ni.protobuf
ni_measurementlink_service._internal.stubs.ni.protobuf.types
ni_measurementlink_service._internal.stubs.ni.protobuf.types.xydata_pb2
ni_measurementlink_service._internal.stubs.ni.protobuf.types.xydata_pb2_grpc
ni_measurementlink_service._internal.stubs.session_pb2
ni_measurementlink_service._internal.stubs.session_pb2_grpc
ni_measurementlink_service._internal.utilities
ni_measurementlink_service._loggers
ni_measurementlink_service._tracelogging
ni_measurementlink_service.measurement
ni_measurementlink_service.measurement.service
ni_measurementlink_service.session_management