Improve code structure

- Use super constructors and super methods
- Remove code duplications where possible
- Fixed typos

Author: gnikit

fortls/helper_functions.py

@@ -38,7 +38,7 @@ def expand_name(line: str, char_poss: int) -> str:
     regexs = [LOGICAL_REGEX, SQ_STRING_REGEX, DQ_STRING_REGEX, WORD_REGEX, NUMBER_REGEX]
     for r in regexs:
         for num_match in r.finditer(line):
-            if num_match.start(0) <= char_poss and num_match.end(0) >= char_poss:
+            if num_match.start(0) <= char_poss <= num_match.end(0):
                 return num_match.group(0)
     return ""
 
@@ -344,7 +344,7 @@ def get_keywords(keywords, keyword_info={}):
 def get_paren_substring(test_str):
     i1 = test_str.find("(")
     i2 = test_str.rfind(")")
-    if i1 > -1 and i2 > i1:
+    if -1 < i1 < i2:
         return test_str[i1 + 1 : i2]
     else:
         return None

fortls/intrinsics.py

@@ -54,17 +54,7 @@ def get_snippet(self, name_replace=None, drop_arg=-1):
             arg_snip = None
         else:
             arg_list = self.args.split(",")
-            place_holders = []
-            for i, arg in enumerate(arg_list):
-                opt_split = arg.split("=")
-                if len(opt_split) > 1:
-                    place_holders.append(
-                        "{1}=${{{0}:{2}}}".format(i + 1, opt_split[0], opt_split[1])
-                    )
-                else:
-                    place_holders.append("${{{0}:{1}}}".format(i + 1, arg))
-            arg_str = "({0})".format(", ".join(arg_list))
-            arg_snip = "({0})".format(", ".join(place_holders))
+            arg_str, arg_snip = self.get_placeholders(arg_list)
         name = self.name
         if name_replace is not None:
             name = name_replace
@@ -80,9 +70,6 @@ def get_signature(self):
         call_sig, _ = self.get_snippet()
         return call_sig, self.doc_str, arg_sigs
 
-    def get_documentation(self):
-        return self.doc_str
-
     def get_hover(self, long=False):
         return self.doc_str, False
 

fortls/jsonrpc.py

@@ -258,35 +258,11 @@ def write_rpc_notification(method, params):
 
 
 def read_rpc_messages(content):
-    def read_header_content_length(line):
-        if len(line) < 2 or line[-2:] != "\r\n":
-            raise JSONRPC2ProtocolError("Line endings must be \\r\\n")
-        if line.startswith("Content-Length: "):
-            _, value = line.split("Content-Length: ")
-            value = value.strip()
-            try:
-                return int(value)
-            except ValueError:
-                raise JSONRPC2ProtocolError(f"Invalid Content-Length header: {value}")
-
-    def receive_next():
-        line = content.readline()
-        if line == "":
-            raise EOFError()
-        length = read_header_content_length(line)
-        # Keep reading headers until we find the sentinel line
-        # for the JSON request.
-        while line != "\r\n":
-            line = content.readline()
-        body = content.read(length)
-        # log.debug("RECV %s", body)
-        return json.loads(body)
-
-    #
+    conn = JSONRPC2Connection(content)
     result_list = []
     while True:
         try:
-            result = receive_next()
+            result = conn._receive()
         except EOFError:
             break
         else:

fortls/langserver.py

@@ -206,12 +206,12 @@ def serve_initialize(self, request):
             datefmt="%H:%M:%S",
             level=logging.INFO,
         )
-        self.__config_logger(request)
+        self._config_logger(request)
         init_debug_log = self._load_config_file()
         if init_debug_log:
-            self.__config_logger(request)
-        self.__load_intrinsics()
-        self.__add_source_dirs()
+            self._config_logger(request)
+        self._load_intrinsics()
+        self._add_source_dirs()
 
         # Initialize workspace
         self.workspace_init()
@@ -905,7 +905,7 @@ def get_all_references(self, def_obj, type_mem, file_obj=None):
                             ref_match = True
                         elif var_def.parent.get_type() == CLASS_TYPE_ID:
                             if type_mem:
-                                for inherit_def in var_def.parent.get_overriden(
+                                for inherit_def in var_def.parent.get_overridden(
                                     def_name
                                 ):
                                     if def_fqsn == inherit_def.FQSN:
@@ -984,19 +984,7 @@ def serve_definition(self, request):
             return None
         # Construct link reference
         if var_obj.file_ast.file is not None:
-            var_file = var_obj.file_ast.file
-            sline, schar, echar = var_file.find_word_in_code_line(
-                var_obj.sline - 1, var_obj.name
-            )
-            if schar < 0:
-                schar = echar = 0
-            return {
-                "uri": path_to_uri(var_file.path),
-                "range": {
-                    "start": {"line": sline, "character": schar},
-                    "end": {"line": sline, "character": echar},
-                },
-            }
+            return self._create_ref_link(var_obj)
         return None
 
     def serve_hover(self, request: dict):
@@ -1052,7 +1040,7 @@ def create_signature_hover():
                     hover_array.append(create_hover(hover_str, highlight))
         elif self.variable_hover and (var_type == VAR_TYPE_ID):
             # Unless we have a Fortran literal include the desc in the hover msg
-            # See get_definition for an explanaiton about this default name
+            # See get_definition for an explanation about this default name
             if not var_obj.desc.startswith(FORTRAN_LITERAL):
                 hover_str, highlight = var_obj.get_hover()
                 hover_array.append(create_hover(hover_str, highlight))
@@ -1095,19 +1083,7 @@ def serve_implementation(self, request):
         if var_obj.parent.get_type() == CLASS_TYPE_ID:
             impl_obj = var_obj.link_obj
             if (impl_obj is not None) and (impl_obj.file_ast.file is not None):
-                impl_file = impl_obj.file_ast.file
-                sline, schar, echar = impl_file.find_word_in_code_line(
-                    impl_obj.sline - 1, impl_obj.name
-                )
-                if schar < 0:
-                    schar = echar = 0
-                return {
-                    "uri": path_to_uri(impl_file.path),
-                    "range": {
-                        "start": {"line": sline, "character": schar},
-                        "end": {"line": sline, "character": echar},
-                    },
-                }
+                return self._create_ref_link(impl_obj)
         return None
 
     def serve_rename(self, request):
@@ -1379,7 +1355,7 @@ def update_workspace_file(
 
     def workspace_init(self):
 
-        file_list = self.__get_source_files()
+        file_list = self._get_source_files()
         # Process files
         pool = Pool(processes=self.nthreads)
         results = {}
@@ -1440,13 +1416,13 @@ def _load_config_file(self) -> bool | None:
                 config_dict = json.load(jsonfile)
 
                 # Include and Exclude directories
-                self.__load_config_file_dirs(config_dict)
+                self._load_config_file_dirs(config_dict)
 
                 # General options
-                self.__load_config_file_general(config_dict)
+                self._load_config_file_general(config_dict)
 
                 # Preprocessor options
-                self.__load_config_file_preproc(config_dict)
+                self._load_config_file_preproc(config_dict)
 
                 # Debug options
                 debugging: bool = config_dict.get("debug_log", self.debug_log)
@@ -1467,7 +1443,7 @@ def _load_config_file(self) -> bool | None:
             self.post_messages.append([1, msg])
             log.error(msg)
 
-    def __load_config_file_dirs(self, config_dict: dict) -> None:
+    def _load_config_file_dirs(self, config_dict: dict) -> None:
         # Exclude paths (directories & files)
         # with glob resolution
         for path in config_dict.get("excl_paths", []):
@@ -1492,7 +1468,7 @@ def __load_config_file_dirs(self, config_dict: dict) -> None:
         self.FORTRAN_SRC_EXT_REGEX = src_file_exts(self.incl_suffixes)
         self.excl_suffixes = set(config_dict.get("excl_suffixes", []))
 
-    def __load_config_file_general(self, config_dict: dict) -> None:
+    def _load_config_file_general(self, config_dict: dict) -> None:
         # General options ------------------------------------------------------
         self.nthreads = config_dict.get("nthreads", self.nthreads)
         self.notify_init = config_dict.get("notify_init", self.notify_init)
@@ -1541,7 +1517,7 @@ def __load_config_file_general(self, config_dict: dict) -> None:
             "enable_code_actions", self.enable_code_actions
         )
 
-    def __load_config_file_preproc(self, config_dict: dict) -> None:
+    def _load_config_file_preproc(self, config_dict: dict) -> None:
         self.pp_suffixes = config_dict.get("pp_suffixes", None)  # TODO: set def
         self.pp_defs = config_dict.get("pp_defs", {})  # TODO: set other dif?
         if isinstance(self.pp_defs, list):
@@ -1552,7 +1528,7 @@ def __load_config_file_preproc(self, config_dict: dict) -> None:
                 only_dirs(resolve_globs(path, self.root_path), self.post_messages)
             )
 
-    def __add_source_dirs(self) -> None:
+    def _add_source_dirs(self) -> None:
         """Will recursively add all subdirectories that contain Fortran
         source files only if the option `source_dirs` has not been specified
         in the configuration file or no configuration file is present
@@ -1570,7 +1546,7 @@ def __add_source_dirs(self) -> None:
             if root not in self.source_dirs and root not in self.excl_paths:
                 self.source_dirs.add(str(Path(root).resolve()))
 
-    def __get_source_files(self) -> list[str]:
+    def _get_source_files(self) -> list[str]:
         """Get all the source files present in `self.source_dirs`,
         exclude any files found in `self.excl_paths`^ and ignore
         any files ending with `self.excl_suffixes`.
@@ -1603,7 +1579,7 @@ def __get_source_files(self) -> list[str]:
                 file_list.append(p)
         return file_list
 
-    def __config_logger(self, request) -> None:
+    def _config_logger(self, request) -> None:
         """Configures the logger to save Language Server requests/responses to a file
         the logger will by default output to the main (stderr, stdout) channels.
         """
@@ -1619,7 +1595,7 @@ def __config_logger(self, request) -> None:
         log.debug("REQUEST %s %s", request.get("id"), request.get("method"))
         self.post_messages.append([3, "FORTLS debugging enabled"])
 
-    def __load_intrinsics(self) -> None:
+    def _load_intrinsics(self) -> None:
         # Load intrinsics
         set_keyword_ordering(True)  # Always sort intrinsics
         if self.lowercase_intrinsics:
@@ -1635,6 +1611,20 @@ def __load_intrinsics(self) -> None:
         # Set object settings
         set_keyword_ordering(self.sort_keywords)
 
+    def _create_ref_link(self, obj):
+        """Create a link reference to an object"""
+        obj_file = obj.file_ast.file
+        sline, schar, echar = obj_file.find_word_in_code_line(obj.sline - 1, obj.name)
+        if schar < 0:
+            schar = echar = 0
+        return {
+            "uri": path_to_uri(obj_file.path),
+            "range": {
+                "start": {"line": sline, "character": schar},
+                "end": {"line": sline, "character": echar},
+            },
+        }
+
 
 class JSONRPC2Error(Exception):
     def __init__(self, code, message, data=None):