Rsdk 2071 support modular validation and implicit dependencies #244

purplenicole730 · 2023-03-23T21:49:40Z

RSDK-2071

Changes in this PR:

Adds a new resource validator type with lookup and register functions to work with and store resource validators.
Adds validate_config function that allows a module to look up and run (if any) a stored resource validator.
Implements ValidateConfig to call validate_config.
Adds a new gRPC error called ValidationError that will be raised when any Exception is thrown during validate_config.
Test validate_config with example Gizmo module that stores a validator during init.
Adds a validator function section to README.md

cc @benjirewis

benjirewis

Looking great! I know this is in draft but thought I'd leave a few comments to potentially discuss offline.

examples/module/src/gizmo/my_gizmo.py

src/viam/module/module.py

src/viam/resource/types.py

benjirewis · 2023-03-24T14:43:41Z

We'll also want to update the module example README to describe the process of registering a custom validator function.

src/viam/errors.py

benjirewis

Looking great 🧑‍🔧 ! Just a few more nits.

examples/module/src/gizmo/my_gizmo.py

src/viam/errors.py

src/viam/resource/registry.py

src/viam/resource/types.py

examples/module/src/gizmo/__init__.py

examples/module/src/gizmo/my_gizmo.py

src/viam/errors.py

src/viam/resource/types.py

src/viam/resource/registry.py

benjirewis

LGTM! Great job + thanks for this 🧑‍🔧

njooma

Just a small nit, but otherwise good!

examples/module/src/gizmo/__init__.py

cheukt

Looks great! had a suggestion to reduce the amount of registries

examples/module/src/gizmo/__init__.py

cheukt

One last request around checking that the registration actually contains something to register

src/viam/resource/registry.py

cheukt

LGTM

purplenicole730 added 2 commits March 23, 2023 16:59

add ValidateConfig to modules and validator types to registry

118695a

add implicit dependencies to gizmo module

0ccdd61

benjirewis reviewed Mar 24, 2023

View reviewed changes

examples/module/src/gizmo/my_gizmo.py Outdated Show resolved Hide resolved

src/viam/module/module.py Show resolved Hide resolved

src/viam/resource/types.py Outdated Show resolved Hide resolved

purplenicole730 added 4 commits March 27, 2023 10:34

add validation error capabilities

d05a12c

make gizmo dependent on a motor

4f9e2d8

raise error if motor is not specified for gizmo

7858e5c

Add details on how to use validate_config

8b3813c

purplenicole730 commented Mar 27, 2023

View reviewed changes

src/viam/errors.py Outdated Show resolved Hide resolved

purplenicole730 added 2 commits March 27, 2023 17:20

put comment in example gizmo and not test

7aca20d

make error a grpc error

34928ca

purplenicole730 marked this pull request as ready for review March 27, 2023 21:25

purplenicole730 requested a review from a team as a code owner March 27, 2023 21:25

purplenicole730 requested review from benjirewis, oliviamiller, cheukt and njooma and removed request for oliviamiller March 27, 2023 21:25

Include motor in gizmo init

20fd6b1

benjirewis reviewed Mar 28, 2023

View reviewed changes

njooma requested changes Mar 28, 2023

View reviewed changes

purplenicole730 added 6 commits March 28, 2023 15:02

Fix comments and types

c29269e

fix comments and types

f8dcaa8

add arg1 as a requirement in gizmo's validation

e85d307

return no-op as default validator

3649ddd

fix errors and add one more test

75c27f4

ignore black error

570b705

purplenicole730 requested review from njooma and benjirewis March 28, 2023 20:03

benjirewis approved these changes Mar 28, 2023

View reviewed changes

njooma approved these changes Mar 28, 2023

View reviewed changes

examples/module/src/gizmo/__init__.py Outdated Show resolved Hide resolved

cheukt requested changes Mar 28, 2023

View reviewed changes

examples/module/src/gizmo/__init__.py Outdated Show resolved Hide resolved

purplenicole730 added 2 commits March 29, 2023 16:42

fix typo

540c83e

register validator with registering resource creator

8af7b98

purplenicole730 requested a review from cheukt March 29, 2023 22:25

purplenicole730 added 4 commits March 31, 2023 13:23

make a resourcecreatorregistration dataclass

d833caa

test if module without validator still passes

6e723b9

Add comments in ResourceCreatorRegistration

5b14197

update resourcecreatorregistration comment

0a0255e

purplenicole730 requested review from cheukt and removed request for cheukt March 31, 2023 17:37

cheukt requested changes Mar 31, 2023

View reviewed changes

src/viam/resource/registry.py Outdated Show resolved Hide resolved

cheukt approved these changes Mar 31, 2023

View reviewed changes

add checks into register_* functions

27edfbf

purplenicole730 merged commit 1cd58d8 into viamrobotics:main Apr 3, 2023

purplenicole730 deleted the RSDK-2071-support-modular-validation-and-implicit-dependencies branch April 3, 2023 14:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rsdk 2071 support modular validation and implicit dependencies #244

Rsdk 2071 support modular validation and implicit dependencies #244

purplenicole730 commented Mar 23, 2023 •

edited

Loading

benjirewis left a comment •

edited

Loading

benjirewis commented Mar 24, 2023

benjirewis left a comment

benjirewis left a comment

njooma left a comment

cheukt left a comment

cheukt left a comment

cheukt left a comment

Rsdk 2071 support modular validation and implicit dependencies #244

Rsdk 2071 support modular validation and implicit dependencies #244

Conversation

purplenicole730 commented Mar 23, 2023 • edited Loading

benjirewis left a comment • edited Loading

Choose a reason for hiding this comment

benjirewis commented Mar 24, 2023

benjirewis left a comment

Choose a reason for hiding this comment

benjirewis left a comment

Choose a reason for hiding this comment

njooma left a comment

Choose a reason for hiding this comment

cheukt left a comment

Choose a reason for hiding this comment

cheukt left a comment

Choose a reason for hiding this comment

cheukt left a comment

Choose a reason for hiding this comment

purplenicole730 commented Mar 23, 2023 •

edited

Loading

benjirewis left a comment •

edited

Loading