chore: improve enum typing for lang and language configs for connectors and handle default values for carrier registration modal

Author: danh91

modules/connectors/canadapost/karrio/mappers/canadapost/settings.py

@@ -1,18 +1,19 @@
 """Karrio Canada post client settings."""
 
 import attr
-from karrio.providers.canadapost import Settings as BaseSettings
+import karrio.lib as lib
+import karrio.providers.canadapost.utils as utils
 
 
 @attr.s(auto_attribs=True)
-class Settings(BaseSettings):
+class Settings(utils.Settings):
     """Canada post connection settings."""
 
     username: str
     password: str
     customer_number: str = None
     contract_id: str = None
-    language: str = "en"
+    language: utils.LanguageEnum = "en"  # type: ignore
 
     id: str = None
     test_mode: bool = False

modules/connectors/canadapost/karrio/providers/canadapost/utils.py

@@ -5,18 +5,17 @@
 import karrio.core.settings as settings
 
 
+LanguageEnum = lib.units.create_enum("LanguageEnum", ["en", "fr"])
+
+
 class Settings(settings.Settings):
     """Canada post connection settings."""
 
     username: str
     password: str
     customer_number: str
     contract_id: str = None
-    language: str = "en"
-
-    id: str = None
-    account_country_code: str = "CA"
-    metadata: dict = {}
+    language: LanguageEnum = "en"  # type: ignore
 
     @property
     def carrier_name(self):

modules/connectors/canpar/karrio/mappers/canpar/settings.py

@@ -1,16 +1,16 @@
 """Karrio Canpar client settings."""
 
 import attr
-from karrio.providers.canpar import Settings as BaseSettings
+import karrio.providers.canpar.utils as utils
 
 
 @attr.s(auto_attribs=True)
-class Settings(BaseSettings):
+class Settings(utils.Settings):
     """Canpar connection settings."""
 
     username: str
     password: str
-    language: str = "en"
+    language: utils.LanguageEnum = "en"  # type: ignore
 
     id: str = None
     test_mode: bool = False

modules/connectors/canpar/karrio/providers/canpar/utils.py

@@ -1,19 +1,20 @@
 """Karrio Canpar client settings."""
 
+import karrio.lib as lib
 from karrio.core.settings import Settings as BaseSettings
 from karrio.core.utils import Envelope, apply_namespaceprefix, XP, Header
 
+LanguageEnum = lib.units.create_enum("LanguageEnum", ["en", "fr"])
+
 
 class Settings(BaseSettings):
     """Canpar connection settings."""
 
     username: str
     password: str
-    language: str = "en"
+    language: LanguageEnum = "en"  # type: ignore
 
-    id: str = None
     account_country_code: str = "CA"
-    metadata: dict = {}
 
     @property
     def carrier_name(self):
@@ -29,7 +30,9 @@ def server_url(self):
 
     @property
     def tracking_url(self):
-        return "https://www.canpar.com/" + self.language + "/tracking/track.htm?barcode={}"
+        return (
+            "https://www.canpar.com/" + self.language + "/tracking/track.htm?barcode={}"
+        )
 
     @staticmethod
     def serialize(

modules/connectors/chronopost/karrio/mappers/chronopost/settings.py

@@ -1,17 +1,17 @@
 """Karrio Chronopost client settings."""
 
 import attr
-from karrio.providers.chronopost.utils import Settings as BaseSettings
+from karrio.providers.chronopost import utils
 
 
 @attr.s(auto_attribs=True)
-class Settings(BaseSettings):
+class Settings(utils.Settings):
     """Chronopost connection settings."""
 
     account_number: str  # type: ignore
     password: str  # type: ignore
     id_emit: str = "CHRFR"  # type: ignore
-    language: str = "en_GB"
+    language: utils.LanguageEnum = "en_GB"  # type: ignore
 
     id: str = None
     test_mode: bool = False

modules/connectors/chronopost/karrio/providers/chronopost/utils.py

@@ -1,16 +1,20 @@
 """Karrio Chronopost client settings."""
 
+import karrio.lib as lib
 from karrio.schemas.chronopost.shippingservice import headerValue
 from karrio.core.settings import Settings as BaseSettings
 
 
+LanguageEnum = lib.units.create_enum("LanguageEnum", ["en_GB", "fr_FR"])
+
+
 class Settings(BaseSettings):
     """Chronopost connection settings."""
 
     account_number: str
     password: str
     id_emit: str = "CHRFR"
-    language: str = "en_GB"
+    language: LanguageEnum = "en_GB"  # type: ignore
 
     account_country_code: str = "FR"
     metadata: dict = {}

modules/connectors/dhl_universal/karrio/mappers/dhl_universal/settings.py

@@ -1,17 +1,17 @@
 """Karrio DHL Universal settings."""
 
 import attr
-from karrio.providers.dhl_universal.utils import Settings as BaseSettings
+import karrio.providers.dhl_universal.utils as utils
 
 
 @attr.s(auto_attribs=True)
-class Settings(BaseSettings):
+class Settings(utils.Settings):
     """DHL Universal connection settings."""
 
     # Carrier specific properties
     consumer_key: str
     consumer_secret: str
-    language: str = "en"
+    language: utils.LanguageEnum = "en"  # type: ignore
 
     # Base properties
     id: str = None

modules/connectors/dhl_universal/karrio/providers/dhl_universal/utils.py

@@ -1,13 +1,16 @@
+import karrio.lib as lib
 from karrio.core import Settings as BaseSettings
 
+LanguageEnum = lib.units.create_enum("LanguageEnum", ["en", "de"])
+
 
 class Settings(BaseSettings):
     """DHL Universal connection settings."""
 
     # Carrier specific properties
     consumer_key: str
     consumer_secret: str
-    language: str = "en"
+    language: LanguageEnum = "en"  # type: ignore
 
     account_country_code: str = "DE"
     metadata: dict = {}

modules/connectors/geodis/karrio/mappers/geodis/settings.py

@@ -16,7 +16,7 @@ class Settings(provider_utils.Settings):
     api_key: str
     identifier: str
     code_client: str = None
-    language: str = "fr"
+    language: provider_utils.LanguageEnum = "fr"  # type: ignore
 
     # generic properties
     id: str = None

modules/connectors/geodis/karrio/providers/geodis/utils.py

@@ -4,14 +4,16 @@
 import karrio.lib as lib
 import karrio.core as core
 
+LanguageEnum = lib.units.create_enum("LanguageEnum", ["fr", "en"])
+
 
 class Settings(core.Settings):
     """GEODIS connection settings."""
 
     api_key: str
     identifier: str
     code_client: str = None
-    language: str = "fr"
+    language: LanguageEnum = "fr"  # type: ignore
 
     account_country_code: str = "FR"
     metadata: dict = {}