Renamed some internal only stuff

Author: suoto

hdl_checker/base_server.py

@@ -82,7 +82,7 @@
 WatchedFile = NamedTuple("WatchedFile", (("path", Path), ("last_read", float)))
 
 
-class HdlCodeCheckerBase(object):  # pylint: disable=useless-object-inheritance
+class BaseServer(object):  # pylint: disable=useless-object-inheritance
     """
     HDL Checker project builder class
     """

hdl_checker/exceptions.py

@@ -71,7 +71,7 @@ def __str__(self):
 class HdlCheckerNotInitializedError(HdlCheckerBaseException):
     """
     Exception thrown by the LSP server when the client asks for info that
-    depends on having HdlCodeCheckerBase properly setup.
+    depends on having BaseServer properly setup.
     """
     def __str__(self):
         return "HDL Checker server needs a root URI to work correctly"

hdl_checker/handlers.py

@@ -28,8 +28,8 @@
 
 from hdl_checker import __version__ as version
 from hdl_checker import types as t  # pylint: disable=unused-import
+from hdl_checker.base_server import BaseServer
 from hdl_checker.builders.fallback import Fallback
-from hdl_checker.base_server import HdlCodeCheckerBase
 from hdl_checker.path import Path
 from hdl_checker.utils import terminateProcess
 
@@ -38,15 +38,15 @@
 app = bottle.Bottle()  # pylint: disable=invalid-name
 
 
-class HdlCodeCheckerServer(HdlCodeCheckerBase):
+class Server(BaseServer):
     """
     HDL Checker project builder class
     """
 
     def __init__(self, *args, **kwargs):
         # type: (...) -> None
         self._msg_queue = Queue()  # type: Queue[Tuple[str, str]]
-        super(HdlCodeCheckerServer, self).__init__(*args, **kwargs)
+        super(Server, self).__init__(*args, **kwargs)
 
     def _handleUiInfo(self, message):
         # type: (...) -> Any
@@ -68,11 +68,10 @@ def getQueuedMessages(self):
 
 
 def _getServerByProjectFile(project_file):
-    # type: (Optional[str]) -> HdlCodeCheckerServer
+    # type: (Optional[str]) -> Server
     """
-    Returns the HdlCodeCheckerServer object that corresponds to the given
-    project file. If the object doesn't exists yet it gets created and
-    then returned
+    Returns the Server object that corresponds to the given project file. If
+    the object doesn't exists yet it gets created and then returned
     """
     _logger.debug("project_file: %s", project_file)
     if isinstance(project_file, str) and project_file.lower() == "none":
@@ -87,13 +86,13 @@ def _getServerByProjectFile(project_file):
     if root_dir not in servers:
         _logger.info("Creating server for %s (root=%s)", project_file, root_dir)
         try:
-            project = HdlCodeCheckerServer(root_dir=root_dir)
+            project = Server(root_dir=root_dir)
             if project_file is not None:
                 project.setConfig(project_file)
             _logger.debug("Created new project server for '%s'", project_file)
         except (IOError, OSError):
             _logger.info("Failed to create checker, reverting to fallback")
-            project = HdlCodeCheckerServer(None)
+            project = Server(None)
 
         servers[root_dir] = project
     return servers[root_dir]
@@ -302,5 +301,5 @@ def getBuildSequence():
 
 
 #  We'll store a dict to store differents hdl_checker objects
-servers = {}  # type: Dict[Path, HdlCodeCheckerServer] # pylint: disable=invalid-name
+servers = {}  # type: Dict[Path, Server] # pylint: disable=invalid-name
 setupSignalHandlers()

hdl_checker/lsp.py

@@ -30,7 +30,7 @@
 from tabulate import tabulate
 
 from hdl_checker import DEFAULT_PROJECT_FILE
-from hdl_checker.base_server import HdlCodeCheckerBase
+from hdl_checker.base_server import BaseServer
 from hdl_checker.config_generators.simple_finder import SimpleFinder
 from hdl_checker.database import _DEFAULT_LIBRARY_NAME
 from hdl_checker.diagnostics import CheckerDiagnostic, DiagType
@@ -103,15 +103,15 @@ def checkerDiagToLspDict(diag):
     return result
 
 
-class HdlCodeCheckerServer(HdlCodeCheckerBase):
+class Server(BaseServer):
     """
     HDL Checker project builder class
     """
 
-    def __init__(self, workspace, root_path):
-        # type: (Workspace, str) -> None
+    def __init__(self, workspace, root_dir):
+        # type: (Workspace, Path) -> None
         self._workspace = workspace
-        super(HdlCodeCheckerServer, self).__init__(Path(root_path))
+        super(Server, self).__init__(root_dir)
 
     def _handleUiInfo(self, message):
         # type: (...) -> Any
@@ -141,7 +141,7 @@ class HdlCheckerLanguageServer(PythonLanguageServer):
 
     def __init__(self, *args, **kwargs):
         # type: (...) -> None
-        self._checker = None  # type: Optional[HdlCodeCheckerServer]
+        self._checker = None  # type: Optional[Server]
         super(HdlCheckerLanguageServer, self).__init__(*args, **kwargs)
         # Default checker
         self._onConfigUpdate({"project_file": None})
@@ -233,8 +233,8 @@ def _onConfigUpdate(self, options):
         if not self.workspace or not self.workspace.root_uri:
             return
 
-        root_path = to_fs_path(self.workspace.root_uri)
-        self._checker = HdlCodeCheckerServer(self.workspace, root_path=root_path)
+        root_dir = to_fs_path(self.workspace.root_uri)
+        self._checker = Server(self.workspace, root_dir=Path(root_dir))
 
         _logger.debug("Updating from %s", options)
 

hdl_checker/path.py

@@ -92,7 +92,8 @@ def __str__(self):
         return self.name
 
     def __repr__(self):
-        return "Path({})".format(repr(self.name))
+        # type: () -> str
+        return "{}({})".format(self.__class__.__name__, repr(self.name))
 
     @property
     def stat(self):

hdl_checker/tests/__init__.py

@@ -32,7 +32,7 @@
 from parameterized import parameterized_class  # type: ignore
 
 from hdl_checker import exceptions
-from hdl_checker.base_server import HdlCodeCheckerBase
+from hdl_checker.base_server import BaseServer
 from hdl_checker.builders.base_builder import BaseBuilder
 from hdl_checker.parsers.elements.dependency_spec import DependencySpec
 from hdl_checker.parsers.elements.identifier import Identifier
@@ -46,8 +46,8 @@
 MockDep = Union[Tuple[str], Tuple[str, str]]
 
 
-class StandaloneProjectBuilder(HdlCodeCheckerBase):
-    "Class for testing HdlCodeCheckerBase"
+class DummyServer(BaseServer):
+    "Class for testing BaseServer"
     _msg_queue = Queue()  # type: Queue[Tuple[str, str]]
     _ui_handler = logging.getLogger("UI")
 

hdl_checker/tests/test_base_server.py

@@ -39,7 +39,7 @@
     MockBuilder,
     PatchBuilder,
     SourceMock,
-    StandaloneProjectBuilder,
+    DummyServer,
     assertCountEqual,
     assertSameFile,
     getTestTempPath,
@@ -136,7 +136,7 @@ def _assertMsgQueueIsEmpty(project):
     @it.should("warn when setup is taking too long")
     @patch("hdl_checker.base_server._HOW_LONG_IS_TOO_LONG", 0.1)
     @patch.object(
-        hdl_checker.base_server.HdlCodeCheckerBase,
+        hdl_checker.base_server.BaseServer,
         "configure",
         lambda *_: time.sleep(0.5),
     )
@@ -151,7 +151,7 @@ def test():
         open(config, "w").write("")
         open(source, "w").write("")
 
-        project = StandaloneProjectBuilder(_Path(path))
+        project = DummyServer(_Path(path))
         project.setConfig(Path(config))
         # Get messages of anything to trigger reading the config
         project.getMessagesByPath(Path(source))
@@ -176,7 +176,7 @@ def test():
         open(config, "w").write("")
         open(source, "w").write("")
 
-        project = StandaloneProjectBuilder(_Path(path))
+        project = DummyServer(_Path(path))
         project.setConfig(Path(config))
         # Get messages of anything to trigger reading the config
         project.getMessagesByPath(Path(source))
@@ -196,15 +196,15 @@ def setup():
 
         @it.should("raise exception when trying to instantiate")  # type: ignore
         def test():
-            project = StandaloneProjectBuilder(_Path("nonexisting"))
+            project = DummyServer(_Path("nonexisting"))
             with it.assertRaises(FileNotFoundError):
                 project.setConfig(str(it.project_file))
 
     with it.having("no project file at all"):
 
         @it.has_setup
         def setup():
-            it.project = StandaloneProjectBuilder(Path(TEST_PROJECT))
+            it.project = DummyServer(Path(TEST_PROJECT))
 
         @it.should("use fallback to Fallback builder")  # type: ignore
         def test():
@@ -240,7 +240,7 @@ def test():
         def setup():
             setupTestSuport(TEST_TEMP_PATH)
 
-            it.project = StandaloneProjectBuilder(_Path(TEST_TEMP_PATH))
+            it.project = DummyServer(_Path(TEST_TEMP_PATH))
 
             it.config_file = _makeConfigFromDict(
                 {
@@ -299,15 +299,15 @@ def test():
 
         @it.should("recover from cache")  # type: ignore
         @patchClassMap(MockBuilder=MockBuilder)
-        @patch("hdl_checker.base_server.HdlCodeCheckerBase._setState")
+        @patch("hdl_checker.base_server.BaseServer._setState")
         def test(set_state):
             source = _SourceMock(
                 library="some_lib", design_units=[{"name": "target", "type": "entity"}]
             )
 
             it.project.getMessagesByPath(source.filename)
 
-            _ = StandaloneProjectBuilder(_Path(TEST_TEMP_PATH))
+            _ = DummyServer(_Path(TEST_TEMP_PATH))
 
             set_state.assert_called_once()
 
@@ -334,7 +334,7 @@ def test():
 
             it.project.clean()
 
-            project = StandaloneProjectBuilder(_Path(TEST_TEMP_PATH))
+            project = DummyServer(_Path(TEST_TEMP_PATH))
 
             if not ON_WINDOWS:
                 it.assertMsgQueueIsEmpty(project)
@@ -355,7 +355,7 @@ def test():
             open(cache_filename.name, "w").write("corrupted cache contents")
 
             # Try to recreate
-            project = StandaloneProjectBuilder(root_dir)
+            project = DummyServer(root_dir)
 
             if six.PY2:
                 it.assertIn(
@@ -552,7 +552,7 @@ def setup():
             removeIfExists(p.join(TEST_TEMP_PATH, WORK_PATH, CACHE_NAME))
 
             with PatchBuilder():
-                it.project = StandaloneProjectBuilder(_Path(TEST_TEMP_PATH))
+                it.project = DummyServer(_Path(TEST_TEMP_PATH))
                 it.project.setConfig(Path(p.join(TEST_PROJECT, "vimhdl.prj")))
                 it.project._updateConfigIfNeeded()
 

hdl_checker/tests/test_lsp.py

@@ -54,7 +54,7 @@
     VhdlDesignUnit,
 )
 from hdl_checker.parsers.elements.identifier import Identifier
-from hdl_checker.path import Path
+from hdl_checker.path import Path, TemporaryPath
 from hdl_checker.types import Location
 
 from hdl_checker.tests import (  # isort:skip
@@ -157,8 +157,8 @@ def test_workspace_notify(self):
         # type: (...) -> Any
         workspace = MagicMock(spec=Workspace)
 
-        server = lsp.HdlCodeCheckerServer(
-            workspace, root_path=mkdtemp(prefix="hdl_checker_")
+        server = lsp.Server(
+            workspace, root_path=TemporaryPath(mkdtemp(prefix="hdl_checker_"))
         )
 
         server._handleUiInfo("some info")  # pylint: disable=protected-access
@@ -613,7 +613,7 @@ def test_ReportBuildSequenceMarkdown(self):
         self.runTestBuildSequenceTable(tablefmt="github")
 
     @patch.object(
-        hdl_checker.base_server.HdlCodeCheckerBase,
+        hdl_checker.base_server.BaseServer,
         "resolveDependencyToPath",
         lambda self, _: None,
     )
@@ -631,7 +631,7 @@ def test_DependencyInfoForPathNotFound(self):
         )
 
     @patch.object(
-        hdl_checker.base_server.HdlCodeCheckerBase,
+        hdl_checker.base_server.BaseServer,
         "resolveDependencyToPath",
         lambda self, _: (Path("some_path"), Identifier("some_library")),
     )