Pydantic 2 conversion #36
Conversation
for more information, see https://pre-commit.ci
|
Do you have a rough overview of the changes necessary to make this library compatible with pydantic 2? Or is this library not being supported anymore and I should fork it either way? |
|
There is a comprehensive test suite, so you can see the places the tests are failing with pydantic 2 and use that as your guide. This is still supported and we'd accept a PR to resolve this. |
|
you can drop 3.8 support |
tests/test_goodconf.py
Outdated
| @@ -141,17 +141,17 @@ class TestConf(GoodConf): | |||
| a: bool = Field(default=False) | |||
|
|
|||
| lines = TestConf.generate_markdown().splitlines() | |||
| assert " * type: `bool`" in lines | |||
| assert " * type: `<class 'bool'>`" in lines | |||
There was a problem hiding this comment.
Is it hard to get it to maintain the original output? (no <class '...'>)
| @@ -56,8 +56,7 @@ First, create a ``conf.py`` file in your project's directory, next to | |||
| description="Used for cryptographic signing. " | |||
| "https://docs.djangoproject.com/en/2.0/ref/settings/#secret-key") | |||
|
|
|||
| class Config: | |||
| default_files = ["/etc/myproject/myproject.yaml", "myproject.yaml"] | |||
| model_config = {"default_files": ["/etc/myproject/myproject.yaml", "myproject.yaml"]} | |||
There was a problem hiding this comment.
The readme still mentions Config below, should get updated to model_config as well.
tests/test_goodconf.py
Outdated
| @@ -208,11 +207,13 @@ def test_precedence(tmpdir): | |||
| path = tmpdir.join("myapp.json") | |||
| path.write(json.dumps({"init": "file", "env": "file", "file": "file"})) | |||
|
|
|||
| class TestConf(GoodConf, default_files=[path]): | |||
There was a problem hiding this comment.
Does this no longer work? The default Pydantic docs still show configuration via class arguments as supported: https://docs.pydantic.dev/2.8/api/config/
There was a problem hiding this comment.
shows what is needed to keep this working.
There was a problem hiding this comment.
Thanks for looking, and for the link @apollo13!
This should be updated to support configuration via class arguments
| # __pydantic_private__ to {} prior to setting self._config_file. | ||
| _object_setattr(self, "__pydantic_private__", {}) | ||
| self._config_file = config_file | ||
|
|
||
| # Emulate Pydantic behavior, load immediately | ||
| if kwargs: | ||
| return super().__init__(**kwargs) | ||
| elif load: | ||
| return self.load() |
There was a problem hiding this comment.
I wonder if it would make sense to get rid of self.load() and always load immediately like pydantic does. We are already backwards incompatible and having .load() doesn't get you much imo. At some point it is simply not worth to fight with pydantic :) What do you think @ipmb?
|
I have a patch (based on this PR) which removes the use of _pydantic internals and uses contextvars instead: apollo13@c55fa3a The nice thing about it is that now the file source is the only one responsible for loading the data, the downside is that it uses contextvars :D EDIT:// Updated the commit with a few fixes, better to check the branch: https://github.com/apollo13/goodconf/commits/pydantic2-fixes/ |
|
@apollo13 thanks for pointing to your patch. The changes seem good to me; could you update the tests based on your changes (replace the commented-out lines), and make a pull request against the |
|
@dchukhin I will try to find some time to do it. Have to think about the tests though. I have commented out the |
|
@dchukhin What do you mean with "and make a pull request against the |
|
@apollo13 Ah yes, sorry for the confusion. We'll be releasing this work soon, so once that's done, you should be able to make a pull request against |
Pydantic 2 made a lot of changes and some of them don't translate well.