Expose an exception-raising entry point

[akshayjshah]

protovalidate.validate is the main entry point for this package, but it's not particularly Pythonic: it returns a collection of violations rather than raising an exception. This commit splits the package entry point into validate and collect_violations, shunting most performance and protobuf-specific concerns to collect_violations.

validate is now more similar to other Python validators: it takes a message and raises a ValidationError if the message is invalid. The exception exposes the raw protobuf Violations object (in case it needs to be sent over the network as an error detail), but it also exposes an errors() method that returns a simple Python list of violations. This matches pydantic, the most popular validation library in Python, as closely as we can without controlling the protobuf-generated initializers.

collect_violations is now the lower-level entry point. It can optionally append violations to a user-provided Violations, and it lets the user choose whether and how to raise an exception.

To my eye, this makes simple use of this package feel more like normal Python while still permitting more complex use.

[akshayjshah]

I'm on the fence about exposing collect_violations at the top level like this. Depending on what you all think, I'd be okay requiring people to construct their own validator to use that method.

[akshayjshah]

This feels more like bog-standard Python to me. What do you all think?

[Alfus]

Looks good, but need to update the main readme as well.

[elliotmjackson]

Im happy to defer to your expertise here Akshay, whilst its different to the UX of other implementations, we want it to feel idiomatic to the language over all else.

[akshayjshah]

😳 Completely forgot about that! Will do now.

…

On Tue, Jul 11, 2023 at 7:38 AM Alfred Fuller ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In tests/validate_test.py <#32 (comment)> : > assert len(violations.violations) == 0 def test_maps(): msg = maps_pb2.MapMinMax() - violations = protovalidate.validate(msg) + try: + protovalidate.validate(msg) + except protovalidate.ValidationError as e: + assert len(e.errors()) == 1 + assert len(e.violations.violations) == 1 + assert str(e) == "invalid MapMinMax" Looks good, but need to update the main readme as well. — Reply to this email directly, view it on GitHub <#32 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAHNP5TFKC7TLGP3AYM5EFDXPVQNPANCNFSM6AAAAAA2CYOPNQ> . You are receiving this because you modified the open/close state.Message ID: ***@***.***>