Make semantic versioning much easier by making everything _private except that which we export in __init__.py

Author: rudolfbyker

mkdocstrings_handlers/vba/__init__.py

@@ -1,5 +1,5 @@
 """This package implements a handler for the VBA language."""
 
-from mkdocstrings_handlers.vba.handler import get_handler
+from mkdocstrings_handlers.vba._handler import get_handler
 
 __all__ = ["get_handler"]

mkdocstrings_handlers/vba/collector.py mkdocstrings_handlers/vba/_collector.pymkdocstrings_handlers/vba/collector.py renamed to mkdocstrings_handlers/vba/_collector.py

@@ -5,8 +5,8 @@
 
 from mkdocstrings.handlers.base import BaseCollector
 
-from mkdocstrings_handlers.vba.types import VbaModuleInfo
-from mkdocstrings_handlers.vba.util import (
+from mkdocstrings_handlers.vba._types import VbaModuleInfo
+from mkdocstrings_handlers.vba._util import (
     collapse_long_lines,
     find_file_docstring,
     find_procedures,

mkdocstrings_handlers/vba/handler.py mkdocstrings_handlers/vba/_handler.pymkdocstrings_handlers/vba/handler.py renamed to mkdocstrings_handlers/vba/_handler.py

@@ -9,8 +9,8 @@
 from mkdocstrings.inventory import Inventory
 from mkdocstrings.loggers import get_logger
 
-from mkdocstrings_handlers.vba.collector import VbaCollector
-from mkdocstrings_handlers.vba.renderer import VbaRenderer
+from mkdocstrings_handlers.vba._collector import VbaCollector
+from mkdocstrings_handlers.vba._renderer import VbaRenderer
 
 patch_loggers(get_logger)
 

mkdocstrings_handlers/vba/regex.py mkdocstrings_handlers/vba/_regex.pymkdocstrings_handlers/vba/regex.py renamed to mkdocstrings_handlers/vba/_regex.py

@@ -19,7 +19,7 @@
 from mkdocstrings.handlers.base import BaseRenderer, CollectorItem
 from mkdocstrings.loggers import get_logger
 
-from mkdocstrings_handlers.vba.types import VbaModuleInfo
+from mkdocstrings_handlers.vba._types import VbaModuleInfo
 
 logger = get_logger(__name__)
 

mkdocstrings_handlers/vba/renderer.py mkdocstrings_handlers/vba/_renderer.pymkdocstrings_handlers/vba/renderer.py renamed to mkdocstrings_handlers/vba/_renderer.py

@@ -4,8 +4,8 @@
 from griffe.dataclasses import Docstring, Function, Parameters, Parameter
 from griffe.docstrings import Parser
 
-from mkdocstrings_handlers.vba.regex import re_signature, re_arg
-from mkdocstrings_handlers.vba.types import (
+from mkdocstrings_handlers.vba._regex import re_signature, re_arg
+from mkdocstrings_handlers.vba._types import (
     VbaArgumentInfo,
     VbaSignatureInfo,
     VbaProcedureInfo,

mkdocstrings_handlers/vba/types.py mkdocstrings_handlers/vba/_types.pymkdocstrings_handlers/vba/types.py renamed to mkdocstrings_handlers/vba/_types.py

@@ -1,7 +1,10 @@
 import unittest
 
-from mkdocstrings_handlers.vba.types import VbaArgumentInfo
-from mkdocstrings_handlers.vba.util import parse_args, parse_arg
+# noinspection PyProtectedMember
+from mkdocstrings_handlers.vba._types import VbaArgumentInfo
+
+# noinspection PyProtectedMember
+from mkdocstrings_handlers.vba._util import parse_args, parse_arg
 
 
 class TestParseArg(unittest.TestCase):
@@ -49,7 +52,7 @@ def test_1(self):
             ),
         ]
 
-        for (arg_string, result) in cases:
+        for arg_string, result in cases:
             with self.subTest(arg_string):
                 self.assertEqual(result, parse_arg(arg_string))
 
@@ -98,7 +101,7 @@ def test_1(self):
             ),
         ]
 
-        for (args_string, result) in cases:
+        for args_string, result in cases:
             with self.subTest(args_string):
                 self.assertEqual(result, list(parse_args(args_string)))
 

mkdocstrings_handlers/vba/util.py mkdocstrings_handlers/vba/_util.pymkdocstrings_handlers/vba/util.py renamed to mkdocstrings_handlers/vba/_util.py

@@ -1,7 +1,10 @@
 import unittest
 
-from mkdocstrings_handlers.vba.types import VbaSignatureInfo, VbaArgumentInfo
-from mkdocstrings_handlers.vba.util import parse_signature
+# noinspection PyProtectedMember
+from mkdocstrings_handlers.vba._types import VbaSignatureInfo, VbaArgumentInfo
+
+# noinspection PyProtectedMember
+from mkdocstrings_handlers.vba._util import parse_signature
 
 
 class TestParseSignature(unittest.TestCase):
@@ -91,7 +94,7 @@ def test_1(self):
             ),
         ]
 
-        for (signature, result) in cases:
+        for signature, result in cases:
             with self.subTest(signature):
                 self.assertEqual(result, parse_signature(signature))