Create protobuf waveform stubs and add unit tests. (#14)

* Initial pass at getting the stubs created. Currently getting mypy error.

Signed-off-by: Michael Johansen <[email protected]>

* Try to change mypy setting to resolve error.

Signed-off-by: Michael Johansen <[email protected]>

* Fix import statements in unit tests and fix mypy config.

Signed-off-by: Michael Johansen <[email protected]>

* Get styleguide and pyright passing.

Signed-off-by: Michael Johansen <[email protected]>

* Remove test placeholder.

Signed-off-by: Michael Johansen <[email protected]>

* Change linting filters to be pb2 specific. Fix a couple of tests.

Signed-off-by: Michael Johansen <[email protected]>

* Test improvements.

Signed-off-by: Michael Johansen <[email protected]>

---------

Signed-off-by: Michael Johansen <[email protected]>
Co-authored-by: Michael Johansen <[email protected]>

Author: mjohanse-emr

packages/ni.protobuf.types/poetry.lock

@@ -32,6 +32,11 @@ packages = [{include = "ni", from = "src"}]
 
 [tool.poetry.dependencies]
 python = "^3.9"
+protobuf = {version=">=4.21"}
+
+[tool.poetry.group.dev.dependencies]
+types-grpcio = ">=1.0"
+types-protobuf = ">=4.21"
 
 [tool.poetry.group.lint.dependencies]
 bandit = { version = ">=1.7", extras = ["toml"] }
@@ -65,16 +70,23 @@ skips = [
   "B101", # assert_used
 ]
 
+[tool.ni-python-styleguide]
+extend_exclude = "*_pb2_grpc.py,*_pb2_grpc.pyi,*_pb2.py,*_pb2.pyi"
+
 [tool.black]
+extend-exclude = '_pb2(_grpc)?\.(py|pyi)$'
 line-length = 100
 
 [tool.mypy]
-files = "src/,tests/"
+mypy_path = "src"
+files = "."
 namespace_packages = true
 strict = true
+explicit_package_bases = true
 
 [tool.pyright]
 include = ["src/", "tests/"]
+exclude = ["**/*_pb2_grpc.py", "**/*_pb2_grpc.pyi", "**/*_pb2.py", "**/*_pb2.pyi"]
 
 [tool.pytest.ini_options]
 addopts = "--doctest-modules --doctest-plus --strict-markers"

packages/ni.protobuf.types/pyproject.toml

@@ -0,0 +1,84 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+---------------------------------------------------------------------
+---------------------------------------------------------------------
+"""
+
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.message
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class Double2DArray(google.protobuf.message.Message):
+    """---------------------------------------------------------------------
+    Defines a 2D array of values. The 2D array is stored as a repeated field of
+    the appropriate element type, a 1D array. It is stored in row major order.
+
+    Example:
+    Repeated Double: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+
+    rows: 2
+    columns: 5
+
+    2D Representation:
+     1  2  3  4  5
+     6  7  8  9 10
+
+    Indices:
+    (0,0) (0,1) (0,2) (0,3) (0,4)
+    (1,0) (1,1) (1,2) (1,3) (1,4)
+
+    Remarks:
+     The length of the 'data' field must be equal to rows * columns.
+     If it is not, implementations should treat this state as invalid
+     and return INVALID_ARGUMENT status code if appropriate.
+    ---------------------------------------------------------------------
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ROWS_FIELD_NUMBER: builtins.int
+    COLUMNS_FIELD_NUMBER: builtins.int
+    DATA_FIELD_NUMBER: builtins.int
+    rows: builtins.int
+    columns: builtins.int
+    @property
+    def data(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.float]: ...
+    def __init__(
+        self,
+        *,
+        rows: builtins.int = ...,
+        columns: builtins.int = ...,
+        data: collections.abc.Iterable[builtins.float] | None = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["columns", b"columns", "data", b"data", "rows", b"rows"]) -> None: ...
+
+global___Double2DArray = Double2DArray
+
+@typing.final
+class String2DArray(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ROWS_FIELD_NUMBER: builtins.int
+    COLUMNS_FIELD_NUMBER: builtins.int
+    DATA_FIELD_NUMBER: builtins.int
+    rows: builtins.int
+    columns: builtins.int
+    @property
+    def data(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
+    def __init__(
+        self,
+        *,
+        rows: builtins.int = ...,
+        columns: builtins.int = ...,
+        data: collections.abc.Iterable[builtins.str] | None = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["columns", b"columns", "data", b"data", "rows", b"rows"]) -> None: ...
+
+global___String2DArray = String2DArray

packages/ni.protobuf.types/src/ni/protobuf/__init__.py

@@ -0,0 +1,42 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+---------------------------------------------------------------------
+---------------------------------------------------------------------
+"""
+
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.final
+class PrecisionTimestamp(google.protobuf.message.Message):
+    """A PrecisionTimestamp represents a point in time expressed in NI Binary Time Format (NI-BTF).
+    https://www.ni.com/docs/en-US/bundle/labwindows-cvi/page/cvi/libref/ni-btf.htm
+    NI-BTF stores time values in Coordinated Universal Time (UTC) format.
+    A PrecisionTimestamp is encoded as a count of seconds and fractions of seconds at
+    2^-64 resolution. The count is relative to an epoch of January 1, 1904.
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    SECONDS_FIELD_NUMBER: builtins.int
+    FRACTIONAL_SECONDS_FIELD_NUMBER: builtins.int
+    seconds: builtins.int
+    """Represents the number of seconds since the epoch
+    1904-01-01T00:00:00Z.
+    """
+    fractional_seconds: builtins.int
+    """Non-negative fractions of a second at 2^-64 resolution."""
+    def __init__(
+        self,
+        *,
+        seconds: builtins.int = ...,
+        fractional_seconds: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["fractional_seconds", b"fractional_seconds", "seconds", b"seconds"]) -> None: ...
+
+global___PrecisionTimestamp = PrecisionTimestamp