feat: Typing improvements

.github/workflows/ci.yml

@@ -83,11 +83,25 @@
           token: ${{ secrets.GITHUB_TOKEN }}
 
   code-style:
-    name: Code style
+    name: "Code style"
     runs-on: ubuntu-latest
     steps:
-      - name: "Run PyAnsys code style checks"
-        uses: ansys/actions/code-style@v10.2
+      - uses: ansys/actions/code-style@v10
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          skip-install: false
+
+      - name: "Make venv"
+        run: uv venv
+
+      - name: "Install basedpyright"
+        run: uv tool install basedpyright
+
+      - name: "Install extras"
+        run: uv pip install -e ".[ci_types]"
+
+      - name: "Check Type hints"
+        run: basedpyright
 
   commit-style:
     name: "Run commit style checks"

.pre-commit-config.yaml

@@ -32,7 +32,7 @@ repos:
       --statistics,
       --max-complexity, "10",
       --max-line-length, "88",
-      --extend-ignore, E203 E501 C901 B007 B009 B010 B011 B028,
+      --extend-ignore, E203 E501 C901 B007 B009 B010 B011 B028 F403 F405 F401 E402,
       src, doc, examples, tests
     ]
 

devel/undocumented_fields/search_undocumented_fields.py

@@ -6,7 +6,6 @@
 
 import os
 import sys
-from typing import Dict, Set
 
 import ast_comments as ast
 
@@ -121,7 +120,7 @@ def visit_FunctionDef(self, node):
                         self.classes[self.current_class].add(child.target.attr)
 
 
-def analyze_file(file_path: str) -> Dict[str, Set[str]]:
+def analyze_file(file_path: str) -> dict[str, set[str]]:
     """Analyze a Python file and return classes with their public fields."""
     with open(file_path, "r", encoding="utf-8") as file:
         try:
@@ -134,7 +133,7 @@ def analyze_file(file_path: str) -> Dict[str, Set[str]]:
             return {}
 
 
-def analyze_package(package_path: str) -> Dict[str, Dict[str, Set[str]]]:
+def analyze_package(package_path: str) -> dict[str, dict[str, set[str]]]:
     """Analyze all Python files in a package directory."""
     result = {}
 
@@ -160,7 +159,7 @@ def analyze_package(package_path: str) -> Dict[str, Dict[str, Set[str]]]:
     return result
 
 
-def write_results(results: Dict[str, Dict[str, Set[str]]], f) -> str:
+def write_results(results: dict[str, dict[str, set[str]]], f) -> None:
     """Format the analysis results."""
     for module_name, classes in sorted(results.items()):
 

doc/changelog.d/4761.added.md

@@ -0,0 +1 @@
+Typing improvements

doc/modify_html.py

@@ -32,7 +32,7 @@ def modify_html(soup: BeautifulSoup) -> None:
         / "settings"
     )
     for html_file in html_dir.glob("*.html"):
-        with open(html_file, "r", encoding="utf-8") as f:
+        with open(html_file, encoding="utf-8") as f:
             soup = BeautifulSoup(f, "html.parser", from_encoding="utf-8")
 
         modify_html(soup)

examples/00-fluent/DOE_ML.py

@@ -63,7 +63,6 @@
 # flake8: noqa: E402
 
 import os
-from pathlib import Path
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -264,8 +263,8 @@
 def display_scores(scores):
     """Display scores."""
     print("\nCross-Validation Scores:", scores)
-    print("Mean:%0.2f" % (scores.mean()))
-    print("Std. Dev.:%0.2f" % (scores.std()))
+    print(f"Mean:{scores.mean():0.2f}")
+    print(f"Std. Dev.:{scores.std():0.2f}")
 
 
 def fit_and_predict(model):
@@ -282,8 +281,8 @@ def fit_and_predict(model):
     test_predictions = model.predict(X_test)
     print(train_predictions.shape[0])
     print("\n\nCoefficient Of Determination")
-    print("Train Data R2 Score: %0.3f" % (r2_score(train_predictions, y_train)))
-    print("Test Data R2 Score: %0.3f" % (r2_score(test_predictions, y_test)))
+    print(f"Train Data R2 Score: {r2_score(train_predictions, y_train):0.3f}")
+    print(f"Test Data R2 Score: {r2_score(test_predictions, y_test):0.3f}")
     print(
         "\n\nPredictions - Ground Truth (Kelvin): ", (test_predictions - y_test), "\n"
     )
@@ -451,8 +450,8 @@ def fit_and_predict(model):
 test_predictions = np.ravel(test_predictions.T)
 print(test_predictions.shape)
 
-print("\n\nTrain R2: %0.3f" % (r2_score(train_predictions, y_train)))
-print("Test R2: %0.3f" % (r2_score(test_predictions, y_test)))
+print(f"\n\nTrain R2: {r2_score(train_predictions, y_train):0.3f}")
+print(f"Test R2: {r2_score(test_predictions, y_test):0.3f}")
 print("Predictions - Ground Truth (Kelvin): ", (test_predictions - y_test))
 
 fig = plt.figure(figsize=(12, 5))

pyproject.toml

@@ -34,6 +34,7 @@ dependencies = [
     "pandas>=1.1.0,<3.0.0",
     "pyansys-tools-report>=0.8.1",
     "pyyaml>=6.0",
+    "typing-extensions>=4.12"
 ]
 dynamic = ["version"]
 
@@ -234,3 +235,12 @@ skips = [
     "B604",
     "B607",
     ]
+
+[tool.basedpyright]
+reportAny = false
+reportUnknownMemberType = false
+reportExplicitAny = false
+reportPrivateUsage = false
+reportUnusedCallResult = false
+ignore = ["doc", "src/ansys/fluent/core/generated"]
+baselineFile = ".ci/basedpyright.json"

src/ansys/fluent/core/__init__.py

@@ -22,64 +22,31 @@
 
 """A package providing Fluent's Solver and Meshing capabilities in Python."""
 
-import os
-import pydoc
-import warnings
-
 # isort: off
 
 # config must be initialized before logging setup.
-from ansys.fluent.core.module_config import config
+from ansys.fluent.core.module_config import *
 
 # Logging has to be imported before importing other PyFluent modules
-from ansys.fluent.core.logger import set_console_logging_level  # noqa: F401
+from ansys.fluent.core.logger import *
 
 # isort: on
 
-from ansys.fluent.core.field_data_interfaces import (  # noqa: F401
-    PathlinesFieldDataRequest,
-    ScalarFieldDataRequest,
-    SurfaceDataType,
-    SurfaceFieldDataRequest,
-    VectorFieldDataRequest,
-)
-from ansys.fluent.core.get_build_details import (  # noqa: F401
-    get_build_version,
-    get_build_version_string,
-)
-from ansys.fluent.core.launcher.launch_options import (  # noqa: F401
-    Dimension,
-    FluentLinuxGraphicsDriver,
-    FluentMode,
-    FluentWindowsGraphicsDriver,
-    Precision,
-    UIMode,
-)
-from ansys.fluent.core.launcher.launcher import (  # noqa: F401
-    connect_to_fluent,
-    launch_fluent,
-)
-from ansys.fluent.core.parametric import LocalParametricStudy  # noqa: F401
-from ansys.fluent.core.pyfluent_warnings import (  # noqa: F401
-    PyFluentDeprecationWarning,
-    PyFluentUserWarning,
-    warning,
-)
-from ansys.fluent.core.search import search  # noqa: F401
-from ansys.fluent.core.services.batch_ops import BatchOps  # noqa: F401
-from ansys.fluent.core.session import BaseSession as Fluent  # noqa: F401
-from ansys.fluent.core.session_utilities import (  # noqa: F401
-    Meshing,
-    PrePost,
-    PureMeshing,
-    Solver,
-    SolverAero,
-    SolverIcing,
-)
-from ansys.fluent.core.streaming_services.events_streaming import *  # noqa: F401, F403
-from ansys.fluent.core.utils import fldoc
-from ansys.fluent.core.utils.fluent_version import FluentVersion  # noqa: F401
-from ansys.fluent.core.utils.setup_for_fluent import setup_for_fluent  # noqa: F401
+from ansys.fluent.core.field_data_interfaces import *
+from ansys.fluent.core.get_build_details import *
+from ansys.fluent.core.launcher.launch_options import *
+from ansys.fluent.core.launcher.launcher import *
+from ansys.fluent.core.parametric import *
+from ansys.fluent.core.pyfluent_warnings import *
+from ansys.fluent.core.search import *
+from ansys.fluent.core.services.batch_ops import *
+from ansys.fluent.core.session import *
+from ansys.fluent.core.session import BaseSession as Fluent
+from ansys.fluent.core.session_utilities import *
+from ansys.fluent.core.streaming_services.events_streaming import *
+from ansys.fluent.core.utils import *
+from ansys.fluent.core.utils.fluent_version import *
+from ansys.fluent.core.utils.setup_for_fluent import *
 
 __version__ = "0.38.dev2"
 
@@ -89,10 +56,14 @@
 Build timestamp and commit hash are added to this variable during packaging.
 """
 
-_THIS_DIRNAME = os.path.dirname(__file__)
-_README_FILE = os.path.normpath(os.path.join(_THIS_DIRNAME, "docs", "README.rst"))
+import os as _os  # noqa: E402
+import warnings as _warnings  # noqa: E402
+
+
+_THIS_DIRNAME = _os.path.dirname(__file__)
+_README_FILE = _os.path.normpath(_os.path.join(_THIS_DIRNAME, "docs", "README.rst"))
 
-if os.path.exists(_README_FILE):
+if _os.path.exists(_README_FILE):
     with open(_README_FILE, encoding="utf8") as f:
         __doc__ = f.read()
 
@@ -112,7 +83,10 @@ def version_info() -> str:
     return _VERSION_INFO if _VERSION_INFO is not None else __version__
 
 
-pydoc.text.docother = fldoc.docother.__get__(pydoc.text, pydoc.TextDoc)
+import pydoc as _pydoc  # noqa: E402
+from ansys.fluent.core.utils import fldoc as _fldoc  # noqa: E402
+
+_pydoc.text.docother = _fldoc.docother.__get__(_pydoc.text, _pydoc.TextDoc)
 
 
 _config_by_deprecated_name = {
@@ -144,14 +118,17 @@ def version_info() -> str:
     "LAUNCH_FLUENT_SKIP_PASSWORD_CHECK": "launch_fluent_skip_password_check",
 }
 
+from typing import TYPE_CHECKING as _TYPE_CHECKING  # noqa: E402
+
+if not _TYPE_CHECKING:
 
-def __getattr__(name: str) -> str:
-    """Get the value of a deprecated configuration variable."""
-    if name in _config_by_deprecated_name:
-        config_name = _config_by_deprecated_name[name]
-        warnings.warn(
-            f"'{name}' is deprecated, use 'config.{config_name}' instead.",
-            category=PyFluentDeprecationWarning,
-        )
-        return getattr(config, config_name)
-    raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
+    def __getattr__(name: str) -> str:
+        """Get the value of a deprecated configuration variable."""
+        if name in _config_by_deprecated_name:
+            config_name = _config_by_deprecated_name[name]
+            _warnings.warn(
+                f"'{name}' is deprecated, use 'config.{config_name}' instead.",
+                category=PyFluentDeprecationWarning,
+            )
+            return getattr(config, config_name)
+        raise AttributeError(f"module '{__name__}' has no attribute '{name}'")

src/ansys/fluent/core/_types.py

@@ -31,5 +31,5 @@
 import os
 from typing import TypeAlias
 
-PathType: TypeAlias = "os.PathLike[str] | os.PathLike[bytes] | str | bytes"
+PathType: TypeAlias = "os.PathLike[str] | str"
 """Type alias for file system paths."""

src/ansys/fluent/core/codegen/datamodelgen.py

@@ -28,7 +28,7 @@
 from pathlib import Path
 import shutil
 import string
-from typing import Any, Dict
+from typing import Any
 
 import ansys.fluent.core as pyfluent
 from ansys.fluent.core import FluentMode, launch_fluent
@@ -230,7 +230,7 @@ class DataModelGenerator:
     def __init__(self, version, static_infos: dict, verbose: bool = False):
         self.version = version
         self._server_static_infos = static_infos
-        self._static_info: Dict[str, DataModelStaticInfo] = {}
+        self._static_info: dict[str, DataModelStaticInfo] = {}
         self._verbose = verbose
         if StaticInfoType.DATAMODEL_WORKFLOW in static_infos:
             self._static_info["workflow"] = DataModelStaticInfo(

src/ansys/fluent/core/codegen/tuigen.py

@@ -43,7 +43,7 @@
 import shutil
 import string
 import subprocess
-from typing import Any, Dict
+from typing import Any
 import uuid
 
 from defusedxml.ElementTree import parse
@@ -194,7 +194,7 @@ def find_class(self, module, name):
         if module == "tuigen":
             renamed_module = "ansys.fluent.core.codegen.tuigen"
 
-        return super(_RenameModuleUnpickler, self).find_class(renamed_module, name)
+        return super().find_class(renamed_module, name)
 
 
 class TUIGenerator:
@@ -217,7 +217,7 @@ def __init__(
         self._static_infos = static_infos
         self._verbose = verbose
 
-    def _populate_menu(self, menu: _TUIMenu, info: Dict[str, Any]):
+    def _populate_menu(self, menu: _TUIMenu, info: dict[str, Any]):
         for child_menu_name, child_menu_info in sorted(info["menus"].items()):
             if _is_valid_tui_menu_name(child_menu_name):
                 child_menu = _TUIMenu(

src/ansys/fluent/core/codegen/walk_api.py

@@ -35,13 +35,12 @@
 """
 
 from inspect import signature
-from typing import List
 
 import ansys.fluent.core.solver.flobject as flobject
 
 
 def walk_api(
-    api_cls, on_each_path, current_path: str | List[str] = "", api_item_type: str = ""
+    api_cls, on_each_path, current_path: str | list[str] = "", api_item_type: str = ""
 ):
     """
     Recursively traverse the API hierarchy, calling `on_each_path` for each item.