✨ Support pattern parameter

[stickM4N]

I faced this issue with Pydantic V2 and there is a simple workaround to it by passing the pattern Field parameter as schema extra:

Ex:

class MyClass(SQLModel) id: str = Field(unique=True, schema_extra={'pattern': r"^\d{5}$"})

I don't know if this issue was already fixed in another branch, I saw there was a temporary PR already made but closed.

[stickM4N]

@tiangolo @alejsdev or some other maintainer... could you please review this issue?

[svlandeg]

Thanks for the PR! We're going through the backlog of PRs right now, and will get back to you once we've had the time to review this and consider the (breaking) change 🙏

[stickM4N]

@svlandeg Nice to hear you are taking action on this matter. There is remark, the parameter the was renamed between Pydantic v1 and v2 is regex-> pattern, not as listed in the PR.

The suggestion I made in the PR was to keep both versions compatible when upgrading, but there is an alternative, which is not managing the change between them and just provide the proper type hints.

If you want me to update the PR just let me know, IDK which approach is more adequate for the project.

[YuriiMotov]

Since we still support regex parameter and just add alias (pattern) and make it working with Pydantic V2, I wouldn't call these changes braking.
So, I would remove the mention of breaking.

Also, I think we should mark regex as deprecated and prioritize pattern over regexp regardless the version of Pydantic.

Still we need to add some test:

• pass regex and validate valid\invalid value
• pass pattern and validate valid\invalid value
• pass both regex and pattern and see that pattern is used
• don't pass pattern directly, but pass schema_extra={"pattern": r"..."} (workaround that is currently being used to make it working with Pydantic V2) - it should still work

[stickM4N]

Noted @YuriiMotov, I will do that.
Here there is the reference to the removed parameter and error raise associated to it. Here is its implementation.

I would like to propose the following change:

def Field(default, *, ..., **schema_extra)

rather than

def Field(default, *, ..., schema_extra)

[YuriiMotov]

I would like to propose the following change:

def Field(default, *, ..., **schema_extra)

I think this should be done in a separate PR. And I would do it in a different way - I would add pydantic_kwargs and json_schema_extra parameters and deprecate schema_extra.

---

Could you please address other ideas from this comment?

[stickM4N]

I think this should be done in a separate PR. And I would do it in a different way - I would add pydantic_kwargs and json_schema_extra parameters and deprecate schema_extra.
Fine by me!

Since we still support regex parameter and just add alias (pattern) and make it working with Pydantic V2, I wouldn't call these changes braking. So, I would remove the mention of breaking.

Regarding this, I would still label it as breaking because pydantic.v2 does not support the keyarg and will raise an error if provided. You can check the docs and the implementation for farther details.

Tests

• pass regex and validate valid\invalid value.
• pass pattern and validate valid\invalid value.
• pass both regex and pattern and see that pattern is used -> this is implicitly tested because if its V1 pattern will not work and if its V2 the test will raise an error.
• don't pass pattern directly, but pass schema_extra={"pattern": r"..."} (workaround that is currently being used to make it working with Pydantic V2) -> kept for compatibility, might be removed in the future

[YuriiMotov]

LGTM in general, just one suggestion:

I still think we should deprecate regex parameter and prioritize pattern regardless the version of Pydantic installed.
Let's leave this decision to Sebastian

[YuriiMotov]

I still think we should deprecate regex parameter and prioritize pattern regardless the version of Pydantic installed.
Let's leave this decision to Sebastian

[stickM4N]

I would leave it like this, separate but not deprecate any, it is the main purpose of this PR, to support both and after migrating from pydantic v1 to v2 it remains compatible

[YuriiMotov]

It's just a bit confusing that we will have 2 duplicating parameters.
Pydantic has marked regex as deprecated in V2

[stickM4N]

Yes, that's true, but since sqlmodel supports both versions we should keep compatibility.
Otherwise this PR would be just renaming the parameter

[YuriiMotov]

We support both, but mark old one as deprecated. This way we give users time to update their code bases to use new parameter instead of old one.
Later we will drop regex and only allow pattern regardless the Pydantic version.
I think we should go this way

[stickM4N]

Ok. Then:

1. Support both parameters (like it is)
2. In future versions schema_extra and regex will be removed in order to support just pattern as pydantic have done

[YuriiMotov]

Yes, but schema_extra will be just renamed to json_schema_extra and schema_extra will be marked as deprecated

[YuriiMotov]

Thanks!
I think we should wait for #1035 to be reviewed by Sebastian and merged, then reflect those changes in this PR.
So, let's wait a bit