Fix line lengths for comments and docstrings (#78)

* Fix line lengths

* Update flake8 config

* Apply suggestions from code review

Co-authored-by: Alex Kaszynski <[email protected]>

* Remove random test

* Apply suggestions from code review

Co-authored-by: Alex Kaszynski <[email protected]>

* Update ansys/dpf/core/time_freq_support.py

Co-authored-by: Alex Kaszynski <[email protected]>

* Remove whitespace

* Fix failing doc test

* Fix field doc string

* Move noqa to next line for docstring

* Remove noqa to test docstring

* Ignore docstring output line lengths

* Fix model displacement

Co-authored-by: Alex Kaszynski <[email protected]>

Author: jleonatti

.flake8

@@ -1,7 +1,6 @@
 [flake8]
-# To be added once code is refactored: E501
 exclude = venv, ansys/dpf/core/operators
-select = W191, W391, E115, E117, E122, E124, E125, E301, W291, W293, E225, E231, E303, F401, F403
+select = W191, W391, E115, E117, E122, E124, E125, E301, W291, W293, E225, E231, E303, E501, F401, F403
 per-file-ignores = __init__.py:F401,F403
 count = True
 max-complexity = 10

ansys/dpf/core/aeneid.py

@@ -14,7 +14,8 @@ def start_server_using_service_manager():  # pragma: no cover
         )
     else:
         raise ValueError(
-            "Module grpc_interceptor_headers is missing. To use Service Manager, install it using pip install grpc_interceptor_headers."
+            "Module grpc_interceptor_headers is missing. To use Service "
+            "Manager, install it using pip install grpc_interceptor_headers."
         )
 
     service_manager_url = f"http://{LOCALHOST}:8089/v1"

ansys/dpf/core/common.py

@@ -51,22 +51,32 @@ def __write_enum_doc__(enum, intro=None):
 types = Enum("types", names)
 types.__doc__ = __write_enum_doc__(
     types,
-    "The ``'types'`` enum contains the available types passed through operators and workflows to DPF.",
+    (
+        "The ``'types'`` enum contains the available types passed "
+        "through operators and workflows to DPF."
+    ),
 )
 
 names = [(m.lower(), num) for m, num in base_pb2.Nature.items()]
 natures = Enum("natures", names)
 natures.__doc__ = __write_enum_doc__(
     natures,
-    "The ``'natures'`` enum contains the dimensionality types.\n It can be used to create a field of a given dimensionality.",
+    (
+        "The ``'natures'`` enum contains the dimensionality types.\n "
+        "It can be used to create a field of a given dimensionality."
+    ),
 )
 
 
 names = [(m.lower(), num - 1) for m, num in field_definition_pb2.ShellLayers.items()]
 shell_layers = Enum("shell_layers", names)
 shell_layers.__doc__ = __write_enum_doc__(
     shell_layers,
-    "The ``'shell_layers'`` enum contains the available order of shell layers (or lack of shell layers) that defines how the field's data is ordered.",
+    (
+        "The ``'shell_layers'`` enum contains the available order of "
+        "shell layers (or lack of shell layers) that defines how the "
+        "field's data is ordered."
+    ),
 )
 
 

ansys/dpf/core/core.py

@@ -247,8 +247,9 @@ def _description(dpf_entity_message, server=None):
 
     Parameters
     ----------
-    dpf_entity_message : core.Operator._message, core.Workflow._message, core.Scoping._message, core.Field._message,
-    core.FieldContainer._message, core.MeshedRegion._message...
+    dpf_entity_message : core.Operator._message, core.Workflow._message,
+                         core.Scoping._message, core.Field._message,
+                         core.FieldContainer._message, core.MeshedRegion._message
 
     server : server.DPFServer, optional
         Server with channel connected to the remote or local instance. When
@@ -313,7 +314,8 @@ def _connect(self, timeout=5):
 
             if not state._matured:
                 raise IOError(
-                    f"Unable to connect to DPF instance at {self._server()._input_ip} {self._server()._input_port}"
+                    f"Unable to connect to DPF instance at {self._server()._input_ip} "
+                    f"{self._server()._input_port}"
                 )
 
         return stub
@@ -419,7 +421,8 @@ def _description(self, dpf_entity_message):
 
         Parameters
         ----------
-        dpf_entity_message : core.Operator._message, core.Workflow._message, core.Scoping._message, core.Field._message,
+        dpf_entity_message : core.Operator._message, core.Workflow._message,
+                             core.Scoping._message, core.Field._message,
         core.FieldContainer._message, core.MeshedRegion._message...
 
         Returns

ansys/dpf/core/cyclic_support.py

@@ -167,8 +167,8 @@ def base_elements_scoping(self, stage_num=0) -> int:
         )
 
     def sectors_set_for_expansion(self, stage_num=0) -> int:
-        """Retrieve a sector's scoping of the already expanded results and mesh or the list of sectors that will
-        be expanded by default.
+        """Retrieve a sector's scoping of the already expanded results
+        and mesh or the list of sectors that will be expanded by default.
 
         A sector's scoping starts from 0, with the maximum equal to num_sectors-1.
 

ansys/dpf/core/dpf_operator.py

@@ -111,7 +111,9 @@ def connect(self, pin, inpt, pin_out=0):
         ----------
         pin : int
             Number of the input pin.
-        inpt :  str, int, double, bool, list of int, list of doubles, Field, FieldsContainer, Scoping, ScopingsContainer, MeshedRegion, MeshesContainer, DataSources, Operator
+        inpt : str, int, double, bool, list of int, list of doubles,
+               Field, FieldsContainer, Scoping, ScopingsContainer, MeshedRegion,
+               MeshesContainer, DataSources, Operator
             Object to connect to.
         pin_out : int, optional
             If the input is an operator, the output pin of the input operator. The

ansys/dpf/core/element_descriptor.py

@@ -39,7 +39,7 @@ class ElementDescriptor:
     >>> from ansys.dpf import core as dpf
     >>> descriptor = dpf.ElementDescriptor(10, "Linear 4-nodes Tetrahedron", "tet4", "solid", 4, 0, 4, True, False, False, False)
 
-    """
+    """  # noqa: E501
 
     def __init__(
         self,

ansys/dpf/core/elements.py

@@ -16,7 +16,8 @@
 class Element:
     """Contains all properties of an element of a mesh.
 
-    The element is created from the :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>` class.
+    The element is created from the
+    :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>` class.
     Properties include the element ID, index, type, shape, and connectivity.
 
     Parameters
@@ -136,7 +137,8 @@ def type(self) -> int:
         Returns
         -------
         int
-            Type of the element. For more information, see :class:`ansys.dpf.core.elements.element_types`.
+            Type of the element. For more information, see
+            :class:`ansys.dpf.core.elements.element_types`.
 
         Examples
         --------

ansys/dpf/core/examples/downloads.py

@@ -250,7 +250,7 @@ def download_msup_files_to_dict() -> dict:
     >>> paths
     {'rfrq': 'C:\\Users\\user\\AppData\\Local\\ansys-dpf-core\\ansys-dpf-core\\examples\\msup\\file.rfrq',
      'mode': 'C:\\Users\\user\\AppData\\Local\\ansys-dpf-core\\ansys-dpf-core\\examples\\msup\\file.mode',
-     'rst': 'C:\\Users\\user\\AppData\\Local\\ansys-dpf-core\\ansys-dpf-core\\examples\\msup\\file.rst'}
+     'rst': 'C:\\Users\\user\\AppData\\Local\\ansys-dpf-core\\ansys-dpf-core\\examples\\msup\\file.rst'} # noqa: E501
 
     """
     return {
@@ -280,7 +280,7 @@ def download_distributed_files() -> dict:
     >>> paths = examples.download_distributed_files()
     >>> paths
     {0: 'C:\\Users\\user\\AppData\\Local\\ansys-dpf-core\\ansys-dpf-core\\examples\\distributed\\file0.rst',
-     1: 'C:\\Users\\user\\AppData\\Local\\ansys-dpf-core\\ansys-dpf-core\\examples\\distributed\\file1.rst'}
+     1: 'C:\\Users\\user\\AppData\\Local\\ansys-dpf-core\\ansys-dpf-core\\examples\\distributed\\file1.rst'} # noqa: E501
 
     """
     return {
@@ -309,7 +309,7 @@ def download_fluent_files() -> dict:
     >>> paths = examples.download_fluent_files()
     >>> paths
     {'cas': 'C:\\Users\\cbellot\\AppData\\Local\\ansys-dpf-core\\ansys-dpf-core\\examples\\fluent\\FFF.cas.h5',
-     'dat': 'C:\\Users\\cbellot\\AppData\\Local\\ansys-dpf-core\\ansys-dpf-core\\examples\\fluent\\FFF.dat.h5'}
+     'dat': 'C:\\Users\\cbellot\\AppData\\Local\\ansys-dpf-core\\ansys-dpf-core\\examples\\fluent\\FFF.dat.h5'} # noqa: E501
 
     """
     return {
@@ -319,15 +319,17 @@ def download_fluent_files() -> dict:
 
 
 def download_extrapolation_3d_result() -> dict:
-    """Download example static results of reference and integrated points for extrapolation of 3d-element and return return the dictionary of 2 download paths.
+    """Download example static results of reference and integrated points
+    for extrapolation of 3d-element and return return the dictionary of 2 download paths.
 
     Examples files are downloaded to a persistent cache to avoid
     re-downloading the same file twice.
 
     Returns
     -------
     dict
-        containing path to the example file of ref and path to the example file of integrated points.
+        containing path to the example file of ref and path to the example
+        file of integrated points.
 
     Examples
     --------
@@ -336,7 +338,10 @@ def download_extrapolation_3d_result() -> dict:
     >>> from ansys.dpf.core import examples
     >>> dict = examples.download_extrapolation_ref_result
     >>> dict
-    {'file_ref': 'C:/Users/user/AppData/local/temp/file_ref.rst', 'file_integrated': 'C:/Users/user/AppData/local/temp/file.rst'}
+    {
+        'file_ref': 'C:/Users/user/AppData/local/temp/file_ref.rst',
+        'file_integrated': 'C:/Users/user/AppData/local/temp/file.rst'
+    }
 
     """
     dict = {
@@ -348,15 +353,17 @@ def download_extrapolation_3d_result() -> dict:
 
 
 def download_extrapolation_2d_result() -> dict:
-    """Download example static results of reference and integrated points for extrapolation of 2d-element and return the dictionary of 2 download paths.
+    """Download example static results of reference and integrated points
+    for extrapolation of 2d-element and return the dictionary of 2 download paths.
 
     Examples files are downloaded to a persistent cache to avoid
     re-downloading the same file twice.
 
     Returns
     -------
     dict
-        containing path to the example file of ref and path to the example file of integrated points.
+        Contains path to the example file of ref and path to the example
+        file of integrated points.
 
      Examples
     --------
@@ -365,7 +372,10 @@ def download_extrapolation_2d_result() -> dict:
     >>> from ansys.dpf.core import examples
     >>> dict = examples.download_extrapolation_ref_result
     >>> dict
-    {'file_ref': 'C:/Users/user/AppData/local/temp/extrapolate_2d_ref.rst', 'file_integrated': 'C:/Users/user/AppData/local/temp/extrapolate_2d.rst'}
+    {
+        'file_ref': 'C:/Users/user/AppData/local/temp/extrapolate_2d_ref.rst',
+        'file_integrated': 'C:/Users/user/AppData/local/temp/extrapolate_2d.rst'
+    }
 
     """
     dict = {

ansys/dpf/core/field.py

@@ -20,8 +20,9 @@ class Field(_FieldBase):
     This can be evaluated data from the :class:`Operator <ansys.dpf.core.Operator>` class
     or created by a factory and directly by an instance of this class.
 
-    A field's data is always associated to its scoping (entities associated to each value)
-    and support (subset of the model where the data is), making the field a self-describing piece of data.
+    A field's data is always associated to its scoping (entities
+    associated to each value) and support (subset of the model where the
+    data is), making the field a self-describing piece of data.
 
     Parameters
     ----------
@@ -140,7 +141,7 @@ def as_local_field(self):
         (array([[0.3, 0.6, 0.9],
                [0.3, 0.6, 0.9]]), [[0.30000000000000004, 0.6000000000000001, 0.8999999999999999], [0.30000000000000004, 0.6000000000000001, 0.8999999999999999]])
 
-        """
+        """  # noqa: E501
         return _LocalField(self)
 
     @property
@@ -413,7 +414,8 @@ def _get_meshed_region(self):
             return meshed_region.MeshedRegion(mesh=message, server=self._server)
         except:
             raise RuntimeError(
-                "The field's support is not a mesh.  Try to retrieve the time frequency support."
+                "The field's support is not a mesh. "
+                "Try to retrieve the time frequency support."
             )
 
     def _get_time_freq_support(self):
@@ -653,7 +655,7 @@ class _LocalField(_LocalFieldBase, Field):
     (array([[0.3, 0.6, 0.9],
            [0.3, 0.6, 0.9]]), [[0.30000000000000004, 0.6000000000000001, 0.8999999999999999], [0.30000000000000004, 0.6000000000000001, 0.8999999999999999]])
 
-    """
+    """  # noqa: E501
 
     def __init__(self, field):
         super().__init__(field)