update codebase to support fastapi>=0.100.0 and pydantic>=2.0.0 #447

johnybx · 2023-08-21T09:17:58Z

Hi,
I updated codebase to support fastapi>=0.100.0 and pydantic>=2.0.0 ( this is breaking change ). I tried to keep same features and interface but when it comes to with_prefix function there were changes required. Currently with pydantic>=2.0.0 when you define attribute like in this example:

        class MainFilter(BaseModel):
            name: str
            number_filter: Optional[NumberFilter] = FilterDepends(with_prefix("number_filter", NumberFilter))

you get error:

pydantic_core._pydantic_core.ValidationError: 1 validation error for FilterWrapper
  address
    Input should be a valid dictionary or instance of NumberFilter [type=model_type, input_value=FilterWrapper(...), input_type=FilterDepends.<locals>.FilterWrapper]
  For further information visit https://errors.pydantic.dev/2.2/v/model_type

The only workaround I found (currently) is to update with_prefix to generate the wrapped model and annotation with PlainValidator.

TODO:

test with all supported python versions
update documentation
this is breaking change - should probably update major version instead of minor ?

netlify · 2023-08-21T09:18:02Z

✅ Deploy Preview for fastapi-filter ready!

Name	Link
🔨 Latest commit	`a267eea`
🔍 Latest deploy log	https://app.netlify.com/sites/fastapi-filter/deploys/650b42510f84df0007198f9c
😎 Deploy Preview	https://deploy-preview-447--fastapi-filter.netlify.app/
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

arthurio · 2023-08-21T14:44:43Z

@johnybx Thanks so much for putting time into this, I'll try to review/help as much as I can 👍🏻 And yeah a major version bump is the way to go.

codecov · 2023-08-21T14:46:25Z

Codecov Report

Merging #447 (a267eea) into main (7f1f367) will not change coverage.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #447   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          180       193   +13     
=========================================
+ Hits           180       193   +13

Files Changed	Coverage Δ
fastapi_filter/base/filter.py	`100.00% <100.00%> (ø)`
fastapi_filter/contrib/mongoengine/filter.py	`100.00% <100.00%> (ø)`
fastapi_filter/contrib/sqlalchemy/filter.py	`100.00% <100.00%> (ø)`

… upgrade of dependencies

johnybx · 2023-09-04T19:35:03Z

I came up with different approach which does not introduce breaking changes to how with_prefix is used. It would be nice if you could review the changes @arthurio. Thanks

Signed-off-by: johnybx <[email protected]>

arthurio

That look really great, thank you so much for all your work!
I just have a few nits but we can ship it after that 🚀

examples/fastapi_filter_mongoengine.py

examples/fastapi_filter_sqlalchemy.py

fastapi_filter/base/filter.py

tests/test_mongoengine/test_order_by.py

Co-authored-by: Arthur Rio <[email protected]> Signed-off-by: johnybx <[email protected]>

Signed-off-by: johnybx <[email protected]>

arthurio

Just that one last question so that we avoid confusion for people hitting that edge case, otherwise looks like it's ready to go! 👍🏻

arthurio · 2023-09-15T04:59:33Z

fastapi_filter/base/filter.py

+            if len(annotation_args) == 1:
+                annotation = annotation_args[0]
+            # Not sure what to do if there is more then 1 value 🤔
+            # Do we need to handle Optional[Annotated[...]] ?


We should raise an exception for now until we figure this out?

I left the comment here for future as a note that union of list type with other types is not supported just in case someone thought that for example type like list[str] | int | None should work with filter. At the same time I don't think that it is reasonable to support such types ( I mean transformation of list part to str split by comma in such complex types) without knowing real usecase. Also supporting such types would be problem in case of types like list[str] | str | None.

Raising exception here is not a good idea because the exception would be raised on any type which is union basically so for example int | float because this is union type and will have length 2 but at the same time it is valid type which we want to skip. Maybe I should just update comment to specifically mention that I am not sure what to do if the type is combination of list and other types like list[str] | str ? Because list filtering will not work in that case 🤔

What do you think ?

@johnybx Do you have time to make that change or do you want me to do it?

@arthurio sure I just wasn't sure if you are fine with what I wrote. I added note to code and also added small section about current limitations of union types in filters with list. Let me know if something should be changed 👍

fastapi_filter/base/filter.py

examples/fastapi_filter_mongoengine.py

johnybx · 2023-09-15T19:14:04Z

fastapi_filter/base/filter.py

+            if len(annotation_args) == 1:
+                annotation = annotation_args[0]
+            # Not sure what to do if there is more then 1 value 🤔
+            # Do we need to handle Optional[Annotated[...]] ?


I left the comment here for future as a note that union of list type with other types is not supported just in case someone thought that for example type like list[str] | int | None should work with filter. At the same time I don't think that it is reasonable to support such types ( I mean transformation of list part to str split by comma in such complex types) without knowing real usecase. Also supporting such types would be problem in case of types like list[str] | str | None.

Raising exception here is not a good idea because the exception would be raised on any type which is union basically so for example int | float because this is union type and will have length 2 but at the same time it is valid type which we want to skip. Maybe I should just update comment to specifically mention that I am not sure what to do if the type is combination of list and other types like list[str] | str ? Because list filtering will not work in that case 🤔

What do you think ?

johnybx · 2023-09-20T19:02:25Z

fastapi_filter/base/filter.py

+            if len(annotation_args) == 1:
+                annotation = annotation_args[0]
+            # Not sure what to do if there is more then 1 value 🤔
+            # Do we need to handle Optional[Annotated[...]] ?


@arthurio sure I just wasn't sure if you are fine with what I wrote. I added note to code and also added small section about current limitations of union types in filters with list. Let me know if something should be changed 👍

johnybx · 2023-09-22T12:10:32Z

@arthurio sorry that it took so long but I just realized that pending label on comment does not mean that it is waiting for reviewer but rather that it is not submitted 🤦

arthurio

Let's do it! Thanks again for all the hard work, really appreciate it.

LucasPickering · 2023-09-28T16:10:56Z

@arthurio @johnybx Thank you so much for your work on this! Very excited to upgrade now

update codebase to support fastapi>=0.100.0 and pydantic>=2.0.0

6a09192

johnybx marked this pull request as draft August 21, 2023 09:18

johnybx added 2 commits August 21, 2023 11:29

update comment

f234e0d

update examples

43268a7

fix unsupported typing, fix compatibility with older python versions

742accd

Kastakin mentioned this pull request Aug 30, 2023

Support for fastapi 0.100 hence pydantic 2.0 #439

Closed

fix breaking change of with_prefix -> keep same behaviour as before…

5bc801b

… upgrade of dependencies

arthurio and others added 7 commits September 5, 2023 10:22

Merge branch 'main' into main

d5618bd

Merge remote-tracking branch 'origin/main' into johnybx/main

c457b97

Merge remote-tracking branch 'origin/main' into johnybx/main

9449e25

Merge remote-tracking branch 'origin/main' into johnybx/main

4af4450

fix coverage

30f4c3b

update required dependencies in readme

3174131

Merge branch 'main' into main

bf7e5c2

Signed-off-by: johnybx <[email protected]>

johnybx marked this pull request as ready for review September 6, 2023 14:54

fix linting

b1f8c0d

johnybx force-pushed the main branch from ea6bc5b to b1f8c0d Compare September 6, 2023 15:00

fix supported pydantic versions

73baabe

arthurio requested changes Sep 12, 2023

View reviewed changes

Merge remote-tracking branch 'origin/main' into johnybx/main

5551a2a

This was referenced Sep 12, 2023

Update dependency pydantic to v2 #415

Closed

Update dependency fastapi to v0.103.1 #406

Closed

fix: Make default filter, sort and split_str a no-op, plus various improvements #272

Open

johnybx and others added 3 commits September 13, 2023 09:12

Update examples/fastapi_filter_mongoengine.py

e76051a

Co-authored-by: Arthur Rio <[email protected]> Signed-off-by: johnybx <[email protected]>

Update examples/fastapi_filter_sqlalchemy.py

94c45f2

Co-authored-by: Arthur Rio <[email protected]> Signed-off-by: johnybx <[email protected]>

Update fastapi_filter/base/filter.py

eadbac0

Co-authored-by: Arthur Rio <[email protected]> Signed-off-by: johnybx <[email protected]>

johnybx added 4 commits September 13, 2023 10:08

resolve conflicts, update poetry.lock

cf2473b

Merge branch 'main' into main

35ff5ae

Signed-off-by: johnybx <[email protected]>

Merge branch 'main' into main

d8406fa

Signed-off-by: johnybx <[email protected]>

fix linting

0f1c161

johnybx requested a review from arthurio September 14, 2023 06:46

arthurio reviewed Sep 15, 2023

View reviewed changes

This was referenced Sep 17, 2023

Add list routes for scrapers and properties dunlas/rest-scraper#9

Closed

Create filters for list routes dunlas/rest-scraper#17

Open

add note and docs section about limitations of union types in filter

a267eea

johnybx force-pushed the main branch from 039ef67 to a267eea Compare September 20, 2023 19:04

johnybx commented Sep 22, 2023

View reviewed changes

johnybx requested a review from arthurio September 28, 2023 12:53

arthurio approved these changes Sep 28, 2023

View reviewed changes

arthurio merged commit 827d2e3 into arthurio:main Sep 28, 2023
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update codebase to support fastapi>=0.100.0 and pydantic>=2.0.0 #447

update codebase to support fastapi>=0.100.0 and pydantic>=2.0.0 #447

johnybx commented Aug 21, 2023 •

edited

Loading

netlify bot commented Aug 21, 2023 •

edited

Loading

arthurio commented Aug 21, 2023

codecov bot commented Aug 21, 2023 •

edited

Loading

johnybx commented Sep 4, 2023

arthurio left a comment

arthurio left a comment

arthurio Sep 15, 2023

johnybx Sep 15, 2023

arthurio Sep 19, 2023

johnybx Sep 20, 2023

johnybx Sep 15, 2023

johnybx Sep 20, 2023

johnybx commented Sep 22, 2023

arthurio left a comment

LucasPickering commented Sep 28, 2023

update codebase to support fastapi>=0.100.0 and pydantic>=2.0.0 #447

update codebase to support fastapi>=0.100.0 and pydantic>=2.0.0 #447

Conversation

johnybx commented Aug 21, 2023 • edited Loading

netlify bot commented Aug 21, 2023 • edited Loading

✅ Deploy Preview for fastapi-filter ready!

arthurio commented Aug 21, 2023

codecov bot commented Aug 21, 2023 • edited Loading

Codecov Report

johnybx commented Sep 4, 2023

arthurio left a comment

Choose a reason for hiding this comment

arthurio left a comment

Choose a reason for hiding this comment

arthurio Sep 15, 2023

Choose a reason for hiding this comment

johnybx Sep 15, 2023

Choose a reason for hiding this comment

arthurio Sep 19, 2023

Choose a reason for hiding this comment

johnybx Sep 20, 2023

Choose a reason for hiding this comment

johnybx Sep 15, 2023

Choose a reason for hiding this comment

johnybx Sep 20, 2023

Choose a reason for hiding this comment

johnybx commented Sep 22, 2023

arthurio left a comment

Choose a reason for hiding this comment

LucasPickering commented Sep 28, 2023

johnybx commented Aug 21, 2023 •

edited

Loading

netlify bot commented Aug 21, 2023 •

edited

Loading

codecov bot commented Aug 21, 2023 •

edited

Loading