[typing] Fix wrong mypy typing annotations (backport #4879) (#4885)

* [typing] Fix wrong mypy typing annotations (#4879) * Fix mypy abqpy issues * Mypy typings * Update typing annotations for SymbolicConstants * Fixing typings * Add future annotations * Use list/dict/tuple instead of List/Dict/Tuple * Fix Optional typings * Add future annotations * Update xyPlot.py * Update .pre-commit-config.yaml * Fix list typings for Python 3.7/3.8 * Fixing more typings * Fix more typings * Update conf.py * Update .pre-commit-config.yaml * Revert "Update conf.py" This reverts commit e8449ae. * Update conf.py * Revert "Update conf.py" This reverts commit 3be44d0. * Docs Not -W (cherry picked from commit d7be4b4) # Conflicts: # src/abaqus/Datum/DatumCsys.py # src/abaqus/EngineeringFeature/DataImperfection.py # src/abaqus/EngineeringFeature/EngineeringFeature.py # src/abaqus/EngineeringFeature/EngineeringFeatureBase.py # src/abaqus/EngineeringFeature/FileImperfection.py # src/abaqus/EngineeringFeature/InputImperfection.py # src/abaqus/Interaction/ContactExp.py # src/abaqus/Interaction/ContactStd.py # src/abaqus/Interaction/ExpInitialization.py # src/abaqus/Interaction/InteractionModel.py # src/abaqus/Job/Coexecution.py # src/abaqus/Material/Material.py # src/abaqus/Material/Plastic/CrushStress/CrushStress.py # src/abaqus/Material/Plastic/CrushStress/CrushStressVelocityFactor.py # src/abaqus/Material/Plastic/PlasticityCorrection.py # src/abaqus/Mdb/MdbBase.py # src/abaqus/Mesh/ElemType.py # src/abaqus/Mesh/MeshEdgeArray.py # src/abaqus/Mesh/MeshFaceArray.py # src/abaqus/Odb/OdbDatumCsys.py # src/abaqus/Optimization/BeadFilter.py # src/abaqus/Optimization/DesignDirection.py # src/abaqus/Optimization/DrillControl.py # src/abaqus/Optimization/OptimizationTask.py # src/abaqus/Optimization/OptimizationTaskModel.py # src/abaqus/Optimization/ShapePlanarSymmetry.py # src/abaqus/Optimization/ShapePointSymmetry.py # src/abaqus/Optimization/ShapeRotationalSymmetry.py # src/abaqus/Optimization/StampControl.py # src/abaqus/Optimization/TopologyMillingControl.py # src/abaqus/Optimization/TopologyRibDesign.py # src/abaqus/Optimization/TopologyTask.py # src/abaqus/Optimization/TurnControl.py # src/abaqus/StepOutput/FieldOutputRequest.py # src/abaqus/XY/XYData.py * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Delete conflicted deleted files by GitHub Action https://github.com/haiiliin/abqpy/actions/runs/5910451845 * Resolve conflicts * Update OptimizationTask.py --------- Co-authored-by: Hailin Wang <hailin.wang@connect.polyu.hk> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
haiiliin · Aug 19, 2023 · 29d78ed · 29d78ed
1 parent f00529e
commit 29d78ed
Show file tree

Hide file tree

Showing 750 changed files with 6,137 additions and 5,495 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -62,7 +62,7 @@ jobs:
         run: |
           sphinx-build -M ${{ matrix.builder }} ${{ env.SPHINXOPTS }} docs/source docs/build/${{ matrix.builder }}/${{ matrix.language }}
         env:
-          SPHINXOPTS: -D language=${{ matrix.language }} -j auto -W
+          SPHINXOPTS: -D language=${{ matrix.language }} -j auto
       - name: Upload artifacts
         if: github.event_name != 'pull_request'
         uses: actions/upload-artifact@v3

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -20,3 +20,9 @@ repos:
     hooks:
       - id: isort
         args: ["--profile", "black"]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.5.1"
+    hooks:
+      - id: mypy
+        files: ^src/
diff --git a/docs/Makefile b/docs/Makefile
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?= -j auto -W
+SPHINXOPTS    ?= -j auto
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build

diff --git a/pyproject.toml b/pyproject.toml
@@ -42,6 +42,7 @@ dev = [
     "crowdin-api-client",
     "docformatter",
     "flake8",
+    "mypy",
     "pofmt",
     "polib",
     "pre-commit",
@@ -109,3 +110,6 @@ wrap-descriptions = 108
 blank = false
 in-place = true
 black = true
+
+[tool.mypy]
+ignore_missing_imports = true
diff --git a/src/ababltin.py b/src/ababltin.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 import re
 import sys

diff --git a/src/abaqus/AbaqusCAEDisplayPreferences/caePrefsAccess.py b/src/abaqus/AbaqusCAEDisplayPreferences/caePrefsAccess.py
@@ -1,4 +1,6 @@
-from typing import List, Union
+from __future__ import annotations
+
+from typing import Union
 
 from typing_extensions import Literal
 
@@ -34,12 +36,11 @@ def getGuiPrefsFileName() -> str:
     str
         A String with the default file name for the GUI preferences file.
     """
-    # TODO: Implement this function
-    ...
+    return ""
 
 
 @abaqus_function_doc
-def getDisplayNamesInGuiPreferences(fileName: str) -> List[str]:
+def getDisplayNamesInGuiPreferences(fileName: str) -> list[str]:
     """The abaqus_2021.gpr file stores a separate guiPreferences record for each display that you use. This
     function returns a list of every displayName recorded in the preferences file.
 
@@ -55,11 +56,10 @@ def getDisplayNamesInGuiPreferences(fileName: str) -> List[str]:
 
     Returns
     -------
-    List[str]
+    list[str]
         A list of Strings of displayNames.
     """
-    # TODO: Implement this function
-    ...
+    return []
 
 
 @abaqus_function_doc
@@ -95,8 +95,7 @@ def printValuesList(
         A String displaying the path, name, and value for all of the options in the object that
         you select.
     """
-    # TODO: Implement this function
-    ...
+    return ""
 
 
 @abaqus_function_doc

diff --git a/src/abaqus/Adaptivity/AdaptiveMeshConstraint.py b/src/abaqus/Adaptivity/AdaptiveMeshConstraint.py
@@ -1,4 +1,4 @@
-from typing import Optional
+from __future__ import annotations
 
 from typing_extensions import Literal
 
@@ -29,23 +29,23 @@ class AdaptiveMeshConstraint:
 
     #: A SymbolicConstant specifying the category of the adaptive mesh constraint. Possible
     #: values are MECHANICAL and THERMAL.
-    category: Optional[SymbolicConstant] = None
+    category: SymbolicConstant
 
     #: A Region object specifying the region to which the adaptive mesh constraint is applied.
     region: Region = Region()
 
     #: None or a DatumCsys object specifying the local coordinate system of the adaptive mesh
     #: constraint's degrees of freedom. If **localCsys** = None, the degrees of freedom are defined
     #: in the global coordinate system. The default value is None.
-    localCsys: Optional[DatumCsys] = None
+    localCsys: DatumCsys | None = DatumCsys()
 
     @abaqus_method_doc
     def __init__(
         self,
         name: str,
         category: Literal[C.THERMAL, C.MECHANICAL],
         region: Region,
-        localCsys: Optional[DatumCsys] = None,
+        localCsys: DatumCsys | None = None,
     ):
         """The AdaptiveMeshConstraint object is the abstract base type for other Arbitrary Lagrangian Eularian
         (ALE) style AdaptiveMeshConstraint objects. The AdaptiveMeshConstraint object has no explicit

diff --git a/src/abaqus/Adaptivity/AdaptiveMeshConstraintState.py b/src/abaqus/Adaptivity/AdaptiveMeshConstraintState.py
@@ -1,4 +1,4 @@
-from typing import Optional
+from __future__ import annotations
 
 from typing_extensions import Literal
 
@@ -24,7 +24,7 @@ class AdaptiveMeshConstraintState:
 
     #: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible
     #: values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
-    amplitudeState: Optional[SymbolicConstant] = None
+    amplitudeState: SymbolicConstant
 
     #: A SymbolicConstant specifying the propagation state of the AdaptiveMeshConstraintState
     #: object. Possible values are:
@@ -41,7 +41,7 @@ class AdaptiveMeshConstraintState:
     #: - MODIFIED_FROM_BASE_STATE
     #: - DEACTIVATED_FROM_BASE_STATE
     #: - BUILT_INTO_MODES
-    status: Optional[SymbolicConstant] = None
+    status: SymbolicConstant
 
     #: A String specifying the name of the amplitude reference. The String is empty if the
     #: adaptive mesh constraint has no amplitude reference.
@@ -50,23 +50,22 @@ class AdaptiveMeshConstraintState:
     @abaqus_method_doc
     def __init__(
         self,
-        amplitudeState: Optional[Literal[C.UNSET, C.SET, C.FREED, C.UNCHANGED, C.MODIFIED]] = None,
-        status: Optional[
-            Literal[
-                C.NOT_YET_ACTIVE,
-                C.PROPAGATED_FROM_BASE_STATE,
-                C.DEACTIVATED_FROM_BASE_STATE,
-                C.DEACTIVATED,
-                C.MODIFIED_FROM_BASE_STATE,
-                C.PROPAGATED,
-                C.NO_LONGER_ACTIVE,
-                C.CREATED,
-                C.INSTANCE_NOT_APPLICABLE,
-                C.BUILT_INTO_MODES,
-                C.TYPE_NOT_APPLICABLE,
-                C.MODIFIED,
-            ]
-        ] = None,
+        amplitudeState: Literal[C.UNSET, C.SET, C.FREED, C.UNCHANGED, C.MODIFIED] | None = None,
+        status: Literal[
+            C.NOT_YET_ACTIVE,
+            C.PROPAGATED_FROM_BASE_STATE,
+            C.DEACTIVATED_FROM_BASE_STATE,
+            C.DEACTIVATED,
+            C.MODIFIED_FROM_BASE_STATE,
+            C.PROPAGATED,
+            C.NO_LONGER_ACTIVE,
+            C.CREATED,
+            C.INSTANCE_NOT_APPLICABLE,
+            C.BUILT_INTO_MODES,
+            C.TYPE_NOT_APPLICABLE,
+            C.MODIFIED,
+        ]
+        | None = None,
         amplitude: str = "",
     ):
         """The AdaptiveMeshConstraintState object is the abstract base type for other Arbitrary Lagrangian

diff --git a/src/abaqus/Adaptivity/AdaptivityIteration.py b/src/abaqus/Adaptivity/AdaptivityIteration.py
@@ -1,11 +1,9 @@
 from __future__ import annotations
 
-from typing import Dict
-
 from abqpy.decorators import abaqus_class_doc, abaqus_method_doc
 
-from .ErrorIndicatorResult import ErrorIndicatorResult
-from .RuleResult import RuleResult
+from .ErrorIndicatorResult import ErrorIndicatorResult as ErrorIndicatorResultType
+from .RuleResult import RuleResult as RuleResultType
 
 
 @abaqus_class_doc
@@ -23,7 +21,7 @@ class AdaptivityIteration:
     #: A repository of RuleResult objects specifying the calculated results from sizing
     #: functions corresponding to the RemeshingRule objects for this iteration of an adaptivity
     #: process.
-    ruleResults: Dict[str, RuleResult] = {}
+    ruleResults: dict[str, RuleResultType] = {}
 
     #: An Int specifying the sequence number for this iteration in the adaptivity process.
     iteration: int
@@ -81,7 +79,7 @@ def __init__(
         ...
 
     @abaqus_method_doc
-    def ErrorIndicatorResult(self, name: str, results: str) -> ErrorIndicatorResult:
+    def ErrorIndicatorResult(self, name: str, results: str) -> ErrorIndicatorResultType:
         """This method creates an ErrorIndicatorResult with data for an error indicator variable in a
         RemeshingRule for a given adaptivity iteration.
 
@@ -108,18 +106,18 @@ def ErrorIndicatorResult(self, name: str, results: str) -> ErrorIndicatorResult:
         ------
         AbaqusException
         """
-        self.ruleResults[name] = ruleResult = ErrorIndicatorResult(name, results)
+        self.ruleResults[name] = ruleResult = ErrorIndicatorResultType(name, results)
         return ruleResult
 
     @abaqus_method_doc
     def RuleResult(
         self,
         name: str,
-        indicatorResults: Dict[str, ErrorIndicatorResult],
+        indicatorResults: dict[str, ErrorIndicatorResultType],
         numElems: int,
         minSizeElemCount: int,
         satisfiedVars: tuple = (),
-    ) -> RuleResult:
+    ) -> RuleResultType:
         """This method creates a RuleResult with data for a RemeshingRule for a given adaptivity iteration.
 
         .. note::
@@ -153,7 +151,7 @@ def RuleResult(
         ------
         AbaqusException
         """
-        self.ruleResults[name] = ruleResult = RuleResult(
+        self.ruleResults[name] = ruleResult = RuleResultType(
             name, indicatorResults, numElems, minSizeElemCount, satisfiedVars
         )
         return ruleResult
diff --git a/src/abaqus/Adaptivity/AdaptivityModel.py b/src/abaqus/Adaptivity/AdaptivityModel.py
@@ -1,4 +1,6 @@
-from typing import Optional, Union
+from __future__ import annotations
+
+from typing import Union
 
 from typing_extensions import Literal
 
@@ -65,7 +67,7 @@ def AdaptiveMeshConstraint(
         name: str,
         category: Literal[C.THERMAL, C.MECHANICAL],
         region: Region,
-        localCsys: Optional[DatumCsys] = None,
+        localCsys: DatumCsys | None = None,
     ) -> AdaptiveMeshConstraint:
         """The AdaptiveMeshConstraint object is the abstract base type for other Arbitrary Lagrangian Eularian
         (ALE) style AdaptiveMeshConstraint objects. The AdaptiveMeshConstraint object has no explicit
@@ -214,7 +216,7 @@ def DisplacementAdaptiveMeshConstraint(
         ur3: Union[Literal[C.SET, C.UNSET], float] = UNSET,
         amplitude: str = UNSET,
         motionType: Literal[C.USER_DEFINED, C.INDEPENDENT, C.FOLLOW] = INDEPENDENT,
-        localCsys: Optional[DatumCsys] = None,
+        localCsys: DatumCsys | None = None,
     ) -> DisplacementAdaptiveMeshConstraint:
         """This method creates a DisplacementAdaptiveMeshConstraint object.
 
@@ -310,7 +312,7 @@ def RemeshingRule(
         specifyMaxSize: Boolean = ON,
         coarseningFactor: Literal[C.NOT_ALLOWED, C.DEFAULT_LIMIT] = DEFAULT_LIMIT,
         refinementFactor: Literal[C.NOT_ALLOWED, C.DEFAULT_LIMIT] = DEFAULT_LIMIT,
-        elementCountLimit: Optional[int] = None,
+        elementCountLimit: int | None = None,
     ) -> RemeshingRule:
         """This method creates a RemeshingRule object.
 
@@ -427,7 +429,7 @@ def VelocityAdaptiveMeshConstraint(
         vr2: Union[Literal[C.SET, C.UNSET], float] = UNSET,
         vr3: Union[Literal[C.SET, C.UNSET], float] = UNSET,
         amplitude: str = UNSET,
-        localCsys: Optional[DatumCsys] = None,
+        localCsys: DatumCsys | None = None,
         motionType: Literal[C.USER_DEFINED, C.INDEPENDENT, C.FOLLOW] = INDEPENDENT,
     ) -> VelocityAdaptiveMeshConstraint:
         """This method creates a VelocityAdaptiveMeshConstraint object.

diff --git a/src/abaqus/Adaptivity/AdaptivityProcess.py b/src/abaqus/Adaptivity/AdaptivityProcess.py
@@ -1,4 +1,4 @@
-from typing import Dict, Optional
+from __future__ import annotations
 
 from abqpy.decorators import abaqus_class_doc, abaqus_method_doc
 
@@ -21,11 +21,11 @@ class AdaptivityProcess:
 
     #: A SymbolicConstant specifying the status of the adaptivity process. Possible values are
     #: SUBMITTED, RUNNING, ABORTED, TERMINATED, and COMPLETED.
-    status: Optional[SymbolicConstant] = None
+    status: SymbolicConstant
 
     #: A repository of AdaptivityIteration objects specifying the AdaptivityIteration objects
     #: received during running the adaptivity process.
-    iterations: Dict[int, AdaptivityIteration] = {}
+    iterations: dict[int, AdaptivityIteration] = {}
 
     #: A String specifying the name of the Adaptivity Process.
     name: str
@@ -156,7 +156,7 @@ def AdaptivityIteration(
         AdaptivityIteration
             An AdaptivityIteration object.
         """
-        self.iterations[iteration] = iteration = AdaptivityIteration(
+        self.iterations[iteration] = adaptivityIteration = AdaptivityIteration(
             iteration, jobName, modelName, odbPath, remeshingErrors
         )
-        return iteration
+        return adaptivityIteration