BLD: Move docformatter pin to v1.7.7

Author: threecgreen

databento/common/bentologging.py

@@ -5,8 +5,9 @@
 
 def enable_logging(level: int | str = logging.INFO) -> None:
     """
-    Enable logging for the Databento module. This function should be used for
-    simple applications and examples. It is advisable to configure your own
+    Enable logging for the Databento module.
+
+    This function should be used for simple applications and examples. It is advisable to configure your own
     logging for serious applications.
 
     Parameters

databento/common/dbnstore.py

@@ -244,8 +244,9 @@ def __init__(self, source: BytesIO | bytes | IO[bytes]):
     @property
     def name(self) -> str:
         """
-        Return the name of the source buffer. Equivalent to `repr` of the
-        input.
+        Return the name of the source buffer.
+
+        Equivalent to `repr` of the input.
 
         Returns
         -------
@@ -269,8 +270,9 @@ def nbytes(self) -> int:
     @property
     def reader(self) -> BytesIO:
         """
-        Return a reader for this buffer. The reader beings at the start of the
-        buffer.
+        Return a reader for this buffer.
+
+        The reader beings at the start of the buffer.
 
         Returns
         -------
@@ -415,8 +417,9 @@ def __repr__(self) -> str:
     @property
     def compression(self) -> Compression:
         """
-        Return the data compression format (if any). This is determined by
-        inspecting the data.
+        Return the data compression format (if any).
+
+        This is determined by inspecting the data.
 
         Returns
         -------
@@ -440,8 +443,9 @@ def dataset(self) -> str:
     @property
     def end(self) -> pd.Timestamp | None:
         """
-        Return the query end for the data. If None, the end time was not known
-        when the data was generated.
+        Return the query end for the data.
+
+        If None, the end time was not known when the data was generated.
 
         Returns
         -------
@@ -545,11 +549,13 @@ def reader(self) -> IO[bytes]:
     @property
     def schema(self) -> Schema | None:
         """
-        Return the DBN record schema. If None, may contain one or more schemas.
+        Return the DBN record schema.
+
+        If None, may contain one or more schemas.
 
         Returns
         -------
-        Schema or None
+                Schema or None
 
         """
         schema = self._metadata.schema
@@ -576,8 +582,9 @@ def start(self) -> pd.Timestamp:
     @property
     def stype_in(self) -> SType | None:
         """
-        Return the query input symbology type for the data. If None, the
-        records may contain mixed STypes.
+        Return the query input symbology type for the data.
+
+        If None, the records may contain mixed STypes.
 
         Returns
         -------

databento/common/enums.py

@@ -85,8 +85,10 @@ def coerced_new(enum: type[M], value: object) -> M:
 
 class StringyMixin:
     """
-    Mixin class for overloading __str__ on Enum types. This will use the
-    Enumerations subclass, if any, to modify the behavior of str().
+    Mixin class for overloading __str__ on Enum types.
+
+    This will use the Enumerations subclass, if any, to modify the
+    behavior of str().
 
     For subclasses of enum.Flag a comma separated string of names is
     returned. For integer enumerations, the lowercase member name is
@@ -196,6 +198,8 @@ class RecordFlags(StringyMixin, IntFlag):  # type: ignore
     """
     Represents record flags.
 
+    Attributes
+    ----------
     F_LAST
         Marks the last record in a single event for a given `instrument_id`.
     F_TOB

databento/common/parsing.py

@@ -168,8 +168,9 @@ def symbols_list_to_list(
 @symbols_list_to_list.register(cls=Integral)
 def _(symbols: Integral, stype_in: SType) -> list[str]:
     """
-    Dispatch method for optional_symbols_list_to_list. Handles integral types,
-    alerting when an integer is given for STypes that expect strings.
+    Dispatch method for optional_symbols_list_to_list.
+
+    Handles integral types, alerting when an integer is given for STypes that expect strings.
 
     See Also
     --------
@@ -187,8 +188,9 @@ def _(symbols: Integral, stype_in: SType) -> list[str]:
 @symbols_list_to_list.register(cls=str)
 def _(symbols: str, stype_in: SType) -> list[str]:
     """
-    Dispatch method for optional_symbols_list_to_list. Handles str, splitting
-    on commas and validating smart symbology.
+    Dispatch method for optional_symbols_list_to_list.
+
+    Handles str, splitting on commas and validating smart symbology.
 
     See Also
     --------
@@ -212,8 +214,9 @@ def _(symbols: str, stype_in: SType) -> list[str]:
 @symbols_list_to_list.register(cls=Iterable)
 def _(symbols: Iterable[Any], stype_in: SType) -> list[str]:
     """
-    Dispatch method for optional_symbols_list_to_list. Handles Iterables by
-    dispatching the individual members.
+    Dispatch method for optional_symbols_list_to_list.
+
+    Handles Iterables by dispatching the individual members.
 
     See Also
     --------

databento/common/symbology.py

@@ -645,8 +645,9 @@ def map_symbols_json(
 
     def build_symbol_map(self) -> dict[int, list[tuple[dt.date, dt.date, str]]]:
         """
-        Build a simple symbol map. This is to interface with methods of
-        databento-dbn.
+        Build a simple symbol map.
+
+        This is to interface with methods of databento-dbn.
 
         Returns
         -------

databento/common/types.py

@@ -22,8 +22,9 @@
 
 class Default(Generic[_T]):
     """
-    A container for a default value. This is to be used when a callable wants
-    to detect if a default parameter value is being used.
+    A container for a default value.
+
+    This is to be used when a callable wants to detect if a default parameter value is being used.
 
     Example
     -------
@@ -152,8 +153,9 @@ def flush(self) -> None:
 
     def write(self, data: bytes) -> None:
         """
-        Write data to the underlying stream. Any exceptions encountered will be
-        dispatched to the exception callback, if defined.
+        Write data to the underlying stream.
+
+        Any exceptions encountered will be dispatched to the exception callback, if defined.
 
         Parameters
         ----------

databento/common/validation.py

@@ -20,8 +20,9 @@
 
 def validate_path(value: PathLike[str] | str, param: str) -> Path:
     """
-    Validate whether the given value is a valid path. This also expands user
-    directories to form valid paths.
+    Validate whether the given value is a valid path.
+
+    This also expands user directories to form valid paths.
 
     Parameters
     ----------

databento/historical/api/batch.py

@@ -588,7 +588,8 @@ class _BatchJob:
     """
     Helper class for downloading multiple batch files from a job.
 
-    Supports sync and async downloads using a shared `ThreadPoolExecutor`.
+    Supports sync and async downloads using a shared
+    `ThreadPoolExecutor`.
 
     """
 

databento/live/client.py

@@ -159,8 +159,9 @@ def __repr__(self) -> str:
     @property
     def dataset(self) -> str:
         """
-        Return the dataset for this live client. If no subscriptions have been
-        made an empty string will be returned.
+        Return the dataset for this live client.
+
+        If no subscriptions have been made an empty string will be returned.
 
         Returns
         -------
@@ -234,8 +235,9 @@ def port(self) -> int:
     @property
     def session_id(self) -> str | None:
         """
-        Return the session ID for the current session. If `None`, the client is
-        not connected.
+        Return the session ID for the current session.
+
+        If `None`, the client is not connected.
 
         Returns
         -------
@@ -279,8 +281,9 @@ def subscription_requests(
     @property
     def symbology_map(self) -> dict[int, str | int]:
         """
-        Return the symbology map for this client session. A symbol mapping is
-        added when the client receives a SymbolMappingMsg.
+        Return the symbology map for this client session.
+
+        A symbol mapping is added when the client receives a SymbolMappingMsg.
 
         This can be used to transform an `instrument_id` in a DBN record
         to the input symbology.
@@ -398,8 +401,9 @@ def add_reconnect_callback(
         exception_callback: ExceptionCallback | None = None,
     ) -> None:
         """
-        Add a callback for handling client reconnection events. This will only
-        be called when using a reconnection policy other than
+        Add a callback for handling client reconnection events.
+
+        This will only be called when using a reconnection policy other than
         `ReconnectPolicy.NONE` and if the session has been started with
         `Live.start`.
 
@@ -614,8 +618,9 @@ def block_for_close(
         timeout: float | None = None,
     ) -> None:
         """
-        Block until the session closes or a timeout is reached. A session will
-        close after the remote gateway disconnects, or after `Live.stop` or
+        Block until the session closes or a timeout is reached.
+
+        A session will close after the remote gateway disconnects, or after `Live.stop` or
         `Live.terminate` are called.
 
         If a `timeout` is specified, `Live.terminate` will be called when the
@@ -661,8 +666,9 @@ async def wait_for_close(
         timeout: float | None = None,
     ) -> None:
         """
-        Coroutine to wait until the session closes or a timeout is reached. A
-        session will close when the remote gateway disconnects, or after
+        Coroutine to wait until the session closes or a timeout is reached.
+
+        A session will close when the remote gateway disconnects, or after
         `Live.stop` or `Live.terminate` are called.
 
         If a `timeout` is specified, `Live.terminate` will be called when the
@@ -718,8 +724,9 @@ def _map_symbol(self, record: DBNRecord) -> None:
 
 class LiveIterator:
     """
-    Iterator class for the `Live` client. Automatically starts the client when
-    created and will stop it when destroyed. This provides context-manager-like
+    Iterator class for the `Live` client.
+
+    Automatically starts the client when created and will stop it when destroyed. This provides context-manager-like
     behavior to for loops.
 
     Parameters

databento/live/gateway.py

@@ -194,8 +194,9 @@ def buffer(self) -> BytesIO:
 
     def write(self, data: bytes) -> None:
         """
-        Write data to the decoder's buffer. This will make the data available
-        for decoding.
+        Write data to the decoder's buffer.
+
+        This will make the data available for decoding.
 
         Parameters
         ----------
@@ -208,8 +209,9 @@ def write(self, data: bytes) -> None:
 
     def decode(self) -> list[GatewayControl]:
         """
-        Decode messages from the decoder's buffer. This will consume decoded
-        data from the buffer.
+        Decode messages from the decoder's buffer.
+
+        This will consume decoded data from the buffer.
 
         Returns
         -------