Skip to content

Add dataclass and pydantic support #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Apr 29, 2020
Merged

Add dataclass and pydantic support #27

merged 13 commits into from
Apr 29, 2020

Conversation

shyamd
Copy link

@shyamd shyamd commented Apr 25, 2020

This PR adds support for parsing dataclass annotations and PyDantic fields as attributes of a class.

@pawamoy
Copy link
Member

pawamoy commented Apr 25, 2020

Great! I will review this tomorrow 🙂

@pawamoy pawamoy self-requested a review April 25, 2020 21:01
Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good 👍

If we can get rid of the pydantic dependency this would be great. I'd rename field property to the more explicit pydantic-field, and add a pydantic-model property on such classes as well 🙂

Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, a few things left 🙂

@pawamoy pawamoy merged commit a172ad8 into mkdocstrings:master Apr 29, 2020
@pawamoy
Copy link
Member

pawamoy commented Apr 29, 2020

Thanks again @shyamd! Really appreciate your contributions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants