Releases: bufbuild/protovalidate-python
v0.6.1
The biggest change in this release is the support of PEP 561 (marking protovalidate
as having type information inline), which should make usage of protovalidate
with tools like mypy
more seamless — see #243 for more details. Other than that, it's mostly dependency updates.
If coming from a release pre-v0.6.0, make sure to check out the release notes for that release when upgrading!
What's Changed
- Bump protobuf from 5.29.0 to 5.29.1 by @dependabot in #225
- Bump types-protobuf from 5.28.3.20241030 to 5.29.1.20241207 by @dependabot in #226
- Bump ruff from 0.8.1 to 0.8.3 by @dependabot in #228
- Fix README cel expression by @stefanvanburen in #230
- Bump mypy from 1.13.0 to 1.14.0 by @dependabot in #231
- Bump ruff from 0.8.3 to 0.8.4 by @dependabot in #232
- Bump protobuf from 5.29.1 to 5.29.2 by @dependabot in #233
- Bump gencode version to 29.2 by @stefanvanburen in #234
- Bump mypy from 1.14.0 to 1.14.1 by @dependabot in #236
- Bump ruff from 0.8.4 to 0.8.6 by @dependabot in #235
- Bump ruff from 0.8.6 to 0.9.1 by @dependabot in #239
- Bump Pipfile python_version to 3.9 and re-lock by @stefanvanburen in #240
- Add PEP 561 type support by @stefanvanburen in #243
Full Changelog: v0.6.0...v0.6.1
v0.6.0
Breaking Change: protovalidate.ValidationError
has changed. The violations
property is now a list of protovalidate.Violation
, instead of a protobuf buf.validate.Violations
message. In most cases, code will need to be updated like this:
violations = protovalidate.collect_violations(msg)
- print(violations.violations[0].constraint_id)
+ print(violations[0].proto.constraint_id)
The ValidationError.errors()
method is removed in favor of the violations
property, and a new ValidationError.to_proto()
method is added to return the equivalent buf.validate.Violations
.
In addition to containing the buf.validate.Violation
protobuf message under the property proto
, the new protovalidate.Violation
class contains additional in-memory information about the violation which cannot be serialized to the wire:
field_value
: Contains the value of the field failing validation, if there is a field corresponding to the violation.rule_value
: Contains the value of the rule failing validation, if there is a rule corresponding to the violation.
Take, for example, the following protobuf message schema:
message User {
string email = 1 [(buf.validate.field).string.email = true];
}
If you try to validate the message User(email="invalid")
, the field_value
will be "invalid"
and the rule_value
will be True
.
Some violations do not correspond directly to a field, such as a message constraint failure; in these cases, the field_value
will be None
.
What's Changed
- Regenerate protos by @stefanvanburen in #198
- Update README for buf v2 commands/config by @stefanvanburen in #197
- Bump generated code to latest version by @stefanvanburen in #201
- Add explicit Python 3.13 support by @stefanvanburen in #204
- Bump mypy from 1.11.1 to 1.13.0 by @dependabot in #207
- Drop Python 3.8 support by @stefanvanburen in #209
- Update protovalidate to v0.8.2 by @jchadwick-buf in #216
- Bump tomli from 2.0.2 to 2.1.0 by @dependabot in #214
- Implement structured field and rule paths for violations by @jchadwick-buf in #217
- Bump ruff from 0.5.5 to 0.8.1 by @dependabot in #219
- Bump pytest from 8.3.2 to 8.3.4 by @dependabot in #222
- Bump tomli from 2.1.0 to 2.2.1 by @dependabot in #221
- Bump protobuf from 5.27.3 to 5.29.0 by @dependabot in #220
- Add rule and field value to violations by @jchadwick-buf in #224
Full Changelog: v0.5.0...v0.6.0
v0.5.0
Adds support for custom predefined field constraints. See the protovalidate documentation for more information.
Updates protovalidate to v0.8.1. Note that this is a breaking change. You may need to make some adjustments to your code:
- Code that imports
buf.validate.expression_pb2
orbuf.validate.priv.private_pb2
should now only importbuf.validate.validate_pb2
. buf.validate.priv.private_pb2.field
was moved tobuf.validate.validate_pb2.predefined
Note
This release updates protovalidate-python to use Protobuf Python v5+, which is not currently compatible with Protobuf Python v4 gencode. If you can not update to Protobuf Python v5 currently, you should continue to use protovalidate-python v0.3.1 for now.
What's Changed
- Implement predefined field constraints by @jchadwick-buf in #189
Full Changelog: v0.4.0...v0.5.0
v0.4.0
This release adds support for the string.host_and_port
CEL utility function and Protobuf Editions, and bumps the versions of many of the dependencies.
Note
This release updates protovalidate-python to use Protobuf Python v5+, which is not currently compatible with Protobuf Python v4 gencode. If you can not update to Protobuf Python v5 currently, you should continue to use protovalidate-python v0.3.1 for now.
What's Changed
- Bump actions/setup-go from 4 to 5 by @dependabot in #109
- Bump actions/setup-python from 4 to 5 by @dependabot in #108
- Create add-to-project workflow by @chrispine in #131
- Add string.host_and_port support by @rodaine in #132
- Bump pytest from 7.4.3 to 8.1.1 by @dependabot in #144
- Bump mypy from 1.7.1 to 1.9.0 by @dependabot in #143
- Bump actions/download-artifact from 3 to 4 by @dependabot in #114
- Bump actions/upload-artifact from 3 to 4 by @dependabot in #115
- Document import path for code generation by @emcfarlane in #153
- Bump aiohttp from 3.9.1 to 3.9.4 by @dependabot in #151
- Bump idna from 3.6 to 3.7 by @dependabot in #150
- Bump morrisoncole/pr-lint-action from 1.7.0 to 1.7.1 by @dependabot in #136
- Bump types-protobuf from 4.24.0.4 to 5.26.0.20240422 by @dependabot in #154
- Bump requests from 2.31.0 to 2.32.2 by @dependabot in #149
- Test 3.12 by @emcfarlane in #148
- Bump ruff from 0.1.7 to 0.4.9 by @dependabot in #157
- Switch from
black
toruff format
by @stefanvanburen in #162 - Bump ruff from 0.4.9 to 0.5.0 by @dependabot in #168
- Update for Protobuf Editions by @jchadwick-buf in #174
New Contributors
- @chrispine made their first contribution in #131
- @emcfarlane made their first contribution in #153
- @stefanvanburen made their first contribution in #162
- @jchadwick-buf made their first contribution in #174
Full Changelog: v0.3.1...v0.4.0
v0.3.1
What's Changed
- Fix behavior of required + ignore_empty constraints by @rodaine in #97
- Bump ruff from 0.1.3 to 0.1.4 by @dependabot in #94
- Bump protobuf from 4.24.4 to 4.25.0 by @dependabot in #95
- Fix JSON formatting in README.md by @kyleconroy in #98
- Combined dependencies PR by @rodaine in #102
- Support Python >=3.10 by @Alfus in #111
- Support Python >=3.8 by @Alfus in #112
New Contributors
- @rodaine made their first contribution in #97
- @kyleconroy made their first contribution in #98
Full Changelog: v0.3.0...v0.3.1
v0.3.0
What's Changed
- Bump actions/checkout from 3 to 4 by @dependabot in #71
- Bump protobuf from 4.24.1 to 4.24.3 by @dependabot in #72
- Bump black from 23.7.0 to 23.9.1 by @dependabot in #73
- Bump pytest from 7.4.0 to 7.4.2 by @dependabot in #74
- Bump types-protobuf from 4.24.0.1 to 4.24.0.2 by @dependabot in #76
- Bump urllib3 from 2.0.4 to 2.0.6 by @dependabot in #79
- Bump ruff from 0.0.285 to 0.0.292 by @dependabot in #80
- Support only Python 3.11+ by @akshayjshah in #90
- Add isIpPrefix by @higebu in #78
New Contributors
Full Changelog: v0.2.1...v0.3.0
v0.2.1
v0.2.0
Breaking Change: Refactoring of Schema-Level Constraint Enforcement
Summary:
In the recent changes to buf/validate/validate.proto
, we've refactored message definitions, targeting the organization and enforcement of rules within number-centric messages like FloatRules
, DoubleRules
, Int32Rules
, and others.
Specific Changes:
Fields such as gt
, gte
, lt
, and lte
have been structured within a oneof to ensure exclusivity:
- Fields associated with lt
and lte
now reside within the less_than
oneof.
- Fields linked to gt
and gte
have transitioned to the greater_than
oneof.
Additionally, timestamp and duration fields related to lt_now
and gt_now
have been assimilated into their respective less_than
and greater_than
oneof categories.
Action Required:
To ensure seamless compatibility and functionality, users must update their protobuf dependencies and package concurrently with this release. If your protos
were designed with mutually exclusive rules initially, the impact of this change should be minimal.
Rationale:
The restructure aims to make the rule application process more intuitive, thereby eliminating ambiguities and overlaps present in the earlier configuration. This approach ensures that rules are naturally exclusive, reinforcing better design practices.
What's Changed
- Add support for for_key and update protovalidate dep by @Alfus in #63
- Add support for isNan and isInf by @Alfus in #64
Full Changelog: v0.1.0...v0.2.0
v0.1.0
We are excited to introduce protovalidate-python
v0.1.0, the Python implementation of protovalidate, providing runtime validation for Protobuf messages based on user-defined constraints, powered by Google's Common Expression Language (CEL).
Key Features
- Protobuf Validation: Validate Protobuf messages at runtime with user-defined rules.
- CEL Support: Define comprehensive validation rules using Google's CEL.
- Efficiency: Designed for performance and minimal system resource usage.
- Flexibility: Create custom validation rules to suit specific needs.
Refer to our official documentation for detailed instructions. For any issues or suggestions, please open an issue on our GitHub page. Stay tuned for future updates.
Full Changelog: https://github.com/bufbuild/protovalidate-python/commits/v0.1.0