Annotate PyMAPDL

[germa89]

I think we should aim to annotate the library completely. A reasonable future we should have:

Phase 0: Enforce commits check wih mypy and pre-commit.

See https://stackoverflow.com/a/70913528/6650211

Phase 1: Annotate the files

Main files

• src/ansys/mapdl/core/_version.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/cli/__init__.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/cli/convert.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/cli/list_instances.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/cli/start.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/cli/stop.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/commands.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/common_grpc.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/component.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/convert.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/database/__init__.py
• src/ansys/mapdl/core/database/database.py
• src/ansys/mapdl/core/database/elems.py
• src/ansys/mapdl/core/database/nodes.py
• src/ansys/mapdl/core/errors.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/helpers.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/examples/__init__.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/examples/downloads.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/examples/examples.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/examples/verif_files.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/__init__.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/component_queries.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/connectivity_queries.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/core.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/geometry_queries.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/inline_functions.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/line_queries.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/nearest_queries.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/normals_queries.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/scalar_queries.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/inline_functions/selection_queries.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/information.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/jupyter.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/krylov.py Fixed in refactor: annotate pymapdl part 1 #3569
• src/ansys/mapdl/core/launcher.py
• src/ansys/mapdl/core/licensing.py
• src/ansys/mapdl/core/logging.py
• src/ansys/mapdl/core/mapdl.py
• src/ansys/mapdl/core/mapdl_console.py
• src/ansys/mapdl/core/mapdl_core.py
• src/ansys/mapdl/core/mapdl_extended.py
• src/ansys/mapdl/core/mapdl_geometry.py
• src/ansys/mapdl/core/mapdl_grpc.py
• src/ansys/mapdl/core/mapdl_inprocess.py
• src/ansys/mapdl/core/mapdl_types.py
• src/ansys/mapdl/core/mesh/__init__.py
• src/ansys/mapdl/core/mesh/mesh.py
• src/ansys/mapdl/core/mesh_grpc.py
• src/ansys/mapdl/core/misc.py Fixed in refactor: adding-type-ints-to-misc #3553
• src/ansys/mapdl/core/parameters.py
• src/ansys/mapdl/core/plotting/__init__.py
• src/ansys/mapdl/core/plotting/consts.py
• src/ansys/mapdl/core/plotting/plotting_defaults.py
• src/ansys/mapdl/core/plotting/theme.py
• src/ansys/mapdl/core/plotting/visualizer.py
• src/ansys/mapdl/core/pool.py
• src/ansys/mapdl/core/post.py
• src/ansys/mapdl/core/solution.py
• src/ansys/mapdl/core/xpl.py
• src/ansys/mapdl/core/__init__.py Fixed in refactor: annotate pymapdl part 1 #3569

Secondary files

These are pretty standard, so we might be able to just use a regex or short python script to annotate it. Or we could just relay on #2224

• src/ansys/mapdl/core/_commands/__init__.py
• src/ansys/mapdl/core/_commands/apdl/__init__.py
• src/ansys/mapdl/core/_commands/apdl/abbreviations.py
• src/ansys/mapdl/core/_commands/apdl/array_param.py
• src/ansys/mapdl/core/_commands/apdl/macro_files.py
• src/ansys/mapdl/core/_commands/apdl/matrix_op.py
• src/ansys/mapdl/core/_commands/apdl/parameter_definition.py
• src/ansys/mapdl/core/_commands/apdl/process_controls.py
• src/ansys/mapdl/core/_commands/aux12_/__init__.py
• src/ansys/mapdl/core/_commands/aux12_/general_radiation.py
• src/ansys/mapdl/core/_commands/aux12_/radiation_mat.py
• src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py
• src/ansys/mapdl/core/_commands/aux15_.py
• src/ansys/mapdl/core/_commands/aux2_/__init__.py
• src/ansys/mapdl/core/_commands/aux2_/bin_dump.py
• src/ansys/mapdl/core/_commands/aux2_/bin_manip.py
• src/ansys/mapdl/core/_commands/aux3_.py
• src/ansys/mapdl/core/_commands/conn.py
• src/ansys/mapdl/core/_commands/database/__init__.py
• src/ansys/mapdl/core/_commands/database/components.py
• src/ansys/mapdl/core/_commands/database/coord_sys.py
• src/ansys/mapdl/core/_commands/database/picking.py
• src/ansys/mapdl/core/_commands/database/selecting.py
• src/ansys/mapdl/core/_commands/database/setup.py
• src/ansys/mapdl/core/_commands/database/working_plane.py
• src/ansys/mapdl/core/_commands/display_/__init__.py
• src/ansys/mapdl/core/_commands/display_/setup.py
• src/ansys/mapdl/core/_commands/graphics_/__init__.py
• src/ansys/mapdl/core/_commands/graphics_/annotation.py
• src/ansys/mapdl/core/_commands/graphics_/graphs.py
• src/ansys/mapdl/core/_commands/graphics_/labeling.py
• src/ansys/mapdl/core/_commands/graphics_/scaling.py
• src/ansys/mapdl/core/_commands/graphics_/setup.py
• src/ansys/mapdl/core/_commands/graphics_/style.py
• src/ansys/mapdl/core/_commands/graphics_/views.py
• src/ansys/mapdl/core/_commands/hidden.py
• src/ansys/mapdl/core/_commands/inq_func.py
• src/ansys/mapdl/core/_commands/map_cmd.py
• src/ansys/mapdl/core/_commands/misc/__init__.py
• src/ansys/mapdl/core/_commands/misc/misc.py
• src/ansys/mapdl/core/_commands/parse.py
• src/ansys/mapdl/core/_commands/post1_/__init__.py
• src/ansys/mapdl/core/_commands/post1_/animation.py
• src/ansys/mapdl/core/_commands/post1_/controls.py
• src/ansys/mapdl/core/_commands/post1_/element_table.py
• src/ansys/mapdl/core/_commands/post1_/failure_criteria.py
• src/ansys/mapdl/core/_commands/post1_/listing.py
• src/ansys/mapdl/core/_commands/post1_/load_case.py
• src/ansys/mapdl/core/_commands/post1_/magnetics_calc.py
• src/ansys/mapdl/core/_commands/post1_/path_operations.py
• src/ansys/mapdl/core/_commands/post1_/results.py
• src/ansys/mapdl/core/_commands/post1_/setup.py
• src/ansys/mapdl/core/_commands/post1_/special.py
• src/ansys/mapdl/core/_commands/post1_/status.py
• src/ansys/mapdl/core/_commands/post1_/surface_operations.py
• src/ansys/mapdl/core/_commands/post1_/trace_points.py
• src/ansys/mapdl/core/_commands/post26_/__init__.py
• src/ansys/mapdl/core/_commands/post26_/controls.py
• src/ansys/mapdl/core/_commands/post26_/display.py
• src/ansys/mapdl/core/_commands/post26_/listing.py
• src/ansys/mapdl/core/_commands/post26_/operations.py
• src/ansys/mapdl/core/_commands/post26_/setup.py
• src/ansys/mapdl/core/_commands/post26_/special.py
• src/ansys/mapdl/core/_commands/post26_/status.py
• src/ansys/mapdl/core/_commands/preproc/__init__.py
• src/ansys/mapdl/core/_commands/preproc/areas.py
• src/ansys/mapdl/core/_commands/preproc/artificially_matched_layers.py
• src/ansys/mapdl/core/_commands/preproc/booleans.py
• src/ansys/mapdl/core/_commands/preproc/constraint_equations.py
• src/ansys/mapdl/core/_commands/preproc/coupled_dof.py
• src/ansys/mapdl/core/_commands/preproc/database.py
• src/ansys/mapdl/core/_commands/preproc/digitizing.py
• src/ansys/mapdl/core/_commands/preproc/element_type.py
• src/ansys/mapdl/core/_commands/preproc/elements.py
• src/ansys/mapdl/core/_commands/preproc/explicit_dynamics.py
• src/ansys/mapdl/core/_commands/preproc/hard_points.py
• src/ansys/mapdl/core/_commands/preproc/keypoints.py
• src/ansys/mapdl/core/_commands/preproc/lines.py
• src/ansys/mapdl/core/_commands/preproc/material_data_tables.py
• src/ansys/mapdl/core/_commands/preproc/materials.py
• src/ansys/mapdl/core/_commands/preproc/meshing.py
• src/ansys/mapdl/core/_commands/preproc/morphing.py
• src/ansys/mapdl/core/_commands/preproc/nodes.py
• src/ansys/mapdl/core/_commands/preproc/primitives.py
• src/ansys/mapdl/core/_commands/preproc/real_constants.py
• src/ansys/mapdl/core/_commands/preproc/sections.py
• src/ansys/mapdl/core/_commands/preproc/special_purpose.py
• src/ansys/mapdl/core/_commands/preproc/status.py
• src/ansys/mapdl/core/_commands/preproc/superelements.py
• src/ansys/mapdl/core/_commands/preproc/volumes.py
• src/ansys/mapdl/core/_commands/reduced/__init__.py
• src/ansys/mapdl/core/_commands/reduced/generation.py
• src/ansys/mapdl/core/_commands/reduced/preparation.py
• src/ansys/mapdl/core/_commands/reduced/setup.py
• src/ansys/mapdl/core/_commands/reduced/use_pass.py
• src/ansys/mapdl/core/_commands/session/__init__.py
• src/ansys/mapdl/core/_commands/session/files.py
• src/ansys/mapdl/core/_commands/session/list_controls.py
• src/ansys/mapdl/core/_commands/session/processor_entry.py
• src/ansys/mapdl/core/_commands/session/run_controls.py
• src/ansys/mapdl/core/_commands/solution/__init__.py
• src/ansys/mapdl/core/_commands/solution/all_others.py
• src/ansys/mapdl/core/_commands/solution/analysis_options.py
• src/ansys/mapdl/core/_commands/solution/birth_and_death.py
• src/ansys/mapdl/core/_commands/solution/dynamic_options.py
• src/ansys/mapdl/core/_commands/solution/fe_body_loads.py
• src/ansys/mapdl/core/_commands/solution/fe_constraints.py
• src/ansys/mapdl/core/_commands/solution/fe_forces.py
• src/ansys/mapdl/core/_commands/solution/fe_surface_loads.py
• src/ansys/mapdl/core/_commands/solution/gap_conditions.py
• src/ansys/mapdl/core/_commands/solution/inertia.py
• src/ansys/mapdl/core/_commands/solution/load_step_operations.py
• src/ansys/mapdl/core/_commands/solution/load_step_options.py
• src/ansys/mapdl/core/_commands/solution/master_dof.py
• src/ansys/mapdl/core/_commands/solution/miscellaneous_loads.py
• src/ansys/mapdl/core/_commands/solution/ multi_field_solver_convergence_controls.py
• src/ansys/mapdl/core/_commands/solution/ multi_field_solver_definition_commands.py
• src/ansys/mapdl/core/_commands/solution/multi_field_solver_global_controls.py
• src/ansys/mapdl/core/_commands/solution/multi_field_solver_interface_mapping. py
• src/ansys/mapdl/core/_commands/solution/multi_field_solver_load_transfer.py
• src/ansys/mapdl/core/_commands/solution/multi_field_solver_time_controls.py
• src/ansys/mapdl/core/_commands/solution/nonlinear_options.py
• src/ansys/mapdl/core/_commands/solution/ocean.py
• src/ansys/mapdl/core/_commands/solution/radiosity.py
• src/ansys/mapdl/core/_commands/solution/rezoning.py
• src/ansys/mapdl/core/_commands/solution/solid_body_loads.py
• src/ansys/mapdl/core/_commands/solution/solid_constraints.py
• src/ansys/mapdl/core/_commands/solution/solid_forces.py
• src/ansys/mapdl/core/_commands/solution/solid_surface_loads.py
• src/ansys/mapdl/core/_commands/solution/solution_status.py
• src/ansys/mapdl/core/_commands/solution/spectrum_options.py
• src/ansys/mapdl/core/_commands/solution/twod_to_3d_analysis.py

Phase 2: Full check wih mypy

See https://mypy.readthedocs.io/en/stable/getting_started.html#

Phase 3: Runtime check using Beartype.

Related #1592