Add mypy configuration and export types

ASIM-5899

Author: nicoddemus

.github/workflows/main.yml

@@ -35,6 +35,8 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install tox codecov
+    - name: Type-check
+      run: tox -e type-check
     - name: Run tests
       run: tox -e py
     - name: Upload codecov

.gitignore

@@ -114,3 +114,4 @@ docs/alfasim_sdk_api/
 
 # PyCharm
 .idea/
+/.dmypy.json

.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
     # Ruff version.
     rev: v0.14.0
     hooks:
-    -   id: ruff
+    -   id: ruff-check
         args: [--fix]
     -   id: ruff-format
 -   repo: https://github.com/pre-commit/pre-commit-hooks
@@ -23,14 +23,3 @@ repos:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
     -   id: debug-statements
--   repo: https://github.com/PyCQA/flake8
-    rev: 7.3.0
-    hooks:
-    -   id: flake8
-        additional_dependencies:
-            - pep8-naming
-            - flake8-typing-imports==1.14.0
-        language_version: python3
-        args:
-            - --ignore=E,W,N803
-            - --per-file-ignores=src/alfasim_sdk/_internal/hook_specs.py:F722,F821

CHANGELOG.rst

@@ -6,6 +6,8 @@ CHANGELOG
 1.4.0 (UNRELEASED)
 ==================
 
+* Types are now exported and can be verified by type-checkers such as ``mypy``.
+
 
 1.3.0 (2025-10-07)
 ==================

docs/source/alfacase_definitions/LengthAndElevationDescription.txt

@@ -5,16 +5,16 @@
     .. parsed-literal::
 
         class LengthAndElevationDescription
-            length: \ :class:`Optional <typing.Optional>`\[\ :class:`Array <barril.units.Array>`\] = None
-            elevation: \ :class:`Optional <typing.Optional>`\[\ :class:`Array <barril.units.Array>`\] = None
+            length: \ :class:`Array <barril.units.Array>`
+            elevation: \ :class:`Array <barril.units.Array>`
 
 .. tab:: Schema
 
     .. parsed-literal::
 
-            length:  # optional
+            length: 
                 values: [number]
                 unit: string
-            elevation:  # optional
+            elevation: 
                 values: [number]
                 unit: string

docs/source/alfacase_definitions/PipeSegmentsDescription.txt

@@ -8,7 +8,7 @@
             start_positions: \ :class:`Array <barril.units.Array>`
             diameters: \ :class:`Array <barril.units.Array>`
             roughnesses: \ :class:`Array <barril.units.Array>`
-            wall_names: \ :class:`Optional <typing.Optional>`\[\ :class:`List <typing.List>`\[str]] = None
+            wall_names: \ :class:`Optional <typing.Optional>`\[\ :class:`List <typing.List>`\[\ :class:`Optional <typing.Optional>`\[str]]] = None
 
 .. tab:: Schema
 
@@ -24,4 +24,4 @@
                 values: [number]
                 unit: string
             wall_names:  # optional    
-                - str
+                - string

docs/source/alfacase_definitions/PluginDescription.txt

@@ -5,7 +5,7 @@
     .. parsed-literal::
 
         class PluginDescription
-            name: \ :class:`Optional <typing.Optional>`\[str] = None
+            name: str
             version: \ :class:`Optional <typing.Optional>`\[str] = None
             gui_models: \ :class:`Dict <typing.Dict>`\[str, Any] = {}
             is_enabled: bool = True
@@ -14,7 +14,7 @@
 
     .. parsed-literal::
 
-            name: string  # optional
+            name: string
             version: string  # optional
             gui_models:  # optional
                 string: Any

docs/source/alfacase_definitions/ProfileOutputDescription.txt

@@ -7,7 +7,7 @@
         class ProfileOutputDescription
             curve_names: \ :class:`List <typing.List>`\[str]
             location: \ :class:`OutputAttachmentLocation <alfasim_sdk._internal.constants.OutputAttachmentLocation>`
-            element_name: str
+            element_name: \ :class:`Optional <typing.Optional>`\[str] = None
 
 .. tab:: Schema
 
@@ -16,4 +16,4 @@
             curve_names: 
                 - str
             location: \ :class:`OutputAttachmentLocation <alfasim_sdk._internal.constants.OutputAttachmentLocation>`
-            element_name: string
+            element_name: string  # optional

docs/source/alfacase_definitions/PumpEquipmentDescription.txt

@@ -22,7 +22,7 @@
             esp_speed_curve: \ :class:`Curve <barril.curve.curve.Curve>`\  = Curve(Hz, s)[]
             esp_number_of_stages: int = 1
             esp_reference_density: \ :class:`Scalar <barril.units.Scalar>`\  = Scalar(0.0, 'kg/m3', 'density')
-            esp_manufacturer: str = ''
+            esp_manufacturer: \ :class:`Optional <typing.Optional>`\[str] = ''
             esp_model: str = ''
             esp_viscosity_model: \ :class:`PumpViscosityModel <alfasim_sdk._internal.constants.PumpViscosityModel>`\  = PumpViscosityModel.NoModel
             density_correction_enabled: bool = False

docs/source/alfacase_definitions/WallLayerDescription.txt

@@ -6,7 +6,7 @@
 
         class WallLayerDescription
             thickness: \ :class:`Scalar <barril.units.Scalar>`
-            material_name: str
+            material_name: \ :class:`Optional <typing.Optional>`\[str] = None
             has_annulus_flow: bool = False
 
 .. tab:: Schema
@@ -16,5 +16,5 @@
             thickness: 
                 value: number
                 unit: string
-            material_name: string
+            material_name: string  # optional
             has_annulus_flow: boolean  # optional