updated Exception classes

Author: zilto

dlt/common/configuration/exceptions.py

@@ -122,6 +122,9 @@ def __init__(self, spec_name: str, field_names: Sequence[str]) -> None:
             f"The config spec `{spec_name}` has dynamic type resolvers for fields: `{field_names}`"
             " but these fields are not defined in the spec.\nWhen using @resolve_type() decorator,"
             f" Add the fields with 'Any' or another common type hint, example:\n\n{example}"
+            f"The config spec `{spec_name}` has dynamic type resolvers for fields: `{field_names}` but"
+            " these fields are not defined in the spec.\nWhen using `@resolve_type()` decorator, Add"
+            f" the fields with 'Any' or another common type hint, example:\n\n{example}"
         )
         super().__init__(msg)
 
@@ -131,8 +134,7 @@ class FinalConfigFieldException(ConfigurationException):
 
     def __init__(self, spec_name: str, field: str) -> None:
         super().__init__(
-            f"Field `{field}` in spec `{spec_name}` is final but is being changed by a config"
-            " provider"
+            f"Field `{field}` in spec `{spec_name}` is final but is being changed by a config provider"
         )
 
 
@@ -144,7 +146,7 @@ def __init__(self, field_name: str, field_value: Any, hint: type) -> None:
         self.field_value = field_value
         self.hint = hint
         super().__init__(
-            f"Can't coerce value for config field `{field_name}` into type {str(hint)}"
+            f"Configured value for field {field_name} cannot be coerced into type {str(hint)}"
         )
 
 
@@ -172,7 +174,7 @@ def __init__(self, field_name: str, spec: Type[Any]) -> None:
         self.field_name = field_name
         self.typ_ = spec
         super().__init__(
-            f"Field {field_name} on configspec {spec} does not provide required type hint"
+            f"Field `{field_name}` on configspec `{spec}` does not provide required type hint"
         )
 
 
@@ -183,7 +185,7 @@ def __init__(self, field_name: str, spec: Type[Any], typ_: Type[Any]) -> None:
         self.field_name = field_name
         self.typ_ = spec
         super().__init__(
-            f"Field {field_name} on configspec {spec} has hint with unsupported type {typ_}"
+            f"Field `{field_name}` on configspec `{spec}` has hint with unsupported type `{typ_}`"
         )
 
 
@@ -192,7 +194,7 @@ def __init__(self, provider_name: str, key: str) -> None:
         self.provider_name = provider_name
         self.key = key
         super().__init__(
-            f"Provider {provider_name} cannot hold secret values but key {key} with secret value is"
+            f"Provider `{provider_name}` cannot hold secret values but key `{key}` with secret value is"
             " present"
         )
 
@@ -211,10 +213,9 @@ def __init__(
         self.inner_exception = inner_exception
         inner_msg = f" {self.inner_exception}" if inner_exception is not ValueError else ""
         super().__init__(
-            f"{spec.__name__} cannot parse the configuration value provided. The value is of type"
-            f" {native_value_type.__name__} and comes from the"
-            " {embedded_sections} section(s). Value may be a secret and is not shown. "
-            f"Details: {inner_msg}"
+            f"`{spec.__name__}` cannot parse the configuration value provided. The value is of type "
+            f"`{native_value_type.__name__}` and comes from the sections `{embedded_sections}` "
+            f"Value may be a secret and is not shown. Details: {inner_msg}"
         )
 
 
@@ -224,20 +225,20 @@ def __init__(self, spec: Type[Any], existing_config: Any, expected_config: Any)
         self.existing_config = existing_config
         self.expected_config = expected_config
         super().__init__(
-            f"When restoring context {spec.__name__}, instance {expected_config} was expected,"
-            f" instead instance {existing_config} was found."
+            f"When restoring context `{spec.__name__}`, instance `{expected_config}` was expected,"
+            f" instead instance `{existing_config}` was found."
         )
 
 
 class ContextDefaultCannotBeCreated(ContainerException, KeyError):
     def __init__(self, spec: Type[Any]) -> None:
         self.spec = spec
-        super().__init__(f"Container cannot create the default value of context {spec.__name__}.")
+        super().__init__(f"Container cannot create the default value of context `{spec.__name__}`.")
 
 
 class DuplicateConfigProviderException(ConfigProviderException):
     def __init__(self, provider_name: str) -> None:
         super().__init__(
             provider_name,
-            f"Provider with name {provider_name} already present in ConfigProvidersContext",
+            f"Provider with name `{provider_name}` already present in `ConfigProvidersContext`",
         )

dlt/common/configuration/specs/exceptions.py

@@ -10,7 +10,7 @@ class OAuth2ScopesRequired(SpecException):
     def __init__(self, spec: type) -> None:
         self.spec = spec
         super().__init__(
-            "Scopes are required to retrieve refresh_token. Use 'openid' scope for a token without"
+            "Scopes are required to retrieve refresh_token. Use `openid` scope for a token without"
             " any permissions to resources."
         )
 
@@ -26,27 +26,27 @@ class InvalidConnectionString(NativeValueError):
     def __init__(self, spec: Type[Any], native_value: str, driver: str):
         driver = driver or "driver"
         msg = (
-            f"The expected representation for {spec.__name__} is a standard database connection"
-            f" string with the following format: {driver}://username:password@host:port/database."
+            f"The expected representation for `{spec.__name__}` is a standard database connection"
+            f" string with the following format: `{driver}://username:password@host:port/database`"
         )
         super().__init__(spec, native_value, msg)
 
 
 class InvalidGoogleNativeCredentialsType(NativeValueError):
     def __init__(self, spec: Type[Any], native_value: Any):
         msg = (
-            f"Credentials {spec.__name__} accept a string with serialized credentials json file or"
-            " an instance of Credentials object from google.* namespace. The value passed is of"
-            f" type {type(native_value)}"
+            f"Credentials `{spec.__name__}` accept a string with serialized credentials json file or"
+            " an instance of `Credentials` object from Google.* namespace. The value passed is of"
+            f" type `{type(native_value)}`"
         )
         super().__init__(spec, native_value, msg)
 
 
 class InvalidGoogleServicesJson(NativeValueError):
     def __init__(self, spec: Type[Any], native_value: Any):
         msg = (
-            f"The expected representation for {spec.__name__} is a string with serialized service"
-            " account credentials, where at least 'project_id', 'private_key' and 'client_email`"
+            f"The expected representation for `{spec.__name__}` is a string with serialized service"
+            " account credentials, where at least `project_id`, `private_key` and `client_email`"
             " keys are present"
         )
         super().__init__(spec, native_value, msg)
@@ -55,7 +55,7 @@ def __init__(self, spec: Type[Any], native_value: Any):
 class InvalidGoogleOauth2Json(NativeValueError):
     def __init__(self, spec: Type[Any], native_value: Any):
         msg = (
-            f"The expected representation for {spec.__name__} is a string with serialized oauth2"
+            f"The expected representation for `{spec.__name__}` is a string with serialized oauth2"
             " user info and may be wrapped in 'install'/'web' node - depending of oauth2 app type."
         )
         super().__init__(spec, native_value, msg)
@@ -64,7 +64,7 @@ def __init__(self, spec: Type[Any], native_value: Any):
 class InvalidBoto3Session(NativeValueError):
     def __init__(self, spec: Type[Any], native_value: Any):
         msg = (
-            f"The expected representation for {spec.__name__} is and instance of boto3.Session"
+            f"The expected representation for `{spec.__name__}` is and instance of boto3.Session"
             " containing credentials"
         )
         super().__init__(spec, native_value, msg)

dlt/common/data_writers/exceptions.py

@@ -12,32 +12,32 @@ class InvalidFileNameTemplateException(DataWriterException, ValueError):
     def __init__(self, file_name_template: str):
         self.file_name_template = file_name_template
         super().__init__(
-            f"Wrong file name template {file_name_template}. File name template must contain"
+            f"Wrong file name template `{file_name_template}`. File name template must contain"
             " exactly one %s formatter"
         )
 
 
 class BufferedDataWriterClosed(DataWriterException):
     def __init__(self, file_name: str):
         self.file_name = file_name
-        super().__init__(f"Writer with recent file name {file_name} is already closed")
+        super().__init__(f"Writer with recent file name `{file_name}` is already closed")
 
 
 class FileImportNotFound(DataWriterException, FileNotFoundError):
     def __init__(self, import_file_path: str, local_file_path: str) -> None:
         self.import_file_path = import_file_path
         self.local_file_path = local_file_path
         super().__init__(
-            f"Attempt to import non existing file {import_file_path} into extract storage file"
-            f" {local_file_path}"
+            f"Attempt to import non existing file `{import_file_path}` into extract storage file"
+            f" `{local_file_path}`"
         )
 
 
 class DestinationCapabilitiesRequired(DataWriterException, ValueError):
     def __init__(self, file_format: TLoaderFileFormat):
         self.file_format = file_format
         super().__init__(
-            f"Writer for {file_format} requires destination capabilities which were not provided."
+            f"Writer for `{file_format=:}` requires destination capabilities which were not provided."
         )
 
 
@@ -50,8 +50,7 @@ def __init__(self, file_format: TLoaderFileFormat, data_item_format: str):
         self.file_format = file_format
         self.data_item_format = data_item_format
         super().__init__(
-            f"Can't find a file writer for file format {file_format} and item format"
-            f" {data_item_format}"
+            f"Can't find a file writer for `{file_format=:}` and item format `{data_item_format=:}`"
         )
 
 
@@ -60,8 +59,7 @@ def __init__(self, file_format: TLoaderFileFormat, data_item_format: str, spec:
         self.file_format = file_format
         self.data_item_format = data_item_format
         super().__init__(
-            f"Can't find a file writer for spec with file format {file_format} and item format"
-            f" {data_item_format} where the full spec is {spec}"
+            f"Can't find a file writer for spec with `{file_format=:}` and `{data_item_format=:}` where the full spec is `{spec}`"
         )
 
 
@@ -76,8 +74,8 @@ def __init__(
         self.possible_file_formats = possible_file_formats
         self.data_item_format = data_item_format
         super().__init__(
-            f"Lookup for best file writer for item format {data_item_format} among file formats"
-            f" {possible_file_formats} failed. The preferred file format was {file_format}."
+            f"Failed to find file writer for {data_item_format=:} among file formats"
+            f" {possible_file_formats=:}. The preferred file format was `{file_format=:}`."
         )
 
 
@@ -86,5 +84,5 @@ def __init__(self, file_format: TLoaderFileFormat, data_item_format: str, detail
         self.file_format = file_format
         self.data_item_format = data_item_format
         super().__init__(
-            f"A data item of type {data_item_format} cannot be written as {file_format}: {details}"
+            f"A data item of type {data_item_format=:} cannot be written as `{file_format}: {details}`"
         )