Merge pull request #356 from sourcebots/future-api

A new API

Author: WillB97

.github/workflows/test_build.yml

@@ -10,16 +10,16 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        py_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        py_version: ["3.9", "3.9", "3.10", "3.11", "3.12", "3.13"]
         include:
           - os: windows-latest
-            py_version: "3.8"
+            py_version: "3.9"
           - os: windows-latest
-            py_version: "3.12"
+            py_version: "3.12"  # WinSDK doesn't support 3.13, need to update april-vision
           - os: macos-latest
-            py_version: "3.8"
+            py_version: "3.9"
           - os: macos-latest
-            py_version: "3.12"
+            py_version: "3.13"
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
@@ -35,16 +35,13 @@ jobs:
         python -m pip install .[dev,vision]
     - name: Lint
       run: |
-        make lint
-    - name: Isort
-      run: |
-        make isort-check
+        poe lint
     - name: Typecheck
       run: |
-        make type
+        poe type
     - name: Run tests
       run: |
-        make test
+        poe test
 
   build:
     permissions:
@@ -55,18 +52,18 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - name: Set up Python 3.8
+    - name: Set up Python 3.10
       uses: actions/setup-python@v5
       with:
-        python-version: "3.8"
+        python-version: "3.10"
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip build
+        python -m pip install --upgrade pip build poethepoet
         # Install package to generate version info
         python -m pip install .
     - name: Build package
       run: |
-        make build
+        poe build
     - name: Save built package
       uses: actions/upload-artifact@v4
       with:

Makefile

@@ -1,3 +1,32 @@
+# ### Linting Rules ###
+[tool.ruff]
+target-version = "py39"
+line-length = 95
+lint.select = [
+    "D",  # pydocstyle
+    "E",  # pycodestyle error
+    "F",  # pyflakes
+    "I",  # isort
+    "W",  # pycodestyle warning
+    "RUF",  # ruff-specific
+    "B006",  # mutable default argument
+    "B021",  # f-string docstring
+    "COM818",  # warn about implicitly creating a tuple
+    "SLF001",  # warn about accessing private members, these can be noqa'd when necessary
+]
+lint.preview = true  # Enable preview to get the rest of pycodestyle errors
+lint.ignore = [
+    "D104",  # Ignore missing docstring in public package
+    "D105",  # Ignore missing docstring in magic method
+    "D107",  # Ignore missing docstring in __init__
+    "D401",  # Ignore first line of docstring should be in imperative mood
+    "D203",  # Ignore 1 blank line required before class docstring
+    "D212",  # Ignore Multi-line docstring summary should start at the first line
+    "RUF005",  # Allow alternate iterable unpacking
+    "RUF015",  # Allow + concatenation
+]
+
+# ### Formatting Rules ###
 [tool.mypy]
 mypy_path = "stubs"
 
@@ -19,6 +48,11 @@ disallow_untyped_decorators = true
 
 check_untyped_defs = true
 
+[[tool.mypy.overrides]]
+# Ignore type checking for the tests
+module = ["tests.*"]
+ignore_errors = true
+
 [tool.isort]
 atomic = true
 balanced_wrapping = true
@@ -50,11 +84,12 @@ authors = [{name = "SourceBots", email =  "[email protected]"}]
 readme = "README.md"
 license = {file = "LICENSE"}
 dynamic = ["version"]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 dependencies = [
     "pyserial >=3,<4",
     "april_vision==2.2.0",
     "typing-extensions; python_version<'3.10'",
+    "python-dotenv==1.0.1",
 ]
 classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
@@ -71,8 +106,8 @@ Documentation = "https://docs.sourcebots.co.uk"
 
 [project.optional-dependencies]
 dev = [
-    "flake8",
-    "isort",
+    "poethepoet >=0.0.1,<1",
+    "ruff >=0.9,<1",
     "mypy==1.10.0; python_version<'3.9'",
     "mypy>=1.7,<2; python_version>='3.9'",
     "build",
@@ -83,3 +118,44 @@ dev = [
 ]
 vision = ["opencv-python-headless >=4,<5"]
 mqtt = ["paho-mqtt >=2,<3"]
+
+# ### Tasks ###
+[tool.poe.env]
+PYMODULE = "sbot"
+PYFOLDERS = "sbot tests"
+
+[tool.poe.tasks.lint]
+help = "Run ruff against the project to check for linting errors."
+cmd = "ruff check $PYFOLDERS"
+
+[tool.poe.tasks.type]
+help = "Run mypy against the project to check for type errors."
+cmd = "python -m mypy $PYMODULE"
+
+[tool.poe.tasks.test]
+help = "Run pytest against the project to check for test errors."
+cmd = "python -m pytest --cov=$PYMODULE --cov-report=term --cov-report=xml tests"
+
+[tool.poe.tasks.test-html]
+help = "Run pytest against the project to check for test errors."
+cmd = "python -m pytest --cov=$PYMODULE --cov-report=html tests"
+
+[tool.poe.tasks.check]
+help = "Check the project for linting, type and test errors."
+sequence = ["lint", "type", "test"]
+
+[tool.poe.tasks.fix]
+help = "Use ruff to fix any auto-fixable linting errors."
+cmd = "ruff check --fix-only $PYFOLDERS"
+
+[tool.poe.tasks.build]
+help = "Build the wheel and source distributions."
+cmd = "python -m build"
+
+[tool.poe.tasks.clean]
+help = "Clean the project of any build artifacts."
+sequence = [
+    "shutil:rmtree('dist', ignore_errors=1)",
+    "shutil:rmtree('build', ignore_errors=1)",
+]
+default_item_type = "script"

pyproject.toml

@@ -1,30 +1,32 @@
-from .arduino import AnalogPins, GPIOPinMode
-from .exceptions import (
-    BoardDisconnectionError, MetadataKeyError, MetadataNotReadyError,
-)
-from .game_specific import GAME_LENGTH
-from .leds import Colour
-from .logging import add_trace_level
-from .motor_board import MotorPower
-from .power_board import Note, PowerOutputPosition
-from .robot import Robot
+from os import environ as _environ
 
-add_trace_level()
+from ._arduinos import AnalogPin, GPIOPinMode
+from ._leds import Colour
+from ._motors import MotorPower
+from ._power import PowerOutputPosition
+from ._utils import Note
+
+if 'SBOT_PYTEST' not in _environ:
+    from .robot import arduino, comp, leds, motors, power, servos, utils, vision
 
 BRAKE = MotorPower.BRAKE
 COAST = MotorPower.COAST
 
 __all__ = [
-    'AnalogPins',
     'BRAKE',
-    'BoardDisconnectionError',
     'COAST',
+    'AnalogPin',
     'Colour',
-    'GAME_LENGTH',
     'GPIOPinMode',
-    'MetadataKeyError',
-    'MetadataNotReadyError',
+    'MotorPower',
     'Note',
     'PowerOutputPosition',
-    'Robot',
+    'arduino',
+    'comp',
+    'leds',
+    'motors',
+    'power',
+    'servos',
+    'utils',
+    'vision',
 ]