Prepare release 1.7 (#362)

^

Author: mscheltienne

.github/workflows/ci.yaml

@@ -328,8 +328,8 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       contents: write
-    environment:
-      RELEASE_TAG=${{ github.event.release.tag_name }}
+    env:
+      RELEASE_TAG: ${{ github.event.release.tag_name }}
     steps:
       - uses: actions/checkout@v4
         with:

doc/development/changes/latest.rst doc/development/changes/1.7.rstdoc/development/changes/latest.rst renamed to doc/development/changes/1.7.rst

@@ -4,7 +4,7 @@ Changelog
 .. toctree::
     :titlesonly:
 
-    latest.rst
+    1.7.rst
     1.6.rst
     1.5.rst
     1.4.rst

doc/development/changes/index.rst

@@ -53,7 +53,7 @@ maintainers = [
 name = 'mne_lsl'
 readme = 'README.md'
 requires-python = '>=3.10'
-version = '1.7.0.dev0'
+version = '1.7.0'
 
 [project.optional-dependencies]
 all = [

pyproject.toml

@@ -878,7 +878,7 @@ class StreamInfo(_BaseStreamInfo):
         Also called ``nominal_srate``, represents the sampling rate (in Hz) as
         advertised by the data source. If the sampling rate is irregular (e.g. for a
         trigger stream), the sampling rate is set to ``0``.
-    dtype : str | dtype
+    dtype : str | int | dtype
         Format of each channel. If your channels have different formats, consider
         supplying multiple streams or use the largest type that can hold them all.
         One of ``('string', 'float32', 'float64', 'int8', 'int16', 'int32')``.
@@ -896,9 +896,9 @@ def __init__(
         stype: str,
         n_channels: int,
         sfreq: float,
-        dtype: str,
+        dtype: str | int | DTypeLike,
         source_id: str,
-    ):
+    ) -> None:
         check_type(name, (str,), "name")
         check_type(stype, (str,), "stype")
         n_channels = ensure_int(n_channels, "n_channels")

src/mne_lsl/lsl/stream_info.py

@@ -63,7 +63,7 @@ def __init__(
         max_buffered: float = 360,
         recover: bool = True,
         processing_flags: str | Sequence[str] | None = None,
-    ):
+    ) -> None:
         check_type(sinfo, (_BaseStreamInfo,), "sinfo")
         chunk_size = ensure_int(chunk_size, "chunk_size")
         if chunk_size < 0:
@@ -130,7 +130,7 @@ def __init__(
         # variable to define if the stream is open or not  sinfo_ = inlet.get_sinfo()
         self._stream_is_open = False
 
-    def _del(self):
+    def _del(self) -> None:
         """Destroy a :class:`~mne_lsl.lsl.StreamInlet` explicitly."""
         logger.debug(f"Destroying {self.__class__.__name__}..")
         try:
@@ -157,7 +157,7 @@ def _del(self):
                 "done."
             )
 
-    def __del__(self):
+    def __del__(self) -> None:
         """Destroy a :class:`~mne_lsl.lsl.StreamInlet`.
 
         The inlet will automatically disconnect.

src/mne_lsl/lsl/stream_inlet.py

@@ -42,7 +42,7 @@ def __init__(
         sinfo: _BaseStreamInfo,
         chunk_size: int = 1,
         max_buffered: float = 360,
-    ):
+    ) -> None:
         check_type(sinfo, (_BaseStreamInfo,), "sinfo")
         chunk_size = ensure_int(chunk_size, "chunk_size")
         if chunk_size < 1:
@@ -75,7 +75,7 @@ def __init__(
         self._do_push_chunk_n = fmt2push_chunk_n[self._dtype]
         self._buffer_sample = self._dtype * self._n_channels
 
-    def _del(self):
+    def _del(self) -> None:
         """Destroy a :class:`~mne_lsl.lsl.StreamOutlet` explicitly."""
         logger.debug(f"Destroying {self.__class__.__name__}..")
         try:
@@ -97,7 +97,7 @@ def _del(self):
                 "done."
             )
 
-    def __del__(self):
+    def __del__(self) -> None:
         """Destroy a :class:`~mne_lsl.lsl.StreamOutlet`.
 
         The outlet will no longer be discoverable after destruction and all connected
@@ -277,7 +277,7 @@ def wait_for_consumers(self, timeout: float | None) -> bool:
 
         Parameters
         ----------
-        timeout : float
+        timeout : float | None
             Timeout duration in seconds.
 
         Returns