fix(api): Make locations a publicly documented class (#2375)

Author: PProfizi

src/ansys/dpf/core/common.py

@@ -28,12 +28,79 @@
 from typing import Dict
 
 from ansys.dpf.core.misc import module_exists
-from ansys.dpf.gate.common import ProgressBarBase, locations  # noqa: F401
+from ansys.dpf.gate.common import (
+    ProgressBarBase,  # noqa: F401
+)
 from ansys.dpf.gate.dpf_vector import (  # noqa: F401
     get_size_of_list as _get_size_of_list,
 )
 
 
+class locations:
+    """Contains strings for scoping and field locations.
+
+    Attributes
+    ----------
+    none = "none"
+
+    elemental = "Elemental"
+        data is one per element
+
+    elemental_nodal = "ElementalNodal"
+        one per node per element
+
+    nodal = "Nodal"
+        one per node
+
+    time_freq = "TimeFreq_sets"
+        one per time set
+
+    overall = "overall"
+        applies everywhere
+
+    time_freq_step = "TimeFreq_steps"
+        one per time step
+
+    faces = "Faces"
+        one per face
+
+    zone = "zone"
+        one per zone
+
+    elemental_and_faces = "ElementalAndFaces"
+        data available in elements and faces of the model
+    """
+
+    none = "none"
+
+    # data is one per element
+    elemental = "Elemental"
+
+    # one per node per element
+    elemental_nodal = "ElementalNodal"
+
+    # one per node
+    nodal = "Nodal"
+
+    # one per time set
+    time_freq = "TimeFreq_sets"
+
+    # applies everywhere
+    overall = "overall"
+
+    # one per time step
+    time_freq_step = "TimeFreq_steps"
+
+    # one per face
+    faces = "Faces"
+
+    # one per zone
+    zone = "zone"
+
+    # data available in elements and faces of the model
+    elemental_and_faces = "ElementalAndFaces"
+
+
 def _camel_to_snake_case(name):
     return re.sub(r"(?<!^)(?=[A-Z])", "_", name).lower()
 

src/ansys/dpf/gate/common.py

@@ -1,71 +1,5 @@
 import abc
 
-
-class locations:
-    """Contains strings for scoping and field locations.
-
-    Attributes
-    -----------
-    none = "none"
-
-    elemental = "Elemental"
-        data is one per element
-
-    elemental_nodal = "ElementalNodal"
-        one per node per element
-
-    nodal = "Nodal"
-        one per node
-
-    time_freq = "TimeFreq_sets"
-        one per time set
-
-    overall = "overall"
-        applies everywhere
-
-    time_freq_step = "TimeFreq_steps"
-        one per time step
-
-    faces = "Faces"
-        one per face
-
-    zone = "zone"
-        one per zone
-
-    elemental_and_faces = "ElementalAndFaces"
-        data available in elements and faces of the model
-    """
-
-    none = "none"
-
-    # data is one per element
-    elemental = "Elemental"
-
-    # one per node per element
-    elemental_nodal = "ElementalNodal"
-
-    # one per node
-    nodal = "Nodal"
-
-    # one per time set
-    time_freq = "TimeFreq_sets"
-
-    # applies everywhere
-    overall = "overall"
-
-    # one per time step
-    time_freq_step = "TimeFreq_steps"
-
-    # one per face
-    faces = "Faces"
-
-    # one per zone
-    zone = "zone"
-
-    # data available in elements and faces of the model
-    elemental_and_faces = "ElementalAndFaces"
-
-
 elemental_property_type_dict = {
     "eltype": "ELEMENT_TYPE",
     "elshape": "ELEMENT_SHAPE",

src/ansys/dpf/gate/meshed_region_grpcapi.py

@@ -51,23 +51,23 @@ def meshed_region_get_num_faces(meshedRegion):
     @staticmethod
     def meshed_region_get_shared_nodes_scoping(meshedRegion):
         from ansys.grpc.dpf import meshed_region_pb2
-        from ansys.dpf.gate.common import locations
+        from ansys.dpf.core.common import locations
         request = meshed_region_pb2.GetScopingRequest(mesh=meshedRegion._internal_obj)
         request.loc.location = locations.nodal
         return _get_stub(meshedRegion._server).GetScoping(request)
 
     @staticmethod
     def meshed_region_get_shared_elements_scoping(meshedRegion):
         from ansys.grpc.dpf import meshed_region_pb2
-        from ansys.dpf.gate.common import locations
+        from ansys.dpf.core.common import locations
         request = meshed_region_pb2.GetScopingRequest(mesh=meshedRegion._internal_obj)
         request.loc.location = locations.elemental
         return _get_stub(meshedRegion._server).GetScoping(request)
 
     @staticmethod
     def meshed_region_get_shared_faces_scoping(meshedRegion):
         from ansys.grpc.dpf import meshed_region_pb2
-        from ansys.dpf.gate.common import locations
+        from ansys.dpf.core.common import locations
         request = meshed_region_pb2.GetScopingRequest(mesh=meshedRegion._internal_obj)
         request.loc.location = locations.elemental_nodal
         return _get_stub(meshedRegion._server).GetScoping(request)