Renamed base_server to core

Author: suoto

hdl_checker/base_server.py renamed to hdl_checker/core.py

@@ -86,7 +86,7 @@
 )
 
 
-class BaseServer(object):  # pylint: disable=useless-object-inheritance
+class HdlCheckerCore:
     """
     HDL Checker project builder class
     """
@@ -282,7 +282,7 @@ def _setState(self, state):
         """
         self._database = state.pop("database")
         self._builder = state.pop("builder", Fallback)
-        self._builder._database = self._database
+        self._builder._database = self._database  #  pylint: disable=protected-access
         config_file = state.pop("config_file", None)
         if config_file is None:
             self.config_file = None
@@ -618,7 +618,7 @@ def resolveDependency(
         """Resolves RequiredDesignUnit and IncludedPath dependencies"""
         if isinstance(dependency, RequiredDesignUnit):
             return self.resolveDependencyToPath(dependency)
-        elif isinstance(dependency, IncludedPath):
+        if isinstance(dependency, IncludedPath):
             return (self.database.resolveIncludedPath(dependency), None)
         _logger.info("Could not resolve %s (%s)", dependency, type(dependency))
         return None

hdl_checker/handlers.py

@@ -27,7 +27,7 @@
 import bottle  # type: ignore
 
 from hdl_checker import __version__ as version
-from hdl_checker.base_server import BaseServer
+from hdl_checker.core import HdlCheckerCore
 from hdl_checker.builders.fallback import Fallback
 from hdl_checker.path import Path
 from hdl_checker.types import ConfigFileOrigin
@@ -38,7 +38,7 @@
 app = bottle.Bottle()  # pylint: disable=invalid-name
 
 
-class Server(BaseServer):
+class Server(HdlCheckerCore):
     """
     HDL Checker project builder class
     """

hdl_checker/lsp.py

@@ -58,7 +58,7 @@
 from tabulate import tabulate
 
 from hdl_checker import DEFAULT_LIBRARY, DEFAULT_PROJECT_FILE
-from hdl_checker.base_server import BaseServer
+from hdl_checker.core import HdlCheckerCore
 from hdl_checker.config_generators.simple_finder import SimpleFinder
 from hdl_checker.diagnostics import CheckerDiagnostic, DiagType
 from hdl_checker.exceptions import UnknownParameterError
@@ -128,7 +128,7 @@ def checkerDiagToLspDict(diag: CheckerDiagnostic) -> Diagnostic:
     )
 
 
-class Server(BaseServer):
+class Server(HdlCheckerCore):
     """
     HDL Checker project builder class
     """

hdl_checker/tests/__init__.py

@@ -36,7 +36,7 @@
 from unittest2 import TestCase
 
 from hdl_checker import exceptions
-from hdl_checker.base_server import BaseServer
+from hdl_checker.core import HdlCheckerCore
 from hdl_checker.builders.base_builder import BaseBuilder
 from hdl_checker.diagnostics import CheckerDiagnostic
 from hdl_checker.parsers.elements.dependency_spec import RequiredDesignUnit
@@ -51,8 +51,8 @@
 MockDep = Union[Tuple[str], Tuple[str, str]]
 
 
-class DummyServer(BaseServer):
-    "Class for testing BaseServer"
+class DummyServer(HdlCheckerCore):
+    "Class for testing HdlCheckerCore"
     _server_index = 0
 
     def __init__(self, *args, **kwargs):
@@ -286,10 +286,10 @@ def getBuilderByName(name):
         self.meth = meth
         self.patches = (
             mock.patch(
-                "hdl_checker.base_server.getPreferredBuilder",
+                "hdl_checker.core.getPreferredBuilder",
                 side_effect=[MockBuilder,],
             ),
-            mock.patch("hdl_checker.base_server.getBuilderByName", getBuilderByName),
+            mock.patch("hdl_checker.core.getBuilderByName", getBuilderByName),
             disableVunit,
         )
 

hdl_checker/tests/test_base_server.py

@@ -113,9 +113,9 @@ def _makeConfigFromDict(dict_):
     it.assertSameFile = assertSameFile(it)
 
     @it.should("warn when setup is taking too long")
-    @patch("hdl_checker.base_server._HOW_LONG_IS_TOO_LONG", 0.1)
+    @patch("hdl_checker.core._HOW_LONG_IS_TOO_LONG", 0.1)
     @patch.object(
-        hdl_checker.base_server.BaseServer, "configure", lambda *_: time.sleep(0.5)
+        hdl_checker.core.HdlCheckerCore, "configure", lambda *_: time.sleep(0.5)
     )
     @patch("hdl_checker.tests.DummyServer._handleUiInfo")
     def test(handle_ui_info):
@@ -135,17 +135,17 @@ def test(handle_ui_info):
         project.getMessagesByPath(Path(source))
 
         handle_ui_info.assert_called_once_with(
-            hdl_checker.base_server._HOW_LONG_IS_TOO_LONG_MSG
+            hdl_checker.core._HOW_LONG_IS_TOO_LONG_MSG
         )
 
         removeIfExists(path)
 
     @it.should(  # type: ignore
         "not warn when setup is taking too long if the user provides the config file"
     )
-    @patch("hdl_checker.base_server._HOW_LONG_IS_TOO_LONG", 0.1)
+    @patch("hdl_checker.core._HOW_LONG_IS_TOO_LONG", 0.1)
     @patch.object(
-        hdl_checker.base_server.BaseServer, "configure", lambda *_: time.sleep(0.5)
+        hdl_checker.core.HdlCheckerCore, "configure", lambda *_: time.sleep(0.5)
     )
     @patch("hdl_checker.tests.DummyServer._handleUiInfo")
     def test(handle_ui_info):
@@ -257,7 +257,7 @@ def test():
 
         @it.should("still report static messages")  # type: ignore
         @patch(
-            "hdl_checker.base_server.getStaticMessages",
+            "hdl_checker.core.getStaticMessages",
             return_value=[CheckerDiagnostic(text="some text")],
         )
         def test(meth):
@@ -339,7 +339,7 @@ def test():
                 library="some_lib", design_units=[{"name": "target", "type": "entity"}]
             )
 
-            with patch("hdl_checker.base_server.json.dump", spec=json.dump) as func:
+            with patch("hdl_checker.core.json.dump", spec=json.dump) as func:
                 it.project.getMessagesByPath(source.filename)
                 func.assert_called_once()
 
@@ -359,7 +359,7 @@ def test():
 
             # Setting the config file should not trigger reparsing
             with patch(
-                "hdl_checker.base_server.WatchedFile.__init__", side_effect=[None]
+                "hdl_checker.core.WatchedFile.__init__", side_effect=[None]
             ) as watched_file:
                 old = it.project.config_file
                 it.project.setConfig(it.config_file, origin=ConfigFileOrigin.user)
@@ -370,7 +370,7 @@ def test():
 
         @it.should("not recover cache if versions differ")  # type: ignore
         @patchClassMap(MockBuilder=MockBuilder)
-        @patch("hdl_checker.base_server.json.load", return_value={"__version__": None})
+        @patch("hdl_checker.core.json.load", return_value={"__version__": None})
         def test(json_load):
             source = _SourceMock(
                 library="some_lib", design_units=[{"name": "target", "type": "entity"}]
@@ -432,7 +432,7 @@ def test(handle_ui_warning):
         @it.should("get builder messages by path")  # type: ignore
         # Avoid saving to cache because the patched method is not JSON
         # serializable
-        @patch("hdl_checker.base_server.json.dump")
+        @patch("hdl_checker.core.json.dump")
         def test(_):
             with PatchBuilder():
                 it.project.setConfig(
@@ -583,7 +583,7 @@ def test():
         )
         @linuxOnly
         @patch(
-            "hdl_checker.base_server.getBuilderByName", new=lambda name: FailingBuilder
+            "hdl_checker.core.getBuilderByName", new=lambda name: FailingBuilder
         )
         def test():
             cache_content = {"builder": FailingBuilder.builder_name}

hdl_checker/tests/test_lsp.py

@@ -424,7 +424,7 @@ def setUp(self):
             patch.object(
                 hdl_checker.config_generators.base_generator.BaseGenerator, "generate",
             ),
-            patch("hdl_checker.base_server.json.dump", spec=json.dump),
+            patch("hdl_checker.core.json.dump", spec=json.dump),
         )
 
         for _patch in self.patches:
@@ -449,7 +449,7 @@ def tearDown(self):
     def test_SearchesForFilesOnInitialization(self):  # pylint: disable=no-self-use
         lsp.SimpleFinder.generate.assert_called_once()  # pylint: disable=no-member
         #  Will get called twice
-        hdl_checker.base_server.json.dump.assert_called()  # pylint: disable=no-member
+        hdl_checker.core.json.dump.assert_called()  # pylint: disable=no-member
 
 
 class TestOldStyleProjectFile(_LspHelper):
@@ -627,7 +627,7 @@ def test_ReportBuildSequenceMarkdown(self):
             self.runTestBuildSequenceTable(tablefmt="github")
 
     @patch.object(
-        hdl_checker.base_server.BaseServer,
+        hdl_checker.core.HdlCheckerCore,
         "resolveDependencyToPath",
         lambda self, _: None,
     )
@@ -645,7 +645,7 @@ def test_DependencyInfoForPathNotFound(self):
         )
 
     @patch.object(
-        hdl_checker.base_server.BaseServer,
+        hdl_checker.core.HdlCheckerCore,
         "resolveDependencyToPath",
         lambda self, _: (Path("some_path"), Identifier("some_library")),
     )