Merge pull request #786 from compas-dev/static-api

Switch to static API

Author: tomvanmele

CHANGELOG.md

@@ -9,10 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## Unreleased
 
 ### Added
+
 * Added `divide_polyline`, `divide_polyline_by_length`, `Polyline.split_at_corners` and `Polyline.tangent_at_point_on_polyline`.
 * Added the magic method `__str__` to `compas.geoemetry.Transformation`.
 * Added `redraw` flag to the `compas_rhino` methods `delete_object`, `delete_objects` and `purge_objects`.
 * Added the `__eq__` method for `compas.geometry.Circle` and `compas.geometry.Line`.
+* Added support for Pylance through static API definitions.
 
 ### Changed
 

setup.cfg

@@ -33,5 +33,4 @@ line_length = 180
 known_first_party = compas
 default_section = THIRDPARTY
 forced_separate = test_compas
-not_skip = __init__.py
-skip = migrations
+skip = migrations, __init__.py

src/compas/datastructures/__init__.py

@@ -126,15 +126,206 @@
 
 
 """
-
 from __future__ import absolute_import
-
-
-from .datastructure import *  # noqa: F401 E402 F403
-
-from .network import *  # noqa: F401 E402 F403
-from .mesh import *  # noqa: F401 E402 F403
-from .volmesh import *  # noqa: F401 E402 F403
-
-
-__all__ = [name for name in dir() if not name.startswith('_')]
+import compas
+
+from .datastructure import Datastructure
+from .network import (
+    Graph,
+    Network,
+    network_join_edges,
+    network_polylines,
+    network_split_edge,
+    network_is_connected,
+    network_complement,
+    network_find_cycles,
+    network_disconnected_nodes,
+    network_disconnected_edges,
+    network_explode,
+    network_is_crossed,
+    network_count_crossings,
+    network_find_crossings,
+    network_is_xy,
+    network_is_planar,
+    network_is_planar_embedding,
+    network_embed_in_plane,
+    network_embed_in_plane_proxy,
+    network_smooth_centroid,
+    network_transform,
+    network_transformed,
+    network_shortest_path
+)
+from .mesh import (
+    HalfEdge,
+    Mesh,
+    trimesh_collapse_edge,
+    mesh_add_vertex_to_face_edge,
+    mesh_insert_vertex_on_edge,
+    mesh_merge_faces,
+    trimesh_split_edge,
+    mesh_substitute_vertex_in_faces,
+    trimesh_swap_edge,
+    mesh_unweld_vertices,
+    mesh_unweld_edges,
+    mesh_conway_dual,
+    mesh_conway_join,
+    mesh_conway_ambo,
+    mesh_conway_kis,
+    mesh_conway_needle,
+    mesh_conway_zip,
+    mesh_conway_truncate,
+    mesh_conway_ortho,
+    mesh_conway_expand,
+    mesh_conway_gyro,
+    mesh_conway_snub,
+    mesh_conway_meta,
+    mesh_conway_bevel,
+    trimesh_mean_curvature,
+    trimesh_gaussian_curvature,
+    mesh_disconnected_vertices,
+    mesh_disconnected_faces,
+    mesh_explode,
+    trimesh_face_circle,
+    mesh_weld,
+    meshes_join,
+    meshes_join_and_weld,
+    mesh_offset,
+    mesh_thicken,
+    mesh_flatness,
+    mesh_planarize_faces,
+    trimesh_remesh
+)
+from .volmesh import (
+    VolMesh,
+    volmesh_bounding_box,
+    volmesh_transform,
+    volmesh_transformed
+)
+
+if not compas.IPY:
+    from .network import (
+        network_adjacency_matrix,
+        network_degree_matrix,
+        network_connectivity_matrix,
+        network_laplacian_matrix,
+    )
+    from .mesh import (
+        mesh_adjacency_matrix,
+        mesh_connectivity_matrix,
+        mesh_degree_matrix,
+        mesh_face_matrix,
+        mesh_laplacian_matrix,
+        trimesh_cotangent_laplacian_matrix,
+        trimesh_vertexarea_matrix,
+        mesh_oriented_bounding_box_numpy,
+        mesh_oriented_bounding_box_xy_numpy,
+        mesh_isolines_numpy,
+        mesh_contours_numpy,
+        trimesh_descent,
+        mesh_geodesic_distances_numpy,
+        trimesh_smooth_laplacian_cotangent,
+        trimesh_pull_points_numpy,
+        mesh_transform_numpy,
+        mesh_transformed_numpy,
+        trimesh_samplepoints_numpy,
+    )
+
+__all__ = [
+    'Datastructure',
+    # Networks
+    'Graph',
+    'Network',
+    'network_join_edges',
+    'network_polylines',
+    'network_split_edge',
+    'network_is_connected',
+    'network_complement',
+    'network_find_cycles',
+    'network_disconnected_nodes',
+    'network_disconnected_edges',
+    'network_explode',
+    'network_is_crossed',
+    'network_count_crossings',
+    'network_find_crossings',
+    'network_is_xy',
+    'network_is_planar',
+    'network_is_planar_embedding',
+    'network_embed_in_plane',
+    'network_embed_in_plane_proxy',
+    'network_smooth_centroid',
+    'network_transform',
+    'network_transformed',
+    'network_shortest_path',
+    # Meshes
+    'HalfEdge',
+    'Mesh',
+    'trimesh_collapse_edge',
+    'mesh_add_vertex_to_face_edge',
+    'mesh_insert_vertex_on_edge',
+    'mesh_merge_faces',
+    'trimesh_split_edge',
+    'mesh_substitute_vertex_in_faces',
+    'trimesh_swap_edge',
+    'mesh_unweld_vertices',
+    'mesh_unweld_edges',
+    'mesh_conway_dual',
+    'mesh_conway_join',
+    'mesh_conway_ambo',
+    'mesh_conway_kis',
+    'mesh_conway_needle',
+    'mesh_conway_zip',
+    'mesh_conway_truncate',
+    'mesh_conway_ortho',
+    'mesh_conway_expand',
+    'mesh_conway_gyro',
+    'mesh_conway_snub',
+    'mesh_conway_meta',
+    'mesh_conway_bevel',
+    'trimesh_mean_curvature',
+    'trimesh_gaussian_curvature',
+    'mesh_disconnected_vertices',
+    'mesh_disconnected_faces',
+    'mesh_explode',
+    'trimesh_face_circle',
+    'mesh_weld',
+    'meshes_join',
+    'meshes_join_and_weld',
+    'mesh_offset',
+    'mesh_thicken',
+    'mesh_flatness',
+    'mesh_planarize_faces',
+    'trimesh_remesh',
+    # Volumetric Meshes
+    'VolMesh',
+    'volmesh_bounding_box',
+    'volmesh_transform',
+    'volmesh_transformed',
+]
+
+if not compas.IPY:
+    __all__ += [
+        # Networks
+        'network_adjacency_matrix',
+        'network_degree_matrix',
+        'network_connectivity_matrix',
+        'network_laplacian_matrix',
+        # Meshes
+        'mesh_adjacency_matrix',
+        'mesh_connectivity_matrix',
+        'mesh_degree_matrix',
+        'mesh_face_matrix',
+        'mesh_laplacian_matrix',
+        'trimesh_cotangent_laplacian_matrix',
+        'trimesh_vertexarea_matrix',
+        'mesh_oriented_bounding_box_numpy',
+        'mesh_oriented_bounding_box_xy_numpy',
+        'mesh_isolines_numpy',
+        'mesh_contours_numpy',
+        'trimesh_descent',
+        'mesh_geodesic_distances_numpy',
+        'trimesh_smooth_laplacian_cotangent',
+        'trimesh_pull_points_numpy',
+        'mesh_transform_numpy',
+        'mesh_transformed_numpy',
+        'trimesh_samplepoints_numpy',
+    ]

src/compas/datastructures/mesh/__init__.py

@@ -5,7 +5,6 @@
 from compas import IPY
 
 from .core import *  # noqa: F401 F403
-from ._mesh import *  # noqa: F401 F403
 
 from .bbox import *  # noqa: F401 F403
 from .combinatorics import *  # noqa: F401 F403
@@ -37,5 +36,7 @@
     from .transformations_numpy import *  # noqa: F401 F403
     from .trimesh_samplepoints_numpy import *  # noqa: F401 F403
 
+from ._mesh import *  # noqa: F401 F403
+
 
 __all__ = [name for name in dir() if not name.startswith('_')]

src/compas/datastructures/mesh/_mesh.py

@@ -37,19 +37,7 @@ class Mesh(BaseMesh):
 
     """
 
-    def bounding_box(self):
-        """Compute the axis-aligned bounding box of the mesh.
-
-        Returns
-        -------
-        box: tuple of 8 points.
-            The corners of the bounding box.
-            The first 4 points are the corners of the bottom face, in counter clockwise direction wrt the positive Z-axis.
-            The last 4 points are the corners of the top face, in counter clockwise direction wrt the positive Z-axis.
-
-        """
-        return mesh_bounding_box(self)
-
+    bounding_box = mesh_bounding_box
     bounding_box_xy = mesh_bounding_box_xy
     collapse_edge = mesh_collapse_edge
     connected_components = mesh_connected_components