Resolve import error for private types module (#89)

* Made types module public

* Fix to pass pre-commit

Author: evan-palmer

.devcontainer/devcontainer.json

@@ -25,7 +25,9 @@
     "editor.formatOnSave": true,
     "editor.tabSize": 4,
     "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.rulers": [88],
+    "editor.rulers": [
+      88
+    ],
     "rewrap.autoWrap.enabled": true,
     "rewrap.wrappingColumn": 80,
     "rewrap.wholeComment": true,
@@ -52,15 +54,19 @@
       "pymavswarm"
     ],
     "[python]": {
-      "editor.rulers": [88],
+      "editor.rulers": [
+        88
+      ],
       "editor.tabSize": 4,
       "editor.defaultFormatter": "ms-python.python",
       "editor.codeActionsOnSave": {
         "source.organizeImports": true
       }
     },
     "[markdown]": {
-      "editor.rulers": [80],
+      "editor.rulers": [
+        80
+      ],
       "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
     },
     "[dockerfile]": {

.github/CONTRIBUTING.md

@@ -120,7 +120,7 @@ from __future__ import annotations
 agent_location: Location | None = None
 ```
 
-Commonly used types will appear in `pymavswarm._types`. These should be used
+Commonly used types will appear in `pymavswarm.types`. These should be used
 where applicable.
 
 ## Writing documentation

examples/goto.py

@@ -21,7 +21,7 @@
 from typing import Any
 
 from pymavswarm import MavSwarm
-from pymavswarm._types import AgentID
+from pymavswarm.types import AgentID
 
 
 def parse_args() -> Any:

examples/subclass_mavswarm.py

@@ -25,7 +25,7 @@
 import monotonic
 
 from pymavswarm import Agent, MavSwarm
-from pymavswarm._types import AgentID
+from pymavswarm.types import AgentID
 
 
 class CustomMavSwarm(MavSwarm):

pymavswarm/handlers/message_receivers.py

@@ -26,9 +26,9 @@
 from pymavlink.dialects.v10 import ardupilotmega as mavlink1
 
 import pymavswarm.state as swarm_state
-from pymavswarm._types import AgentID
 from pymavswarm.agent import Agent
 from pymavswarm.handlers.receivers import Receivers
+from pymavswarm.types import AgentID
 
 
 class MessageReceivers(Receivers):

pymavswarm/handlers/receivers.py

@@ -20,7 +20,7 @@
 from typing import Callable
 
 import pymavswarm.utils as swarm_utils
-from pymavswarm._types import MessageHandler
+from pymavswarm.types import MessageHandler
 
 
 class Receivers:

pymavswarm/mavswarm.py

@@ -28,19 +28,19 @@
 from pymavlink import mavutil
 
 from pymavswarm import Connection
-from pymavswarm._types import (
+from pymavswarm.agent import Agent
+from pymavswarm.handlers import MessageReceivers
+from pymavswarm.message import codes
+from pymavswarm.message.response import Response
+from pymavswarm.state import Parameter
+from pymavswarm.types import (
     AgentID,
     CommandExecutor,
     MessageCode,
     MessageHandler,
     PostExecutionHandler,
     StateVerifier,
 )
-from pymavswarm.agent import Agent
-from pymavswarm.handlers import MessageReceivers
-from pymavswarm.message import codes
-from pymavswarm.message.response import Response
-from pymavswarm.state import Parameter
 from pymavswarm.utils import Event, FileLogger, NotifierDict, init_logger
 
 

pymavswarm/message/response.py

@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-from pymavswarm._types import AgentID, MessageCode
+from pymavswarm.types import AgentID, MessageCode
 
 
 class Response:

pymavswarm/tests/test_receivers.py

@@ -18,8 +18,8 @@
 from typing import Any
 
 from pymavswarm import Agent
-from pymavswarm._types import AgentID
 from pymavswarm.handlers.receivers import Receivers
+from pymavswarm.types import AgentID
 
 
 class TestReceivers(unittest.TestCase):

pymavswarm/tests/test_types.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+import unittest
+from typing import Callable
+
+from pymavswarm.types import AgentID, StateVerifier
+
+
+class TestTypes(unittest.TestCase):
+    """Verify that the system types are properly imported."""
+
+    def test_agent_id_import(self) -> None:
+        """Test the AgentID type import."""
+        self.assertEqual(AgentID, tuple[int, int])  # type: ignore
+        return
+
+    def test_state_verifier(self) -> None:
+        """Test the StateVerifier type import."""
+        self.assertEqual(StateVerifier, Callable[[AgentID], bool])
+        return
+
+
+if __name__ == "__main__":
+    unittest.main()