harp-python 0.2.0__tar.gz → 0.3.0__tar.gz

harp_python-0.3.0/.github/workflows/build.yml

@@ -0,0 +1,37 @@
+# Builds the python environment; linter and formatting via ruff; type annotations via pyright;
+# tests via pytest; reports test coverage via pytest-cov.
+
+name: build
+on:
+  push:
+    branches: ['*']
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build_run_tests:
+    name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    if: github.event.pull_request.draft == false
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: [3.9, 3.11]
+      fail-fast: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+      - name: Install dependencies
+        run: pip install -e .[dev]
+
+      - name: ruff
+        run: ruff check .
+      - name: pyright
+        run: pyright . 
+      - name: pytest
+        run: pytest --cov harp

{harp-python-0.2.0 → harp_python-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: harp-python
-Version: 0.2.0
+Version: 0.3.0
 Summary: A low-level interface for loading binary Harp protocol data
 Author-email: Goncalo Lopes <g.lopes@neurogears.org>
 License: MIT License
@@ -20,15 +20,31 @@ Requires-Dist: pydantic-yaml
 Requires-Dist: pandas
 Provides-Extra: dev
 Requires-Dist: datamodel-code-generator; extra == "dev"
+Requires-Dist: pandas-stubs; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
-Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: codespell; extra == "dev"
 Provides-Extra: jupyter
 Requires-Dist: ipykernel; extra == "jupyter"
 Requires-Dist: matplotlib; extra == "jupyter"
 
 # harp-python
 
-A low-level interface to data collected with the [Harp](https://harp-tech.org/) binary protocol.
+A low-level interface to data collected with the [Harp binary protocol](https://harp-tech.org/protocol/BinaryProtocol-8bit.html).
+
+## How to install
+
+The source code is currently hosted on [GitHub](https://github.com/harp-tech/harp-python).
+
+Binary installers for the latest released version are available at the [Python Package Index (PyPI)](https://pypi.org/project/harp-python) and can be installed using `pip`.
+
+```sh
+pip install harp-python
+```
+
+The list of changes between each release can be found [here](https://github.com/harp-tech/harp-python/releases).
 
 ## Data model 
 

{harp-python-0.2.0 → harp_python-0.3.0}/README.md

@@ -1,6 +1,18 @@
 # harp-python
 
-A low-level interface to data collected with the [Harp](https://harp-tech.org/) binary protocol.
+A low-level interface to data collected with the [Harp binary protocol](https://harp-tech.org/protocol/BinaryProtocol-8bit.html).
+
+## How to install
+
+The source code is currently hosted on [GitHub](https://github.com/harp-tech/harp-python).
+
+Binary installers for the latest released version are available at the [Python Package Index (PyPI)](https://pypi.org/project/harp-python) and can be installed using `pip`.
+
+```sh
+pip install harp-python
+```
+
+The list of changes between each release can be found [here](https://github.com/harp-tech/harp-python/releases).
 
 ## Data model 
 

{harp-python-0.2.0 → harp_python-0.3.0}/harp/__init__.py

@@ -1,3 +1,5 @@
 from harp.io import REFERENCE_EPOCH, MessageType, read
 from harp.reader import create_reader
 from harp.schema import read_schema
+
+__all__ = ["REFERENCE_EPOCH", "MessageType", "read", "create_reader", "read_schema"]

{harp-python-0.2.0 → harp_python-0.3.0}/harp/io.py

@@ -2,9 +2,10 @@ from datetime import datetime
 from enum import IntEnum
 from os import PathLike
 from typing import Any, BinaryIO, Optional, Union
-from pandas._typing import Axes
+
 import numpy as np
 import pandas as pd
+from pandas._typing import Axes
 
 REFERENCE_EPOCH = datetime(1904, 1, 1)
 """The reference epoch for UTC harp time."""
@@ -73,29 +74,23 @@ def read(
     """
     data = np.fromfile(file, dtype=np.uint8)
     if len(data) == 0:
-        return pd.DataFrame(
-            columns=columns, index=pd.Index([], dtype=np.float64, name="Time")
-        )
+        return pd.DataFrame(columns=columns, index=pd.Index([], dtype=np.float64, name="Time"))
 
     if address is not None and address != data[2]:
         raise ValueError(f"expected address {address} but got {data[2]}")
 
     index = None
-    stride = data[1] + 2
+    stride = int(data[1] + 2)
     nrows = len(data) // stride
     payloadtype = data[4]
     payloadoffset = 5
     if payloadtype & 0x10 != 0:
-        seconds = np.ndarray(
-            nrows, dtype=np.uint32, buffer=data, offset=payloadoffset, strides=stride
-        )
+        seconds = np.ndarray(nrows, dtype=np.uint32, buffer=data, offset=payloadoffset, strides=stride)
         payloadoffset += 4
-        micros = np.ndarray(
-            nrows, dtype=np.uint16, buffer=data, offset=payloadoffset, strides=stride
-        )
+        micros = np.ndarray(nrows, dtype=np.uint16, buffer=data, offset=payloadoffset, strides=stride)
         payloadoffset += 2
         time = micros * _SECONDS_PER_TICK + seconds
-        payloadtype = payloadtype & ~0x10
+        payloadtype = payloadtype & ~np.uint8(0x10)
         if epoch is not None:
             time = epoch + pd.to_timedelta(time, "s")  # type: ignore
         index = pd.Series(time)
@@ -121,9 +116,7 @@ def read(
 
     result = pd.DataFrame(payload, index=index, columns=columns)
     if keep_type:
-        msgtype = np.ndarray(
-            nrows, dtype=np.uint8, buffer=data, offset=0, strides=stride
-        )
+        msgtype = np.ndarray(nrows, dtype=np.uint8, buffer=data, offset=0, strides=stride)
         msgtype = pd.Categorical.from_codes(msgtype, categories=_messagetypes)  # type: ignore
         result[MessageType.__name__] = msgtype
     return result

{harp-python-0.2.0 → harp_python-0.3.0}/harp/model.py

@@ -5,8 +5,7 @@
 from __future__ import annotations
 
 from enum import Enum
-from typing import Dict, List, Optional, Union
-from typing_extensions import Annotated
+from typing import Annotated, Dict, List, Optional, Union
 
 from pydantic import (
     BaseModel,
@@ -136,16 +135,12 @@ class Visibility(Enum):
 class Register(BaseModel):
     address: Annotated[
         int,
-        Field(
-            le=255, description="Specifies the unique 8-bit address of the register."
-        ),
+        Field(le=255, description="Specifies the unique 8-bit address of the register."),
     ]
     type: Annotated[PayloadType, BeforeValidator(lambda v: PayloadType[v])]
     length: Annotated[
         Optional[int],
-        Field(
-            ge=1, default=1, description="Specifies the length of the register payload."
-        ),
+        Field(ge=1, default=1, description="Specifies the length of the register payload."),
     ]
     access: Union[Access, List[Access]] = Field(
         ..., description="Specifies the expected use of the register."
@@ -191,12 +186,6 @@ class Registers(BaseModel):
 
 class Model(Registers):
     device: str = Field(..., description="Specifies the name of the device.")
-    whoAmI: int = Field(
-        ..., description="Specifies the unique identifier for this device type."
-    )
-    firmwareVersion: str = Field(
-        ..., description="Specifies the semantic version of the device firmware."
-    )
-    hardwareTargets: str = Field(
-        ..., description="Specifies the semantic version of the device hardware."
-    )
+    whoAmI: int = Field(..., description="Specifies the unique identifier for this device type.")
+    firmwareVersion: str = Field(..., description="Specifies the semantic version of the device firmware.")
+    hardwareTargets: str = Field(..., description="Specifies the semantic version of the device hardware.")

{harp-python-0.2.0 → harp_python-0.3.0}/harp/reader.py

@@ -1,16 +1,19 @@
 import os
+from collections import UserDict
+from dataclasses import dataclass
+from datetime import datetime
+from functools import partial
 from math import log2
 from os import PathLike
 from pathlib import Path
-from datetime import datetime
-from functools import partial
-from dataclasses import dataclass
+from typing import Any, BinaryIO, Callable, Iterable, Mapping, Optional, Protocol, Union
+
 from numpy import dtype
 from pandas import DataFrame, Series
-from typing import Any, BinaryIO, Callable, Iterable, Optional, Protocol, Union
 from pandas._typing import Axes
-from harp.model import BitMask, GroupMask, Model, PayloadMember, Register
+
 from harp.io import MessageType, read
+from harp.model import BitMask, GroupMask, Model, PayloadMember, Register
 from harp.schema import read_schema
 
 
@@ -27,8 +30,7 @@ class _ReadRegister(Protocol):
         file: Optional[Union[str, bytes, PathLike[Any], BinaryIO]] = None,
         epoch: Optional[datetime] = None,
         keep_type: bool = False,
-    ) -> DataFrame:
-        ...
+    ) -> DataFrame: ...
 
 
 class RegisterReader:
@@ -44,13 +46,27 @@ class RegisterReader:
         self.read = read
 
 
+class RegisterMap(UserDict[str, RegisterReader]):
+    _address_map: Mapping[int, RegisterReader]
+
+    def __init__(self, registers: Mapping[str, RegisterReader]) -> None:
+        super().__init__(registers)
+        self._address_map = {value.register.address: value for value in registers.values()}
+
+    def __getitem__(self, key: Union[str, int]) -> RegisterReader:
+        if isinstance(key, int):
+            return self._address_map[key]
+        else:
+            return super().__getitem__(key)
+
+
 class DeviceReader:
     device: Model
-    registers: dict[str, RegisterReader]
+    registers: RegisterMap
 
-    def __init__(self, device: Model, registers: dict[str, RegisterReader]) -> None:
+    def __init__(self, device: Model, registers: Mapping[str, RegisterReader]) -> None:
         self.device = device
-        self.registers = registers
+        self.registers = RegisterMap(registers)
 
     def __dir__(self) -> Iterable[str]:
         return self.registers.keys()
@@ -214,7 +230,7 @@ def create_reader(
     keep_type: bool = False,
 ):
     """Creates a device reader object from the specified dataset or schema.
-    
+
     Parameters
     ----------
     device
@@ -249,9 +265,7 @@ def create_reader(
         base_path = path / device.device if is_dir else path.parent / device.device
 
     reg_readers = {
-        name: _create_register_parser(
-            device, name, _ReaderParams(base_path, epoch, keep_type)
-        )
+        name: _create_register_parser(device, name, _ReaderParams(base_path, epoch, keep_type))
         for name in device.registers.keys()
     }
     return DeviceReader(device, reg_readers)

{harp-python-0.2.0 → harp_python-0.3.0}/harp/schema.py

@@ -1,21 +1,21 @@
+from importlib import resources
 from os import PathLike
 from typing import TextIO, Union
-from harp.model import Model, Registers
+
 from pydantic_yaml import parse_yaml_raw_as
-from importlib import resources
+
+from harp.model import Model, Registers
 
 
 def _read_common_registers() -> Registers:
     file = resources.files(__package__) / "common.yml"
-    with file.open("rt") as fileIO:
+    with file.open("r") as fileIO:
         return parse_yaml_raw_as(Registers, fileIO.read())
 
 
-def read_schema(
-    file: Union[str, PathLike, TextIO], include_common_registers: bool = True
-) -> Model:
+def read_schema(file: Union[str, PathLike, TextIO], include_common_registers: bool = True) -> Model:
     """Read and parse a device schema from the specified file.
-    
+
     Parameters
     ----------
     file
@@ -35,14 +35,12 @@ def read_schema(
             return read_schema(fileIO)
     else:
         schema = parse_yaml_raw_as(Model, file.read())
-        if not "WhoAmI" in schema.registers and include_common_registers:
+        if "WhoAmI" not in schema.registers and include_common_registers:
             common = _read_common_registers()
             schema.registers = dict(common.registers, **schema.registers)
             if common.bitMasks:
                 schema.bitMasks = (
-                    common.bitMasks
-                    if schema.bitMasks is None
-                    else dict(common.bitMasks, **schema.bitMasks)
+                    common.bitMasks if schema.bitMasks is None else dict(common.bitMasks, **schema.bitMasks)
                 )
             if common.groupMasks:
                 schema.groupMasks = (

{harp-python-0.2.0 → harp_python-0.3.0}/harp_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: harp-python
-Version: 0.2.0
+Version: 0.3.0
 Summary: A low-level interface for loading binary Harp protocol data
 Author-email: Goncalo Lopes <g.lopes@neurogears.org>
 License: MIT License
@@ -20,15 +20,31 @@ Requires-Dist: pydantic-yaml
 Requires-Dist: pandas
 Provides-Extra: dev
 Requires-Dist: datamodel-code-generator; extra == "dev"
+Requires-Dist: pandas-stubs; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
-Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: codespell; extra == "dev"
 Provides-Extra: jupyter
 Requires-Dist: ipykernel; extra == "jupyter"
 Requires-Dist: matplotlib; extra == "jupyter"
 
 # harp-python
 
-A low-level interface to data collected with the [Harp](https://harp-tech.org/) binary protocol.
+A low-level interface to data collected with the [Harp binary protocol](https://harp-tech.org/protocol/BinaryProtocol-8bit.html).
+
+## How to install
+
+The source code is currently hosted on [GitHub](https://github.com/harp-tech/harp-python).
+
+Binary installers for the latest released version are available at the [Python Package Index (PyPI)](https://pypi.org/project/harp-python) and can be installed using `pip`.
+
+```sh
+pip install harp-python
+```
+
+The list of changes between each release can be found [here](https://github.com/harp-tech/harp-python/releases).
 
 ## Data model 
 

{harp-python-0.2.0 → harp_python-0.3.0}/harp_python.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ LICENSE
 MANIFEST.in
 README.md
 pyproject.toml
+.github/workflows/build.yml
 harp/__init__.py
 harp/common.yml
 harp/io.py

{harp-python-0.2.0 → harp_python-0.3.0}/harp_python.egg-info/requires.txt

@@ -3,8 +3,12 @@ pandas
 
 [dev]
 datamodel-code-generator
+pandas-stubs
 pytest
-black
+pytest-cov
+pyright
+ruff
+codespell
 
 [jupyter]
 ipykernel

{harp-python-0.2.0 → harp_python-0.3.0}/pyproject.toml

@@ -31,9 +31,14 @@ classifiers = [
 [project.optional-dependencies]
 dev = [
     "datamodel-code-generator",
+    "pandas-stubs",
     "pytest",
-    "black"
+    "pytest-cov",
+    "pyright",
+    "ruff",
+    "codespell"
 ]
+
 jupyter = [
     "ipykernel",
     "matplotlib"
@@ -55,16 +60,21 @@ include = ["harp*"]
 
 [tool.setuptools_scm]
 
-[tool.black]
-line-length = 88
-target-version = ['py39']
-include = '\.pyi?$'
-extend-exclude = '''
-# A regex preceded with ^/ will apply only to files and directories
-# in the root of the project.
-(
-  ^/LICENSE
-  ^/README.md
-  | reflex-generator
-)
-'''
+[tool.ruff]
+line-length = 108
+target-version = "py39"
+exclude = [
+    "reflex-generator"
+]
+
+[tool.pyright]
+venvPath = "."
+venv = ".venv"
+exclude = [
+    ".venv/*",
+    "reflex-generator"
+]
+
+[tool.codespell]
+skip = '.git,*.pdf,*.svg'
+ignore-words-list = 'nd'

{harp-python-0.2.0 → harp_python-0.3.0}/tests/params.py

@@ -1,8 +1,10 @@
-import numpy as np
+from dataclasses import dataclass
 from os import PathLike
 from pathlib import Path
-from dataclasses import dataclass
 from typing import Iterable, Optional, Type, Union
+
+import numpy as np
+
 from harp.model import Model
 
 datapath = Path(__file__).parent

{harp-python-0.2.0 → harp_python-0.3.0}/tests/test_io.py

@@ -1,8 +1,10 @@
-import pytest
-import numpy as np
 from contextlib import nullcontext
+
+import numpy as np
+import pytest
 from pytest import mark
-from harp.io import read, MessageType
+
+from harp.io import MessageType, read
 from tests.params import DataFileParam
 
 testdata = [
@@ -26,9 +28,7 @@ testdata = [
         expected_error=ValueError,
     ),
     DataFileParam(path="data/write_0.bin", expected_address=0, expected_rows=4),
-    DataFileParam(
-        path="data/write_0.bin", expected_address=0, expected_rows=4, keep_type=True
-    ),
+    DataFileParam(path="data/write_0.bin", expected_address=0, expected_rows=4, keep_type=True),
 ]
 
 
@@ -45,10 +45,7 @@ def test_read(dataFile: DataFileParam):
         )
         assert len(data) == dataFile.expected_rows
         if dataFile.keep_type:
-            assert (
-                MessageType.__name__ in data.columns
-                and data[MessageType.__name__].dtype == "category"
-            )
+            assert MessageType.__name__ in data.columns and data[MessageType.__name__].dtype == "category"
 
         if dataFile.expected_cols:
             for col in dataFile.expected_cols:

{harp-python-0.2.0 → harp_python-0.3.0}/tests/test_reader.py

@@ -1,5 +1,6 @@
 import numpy as np
 from pytest import mark
+
 from harp.io import REFERENCE_EPOCH, MessageType
 from harp.reader import create_reader
 from tests.params import DeviceSchemaParam

{harp-python-0.2.0 → harp_python-0.3.0}/tests/test_schema.py

@@ -1,4 +1,5 @@
 from pytest import mark
+
 from harp.schema import read_schema
 from tests.params import DeviceSchemaParam