Merge branch 'multi_user_requirements_update' of https://github.com/Orchius83/api-client-py into Orchius83-multi_user_requirements_update

Author: nicola-corbellini

Pipfile

@@ -0,0 +1,16 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+python-dateutil = "*"
+urllib3 = "*"
+pydantic = "*"
+aenum = "*"
+websocket-client = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.11"

Pipfile.lock

@@ -46,9 +46,12 @@ def url(self):
         return f"{secure}{self.settings.base_url}{port}"
 
     def _connect(self):
+        connection_url = f"ws{self.url}/{self.settings.ws.path}"
+        if self.settings.ws.user_id is not None:
+            connection_url += f"/{self.settings.ws.user_id}"
         """"Connect to the WebSocket in a separate thread"""
         self._ws = WebSocketApp(
-            f"ws{self.url}/{self.settings.ws.path}",
+            connection_url,
             on_message=self.on_ws_message,
             on_error=self.on_ws_error,
             on_close=self.on_ws_close,

cheshire_cat_api/cat_client.py

@@ -32,7 +32,7 @@ class BodyUploadUrl(BaseModel):
 
     class Config:
         """Pydantic configuration"""
-        allow_population_by_field_name = True
+        populate_by_name = True
         validate_assignment = True
 
     def to_str(self) -> str:

cheshire_cat_api/models/body_upload_url.py

@@ -31,7 +31,7 @@ class HTTPValidationError(BaseModel):
 
     class Config:
         """Pydantic configuration"""
-        allow_population_by_field_name = True
+        populate_by_name = True
         validate_assignment = True
 
     def to_str(self) -> str:

cheshire_cat_api/models/http_validation_error.py

@@ -19,7 +19,7 @@
 import re  # noqa: F401
 
 from typing import Optional
-from pydantic import BaseModel, Field, StrictInt, StrictStr, ValidationError, validator
+from pydantic import BaseModel, Field, StrictInt, StrictStr, ValidationError, validator, field_validator
 from typing import Union, Any, List, TYPE_CHECKING
 from pydantic import StrictStr, Field
 
@@ -38,7 +38,7 @@ class LocationInner(BaseModel):
         actual_instance: Union[int, str]
     else:
         actual_instance: Any
-    any_of_schemas: List[str] = Field(LOCATIONINNER_ANY_OF_SCHEMAS, const=True)
+    any_of_schemas: List[str] = Field(LOCATIONINNER_ANY_OF_SCHEMAS, Literal=True)
 
     class Config:
         validate_assignment = True
@@ -53,7 +53,7 @@ def __init__(self, *args, **kwargs):
         else:
             super().__init__(**kwargs)
 
-    @validator('actual_instance')
+    @field_validator('actual_instance')
     def actual_instance_must_validate_anyof(cls, v):
         instance = LocationInner.construct()
         error_messages = []

cheshire_cat_api/models/location_inner.py

@@ -33,7 +33,7 @@ class SettingBody(BaseModel):
 
     class Config:
         """Pydantic configuration"""
-        allow_population_by_field_name = True
+        populate_by_name = True
         validate_assignment = True
 
     def to_str(self) -> str:

cheshire_cat_api/models/setting_body.py

@@ -33,7 +33,7 @@ class ValidationError(BaseModel):
 
     class Config:
         """Pydantic configuration"""
-        allow_population_by_field_name = True
+        populate_by_name = True
         validate_assignment = True
 
     def to_str(self) -> str:

cheshire_cat_api/models/validation_error.py

@@ -19,7 +19,7 @@
 import re  # noqa: F401
 
 from typing import Any, Dict, List, Optional
-from pydantic import BaseModel, Field, StrictStr, ValidationError, conlist, validator
+from pydantic import BaseModel, Field, StrictStr, ValidationError, conlist, validator, field_validator
 from typing import Union, Any, List, TYPE_CHECKING
 from pydantic import StrictStr, Field
 
@@ -38,7 +38,7 @@ class Value(BaseModel):
         actual_instance: Union[List[object], object]
     else:
         actual_instance: Any
-    any_of_schemas: List[str] = Field(VALUE_ANY_OF_SCHEMAS, const=True)
+    any_of_schemas: List[str] = Field(VALUE_ANY_OF_SCHEMAS, Literal=True)
 
     class Config:
         validate_assignment = True
@@ -53,7 +53,7 @@ def __init__(self, *args, **kwargs):
         else:
             super().__init__(**kwargs)
 
-    @validator('actual_instance')
+    @field_validator('actual_instance')
     def actual_instance_must_validate_anyof(cls, v):
         instance = Value.construct()
         error_messages = []

cheshire_cat_api/models/value.py

@@ -24,34 +24,44 @@ class WebSocketSettings:
     Class containing the WebSocket configuration options and variables used by ccat-api package
     """
 
-    def __init__(self):
+    def __init__(self, path='ws', retries=3, delay=5000, on_failed=None, user_id=None):
         # Websocket path to use to communicate with the CCat
-        self.path = 'ws'
+        self.path = path
         # The maximum number of retries before calling on_failed
-        self.retries = 3
+        self.retries = retries
         # The delay for reconnect, in milliseconds
-        self.delay = 5000
+        self.delay = delay
         # The function to call after failing to reconnect
-        self.on_failed = None
+        self.on_failed = on_failed
+        # User to connect with
+        self.user_id = user_id
 
 
 class Settings:
     """
     Class containing all the configuration options and variables used by ccat-api package
     """
 
-    def __init__(self):
+    def __init__(self,
+                 base_url='localhost',
+                 auth_key='',
+                 port=1865,
+                 secure=False,
+                 timeout=10000,
+                 instant=True,
+                 ws=WebSocketSettings(),
+                 ):
         # The URL to which connect to the Cat
-        self.base_url = 'localhost'
+        self.base_url = base_url
         # The key to authenticate the Cat endpoints
-        self.auth_key = ''
+        self.auth_key = auth_key
         # The port to which connect to the Cat
-        self.port = 1865
+        self.port = port
         # Choose to either use the secure protocol or not
-        self.secure = False
+        self.secure = secure
         # Timeout for the endpoints, in milliseconds
-        self.timeout = 10000
+        self.timeout = timeout
         # Choose to either instantly initialize websocket and api client or not
-        self.instant = True
+        self.instant = instant
         # WebSocket Settings
-        self.ws = WebSocketSettings()
+        self.ws = ws