Merge branch 'main' into release/0.5

RobPasMue · RobPasMue · commit 9a1476846ba0 · 2024-05-21T12:51:58.000+02:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -64,7 +64,7 @@ repos:
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.28.3
+  rev: 0.28.4
   hooks:
     - id: check-github-workflows
 
diff --git a/doc/changelog.d/1135.changed.md b/doc/changelog.d/1135.changed.md
@@ -0,0 +1 @@
+docs: adapt ``ansys_sphinx_theme_autoapi`` extension for ``autoapi``
diff --git a/doc/changelog.d/1194.changed.md b/doc/changelog.d/1194.changed.md
@@ -0,0 +1 @@
+chore: update CHANGELOG for v0.5.4
diff --git a/doc/changelog.d/1196.fixed.md b/doc/changelog.d/1196.fixed.md
@@ -0,0 +1 @@
+fix: adapting ``Arc`` class constructor order to (start, end, center)
diff --git a/doc/changelog.d/1198.dependencies.md b/doc/changelog.d/1198.dependencies.md
@@ -0,0 +1 @@
+build: bump grpcio from 1.63.0 to 1.64.0 in the grpc-deps group
diff --git a/doc/changelog.d/1199.dependencies.md b/doc/changelog.d/1199.dependencies.md
@@ -0,0 +1 @@
+build: bump the docs-deps group with 2 updates
diff --git a/doc/changelog.d/1200.dependencies.md b/doc/changelog.d/1200.dependencies.md
@@ -0,0 +1 @@
+build: bump pytest from 8.2.0 to 8.2.1
diff --git a/doc/changelog.d/1202.miscellaneous.md b/doc/changelog.d/1202.miscellaneous.md
@@ -0,0 +1 @@
+chore: pre-commit automatic update
diff --git a/doc/changelog.d/1203.fixed.md b/doc/changelog.d/1203.fixed.md
@@ -0,0 +1 @@
+chore: limit requests library version under 2.32
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -10,7 +10,6 @@
     ansys_favicon,
     ansys_logo_white,
     ansys_logo_white_cropped,
-    get_autoapi_templates_dir_relative_path,
     get_version_match,
     latex,
     pyansys_logo_black,
@@ -158,8 +157,10 @@ def intersphinx_pyansys_geometry(switcher_version: str):
             f"pyansys-geometry-v{get_version_match(__version__).replace('.', '-')}": "PyAnsys-Geometry",  # noqa: E501
         },
     },
+    "ansys_sphinx_theme_autoapi": {
+        "project": project,
+    },
 }
-
 # Sphinx extensions
 extensions = [
     "sphinx.ext.intersphinx",
@@ -169,7 +170,7 @@ def intersphinx_pyansys_geometry(switcher_version: str):
     "jupyter_sphinx",
     "sphinx_design",
     "sphinx_jinja",
-    "autoapi.extension",
+    "ansys_sphinx_theme.extension.autoapi",
     "numpydoc",
 ]
 
@@ -239,21 +240,7 @@ def intersphinx_pyansys_geometry(switcher_version: str):
 master_doc = "index"
 
 # Configuration for Sphinx autoapi
-autoapi_type = "python"
-autoapi_dirs = ["../../src/ansys"]
-autoapi_root = "api"
-autoapi_options = [
-    "members",
-    "undoc-members",
-    "show-inheritance",
-    "show-module-summary",
-    "special-members",
-]
-autoapi_template_dir = get_autoapi_templates_dir_relative_path(Path(__file__))
-suppress_warnings = ["autoapi.python_import_resolution", "design.grid"]
-autoapi_python_use_implicit_namespaces = True
-autoapi_keep_files = True
-autoapi_own_page_level = "class"
+suppress_warnings = ["autoapi.python_import_resolution", "design.grid", "config.cache"]
 
 # Examples gallery customization
 nbsphinx_execute = "always"
@@ -367,19 +354,6 @@ def intersphinx_pyansys_geometry(switcher_version: str):
     "wheelhouse-assets": {"assets": get_wheelhouse_assets_dictionary()},
 }
 
-
-def prepare_jinja_env(jinja_env) -> None:
-    """
-    Customize the jinja env.
-
-    Notes
-    -----
-    See https://jinja.palletsprojects.com/en/3.0.x/api/#jinja2.Environment
-    """
-    jinja_env.globals["project_name"] = project
-
-
-autoapi_prepare_jinja_env = prepare_jinja_env
 nitpick_ignore_regex = [
     # Ignore typing
     (r"py:.*", r"optional"),
diff --git a/pyproject.toml b/pyproject.toml
@@ -33,7 +33,7 @@ dependencies = [
     "Pint>=0.18,<1",
     "protobuf>=3.20.2,<6",
     "pyvista>=0.37.0,<1",
-    "requests>=2,<3",
+    "requests>=2,<2.32",
     "scipy>=1.7.3,<2",
     "semver>=3,<4",
     "six>=1.16.0,<2",
@@ -51,30 +51,30 @@ tests = [
     "ansys-tools-path==0.5.2",
     "beartype==0.18.5",
     "docker==7.0.0",
-    "grpcio==1.63.0",
+    "grpcio==1.64.0",
     "grpcio-health-checking==1.60.0",
     "numpy==1.26.4",
     "Pint==0.23",
     "protobuf==5.26.1",
-    "pytest==8.2.0",
+    "pytest==8.2.1",
     "pytest-cov==5.0.0",
     "pytest-pyvista==0.1.9",
     "pytest-xvfb==3.0.0",
-    "pyvista[jupyter]==0.43.7",
+    "pyvista[jupyter]==0.43.8",
     "requests==2.31.0",
     "scipy==1.13.0",
     "semver==3.0.2",
     "six==1.16.0",
     "vtk==9.3.0",
 ]
 tests-minimal = [
-    "pytest==8.2.0",
+    "pytest==8.2.1",
     "pytest-cov==5.0.0",
     "pytest-pyvista==0.1.9",
     "pytest-xvfb==3.0.0",
 ]
 doc = [
-    "ansys-sphinx-theme[autoapi]==0.15.2",
+    "ansys-sphinx-theme[autoapi]==0.16.0",
     "beartype==0.18.5",
     "docker==7.0.0",
     "ipyvtklink==0.2.3",
@@ -83,12 +83,12 @@ doc = [
     "myst-parser==3.0.1",
     "nbconvert==7.16.4",
     "nbsphinx==0.9.4",
-    "notebook==7.1.3",
+    "notebook==7.2.0",
     "numpydoc==1.7.0",
     "panel==1.4.2",
-    "pyvista[jupyter]==0.43.7",
+    "pyvista[jupyter]==0.43.8",
     "requests==2.31.0",
-    "sphinx==7.2.6",
+    "sphinx==7.3.7",
     "sphinx-autodoc-typehints==1.24.0",
     "sphinx-copybutton==0.5.2",
     "sphinx-jinja==2.0.2",
diff --git a/src/ansys/geometry/core/sketch/arc.py b/src/ansys/geometry/core/sketch/arc.py
@@ -40,12 +40,12 @@ class Arc(SketchEdge):
 
     Parameters
     ----------
-    center : Point2D
-        Center point of the arc.
     start : Point2D
         Starting point of the arc.
     end : Point2D
         Ending point of the arc.
+    center : Point2D
+        Center point of the arc.
     clockwise : bool, default: False
         Whether the arc spans the clockwise angle between the start and end points.
         When ``False`` (default), the arc spans the counter-clockwise angle. When
@@ -55,9 +55,9 @@ class Arc(SketchEdge):
     @check_input_types
     def __init__(
         self,
-        center: Point2D,
         start: Point2D,
         end: Point2D,
+        center: Point2D,
         clockwise: Optional[bool] = False,
     ):
         """Initialize the arc shape."""
@@ -78,7 +78,7 @@ def __init__(
             )
 
         # Store the main three points of the arc
-        self._center, self._start, self._end = center, start, end
+        self._start, self._end, self._center = start, end, center
 
         # Compute the vectors from the center to the start and end points
         to_start_vector = Vector2D.from_points(start, center)
@@ -107,6 +107,11 @@ def end(self) -> Point2D:
         """Ending point of the arc line."""
         return self._end
 
+    @property
+    def center(self) -> Point2D:
+        """Center point of the arc."""
+        return self._center
+
     @property
     def length(self) -> Quantity:
         """Length of the arc."""
@@ -117,11 +122,6 @@ def radius(self) -> Quantity:
         """Radius of the arc."""
         return self._radius
 
-    @property
-    def center(self) -> Point2D:
-        """Center point of the arc."""
-        return self._center
-
     @property
     def angle(self) -> Quantity:
         """Angle of the arc."""
@@ -341,4 +341,4 @@ def from_three_points(cls, start: Point2D, inter: Point2D, end: Point2D):
         is_clockwise = False if angle_s_i < angle_s_e else True
 
         # Finally... you can create the arc
-        return Arc(center=center, start=start, end=end, clockwise=is_clockwise)
+        return Arc(start=start, end=end, center=center, clockwise=is_clockwise)
diff --git a/src/ansys/geometry/core/sketch/gears.py b/src/ansys/geometry/core/sketch/gears.py
@@ -142,13 +142,13 @@ def __init__(
             # Now, proceed to draw the arcs and segments
             # TODO: add plane to SketchSegment when available
             self._edges.append(
-                Arc(center=origin, start=outer_arc_start + origin, end=outer_arc_end + origin)
+                Arc(start=outer_arc_start + origin, end=outer_arc_end + origin, center=origin)
             )
             self._edges.append(
                 SketchSegment(start=outer_arc_end + origin, end=inner_arc_start + origin)
             )
             self._edges.append(
-                Arc(center=origin, start=inner_arc_start + origin, end=inner_arc_end + origin)
+                Arc(start=inner_arc_start + origin, end=inner_arc_end + origin, center=origin)
             )
             self._edges.append(
                 SketchSegment(start=inner_arc_end + origin, end=next_outer_arc_start + origin)
@@ -513,19 +513,19 @@ def _generate_arcs(
                 # needed values from the preliminary arc
                 arcs.append(
                     Arc(
-                        center=preliminary_arc.center,
                         start=points[idx],
                         end=points[idx + 1],
+                        center=preliminary_arc.center,
                         clockwise=preliminary_arc.is_clockwise,
                     )
                 )
 
             # Once the loop has finished... extend the last arc
             arcs.append(
                 Arc(
-                    center=preliminary_arc.center,
                     start=points[-2],
                     end=points[-1],
+                    center=preliminary_arc.center,
                     clockwise=preliminary_arc.is_clockwise,
                 )
             )
@@ -537,9 +537,9 @@ def _generate_arcs(
             # Just in case, let us only take the first and last elements of the given list
             arcs.append(
                 Arc(
-                    center=self.origin,
                     start=points[0],
                     end=points[-1],
+                    center=self.origin,
                 )
             )
 
diff --git a/src/ansys/geometry/core/sketch/sketch.py b/src/ansys/geometry/core/sketch/sketch.py
@@ -414,7 +414,7 @@ def arc(
         Sketch
             Revised sketch state ready for further sketch actions.
         """
-        arc = Arc(center, start, end, clockwise)
+        arc = Arc(start, end, center, clockwise)
         return self.edge(arc, tag)
 
     @check_input_types
@@ -453,7 +453,7 @@ def arc_to_point(
         of the sketch, such as the end point of a previously added edge.
         """
         start = self._single_point_context_reference()
-        arc = Arc(center, start, end, clockwise)
+        arc = Arc(start, end, center, clockwise)
         return self.edge(arc, tag)
 
     def arc_from_three_points(
diff --git a/src/ansys/geometry/core/sketch/slot.py b/src/ansys/geometry/core/sketch/slot.py
@@ -120,9 +120,9 @@ def __init__(
         )
 
         # TODO: add plane to SketchSegment when available
-        self._arc1 = Arc(self._arc_1_center, self._slot_corner_1, self._slot_corner_2)
+        self._arc1 = Arc(self._slot_corner_1, self._slot_corner_2, self._arc_1_center)
         self._segment1 = SketchSegment(self._slot_corner_2, self._slot_corner_3)
-        self._arc2 = Arc(self._arc_2_center, self._slot_corner_3, self._slot_corner_4)
+        self._arc2 = Arc(self._slot_corner_3, self._slot_corner_4, self._arc_2_center)
         self._segment2 = SketchSegment(self._slot_corner_4, self._slot_corner_1)
 
         self._edges.append(self._arc1)
diff --git a/tests/integration/test_plotter.py b/tests/integration/test_plotter.py
@@ -563,7 +563,7 @@ def test_visualization_polydata():
     assert polygon.visualization_polydata.n_open_edges == 5
 
     # Test for arc visualization polydata
-    arc = Arc(Point2D([10, 0]), Point2D([10, 10]), Point2D([10, -10]))
+    arc = Arc(Point2D([10, 10]), Point2D([10, -10]), Point2D([10, 0]))
     assert arc.visualization_polydata.center == ([5.0, 0.0, 0.0])
     assert arc.visualization_polydata.bounds == pytest.approx([0.0, 10.0, -10.0, 10.0, 0.0, 0.0])
     assert arc.visualization_polydata.n_faces == 2
diff --git a/tests/test_connection.py b/tests/test_connection.py
@@ -209,9 +209,9 @@ def test_arc_message_conversion():
     """Test conversion between :class:`Arc <ansys.geometry.core.sketch.arc.Arc>` and
     expected gRPC message type."""
     arc = Arc(
-        Point2D([500, 600], UNITS.mm),
         Point2D([100, 400], UNITS.mm),
         Point2D([900, 800], UNITS.mm),
+        Point2D([500, 600], UNITS.mm),
     )
     grpc_arc_message = sketch_arc_to_grpc_arc(arc, Plane(Point3D([10, 100, 1000], UNITS.mm)))
 
@@ -232,9 +232,9 @@ def test_arc_message_conversion():
     assert grpc_arc_message.axis.z == 1
 
     arc2 = Arc(
-        Point2D([600, 700], UNITS.mm),
         Point2D([200, 500], UNITS.mm),
         Point2D([1000, 900], UNITS.mm),
+        Point2D([600, 700], UNITS.mm),
         True,
     )
     grpc_arc_message2 = sketch_arc_to_grpc_arc(arc2, Plane(Point3D([10, 100, 1000], UNITS.mm)))
diff --git a/tests/test_sketch.py b/tests/test_sketch.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+docs: adapt ``ansys_sphinx_theme_autoapi`` extension for ``autoapi``
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+fix: adapting ``Arc`` class constructor order to (start, end, center)
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+build: bump grpcio from 1.63.0 to 1.64.0 in the grpc-deps group`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+build: bump the docs-deps group with 2 updates`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+chore: limit requests library version under 2.32`