Skip to content
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

Move TODO regarding pickling to markdown #9288

Merged
merged 1 commit into from Apr 23, 2024

Conversation

lgeiger
Copy link
Contributor

@lgeiger lgeiger commented Apr 19, 2024

Change Summary

As far as I can tell pickling is supported by pydantic, so I think this TODO in the docs can be removed.

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

Selected Reviewer: @adriangb

Copy link

codspeed-hq bot commented Apr 19, 2024

CodSpeed Performance Report

Merging #9288 will not alter performance

Comparing lgeiger:pickling-docs (ffcaa5d) with main (82e4664)

Summary

✅ 13 untouched benchmarks

@lgeiger
Copy link
Contributor Author

lgeiger commented Apr 19, 2024

please review

@adriangb
Copy link
Member

We'll have to get the test working to verify that!

@lgeiger
Copy link
Contributor Author

lgeiger commented Apr 19, 2024

We'll have to get the test working to verify that!

Sorry about that, I re-enabled the test. At least locally it seems to work as expected. Let's see what CI thinks.

Copy link
Member

@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

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

Great, thank you!

@sydney-runkle
Copy link
Member

Oh hmm, looks like this is still failing tests:

data = pickle.dumps(m)
E   _pickle.PicklingError: Can't pickle <class '__main__.FooBarModel'>: attribute lookup FooBarModel on __main__ failed

@lgeiger
Copy link
Contributor Author

lgeiger commented Apr 22, 2024

Yeah, looks like the failure just happens in the doctests. I moved the comment to a markdown such that it doesn't show up in the public docs which might confuse some users

@lgeiger lgeiger changed the title Remove outdated TODO regarding pickling in docs Move TODO regarding pickling to markdown Apr 22, 2024
@sydney-runkle sydney-runkle added the relnotes-ignore Omit this PR from the release notes. label Apr 23, 2024
@sydney-runkle
Copy link
Member

Ah nice. Looks good!

@sydney-runkle sydney-runkle merged commit 2b8efa2 into pydantic:main Apr 23, 2024
53 of 54 checks passed
@lgeiger lgeiger deleted the pickling-docs branch April 23, 2024 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for review relnotes-ignore Omit this PR from the release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants