refactor(tidy3d): FXC-4436-move-typing-only-imports-behind-if-type-checking

Author: marcorudolphflex

tests/config/test_legacy_env.py

@@ -43,9 +43,9 @@ def test_env_pending_overrides_apply_on_activation(mock_config_dir, config_manag
         assert current_manager.profile == "dev"
         dev_web = current_manager.get_section("web")
         assert dev_web.enable_caching is False
-        assert dev_web.ssl_version == ssl.TLSVersion.TLSv1_2
+        assert dev_web.ssl_version == "TLSv1_2"
         assert Env.current.enable_caching is False
-        assert Env.current.ssl_version == ssl.TLSVersion.TLSv1_2
+        assert Env.current.ssl_version == "TLSv1_2"
     finally:
         reload_config(profile="default")
 

tests/test_web/test_env.py

@@ -14,14 +14,14 @@ def test_tidy3d_env():
 
 
 def test_set_ssl_version():
-    Env.set_ssl_version(ssl.TLSVersion.TLSv1_3)
-    assert Env.current.ssl_version == ssl.TLSVersion.TLSv1_3
+    Env.set_ssl_version("TLSv1_3")
+    assert Env.current.ssl_version == "TLSv1_3"
 
     Env.set_ssl_version(ssl.TLSVersion.TLSv1_2)
-    assert Env.current.ssl_version == ssl.TLSVersion.TLSv1_2
+    assert Env.current.ssl_version == "TLSv1_2"
 
     Env.set_ssl_version(ssl.TLSVersion.TLSv1_1)
-    assert Env.current.ssl_version == ssl.TLSVersion.TLSv1_1
+    assert Env.current.ssl_version == "TLSv1_1"
 
     Env.set_ssl_version(None)
     assert Env.current.ssl_version is None

tidy3d/config/legacy.py

@@ -7,7 +7,6 @@
 from __future__ import annotations
 
 import os
-import ssl
 import warnings
 from pathlib import Path
 from typing import Any, Optional
@@ -160,7 +159,7 @@ def __init__(
         s3_region: Optional[str] = None,
         ssl_verify: Optional[bool] = None,
         enable_caching: Optional[bool] = None,
-        ssl_version: Optional[ssl.TLSVersion] = None,
+        ssl_version: Optional[str] = None,
         env_vars: Optional[dict[str, str]] = None,
         environment: Optional[LegacyEnvironment] = None,
     ) -> None:
@@ -239,11 +238,11 @@ def enable_caching(self, value: Optional[bool]) -> None:
         self._set_pending("enable_caching", value)
 
     @property
-    def ssl_version(self) -> Optional[ssl.TLSVersion]:
+    def ssl_version(self) -> Optional[str]:
         return self._value("ssl_version")
 
     @ssl_version.setter
-    def ssl_version(self, value: Optional[ssl.TLSVersion]) -> None:
+    def ssl_version(self, value: Optional[str]) -> None:
         self._set_pending("ssl_version", value)
 
     @property
@@ -363,7 +362,7 @@ def enable_caching(self, enable_caching: Optional[bool] = True) -> None:
         config.enable_caching = enable_caching
         self._sync_to_manager()
 
-    def set_ssl_version(self, ssl_version: Optional[ssl.TLSVersion]) -> None:
+    def set_ssl_version(self, ssl_version: Optional[str]) -> None:
         config = self.current
         config.ssl_version = ssl_version
         self._sync_to_manager()

tidy3d/config/sections.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import os
-import ssl
 from os import PathLike
 from pathlib import Path
 from typing import Any, Literal, Optional
@@ -28,6 +27,28 @@
 from .registry import get_manager as _get_attached_manager
 from .registry import register_handler, register_section
 
+TLS_VERSION_CHOICES = {"TLSv1", "TLSv1_1", "TLSv1_2", "TLSv1_3"}
+
+
+def _normalize_tls_version(value: Any) -> str:
+    """Normalize TLS version-like inputs to the canonical ``TLSvX_Y`` form."""
+
+    if hasattr(value, "name") and isinstance(value.name, str):
+        candidate = value.name
+    else:
+        candidate = str(value).strip()
+    if not candidate:
+        raise ValueError("TLS version cannot be empty")
+    normalized = candidate.replace("-", "_").replace(" ", "")
+    normalized = normalized.replace(".", "_").upper()
+    if not normalized.startswith("TLSV"):
+        raise ValueError("TLS version must start with 'TLSv'")
+    canonical = "TLSv" + normalized[4:]
+    if canonical not in TLS_VERSION_CHOICES:
+        allowed = ", ".join(sorted(TLS_VERSION_CHOICES))
+        raise ValueError(f"TLS version must be one of: {allowed}")
+    return canonical
+
 
 class ConfigSection(BaseModel):
     """Base class for configuration sections."""
@@ -328,10 +349,13 @@ class WebConfig(ConfigSection):
         le=300,
     )
 
-    ssl_version: Optional[ssl.TLSVersion] = Field(
+    ssl_version: Optional[str] = Field(
         None,
         title="SSL/TLS version",
-        description="Optional SSL/TLS version to enforce for requests.",
+        description=(
+            "Optional TLS version override to enforce for requests. Accepts values such as "
+            "'TLSv1_2'."
+        ),
     )
 
     env_vars: dict[str, str] = Field(
@@ -349,14 +373,18 @@ def to_dict(self, *, mask_secrets: bool = True) -> dict[str, Any]:
             secret = data.get("apikey")
             if isinstance(secret, SecretStr):
                 data["apikey"] = secret.get_secret_value()
-        ssl_version = data.get("ssl_version")
-        if isinstance(ssl_version, ssl.TLSVersion):
-            data["ssl_version"] = ssl_version.value
         for field in ("api_endpoint", "website_endpoint"):
             if field in data and data[field] is not None:
                 data[field] = str(data[field])
         return data
 
+    @field_validator("ssl_version", mode="before")
+    @classmethod
+    def _validate_ssl_version(cls, value: Any) -> Optional[str]:
+        if value is None:
+            return None
+        return _normalize_tls_version(value)
+
     @field_validator("api_endpoint", "website_endpoint", mode="before")
     @classmethod
     def _validate_http_url(cls, value: Any) -> str:

tidy3d/plugins/dispersion/web.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-import ssl
 from enum import Enum
 from typing import Literal, Optional
 
@@ -247,7 +246,7 @@ def _setup_server(url_server: str) -> tuple[dict[str, str], bool]:
             # test connection
             resp = requests.get(f"{url_server}/health", verify=ssl_verify)
             resp.raise_for_status()
-        except (requests.exceptions.SSLError, ssl.SSLError):
+        except requests.exceptions.SSLError:
             log.info("Retrying with SSL verification disabled.")
             ssl_verify = False
             resp = requests.get(f"{url_server}/health", verify=ssl_verify)

tidy3d/web/cli/app.py

@@ -6,7 +6,6 @@
 
 import os
 import shutil
-import ssl
 from typing import Any
 
 import click
@@ -99,7 +98,7 @@ def auth(req: requests.Request) -> requests.Request:
 
     try:
         resp = requests.get(target_url, auth=auth, verify=config.web.ssl_verify)
-    except (requests.exceptions.SSLError, ssl.SSLError):
+    except requests.exceptions.SSLError:
         resp = requests.get(target_url, auth=auth, verify=False)
 
     if resp.status_code == 200: