Make path of the item to validate available in plugin by hramezani · Pull Request #7861 · pydantic/pydantic

hramezani · 2023-10-18T14:06:39Z

Change Summary

Related issue number

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

cloudflare-workers-and-pages · 2023-10-18T14:08:42Z

Deploying with Cloudflare Pages

Latest commit:	`17b7125`
Status:	✅ Deploy successful!
Preview URL:	https://b0f00146.pydantic-docs2.pages.dev
Branch Preview URL:	https://plugin-path.pydantic-docs2.pages.dev

View logs

hramezani · 2023-10-18T14:34:52Z

Please review

adriangb · 2023-10-18T14:42:22Z

Should we be using __qualname__? Or otherwise, how are we handling e.g. a class nested in a function / differentiating them if there are multiple with the same name?

adriangb · 2023-10-18T15:09:33Z

Can you add a test for that scenario? Something like:

def foo():
    class Model(BaseModel): pass

def bar():
    class Model(BaseModel): pass

foo()
bar()

Alternatively, instead of making the class name and module available why can't we just make the class itself available? Then the plugin can decide what to do with weird cases like above. Or plugins may want to keep a some soft of dict[cls, ??] which would be easier with actual classes instead of names.

hramezani · 2023-10-18T15:43:44Z

def foo():
    class Model(BaseModel): pass

def bar():
    class Model(BaseModel): pass

foo()
bar()

I've added a test for this.

hmm, this is also an idea to make the class itself available on plugin. The current solution suggested by @samuelcolvin. So, what do you think here @samuelcolvin ?

samuelcolvin

otherwise LGTM.

please update.

hramezani · 2023-10-20T09:34:42Z

@samuelcolvin I've addressed your comments.

Also, I've pushed a new commit and added item_type param that contains the type of the item to be validated. e.g BaseModel, create_model, dataclass, ...

please review

hramezani · 2023-10-20T16:23:41Z

I've added source_type as well.

Here are the params:

source_type: str -> The model, dataclass or type itself.
type_path: str -> It's path e.g. foo.bar.MyModel
item_type: str -> it's type e.g BaseModel, create_model, dataclass

TBH, I am not happy with param names. Any suggestions?

samuelcolvin

Sorry, some more changes to make it clearer. Hope this is makes sense to you.

samuelcolvin · 2023-10-25T14:13:03Z

+        source_type: str,
+        type_path: str,
+        item_type: str,


Suggested change

source_type: str,

type_path: str,

item_type: str,

schema_type: Any,

schema_type_path: tuple[str, str],

schema_kind: Literal['BaseModel', 'create_mode', 'validate_call', 'TypeAdapter'],

Maybe I'm confused, but source_type should be Any I think?

Also:

item_type is a very confusing name, better to use schema_kind and make it a literal

I think it's more pythonic/correct ot make type_path, now schema_type_path an enum of module, name - you could even used a NamedTuple? Sorry for confusion.

samuelcolvin · 2023-10-25T14:17:57Z

+    source_type: Any,
+    module: str,
+    type_name: str,
+    item_type: str,


rename and change type types here to. You can leave schema_type_module and schema_type_name as separate parameters if you like.

samuelcolvin

otherwise LGTM.

please update.

samuelcolvin · 2023-10-30T18:08:56Z

        namespace: dict[str, Any],
        __pydantic_generic_metadata__: PydanticGenericMetadata | None = None,
        __pydantic_reset_parent_namespace__: bool = True,
+        cls_module: str | None = None,


Are you sure it's valid to pass cls_module as a kwarg to __new__?

if module has to be passed this way for create_model, maybe better to use _cls_module to avoid clashes with config?

Yes, it's there for create_model. I renamed all of them to _cls_module

hramezani · 2023-10-31T07:38:53Z

Ok, @samuelcolvin I've addressed your comments

Please review again

samuelcolvin

LGTM

hramezani added the relnotes-feature label Oct 18, 2023

hramezani force-pushed the plugin-path branch 2 times, most recently from a2c10ac to 77b401b Compare October 18, 2023 14:21

pydantic-hooky Bot added the ready for review label Oct 18, 2023

pydantic-hooky Bot assigned sydney-runkle Oct 18, 2023

hramezani assigned samuelcolvin and unassigned sydney-runkle Oct 18, 2023

samuelcolvin reviewed Oct 19, 2023

View reviewed changes

pydantic-hooky Bot added awaiting author revision awaiting changes from the PR author and removed ready for review labels Oct 19, 2023

pydantic-hooky Bot assigned hramezani and unassigned samuelcolvin Oct 19, 2023

hramezani force-pushed the plugin-path branch from 4edb244 to 559734b Compare October 20, 2023 09:27

pydantic-hooky Bot added ready for review and removed awaiting author revision awaiting changes from the PR author labels Oct 20, 2023

pydantic-hooky Bot assigned sydney-runkle and unassigned hramezani Oct 20, 2023

hramezani force-pushed the plugin-path branch from 559734b to 62ec577 Compare October 20, 2023 15:44

samuelcolvin requested changes Oct 25, 2023

View reviewed changes

pydantic-hooky Bot added awaiting author revision awaiting changes from the PR author and removed ready for review labels Oct 25, 2023

pydantic-hooky Bot assigned hramezani and unassigned sydney-runkle Oct 25, 2023

pydantic-hooky Bot assigned sydney-runkle and unassigned hramezani Oct 26, 2023

samuelcolvin reviewed Oct 30, 2023

View reviewed changes

pydantic-hooky Bot added awaiting author revision awaiting changes from the PR author and removed ready for review labels Oct 30, 2023

pydantic-hooky Bot assigned hramezani and unassigned sydney-runkle Oct 30, 2023

hramezani added 8 commits October 31, 2023 10:46

Make path of the item to validate available in plugin

e2b407b

Use __qualname__

be9c166

Add more tests

f98883f

Address comments

514e267

Add item_type

ecbfd5b

Add source_type

b3606eb

Address comments

586d460

Address comments

218b61b

hramezani force-pushed the plugin-path branch from e6b0504 to 218b61b Compare October 31, 2023 07:17

Fix formatting

4624c9f

pydantic-hooky Bot added ready for review and removed awaiting author revision awaiting changes from the PR author labels Oct 31, 2023

pydantic-hooky Bot assigned sydney-runkle and unassigned hramezani Oct 31, 2023

samuelcolvin added 2 commits October 31, 2023 15:14

type tweaks

9162495

fix tests

17b7125

samuelcolvin approved these changes Oct 31, 2023

View reviewed changes

hramezani merged commit 60c5db6 into main Oct 31, 2023

hramezani deleted the plugin-path branch October 31, 2023 16:33

KhoomeiK mentioned this pull request Dec 29, 2023

Running pydantic type validation in generated code string raises KeyError: '__name__' #8448

Closed

1 task

Uh oh!

Conversation

hramezani commented Oct 18, 2023 • edited by samuelcolvin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Summary

Related issue number

Checklist

Uh oh!

cloudflare-workers-and-pages Bot commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying with Cloudflare Pages

Uh oh!

hramezani commented Oct 18, 2023

Uh oh!

adriangb commented Oct 18, 2023

Uh oh!

adriangb commented Oct 18, 2023

Uh oh!

hramezani commented Oct 18, 2023

Uh oh!

samuelcolvin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hramezani commented Oct 20, 2023

Uh oh!

hramezani commented Oct 20, 2023

Uh oh!

samuelcolvin left a comment

Choose a reason for hiding this comment

Uh oh!

samuelcolvin Oct 25, 2023

Choose a reason for hiding this comment

Uh oh!

samuelcolvin Oct 25, 2023

Choose a reason for hiding this comment

Uh oh!

samuelcolvin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

samuelcolvin Oct 30, 2023

Choose a reason for hiding this comment

Uh oh!

samuelcolvin Oct 30, 2023

Choose a reason for hiding this comment

Uh oh!

hramezani Oct 31, 2023

Choose a reason for hiding this comment

Uh oh!

hramezani commented Oct 31, 2023

Uh oh!

samuelcolvin left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hramezani commented Oct 18, 2023 •

edited by samuelcolvin

Loading

cloudflare-workers-and-pages Bot commented Oct 18, 2023 •

edited

Loading