Update stub files (#434)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Mathieu Scheltienne <mathieu.scheltienne@gmail.com>

Author: github-actions[bot]

src/mne_lsl/player/_base.pyi

@@ -53,6 +53,8 @@ class BasePlayer(ABC, ContainsMixin, SetChannelsMixin):
         chunk_size: int = 10,
         n_repeat: int | float = ...,
     ): ...
+    @verbose
+    @fill_doc
     def anonymize(
         self,
         daysback: int | None = None,
@@ -114,6 +116,7 @@ class BasePlayer(ABC, ContainsMixin, SetChannelsMixin):
         Operates in place.
         """
 
+    @fill_doc
     def get_channel_units(
         self, picks: Incomplete | None = None, only_data_chs: bool = False
     ) -> list[tuple[int, int]]:
@@ -143,6 +146,8 @@ class BasePlayer(ABC, ContainsMixin, SetChannelsMixin):
         """
 
     @abstractmethod
+    @verbose
+    @fill_doc
     def rename_channels(
         self,
         mapping: dict[str, str] | Callable,
@@ -180,6 +185,8 @@ class BasePlayer(ABC, ContainsMixin, SetChannelsMixin):
         """Start streaming data."""
 
     @abstractmethod
+    @verbose
+    @fill_doc
     def set_channel_types(
         self,
         mapping: dict[str, str],

src/mne_lsl/stream/base.pyi

@@ -1,5 +1,6 @@
 from abc import ABC, abstractmethod
 from collections.abc import Callable, Generator
+from contextlib import contextmanager
 from datetime import datetime
 from typing import Any
 
@@ -141,6 +142,7 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
         """
     _buffer: Incomplete
 
+    @fill_doc
     def add_reference_channels(
         self,
         ref_channels: str | list[str] | tuple[str, ...],
@@ -177,6 +179,8 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
         buffer <resources/implementations:StreamLSL>`.
         """
 
+    @verbose
+    @fill_doc
     def anonymize(
         self,
         daysback: int | None = None,
@@ -304,6 +308,8 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
         pick
         """
 
+    @verbose
+    @fill_doc
     def filter(
         self,
         l_freq: float | None,
@@ -395,6 +401,7 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
             The channel types.
         """
 
+    @fill_doc
     def get_channel_units(
         self,
         picks: str | list[str] | int | list[int] | ScalarIntArray | None = None,
@@ -425,6 +432,7 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
             for micro (corresponds to ``1e-6``).
         """
 
+    @fill_doc
     def get_data(
         self,
         winsize: float | None = None,
@@ -478,6 +486,8 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
             A copy of the channel positions, if available, otherwise ``None``.
         """
 
+    @verbose
+    @fill_doc
     def notch_filter(
         self,
         freqs: float,
@@ -546,6 +556,7 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
     def plot(self) -> None:
         """Open a real-time stream viewer. Not implemented."""
 
+    @fill_doc
     def pick(
         self,
         picks: str | list[str] | int | list[int] | ScalarIntArray | None = None,
@@ -585,6 +596,8 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
     def record(self) -> None:
         """Record the stream data to disk. Not implemented."""
 
+    @verbose
+    @fill_doc
     def rename_channels(
         self,
         mapping: dict[str, str] | Callable,
@@ -625,6 +638,8 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
             The stream instance modified in-place.
         """
 
+    @verbose
+    @fill_doc
     def set_channel_types(
         self,
         mapping: dict[str, str],
@@ -689,6 +704,7 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
     _ref_channels: Incomplete
     _ref_from: Incomplete
 
+    @fill_doc
     def set_eeg_reference(
         self,
         ref_channels: str | list[str] | tuple[str, ...],
@@ -746,6 +762,8 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
         anonymize
         """
 
+    @verbose
+    @fill_doc
     def set_montage(
         self,
         montage: str | DigMontage | None,
@@ -825,6 +843,7 @@ class BaseStream(ABC, ContainsMixin, SetChannelsMixin):
     def _check_not_epoched(self, name: str) -> None:
         """Check that the stream is not being epoched."""
 
+    @contextmanager
     def _interrupt_acquisition(self) -> Generator[None]:
         """Context manager interrupting the acquisition thread."""
     _info: Incomplete

src/mne_lsl/stream/epochs.pyi

@@ -264,6 +264,7 @@ class EpochsStream:
         """
     _n_new_epochs: int
 
+    @fill_doc
     def get_data(
         self,
         n_epochs: int | None = None,

src/mne_lsl/utils/_checks.pyi

@@ -76,6 +76,7 @@ def check_value(
         When the value of the item is not one of the valid options.
     """
 
+@fill_doc
 def check_verbose(verbose: Any) -> int:
     """Check that the value of verbose is valid.
 

src/mne_lsl/utils/logs.pyi

@@ -11,6 +11,7 @@ from ._fixes import WrapStdOut as WrapStdOut
 
 _PACKAGE: str
 
+@fill_doc
 def _init_logger(*, verbose: bool | str | int | None = ...) -> Logger:
     """Initialize a logger.
 
@@ -55,6 +56,7 @@ def add_file_handler(
         ``"INFO"`` for True. If None is provided, the verbosity of the logger is used.
     """
 
+@fill_doc
 def set_log_level(verbose: bool | str | int | None) -> None:
     """Set the log level for the logger.