Pydantic plugins - `entry-point` support #6820

Kludex · 2023-07-24T10:34:02Z

Change Summary

Implement a plugin system using Python entry points.

Related issue number

Closes Support plugins #6765

Checklist

The pull request title is a good summary of the changes - it will be used in the changelog
Unit tests for the changes exist
Tests pass on CI
Documentation reflects the changes where applicable
My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Missing

I'll add them if everything is fine with the current implementation.

Tests
Documentation
Other places where we can have PluggableSchemaValidator

Selected Reviewer: @samuelcolvin

linear · 2023-07-24T10:34:04Z

PYD-181 Pydantic observability plugin

The idea is to support plugins from Pydantic, in a way we could "intercept", or "have hooks" on validation. For that, we intend to leverage the Entry Points Specification from Python.

As a reference, the two most known entry points are for flake8 and pytest.

The plugin needs to be agnostic i.e. it should just wrap the code we call the SchemaValidator.validate_*, which should allow pydantic_sdk to intercept the validation, and retrieve the data it wants.

The implementation will be "hidden" in a fork.

Questions

Do we want to raise if the extra key doesn't have a plugin?

cloudflare-pages · 2023-07-24T10:34:43Z

Deploying with Cloudflare Pages

Latest commit:	`e073168`
Status:	✅ Deploy successful!
Preview URL:	https://720a4185.pydantic-docs2.pages.dev
Branch Preview URL:	https://kludex-pyd-181.pydantic-docs2.pages.dev

View logs

Kludex · 2023-07-24T10:35:05Z

please review

samuelcolvin

otherwise I think this looks like a great start.

Obviously needs tests and documentation.

pydantic/_internal/_dataclasses.py

pydantic/plugin/loader.py

samuelcolvin · 2023-07-24T13:32:18Z

pydantic/plugin/schema_validator.py

+
+        def on_step(*args: Any, **kwargs: Any) -> None:
+            for plugin in plugins:
+                with contextlib.suppress(AttributeError, TypeError):


I'm not sure we should be suppressing these errors?

Otherwise, I'll need more conditionals below to check if the steps are implemented, i.e. if on_event is not None and if step_func is not None. It's a bit more verbose.

What do you prefer?

pydantic/plugin/schema_validator.py

Kludex · 2023-07-24T15:32:11Z

@samuelcolvin Should I allow BaseModel.__init_subclass__ to receive keyword arguments on this PR?

Kludex · 2023-07-25T09:20:35Z

@samuelcolvin Should I allow BaseModel.__init_subclass__ to receive keyword arguments on this PR?

I've talked to @davidhewitt. I'll accept other keyword arguments for __init_subclass__, and allow the plugin to customize itself depending on that.

Kludex · 2023-07-26T10:19:27Z

Only some tests missing here.

Kludex · 2023-07-26T13:23:57Z

please review

docs/usage/plugins.md

pydantic/main.py

tests/test_plugins.py

Kludex requested a review from adriangb July 24, 2023 10:35

pydantic-hooky bot added the ready for review label Jul 24, 2023

pydantic-hooky bot assigned davidhewitt Jul 24, 2023

Kludex requested a review from samuelcolvin July 24, 2023 10:35

samuelcolvin requested changes Jul 24, 2023

View reviewed changes

pydantic-hooky bot added awaiting author revision and removed ready for review labels Jul 24, 2023

pydantic-hooky bot assigned Kludex and unassigned davidhewitt Jul 24, 2023

Kludex force-pushed the kludex/PYD-181 branch from 8b026e4 to 3aa9316 Compare July 24, 2023 15:27

Kludex marked this pull request as draft July 25, 2023 09:43

Kludex force-pushed the kludex/PYD-181 branch 2 times, most recently from 54a7612 to f7c32d1 Compare July 25, 2023 12:29

Kludex mentioned this pull request Jul 25, 2023

Add _ignored argument to SchemaValidator pydantic/pydantic-core#822

Closed

4 tasks

Kludex force-pushed the kludex/PYD-181 branch from 92b2bce to 1876c06 Compare July 25, 2023 15:37

Kludex marked this pull request as ready for review July 26, 2023 10:16

Kludex force-pushed the kludex/PYD-181 branch from 6de1425 to e8aa98f Compare July 26, 2023 13:19

pydantic-hooky bot added ready for review and removed awaiting author revision labels Jul 26, 2023

pydantic-hooky bot assigned davidhewitt and unassigned Kludex Jul 26, 2023

samuelcolvin changed the title ~~Support pydantic entry point~~ Pydantic plugin - entry point support Jul 26, 2023

lig assigned samuelcolvin and unassigned lig Sep 18, 2023

lig added ready for review and removed awaiting author revision labels Sep 18, 2023

🚑 Suppress ImportError only while running plugin callbacks

1e93da5

samuelcolvin mentioned this pull request Sep 22, 2023

pytest returtn "AttributeError: 'Person' object has no attribute '__pydantic_extra__'" in V2 #7556

Closed

1 task

samuelcolvin added 5 commits September 22, 2023 11:04

confirm that repr(model) works before validation

4587cfd

refactor plugin

9b1ed15

Merge branch 'main' into kludex/PYD-181

ec32d59

simplify call method

74e2ff1

fixing tests

c3990bb

samuelcolvin added the relnotes-feature label Sep 22, 2023

samuelcolvin added 4 commits September 22, 2023 15:19

fix docs

56aab5b

Merge branch 'main' into kludex/PYD-181

49d72a5

skip plugin tests by default

fce3acf

fix docs

9fa2da0

samuelcolvin mentioned this pull request Sep 22, 2023

Prepare release 2.4.0 #7568

Merged

7 tasks

lig suggested changes Sep 22, 2023

View reviewed changes

docs/usage/plugins.md Outdated Show resolved Hide resolved

docs/usage/plugins.md Outdated Show resolved Hide resolved

pydantic/main.py Show resolved Hide resolved

tests/test_plugins.py Show resolved Hide resolved

tests/test_plugins.py Show resolved Hide resolved

pydantic-hooky bot added awaiting author revision and removed ready for review labels Sep 22, 2023

pydantic-hooky bot assigned Kludex and unassigned samuelcolvin Sep 22, 2023

samuelcolvin and others added 2 commits September 22, 2023 16:21

docs improvements and more tests

1f07b42

📝 Fix some docs and doc strings

e073168

lig approved these changes Sep 22, 2023

View reviewed changes

lig enabled auto-merge (squash) September 22, 2023 16:18

samuelcolvin approved these changes Sep 22, 2023

View reviewed changes

lig merged commit f120e7c into main Sep 22, 2023
58 checks passed

lig deleted the kludex/PYD-181 branch September 22, 2023 16:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pydantic plugins - `entry-point` support #6820

Pydantic plugins - `entry-point` support #6820

Kludex commented Jul 24, 2023 •

edited by samuelcolvin

linear bot commented Jul 24, 2023

Questions

cloudflare-pages bot commented Jul 24, 2023 •

edited

Kludex commented Jul 24, 2023

samuelcolvin left a comment

samuelcolvin Jul 24, 2023

Kludex Jul 24, 2023 •

edited

Kludex commented Jul 24, 2023

Kludex commented Jul 25, 2023

Kludex commented Jul 26, 2023

Kludex commented Jul 26, 2023

Pydantic plugins - entry-point support #6820

Pydantic plugins - entry-point support #6820

Conversation

Kludex commented Jul 24, 2023 • edited by samuelcolvin

Change Summary

Related issue number

Checklist

Missing

linear bot commented Jul 24, 2023

Questions

cloudflare-pages bot commented Jul 24, 2023 • edited

Deploying with Cloudflare Pages

Kludex commented Jul 24, 2023

samuelcolvin left a comment

Choose a reason for hiding this comment

samuelcolvin Jul 24, 2023

Choose a reason for hiding this comment

Kludex Jul 24, 2023 • edited

Choose a reason for hiding this comment

Kludex commented Jul 24, 2023

Kludex commented Jul 25, 2023

Kludex commented Jul 26, 2023

Kludex commented Jul 26, 2023

Pydantic plugins - `entry-point` support #6820

Pydantic plugins - `entry-point` support #6820

Kludex commented Jul 24, 2023 •

edited by samuelcolvin

cloudflare-pages bot commented Jul 24, 2023 •

edited

Kludex Jul 24, 2023 •

edited