195 migrate to pydantic v2

.gitlab-ci.yml

@@ -6,17 +6,18 @@ stages:
     - deploy
 
 variables:
-    EXCLUDE_PYTHON: 311
+    EXCLUDE_PYTHON: 311, 312
     PYTHON_VERSION: "registry.git.rwth-aachen.de/ebc/ebc_all/gitlab_ci/templates:python_3.9"
     PAGES_BRANCH: master
+    PYTHON_PACKAGE_NAME: "filip"
 
 include:
     - project: 'EBC/EBC_all/gitlab_ci/templates'
       file: 'python/code-quality/pylint.gitlab-ci.yml'
     - project: 'EBC/EBC_all/gitlab_ci/templates'
       file: 'python/doc/sphinxdoc.gitlab-ci.yml'
     - project: 'EBC/EBC_all/gitlab_ci/templates'
-      file: 'pages/pages.gitlab-ci.yml'
+      file: 'pages/gl-pages.gitlab-ci.yml'
     - project: 'EBC/EBC_all/gitlab_ci/templates'
       file: 'python/tests/tests.gitlab-ci.yml'
     - project: 'EBC/EBC_all/gitlab_ci/templates'

CHANGELOG.md

@@ -1,5 +1,6 @@
-#### v0.2.5
+#### v0.3.0
 - fixed inconsistency of `entity_type` as required argument ([#188](https://github.com/RWTH-EBC/FiLiP/issues/188))
+- BREAKING CHANGE: Migration of pydantic v1 to v2 ([#199](https://github.com/RWTH-EBC/FiLiP/issues/199))
 
 #### v0.2.5
 - fixed service group edition not working ([#170](https://github.com/RWTH-EBC/FiLiP/issues/170))

README.md

@@ -66,6 +66,7 @@ on this.
 If this is not an option for you, FIWARE also provides a testing server.
 You can register for a testing account 
 [here](https://www.fiware.org/developers/fiware-lab/).
+> **Note**: FiLiP is now compatible to [Pydantic V2](https://docs.pydantic.dev/latest/migration/). If your program still require Pydantic V1.x for some reason, please use release [v0.2.5](https://github.com/RWTH-EBC/FiLiP/releases/tag/v0.2.5) or earlier version of FiLiP. Besides, we recommended to use `pydantic~=1.10` in the `requirements.txt`
 
 ### Installation
 

filip/clients/base_http_client.py

@@ -58,7 +58,7 @@ def __init__(self,
     def __enter__(self):
         if not self.session:
             self.session = requests.Session()
-            self.headers.update(self.fiware_headers.dict(by_alias=True))
+            self.headers.update(self.fiware_headers.model_dump(by_alias=True))
             self._external_session = False
         return self
 
@@ -94,12 +94,12 @@ def fiware_headers(self, headers: Union[Dict, FiwareHeader]) -> None:
         if isinstance(headers, FiwareHeader):
             self._fiware_headers = headers
         elif isinstance(headers, dict):
-            self._fiware_headers = FiwareHeader.parse_obj(headers)
+            self._fiware_headers = FiwareHeader.model_validate(headers)
         elif isinstance(headers, str):
-            self._fiware_headers = FiwareHeader.parse_raw(headers)
+            self._fiware_headers = FiwareHeader.model_validate_json(headers)
         else:
             raise TypeError(f'Invalid headers! {type(headers)}')
-        self.headers.update(self.fiware_headers.dict(by_alias=True))
+        self.headers.update(self.fiware_headers.model_dump(by_alias=True))
 
     @property
     def fiware_service(self) -> str:
@@ -121,7 +121,7 @@ def fiware_service(self, service: str) -> None:
             None
         """
         self._fiware_headers.service = service
-        self.headers.update(self.fiware_headers.dict(by_alias=True))
+        self.headers.update(self.fiware_headers.model_dump(by_alias=True))
 
     @property
     def fiware_service_path(self) -> str:
@@ -143,7 +143,7 @@ def fiware_service_path(self, service_path: str) -> None:
             None
         """
         self._fiware_headers.service_path = service_path
-        self.headers.update(self.fiware_headers.dict(by_alias=True))
+        self.headers.update(self.fiware_headers.model_dump(by_alias=True))
 
     @property
     def headers(self):

filip/clients/mqtt/client.py

@@ -281,7 +281,7 @@ def __validate_device(self, device: Union[Device, Dict]) -> Device:
             AssertionError: for faulty configurations
         """
         if isinstance(device, dict):
-            device = Device.parse_obj(device)
+            device = Device.model_validate(device)
 
         assert isinstance(device, Device), "Invalid device configuration!"
 
@@ -444,7 +444,7 @@ def add_service_group(self, service_group: Union[ServiceGroup, Dict]):
             ValueError: if service group already exists
         """
         if isinstance(service_group, dict):
-            service_group = ServiceGroup.parse_obj(service_group)
+            service_group = ServiceGroup.model_validate(service_group)
         assert isinstance(service_group, ServiceGroup), \
             "Invalid content for service group!"
 
@@ -491,7 +491,7 @@ def update_service_group(self, service_group: Union[ServiceGroup, Dict]):
             KeyError: if service group not yet registered
         """
         if isinstance(service_group, dict):
-            service_group = ServiceGroup.parse_obj(service_group)
+            service_group = ServiceGroup.model_validate(service_group)
         assert isinstance(service_group, ServiceGroup), \
             "Invalid content for service group"
 

filip/clients/ngsi_v2/cb.py

@@ -7,11 +7,11 @@
 from math import inf
 from pkg_resources import parse_version
 from pydantic import \
-    parse_obj_as, \
     PositiveInt, \
     PositiveFloat, \
     AnyHttpUrl
-from typing import Any, Dict, List , Optional, TYPE_CHECKING, Union
+from pydantic.type_adapter import TypeAdapter
+from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union
 import re
 import requests
 from urllib.parse import urljoin
@@ -53,6 +53,7 @@ class ContextBrokerClient(BaseHttpClient):
         We use the reference implementation for development. Therefore, some
         other brokers may show slightly different behavior!
     """
+
     def __init__(self,
                  url: str = None,
                  *,
@@ -232,9 +233,9 @@ def post_entity(self,
             res = self.post(
                 url=url,
                 headers=headers,
-                json=entity.dict(exclude_unset=True,
-                                 exclude_defaults=True,
-                                 exclude_none=True))
+                json=entity.model_dump(exclude_unset=True,
+                                       exclude_defaults=True,
+                                       exclude_none=True))
             if res.ok:
                 self.logger.info("Entity successfully posted!")
                 return res.headers.get('Location')
@@ -385,9 +386,11 @@ def get_entity_list(self,
                                       params=params,
                                       headers=headers)
             if AttrsFormat.NORMALIZED in response_format:
-                return parse_obj_as(List[ContextEntity], items)
+                adapter = TypeAdapter(List[ContextEntity])
+                return adapter.validate_python(items)
             if AttrsFormat.KEY_VALUES in response_format:
-                return parse_obj_as(List[ContextEntityKeyValues], items)
+                adapter = TypeAdapter(List[ContextEntityKeyValues])
+                return adapter.validate_python(items)
             return items
 
         except requests.RequestException as err:
@@ -615,7 +618,6 @@ def delete_entity(self,
 
             iota_client_local.close()
 
-
     def delete_entities(self, entities: List[ContextEntity]) -> None:
         """
         Remove a list of entities from the context broker. This methode is
@@ -637,8 +639,8 @@ def delete_entities(self, entities: List[ContextEntity]) -> None:
         # attributes.
         entities_with_attributes: List[ContextEntity] = []
         for entity in entities:
-            attribute_names = [key for key in entity.dict() if key not in
-                               ContextEntity.__fields__]
+            attribute_names = [key for key in entity.model_dump() if key not in
+                               ContextEntity.model_fields]
             if len(attribute_names) > 0:
                 entities_with_attributes.append(
                     ContextEntity(id=entity.id, type=entity.type))
@@ -705,9 +707,9 @@ def update_or_append_entity_attributes(
         try:
             res = self.post(url=url,
                             headers=headers,
-                            json=entity.dict(exclude=excluded_keys,
-                                             exclude_unset=True,
-                                             exclude_none=True),
+                            json=entity.model_dump(exclude=excluded_keys,
+                                                   exclude_unset=True,
+                                                   exclude_none=True),
                             params=params)
             if res.ok:
                 self.logger.info("Entity '%s' successfully "
@@ -753,9 +755,9 @@ def update_existing_entity_attributes(
         try:
             res = self.patch(url=url,
                              headers=headers,
-                             json=entity.dict(exclude={'id', 'type'},
-                                              exclude_unset=True,
-                                              exclude_none=True),
+                             json=entity.model_dump(exclude={'id', 'type'},
+                                                    exclude_unset=True,
+                                                    exclude_none=True),
                              params=params)
             if res.ok:
                 self.logger.info("Entity '%s' successfully "
@@ -800,9 +802,9 @@ def replace_entity_attributes(
         try:
             res = self.put(url=url,
                            headers=headers,
-                           json=entity.dict(exclude={'id', 'type'},
-                                            exclude_unset=True,
-                                            exclude_none=True),
+                           json=entity.model_dump(exclude={'id', 'type'},
+                                                  exclude_unset=True,
+                                                  exclude_none=True),
                            params=params)
             if res.ok:
                 self.logger.info("Entity '%s' successfully "
@@ -820,7 +822,7 @@ def get_attribute(self,
                       attr_name: str,
                       entity_type: str = None,
                       metadata: str = None,
-                      response_format = '') -> ContextAttribute:
+                      response_format='') -> ContextAttribute:
         """
         Retrieves a specified attribute from an entity.
 
@@ -910,9 +912,9 @@ def update_entity_attribute(self,
             res = self.put(url=url,
                            headers=headers,
                            params=params,
-                           json=attr.dict(exclude={'name'},
-                                          exclude_unset=True,
-                                          exclude_none=True))
+                           json=attr.model_dump(exclude={'name'},
+                                                exclude_unset=True,
+                                                exclude_none=True))
             if res.ok:
                 self.logger.info("Attribute '%s' of '%s' "
                                  "successfully updated!", attr_name, entity_id)
@@ -1127,7 +1129,8 @@ def get_subscription_list(self,
                                       url=url,
                                       params=params,
                                       headers=headers)
-            return parse_obj_as(List[Subscription], items)
+            adapter = TypeAdapter(List[Subscription])
+            return adapter.validate_python(items)
         except requests.RequestException as err:
             msg = "Could not load subscriptions!"
             self.log_error(err=err, msg=msg)
@@ -1162,9 +1165,9 @@ def post_subscription(self,
         """
         existing_subscriptions = self.get_subscription_list()
 
-        sub_hash = subscription.json(include={'subject', 'notification'})
+        sub_hash = subscription.model_dump_json(include={'subject', 'notification'})
         for ex_sub in existing_subscriptions:
-            if sub_hash == ex_sub.json(include={'subject', 'notification'}):
+            if sub_hash == ex_sub.model_dump_json(include={'subject', 'notification'}):
                 self.logger.info("Subscription already exists")
                 if update:
                     self.logger.info("Updated subscription")
@@ -1197,10 +1200,10 @@ def post_subscription(self,
             res = self.post(
                 url=url,
                 headers=headers,
-                data=subscription.json(exclude={'id'},
-                                       exclude_unset=True,
-                                       exclude_defaults=True,
-                                       exclude_none=True),
+                data=subscription.model_dump_json(exclude={'id'},
+                                                  exclude_unset=True,
+                                                  exclude_defaults=True,
+                                                  exclude_none=True),
                 params=params)
             if res.ok:
                 self.logger.info("Subscription successfully created!")
@@ -1271,10 +1274,10 @@ def update_subscription(self,
             res = self.patch(
                 url=url,
                 headers=headers,
-                data=subscription.json(exclude={'id'},
-                                       exclude_unset=True,
-                                       exclude_defaults=False,
-                                       exclude_none=True))
+                data=subscription.model_dump_json(exclude={'id'},
+                                                  exclude_unset=True,
+                                                  exclude_defaults=False,
+                                                  exclude_none=True))
             if res.ok:
                 self.logger.info("Subscription successfully updated!")
             else:
@@ -1329,8 +1332,8 @@ def get_registration_list(self,
                                       url=url,
                                       params=params,
                                       headers=headers)
-
-            return parse_obj_as(List[Registration], items)
+            adapter = TypeAdapter(List[Registration])
+            return adapter.validate_python(items)
         except requests.RequestException as err:
             msg = "Could not load registrations!"
             self.log_error(err=err, msg=msg)
@@ -1355,10 +1358,10 @@ def post_registration(self, registration: Registration):
             res = self.post(
                 url=url,
                 headers=headers,
-                data=registration.json(exclude={'id'},
-                                       exclude_unset=True,
-                                       exclude_defaults=True,
-                                       exclude_none=True))
+                data=registration.model_dump_json(exclude={'id'},
+                                                  exclude_unset=True,
+                                                  exclude_defaults=True,
+                                                  exclude_none=True))
             if res.ok:
                 self.logger.info("Registration successfully created!")
                 return res.headers['Location'].split('/')[-1]
@@ -1407,10 +1410,10 @@ def update_registration(self, registration: Registration):
             res = self.patch(
                 url=url,
                 headers=headers,
-                data=registration.json(exclude={'id'},
-                                       exclude_unset=True,
-                                       exclude_defaults=True,
-                                       exclude_none=True))
+                data=registration.model_dump_json(exclude={'id'},
+                                                  exclude_unset=True,
+                                                  exclude_defaults=True,
+                                                  exclude_none=True))
             if res.ok:
                 self.logger.info("Registration successfully updated!")
             else:
@@ -1496,7 +1499,7 @@ def update(self,
                 url=url,
                 headers=headers,
                 params=params,
-                data=update.json(by_alias=True))
+                json=update.model_dump(by_alias=True))
             if res.ok:
                 self.logger.info("Update operation '%s' succeeded!",
                                  action_type)
@@ -1541,13 +1544,15 @@ def query(self,
                                       url=url,
                                       headers=headers,
                                       params=params,
-                                      data=query.json(exclude_unset=True,
-                                                      exclude_none=True),
+                                      data=query.model_dump_json(exclude_unset=True,
+                                                                 exclude_none=True),
                                       limit=limit)
             if response_format == AttrsFormat.NORMALIZED:
-                return parse_obj_as(List[ContextEntity], items)
+                adapter = TypeAdapter(List[ContextEntity])
+                return adapter.validate_python(items)
             if response_format == AttrsFormat.KEY_VALUES:
-                return parse_obj_as(List[ContextEntityKeyValues], items)
+                adapter = TypeAdapter(List[ContextEntityKeyValues])
+                return adapter.validate_python(items)
             return items
         except requests.RequestException as err:
             msg = "Query operation failed!"
@@ -1579,14 +1584,14 @@ def notify(self, message: Message) -> None:
                 url=url,
                 headers=headers,
                 params=params,
-                data=message.json(by_alias=True))
+                data=message.model_dump_json(by_alias=True))
             if res.ok:
                 self.logger.info("Notification message sent!")
             else:
                 res.raise_for_status()
         except requests.RequestException as err:
             msg = f"Sending notifcation message failed! \n " \
-                  f"{message.json(inent=2)}"
+                  f"{message.model_dump_json(inent=2)}"
             self.log_error(err=err, msg=msg)
             raise
 
@@ -1613,7 +1618,7 @@ def post_command(self,
             assert isinstance(command, (Command, dict))
             if isinstance(command, dict):
                 command = Command(**command)
-            command = {command_name: command.dict()}
+            command = {command_name: command.model_dump()}
         else:
             assert isinstance(command, (NamedCommand, dict))
             if isinstance(command, dict):
@@ -1654,7 +1659,6 @@ def does_entity_exist(self,
                 raise
             return False
 
-
     def patch_entity(self,
                      entity: ContextEntity,
                      old_entity: Optional[ContextEntity] = None,