Add __all__ to all modules to make star imports work better

Author: barisione

CHANGELOG.md

@@ -9,6 +9,7 @@ Internal changes
 
 - Update and freeze dependencies for documentation generation
 - Refactored the code to parse MI records to decrease the number of regex matches to perform
+- Added `__all__` to all modules, which means that star imports (like `from pygdbmi.gdbmiparser import *`) will not pollute the namespace with modules used by pygdbmi itself
 
 ## 0.10.0.2
 

pygdbmi/IoManager.py

@@ -24,6 +24,13 @@
 else:
     import fcntl
 
+
+__all__ = [
+    "IoManager",
+    "make_non_blocking",
+]
+
+
 logger = logging.getLogger(__name__)
 
 

pygdbmi/StringStream.py

@@ -1,6 +1,9 @@
 from pygdbmi.gdbescapes import advance_past_string_with_gdb_escapes
 
 
+__all__ = ["StringStream"]
+
+
 class StringStream:
     """A simple class to hold text so that when passed
     between functions, the object is passed by reference

pygdbmi/__init__.py

@@ -1 +1,7 @@
 __version__ = "0.10.0.2"
+
+__all__ = [
+    "IoManager",
+    "gdbcontroller",
+    "gdbmiparser",
+]

pygdbmi/constants.py

@@ -1,5 +1,14 @@
 import os
 
+
+__all__ = [
+    "DEFAULT_GDB_TIMEOUT_SEC",
+    "DEFAULT_TIME_TO_CHECK_FOR_ADDITIONAL_OUTPUT_SEC",
+    "GdbTimeoutError",
+    "USING_WINDOWS",
+]
+
+
 DEFAULT_GDB_TIMEOUT_SEC = 1
 DEFAULT_TIME_TO_CHECK_FOR_ADDITIONAL_OUTPUT_SEC = 0.2
 USING_WINDOWS = os.name == "nt"

pygdbmi/gdbcontroller.py

@@ -13,6 +13,10 @@
     DEFAULT_TIME_TO_CHECK_FOR_ADDITIONAL_OUTPUT_SEC,
 )
 
+
+__all__ = ["GdbController"]
+
+
 DEFAULT_GDB_LAUNCH_COMMAND = ["gdb", "--nx", "--quiet", "--interpreter=mi3"]
 logger = logging.getLogger(__name__)
 

pygdbmi/gdbescapes.py

@@ -6,6 +6,12 @@
 from typing import Iterator, Tuple
 
 
+__all__ = [
+    "advance_past_string_with_gdb_escapes",
+    "unescape",
+]
+
+
 def unescape(escaped_str: str) -> str:
     """Unescape a string escaped by GDB in MI mode.
 

pygdbmi/gdbmiparser.py

@@ -16,6 +16,13 @@
 from pygdbmi.StringStream import StringStream
 from pygdbmi.gdbescapes import unescape
 
+
+__all__ = [
+    "parse_response",
+    "response_is_finished",
+]
+
+
 _DEBUG = False
 logger = logging.getLogger(__name__)
 

pygdbmi/printcolor.py

@@ -1,5 +1,15 @@
 import os
 
+
+__all__ = [
+    "fmt_cyan",
+    "fmt_green",
+    "print_cyan",
+    "print_green",
+    "print_red",
+]
+
+
 USING_WINDOWS = os.name == "nt"