checking code style

Author: zhangzhanqun

src/ansys/dyna/core/pre/__init__.py

@@ -2,22 +2,13 @@
 import logging
 import os
 
-import appdirs
-
 from ansys.dyna.core.pre.dynalogging import Logger
 
 LOG = Logger(level=logging.ERROR, to_file=False, to_stdout=True)
 LOG.debug("Loaded logging module as LOG")
 
 _LOCAL_PORTS = []
 
-try:
-    import importlib.metadata as importlib_metadata
-except ModuleNotFoundError:  # pragma: no cover
-    import importlib_metadata
-
-# __version__ = importlib_metadata.version(__name__.replace(".", "-"))
-
 from .dynabase import *
 from .dynadem import DynaDEM
 from .dynaicfd import DynaICFD

src/ansys/dyna/core/pre/dynalogging.py

@@ -35,16 +35,16 @@
 
 .. code:: python
 
-   LOG.logger.setLevel('DEBUG')
-   LOG.file_handler.setLevel('DEBUG')  # If present.
-   LOG.stdout_handler.setLevel('DEBUG')  # If present.
+   LOG.logger.setLevel("DEBUG")
+   LOG.file_handler.setLevel("DEBUG")  # If present.
+   LOG.stdout_handler.setLevel("DEBUG")  # If present.
 
 
 Alternatively:
 
 .. code:: python
 
-   LOG.setLevel('DEBUG')
+   LOG.setLevel("DEBUG")
 
 This way ensures all the handlers are set to the input log level.
 
@@ -54,7 +54,8 @@
 .. code:: python
 
    import os
-   file_path = os.path.join(os.getcwd(), 'pydyna.log')
+
+   file_path = os.path.join(os.getcwd(), "pydyna.log")
    LOG.log_to_file(file_path)
 
 This sets the logger to be redirected also to that file.  If you wish
@@ -64,15 +65,6 @@
 
 To log using this logger, just call the desired method as a normal logger.
 
-.. code:: python
-
-    >>> import logging
-    >>> from ansys.dyna.core.pre.logging import Logger
-    >>> LOG = Logger(level=logging.DEBUG, to_file=False, to_stdout=True)
-    >>> LOG.debug('This is LOG debug message.')
-
-    DEBUG -  -  <ipython-input-24-80df150fe31f> - <module> - This is LOG debug message.
-
 
 Instance Logger
 ~~~~~~~~~~~~~~~
@@ -89,17 +81,6 @@
 :func:`log_to_file() <PymapdlCustomAdapter.log_to_file>` or change the log level
 using :func:`logger.Logging.setLevel`.
 
-You can use this logger like this:
-
-.. code:: python
-    >>> from ansys.dyna.core.pre import launch_mapdl
-    >>> mapdl = launch_mapdl()
-    >>> mapdl._log.info('This is a useful message')
-
-    INFO - GRPC_127.0.0.1:50056 -  <ipython-input-19-f09bb2d8785c> - <module> - This is a useful message
-
-
-
 Other loggers
 ~~~~~~~~~~~~~
 You can create your own loggers using python ``logging`` library as
@@ -127,9 +108,7 @@
 
 ## Formatting
 
-STDOUT_MSG_FORMAT = (
-    "%(levelname)s - %(instance_name)s -  %(module)s - %(funcName)s - %(message)s"
-)
+STDOUT_MSG_FORMAT = "%(levelname)s - %(instance_name)s -  %(module)s - %(funcName)s - %(message)s"
 
 FILE_MSG_FORMAT = STDOUT_MSG_FORMAT
 
@@ -180,9 +159,7 @@ def __init__(self, logger, extra=None):
     def process(self, msg, kwargs):
         kwargs["extra"] = {}
         # This are the extra parameters sent to log
-        kwargs["extra"][
-            "instance_name"
-        ] = self.extra.name  # here self.extra is the argument pass to the log records.
+        kwargs["extra"]["instance_name"] = self.extra.name  # here self.extra is the argument pass to the log records.
         return msg, kwargs
 
     def log_to_file(self, filename=FILE_NAME, level=LOG_LEVEL):
@@ -196,9 +173,7 @@ def log_to_file(self, filename=FILE_NAME, level=LOG_LEVEL):
             Level of logging. E.x. 'DEBUG'. By default LOG_LEVEL
         """
 
-        self.logger = addfile_handler(
-            self.logger, filename=filename, level=level, write_headers=True
-        )
+        self.logger = addfile_handler(self.logger, filename=filename, level=level, write_headers=True)
         self.file_handler = self.logger.file_handler
 
     def log_to_stdout(self, level=LOG_LEVEL):
@@ -320,9 +295,7 @@ class Logger:
     _level = logging.DEBUG
     _instances = {}
 
-    def __init__(
-        self, level=logging.DEBUG, to_file=False, to_stdout=True, filename=FILE_NAME
-    ):
+    def __init__(self, level=logging.DEBUG, to_file=False, to_stdout=True, filename=FILE_NAME):
         """Customized logger class for PyDyna-Pre.
 
         Parameters
@@ -471,13 +444,9 @@ def add_child_logger(self, sufix, level=None):
 
     def _add_mapdl_instance_logger(self, name, mapdl_instance, level):
         if isinstance(name, str):
-            instance_logger = PymapdlCustomAdapter(
-                self._make_child_logger(name, level), mapdl_instance
-            )
+            instance_logger = PymapdlCustomAdapter(self._make_child_logger(name, level), mapdl_instance)
         elif not name:  # pragma: no cover
-            instance_logger = PymapdlCustomAdapter(
-                self._make_child_logger("NO_NAMED_YET", level), mapdl_instance
-            )
+            instance_logger = PymapdlCustomAdapter(self._make_child_logger("NO_NAMED_YET", level), mapdl_instance)
         else:
             raise ValueError("You can only input 'str' classes to this method.")
 
@@ -516,9 +485,7 @@ def add_instance_logger(self, name, mapdl_instance, level=None):
             count_ += 1
             new_name = name + "_" + str(count_)
 
-        self._instances[new_name] = self._add_mapdl_instance_logger(
-            new_name, mapdl_instance, level
-        )
+        self._instances[new_name] = self._add_mapdl_instance_logger(new_name, mapdl_instance, level)
         return self._instances[new_name]
 
     def __getitem__(self, key):
@@ -534,9 +501,7 @@ def handle_exception(exc_type, exc_value, exc_traceback):
             if issubclass(exc_type, KeyboardInterrupt):
                 sys.__excepthook__(exc_type, exc_value, exc_traceback)
                 return
-            logger.critical(
-                "Uncaught exception", exc_info=(exc_type, exc_value, exc_traceback)
-            )
+            logger.critical("Uncaught exception", exc_info=(exc_type, exc_value, exc_traceback))
 
         sys.excepthook = handle_exception
 

src/ansys/dyna/core/pre/errors.py

@@ -1,10 +1,5 @@
 """pydyna specific errors"""
 
-from functools import wraps
-
-from grpc._channel import _InactiveRpcError, _MultiThreadedRendezvous
-
-from ansys.dyna.core.pre import LOG as logger
 
 SIGINT_TRACKER = []
 
@@ -51,4 +46,3 @@ class KwserverDidNotStart(RuntimeError):
 
     def __init__(self, msg=""):
         RuntimeError.__init__(self, msg)
-

src/ansys/dyna/core/pre/launcher.py

@@ -6,10 +6,7 @@
 import threading
 
 from ansys.dyna.core.pre import LOG
-from ansys.dyna.core.pre.misc import (
-    check_valid_ip,
-    check_valid_port,
-)
+from ansys.dyna.core.pre.misc import check_valid_ip, check_valid_port
 
 LOCALHOST = "127.0.0.1"
 DYNAPRE_DEFAULT_PORT = 50051
@@ -39,42 +36,38 @@ def port_in_use(port, host=LOCALHOST):
             return True
 
 
-def launch_grpc(
-    port=DYNAPRE_DEFAULT_PORT,
-    ip=LOCALHOST,
-    server_path = None
-) -> tuple:  # pragma: no cover
+def launch_grpc(port=DYNAPRE_DEFAULT_PORT, ip=LOCALHOST, server_path=None) -> tuple:  # pragma: no cover
     """Start kwserver locally in gRPC mode.
     Parameters
     ----------
     port : int
         Port to launch PyDyna gRPC on.  Final port will be the first
         port available after (or including) this port.
-    
+
     Returns
     -------
     int
         Returns the port number that the gRPC instance started on.
 
     """
     LOG.debug("Starting 'launch_kwserver'.")
-    
+
     command = "python kwserver.py"
     LOG.debug(f"Starting kwserver with command: {command}")
 
-    #env_vars = update_env_vars(add_env_vars, replace_env_vars)
+    # env_vars = update_env_vars(add_env_vars, replace_env_vars)
     LOG.info(f"Running in {ip}:{port} the following command: '{command}'")
 
     LOG.debug("kwserver starting in background.")
-    process = subprocess.Popen(['python','kwserver.py'],cwd = server_path ,shell=True)
+    process = subprocess.Popen(["python", "kwserver.py"], cwd=server_path, shell=True)
     process.wait()
     # while True:
     #     pass
     return port
 
 
 class ServerThread(threading.Thread):
-    def __init__(self,threadID,port,ip,server_path):
+    def __init__(self, threadID, port, ip, server_path):
         threading.Thread.__init__(self)
         self.threadID = threadID
         self.port = port
@@ -83,7 +76,7 @@ def __init__(self,threadID,port,ip,server_path):
         self.process = None
 
     def run(self):
-        self.process = launch_grpc(ip=self.ip,port=self.port,server_path=self.server_path)
+        self.process = launch_grpc(ip=self.ip, port=self.port, server_path=self.server_path)
 
     def termination(self):
         self.process.termination()
@@ -97,7 +90,7 @@ def launch_dynapre(
     Parameters
     ----------
     port : int
-        Port to launch MAPDL gRPC on. 
+        Port to launch MAPDL gRPC on.
     ip : bool, optional
         Specify the IP address of the PyDyna instance to connect to.
         You can also provide a hostname as an alternative to an IP address.
@@ -115,7 +108,7 @@ def launch_dynapre(
     if (ip.lower() == "localhost" or ip == LOCALHOST) and not DynaSolution.grpc_local_server_on():
         LOG.debug("Starting kwserver")
         server_path = os.path.join(os.getcwd(), "../../src/ansys/dyna/core/pre/Server")
-        threadserver = ServerThread(1,port=port,ip=ip,server_path=server_path)
+        threadserver = ServerThread(1, port=port, ip=ip, server_path=server_path)
         threadserver.setDaemon(True)
         threadserver.start()
 
@@ -126,9 +119,10 @@ def launch_dynapre(
 
     # return dynasln
 
+
 if __name__ == "__main__":
     server_path = os.path.join(os.getcwd(), "Server")
-    process = subprocess.Popen(['python','kwserver.py'],cwd = server_path ,shell=True)
+    process = subprocess.Popen(["python", "kwserver.py"], cwd=server_path, shell=True)
     process.wait()
     process.terminate()
-    print(process)
+    print(process)

src/ansys/dyna/core/pre/misc.py

@@ -1,19 +1,16 @@
 """Module for miscellaneous functions and methods"""
-from functools import wraps
 import inspect
 import os
 import random
 import socket
 import string
 import sys
 import tempfile
-from warnings import warn
-
-from ansys.dyna.core.pre import LOG
 
 # path of this module
 MODULE_PATH = os.path.dirname(inspect.getfile(inspect.currentframe()))
 
+
 class Plain_Report:
     def __init__(self, core, optional=None, additional=None, **kwargs):
         """
@@ -54,8 +51,8 @@ def __init__(self, core, optional=None, additional=None, **kwargs):
             except RuntimeError as e:  # pragma: no cover
                 self.kwargs["extra_meta"] = ("GPU Details", f"Error: {str(e)}")
         else:
-            self.kwargs["extra_meta"] = ("GPU Details", "None")  
-            
+            self.kwargs["extra_meta"] = ("GPU Details", "None")
+
     def get_version(self, package):
         try:
             import importlib.metadata as importlib_metadata
@@ -78,34 +75,20 @@ def __repr__(self):
         ]
 
         core = ["\nCore packages", "-------------"]
-        core.extend(
-            [
-                f"{each.ljust(20)}: {self.get_version(each)}"
-                for each in self.core
-                if self.get_version(each)
-            ]
-        )
+        core.extend([f"{each.ljust(20)}: {self.get_version(each)}" for each in self.core if self.get_version(each)])
 
         if self.optional:
             optional = ["\nOptional packages", "-----------------"]
             optional.extend(
-                [
-                    f"{each.ljust(20)}: {self.get_version(each)}"
-                    for each in self.optional
-                    if self.get_version(each)
-                ]
+                [f"{each.ljust(20)}: {self.get_version(each)}" for each in self.optional if self.get_version(each)]
             )
         else:
             optional = [""]
 
         if self.additional:
             additional = ["\nAdditional packages", "-----------------"]
             additional.extend(
-                [
-                    f"{each.ljust(20)}: {self.get_version(each)}"
-                    for each in self.additional
-                    if self.get_version(each)
-                ]
+                [f"{each.ljust(20)}: {self.get_version(each)}" for each in self.additional if self.get_version(each)]
             )
         else:
             additional = [""]
@@ -126,6 +109,7 @@ def is_float(input_string):
     except ValueError:
         return False
 
+
 def random_string(stringLength=10, letters=string.ascii_lowercase):
     """Generate a random string of fixed length"""
     return "".join(random.choice(letters) for i in range(stringLength))
@@ -151,8 +135,7 @@ def create_temp_dir(tmpdir=None):
         os.mkdir(path)
     except:
         raise RuntimeError(
-            "Unable to create temporary working "
-            "directory %s\n" % path + "Please specify run_location="
+            "Unable to create temporary working " "directory %s\n" % path + "Please specify run_location="
         )
 
     return path
@@ -172,6 +155,4 @@ def check_valid_port(port, lower_bound=1000, high_bound=60000):
     if lower_bound < port < high_bound:
         return
     else:
-        raise ValueError(
-            f"'port' values should be between {lower_bound} and {high_bound}."
-        )
+        raise ValueError(f"'port' values should be between {lower_bound} and {high_bound}.")