Make importcompletion skiplist configurable (fixes #849)

sebastinas · sebastinas · commit cf5763eca1ca · 2020-12-30T22:22:02.000+01:00
diff --git a/bpython/config.py b/bpython/config.py
@@ -70,6 +70,26 @@ def loadini(struct, configfile):
             "default_autoreload": False,
             "editor": os.environ.get("VISUAL", os.environ.get("EDITOR", "vi")),
             "flush_output": True,
+            "import_completion_skiplist": ":".join(
+                (
+                    # version tracking
+                    ".git",
+                    ".svn",
+                    ".hg"
+                    # XDG
+                    ".config",
+                    ".local",
+                    ".share",
+                    # nodejs
+                    "node_modules",
+                    # PlayOnLinux
+                    "PlayOnLinux's virtual drives",
+                    # wine
+                    "dosdevices",
+                    # Python byte code cache
+                    "__pycache__",
+                )
+            ),
             "highlight_show_source": True,
             "hist_duplicates": True,
             "hist_file": "~/.pythonhist",
@@ -188,6 +208,9 @@ def get_key_no_doublebind(command):
     struct.default_autoreload = config.getboolean(
         "general", "default_autoreload"
     )
+    struct.import_completion_skiplist = config.get(
+        "general", "import_completion_skiplist"
+    ).split(":")
 
     struct.pastebin_key = get_key_no_doublebind("pastebin")
     struct.copy_clipboard_key = get_key_no_doublebind("copy_clipboard")
diff --git a/bpython/importcompletion.py b/bpython/importcompletion.py
@@ -38,32 +38,14 @@
 
 
 class ModuleGatherer:
-    def __init__(self, path=None):
+    def __init__(self, path=None, skiplist=None):
         # The cached list of all known modules
         self.modules = set()
         # List of stored paths to compare against so that real paths are not repeated
         # handles symlinks not mount points
         self.paths = set()
         # Patterns to skip
-        # TODO: This skiplist should be configurable.
-        self.skiplist = (
-            # version tracking
-            ".git",
-            ".svn",
-            ".hg"
-            # XDG
-            ".config",
-            ".local",
-            ".share",
-            # nodejs
-            "node_modules",
-            # PlayOnLinux
-            "PlayOnLinux's virtual drives",
-            # wine
-            "dosdevices",
-            # cache
-            "__pycache__",
-        )
+        self.skiplist = skiplist if skiplist is not None else tuple()
         self.fully_loaded = False
         self.find_iterator = self.find_all_modules(path)
 
diff --git a/bpython/repl.py b/bpython/repl.py
@@ -444,7 +444,9 @@ def __init__(self, interp, config):
             except OSError:
                 pass
 
-        self.module_gatherer = ModuleGatherer()
+        self.module_gatherer = ModuleGatherer(
+            skiplist=self.config.import_completion_skiplist
+        )
         self.completers = autocomplete.get_default_completer(
             config.autocomplete_mode, self.module_gatherer
         )
diff --git a/doc/sphinx/source/configuration-options.rst b/doc/sphinx/source/configuration-options.rst
@@ -174,6 +174,12 @@ Whether to use Unicode characters to draw boxes.
 
 .. versionadded:: 0.14
 
+import_completion_skiplist
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+A `:`-seperated list of patterns to skip when processing modules for import completion.
+
+.. versionadded:: 0.21
+
 Keyboard
 --------
 This section refers to the ``[keyboard]`` section in your
