Feat/upgrade pydantic v2 #354
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
src/charm_state.py
Outdated
| @@ -407,12 +403,12 @@ class CharmConfig(BaseModel): | |||
| """ | |||
|
|
|||
| denylist: list[FirewallEntry] | |||
| dockerhub_mirror: AnyHttpsUrl | None | |||
| dockerhub_mirror: AnyHttpsUrl | None = None | |||
There was a problem hiding this comment.
Is it necessary to add a default value?
src/charm_state.py
Outdated
| labels: tuple[str, ...] | ||
| openstack_clouds_yaml: OpenStackCloudsYAML | None | ||
| openstack_clouds_yaml: OpenStackCloudsYAML | None = None |
There was a problem hiding this comment.
Is it necessary to add a default value?
src/charm_state.py
Outdated
| path: GitHubPath | ||
| reconcile_interval: int | ||
| repo_policy_compliance: RepoPolicyComplianceConfig | None | ||
| repo_policy_compliance: RepoPolicyComplianceConfig | None = None |
There was a problem hiding this comment.
Is it necessary to add a default value?
| @@ -486,8 +483,6 @@ def _parse_openstack_clouds_config(cls, charm: CharmBase) -> OpenStackCloudsYAML | |||
| openstack_clouds_yaml: OpenStackCloudsYAML = yaml.safe_load( | |||
| cast(str, openstack_clouds_yaml_str) | |||
| ) | |||
| # use Pydantic to validate TypedDict. | |||
| create_model_from_typeddict(OpenStackCloudsYAML)(**openstack_clouds_yaml) | |||
There was a problem hiding this comment.
IINM, this raises if the input dict does not match the typedict, so there is a change in functionality. I see in pydantic 2 something similar https://docs.pydantic.dev/2.3/usage/types/dicts_mapping/#typeddict (not sure if appropriate as it says that for python < 3.12 you may need a library)
src/charm.py
Outdated
| @@ -1182,8 +1182,9 @@ def _on_image_relation_joined(self, _: ops.RelationJoinedEvent) -> None: | |||
| return | |||
|
|
|||
| clouds_yaml = state.charm_config.openstack_clouds_yaml | |||
| cloud = list(clouds_yaml["clouds"].keys())[0] | |||
| auth_map = clouds_yaml["clouds"][cloud]["auth"] | |||
| # unsubscriptable-object / thinks cloud_yaml is kind of a list | |||
There was a problem hiding this comment.
Looking at charm_config it is OpenStackCloudsYAML | None, so it probably thinks it can be None, which it can be....
src/charm_state.py
Outdated
| @@ -496,15 +492,15 @@ def _parse_openstack_clouds_config(cls, charm: CharmBase) -> OpenStackCloudsYAML | |||
|
|
|||
| try: | |||
| openstack_cloud.initialize(openstack_clouds_yaml) | |||
| except OpenStackInvalidConfigError as exc: | |||
| except (OpenStackInvalidConfigError, TypeError) as exc: | |||
There was a problem hiding this comment.
the linter has found something strange after the change in:
openstack_clouds_yaml: OpenStackCloudsYAML | None
openstack_clouds_yaml: OpenStackCloudsYAML | None = None
src/charm_state.py
Outdated
| if not proxy_address.port | ||
| else f"{proxy_address.host}:{proxy_address.port}" | ||
| ) | ||
| if "http" in proxy_address.host: |
There was a problem hiding this comment.
is http or https in the host?
| @@ -194,7 +194,7 @@ def create_runner(self, registration_token: str) -> InstanceId: | |||
| instance_id=instance_id, | |||
| image=self._server_config.image, | |||
| flavor=self._server_config.flavor, | |||
| network=self._server_config.network, | |||
| network=str(self._server_config.network) if self._server_config.network else None, | |||
There was a problem hiding this comment.
testing locally I do not need the change.
…rator into feat/upgrade-pydantic-v2
|
Test coverage for 368b7e6 Static code analysis report |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated Pydantic version to v2.8.2
Overview
Rationale
Juju Events Changes
Module Changes
Library Changes
Checklist
src-docsurgent,trivial,complex)