Merge pull request #25 from gnikit/bug/visibility-modules

Bug/visibility modules

Author: gnikit

.github/workflows/python-publish.yml

@@ -41,7 +41,15 @@ jobs:
 
       - name: Set __version__
         shell: bash
-        run: sed -i "s/PLACEHOLDER/${VERSION}/g" "fortls/_version.py"
+        run: sed -i "s@\".*\"@\"${VERSION}\"@g" "fortls/_version.py"
+
+      - name: Commit the new version
+        shell: bash
+        run: |
+          git config --global user.name 'gnikit'
+          git config --global user.email '[email protected]'
+          git commit fortls/_version.py -am "Auto-Update version"
+          git push
 
       - name: Build package
         run: python -m build

.gitignore

@@ -9,4 +9,5 @@ docs/fortls_changes.md
 
 *.o
 *.mod
+*.smod
 *.log

CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELONG
 
+## 2.0.1
+
+### Added
+
+- Add support for absolute include, source and exclude paths
+
+### Changed
+
+- Changed `USE_info` named tuple to storing use modules as `sets` instead of `lists`
+- Changed `include_dirs` from a `list` to a `set`
+
+### Fixed
+
+- Fixed some mutable default argument warnings in methods and classes
+- Fixed private variables showing in autocomplete
+  ([#191](https://github.com/hansec/fortran-language-server/issues/191))
+  ([gnikit/fortls#3](https://github.com/gnikit/fortls/issues/3))
+
 ## 2.0.0
 
 ### Added

fortls/__init__.py

@@ -461,7 +461,7 @@ def debug_server_parser(args):
     # Get preprocessor definitions from config file
     pp_suffixes = None
     pp_defs = {}
-    include_dirs = []
+    include_dirs = set()
     if args.debug_rootpath:
         config_path = os.path.join(args.debug_rootpath, args.config)
         config_exists = os.path.isfile(config_path)
@@ -471,9 +471,9 @@ def debug_server_parser(args):
                     config_dict = json.load(fhandle)
                     pp_suffixes = config_dict.get("pp_suffixes", None)
                     pp_defs = config_dict.get("pp_defs", {})
-                    include_dirs = []
-                    for path in config_dict.get("include_dirs", []):
-                        include_dirs.extend(
+                    include_dirs = set()
+                    for path in config_dict.get("include_dirs", set()):
+                        include_dirs.update(
                             only_dirs(resolve_globs(path, args.debug_rootpath))
                         )
 

fortls/helper_functions.py

@@ -258,7 +258,7 @@ def get_line_prefix(pre_lines: list, curr_line: str, col: int, qs: bool = True)
 
 
 def resolve_globs(glob_path: str, root_path: str = None) -> list[str]:
-    """Resolve glob patterns
+    """Resolve paths (absolute and relative) and glob patterns
 
     Parameters
     ----------
@@ -277,16 +277,14 @@ def resolve_globs(glob_path: str, root_path: str = None) -> list[str]:
         Expanded glob patterns with absolute paths.
         Absolute paths are used to resolve any potential ambiguity
     """
-    # Path.glob returns a generator, we then cast the Path obj to a str
-    # alternatively use p.as_posix()
-    if root_path:
-        return [str(p) for p in Path(root_path).resolve().glob(glob_path)]
-    # Attempt to extract the root and glob pattern from the glob_path
-    # This is substantially less robust that then above
+    # Resolve absolute paths i.e. not in our root_path
+    if os.path.isabs(glob_path) or not root_path:
+        p = Path(glob_path).resolve()
+        root = p.root
+        rel = str(p.relative_to(root))  # contains glob pattern
+        return [str(p.resolve()) for p in Path(root).glob(rel)]
     else:
-        p = Path(glob_path).expanduser()
-        parts = p.parts[p.is_absolute() :]
-        return [str(i) for i in Path(p.root).resolve().glob(str(Path(*parts)))]
+        return [str(p.resolve()) for p in Path(root_path).resolve().glob(glob_path)]
 
 
 def only_dirs(paths: list[str], err_msg: list = []) -> list[str]:

fortls/interface.py

@@ -219,7 +219,8 @@ def commandline_args(name: str = "fortls") -> argparse.ArgumentParser:
         # "--pp_include_dirs",  # TODO: make main
         type=str,
         nargs="*",
-        default=list(),
+        default=set(),
+        action=SetAction,
         metavar="DIRS",
         help="Folders containing preprocessor files with extensions PP_SUFFIXES.",
     )

fortls/langserver.py

@@ -382,8 +382,10 @@ def get_candidates(
         ):
             #
             def child_candidates(
-                scope, only_list=[], filter_public=True, req_abstract=False
+                scope, only_list: list = None, filter_public=True, req_abstract=False
             ):
+                if only_list is None:
+                    only_list = []
                 tmp_list = []
                 # Filter children
                 nonly = len(only_list)
@@ -1546,8 +1548,8 @@ def __load_config_file_preproc(self, config_dict: dict) -> None:
         if isinstance(self.pp_defs, list):
             self.pp_defs = {key: "" for key in self.pp_defs}
 
-        for path in config_dict.get("include_dirs", []):
-            self.include_dirs.extend(
+        for path in config_dict.get("include_dirs", set()):
+            self.include_dirs.update(
                 only_dirs(resolve_globs(path, self.root_path), self.post_messages)
             )
 

fortls/objects.py

@@ -3,7 +3,7 @@
 import copy
 import os
 import re
-from typing import Dict, NamedTuple, List, Pattern
+from typing import Dict, NamedTuple, List, Set, Pattern
 from dataclasses import dataclass
 
 from fortls.constants import (
@@ -56,7 +56,7 @@
 )
 USE_info = NamedTuple(
     "USE_info",
-    [("mod_name", str), ("only_list", List[str]), ("rename_map", Dict[str, str])],
+    [("mod_name", str), ("only_list", Set[str]), ("rename_map", Dict[str, str])],
 )
 GEN_info = NamedTuple(
     "GEN_info",
@@ -79,9 +79,9 @@ def get_use_tree(
     scope: fortran_scope,
     use_dict: dict,
     obj_tree: dict,
-    only_list: list = [],
-    rename_map: dict = {},
-    curr_path: list = [],
+    only_list: list = None,
+    rename_map: dict = None,
+    curr_path: list = None,
 ):
     def intersect_only(use_stmnt):
         tmp_list = []
@@ -97,6 +97,13 @@ def intersect_only(use_stmnt):
                 tmp_map.pop(val1, None)
         return tmp_list, tmp_map
 
+    if only_list is None:
+        only_list = []
+    if rename_map is None:
+        rename_map = {}
+    if curr_path is None:
+        curr_path = []
+
     # Detect and break circular references
     if scope.FQSN in curr_path:
         return use_dict
@@ -297,15 +304,17 @@ def __init__(
         self,
         mod_name: str,
         line_number: int,
-        only_list: list = [],
-        rename_map: dict = {},
+        only_list: list = None,
+        rename_map: dict = None,
     ):
         self.mod_name: str = mod_name.lower()
         self.line_number: int = line_number
-        self.only_list: list = [only.lower() for only in only_list]
-        self.rename_map: dict = {
-            key.lower(): value.lower() for key, value in rename_map.items()
-        }
+        if only_list is not None:
+            self.only_list: list = [only.lower() for only in only_list]
+        if rename_map is not None:
+            self.rename_map: dict = {
+                key.lower(): value.lower() for key, value in rename_map.items()
+            }
 
 
 class fortran_diagnostic:
@@ -466,15 +475,19 @@ def req_named_end(self):
     def check_valid_parent(self):
         return True
 
-    def check_definition(self, obj_tree, known_types={}, interface=False):
+    def check_definition(self, obj_tree, known_types: dict = None, interface=False):
+        if known_types is None:
+            known_types = {}
         return None, known_types
 
 
 class fortran_scope(fortran_obj):
     def __init__(self, file_ast, line_number: int, name: str):
         self.base_setup(file_ast, line_number, name)
 
-    def base_setup(self, file_ast, sline: int, name: str, keywords: list = []):
+    def base_setup(self, file_ast, sline: int, name: str, keywords: list = None):
+        if keywords is None:
+            keywords = []
         self.file_ast: fortran_ast = file_ast
         self.sline: int = sline
         self.eline: int = sline
@@ -514,7 +527,13 @@ def copy_from(self, copy_source):
         self.implicit_vars = copy_source.implicit_vars
         self.implicit_line = copy_source.implicit_line
 
-    def add_use(self, use_mod, line_number, only_list=[], rename_map={}):
+    def add_use(
+        self, use_mod, line_number, only_list: list = None, rename_map: dict = None
+    ):
+        if only_list is None:
+            only_list = []
+        if rename_map is None:
+            rename_map = {}
         self.use.append(USE_line(use_mod, line_number, only_list, rename_map))
 
     def set_inherit(self, inherit_type):
@@ -841,8 +860,10 @@ def __init__(
         name: str,
         args: str = "",
         mod_flag: bool = False,
-        keywords: list = [],
+        keywords: list = None,
     ):
+        if keywords is None:
+            keywords = []
         self.base_setup(file_ast, line_number, name, keywords=keywords)
         self.args: str = args.replace(" ", "")
         self.args_snip: str = self.args
@@ -1055,10 +1076,12 @@ def __init__(
         name: str,
         args: str = "",
         mod_flag: bool = False,
-        keywords: list = [],
+        keywords: list = None,
         return_type=None,
         result_var=None,
     ):
+        if keywords is None:
+            keywords = []
         self.base_setup(file_ast, line_number, name, keywords=keywords)
         self.args: str = args.replace(" ", "").lower()
         self.args_snip: str = self.args
@@ -1495,7 +1518,7 @@ class fortran_int(fortran_scope):
     def __init__(
         self,
         file_ast: fortran_ast,
-        line_number: list,
+        line_number: int,
         name: str,
         abstract: bool = False,
     ):
@@ -1540,9 +1563,11 @@ def __init__(
         name: str,
         var_desc: str,
         keywords: list,
-        keyword_info: dict = {},
+        keyword_info: dict = None,
         link_obj=None,
     ):
+        if keyword_info is None:
+            keyword_info = {}
         self.base_setup(
             file_ast, line_number, name, var_desc, keywords, keyword_info, link_obj
         )
@@ -1920,7 +1945,7 @@ def get_enc_scope_name(self):
     def add_scope(
         self,
         new_scope: fortran_scope,
-        END_SCOPE_REGEX,
+        END_SCOPE_REGEX: Pattern[str],
         exportable: bool = True,
         req_container: bool = False,
     ):