ADD: Add docformatter to pre-commit

Author: nmacholl

databento/common/bentologging.py

@@ -5,9 +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 advisible to configure your own logging for serious applications.
+    Enable logging for the Databento module. This function should be used for
+    simple applications and examples. It is advisible to configure your own
+    logging for serious applications.
 
     Parameters
     ----------

databento/common/cram.py

@@ -1,4 +1,6 @@
-"""Functions for handling challenge-response authentication"""
+"""
+Functions for handling challenge-response authentication.
+"""
 import argparse
 import hashlib
 import os
@@ -10,9 +12,8 @@
 
 def get_challenge_response(challenge: str, key: str) -> str:
     """
-    Return the response for a given challenge-response
-    authentication mechanism (CRAM) code provided by
-    a Databento service.
+    Return the response for a given challenge-response authentication mechanism
+    (CRAM) code provided by a Databento service.
 
     A valid API key is hashed with the challenge string.
 

databento/common/dbnstore.py

@@ -55,8 +55,7 @@
 
 def is_zstandard(reader: IO[bytes]) -> bool:
     """
-    Determine if an `IO[bytes]` reader contains zstandard compressed
-    data.
+    Determine if an `IO[bytes]` reader contains zstandard compressed data.
 
     Parameters
     ----------
@@ -96,7 +95,9 @@ def is_dbn(reader: IO[bytes]) -> bool:
 
 
 class DataSource(abc.ABC):
-    """Abstract base class for backing DBNStore instances with data."""
+    """
+    Abstract base class for backing DBNStore instances with data.
+    """
 
     def __init__(self, source: object) -> None:
         ...
@@ -244,8 +245,8 @@ def nbytes(self) -> int:
     @property
     def reader(self) -> IO[bytes]:
         """
-        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
         -------
@@ -500,8 +501,8 @@ def _map_symbols(self, df: pd.DataFrame, pretty_ts: bool) -> pd.DataFrame:
     @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
         -------
@@ -525,8 +526,8 @@ 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
         -------
@@ -632,8 +633,7 @@ 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
         -------
@@ -664,8 +664,8 @@ 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

@@ -22,7 +22,8 @@
 
 
 def coercible(enum_type: type[M]) -> type[M]:
-    """Decorate coercible enumerations.
+    """
+    Decorate coercible enumerations.
 
     Decorating an Enum class with this function will intercept calls to
     __new__ and perform a type coercion for the passed value. The type conversion
@@ -94,13 +95,12 @@ 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 returned.
-    For string enumerations, the value is returned.
+    For subclasses of enum.Flag a comma separated string of names is
+    returned. For integer enumerations, the lowercase member name is
+    returned. For string enumerations, the value is returned.
 
     """
 
@@ -115,15 +115,19 @@ def __str__(self) -> str:
 @unique
 @coercible
 class HistoricalGateway(StringyMixin, str, Enum):
-    """Represents a historical data center gateway location."""
+    """
+    Represents a historical data center gateway location.
+    """
 
     BO1 = "https://hist.databento.com"
 
 
 @unique
 @coercible
 class FeedMode(StringyMixin, str, Enum):
-    """Represents a data feed mode."""
+    """
+    Represents a data feed mode.
+    """
 
     HISTORICAL = "historical"
     HISTORICAL_STREAMING = "historical-streaming"
@@ -133,7 +137,9 @@ class FeedMode(StringyMixin, str, Enum):
 @unique
 @coercible
 class Dataset(StringyMixin, str, Enum):
-    """Represents a dataset code (string identifier)."""
+    """
+    Represents a dataset code (string identifier).
+    """
 
     GLBX_MDP3 = "GLBX.MDP3"
     XNAS_ITCH = "XNAS.ITCH"
@@ -142,7 +148,9 @@ class Dataset(StringyMixin, str, Enum):
 @unique
 @coercible
 class Schema(StringyMixin, str, Enum):
-    """Represents a data record schema."""
+    """
+    Represents a data record schema.
+    """
 
     MBO = "mbo"
     MBP_1 = "mbp-1"
@@ -188,7 +196,9 @@ def get_record_type(self) -> type[DBNRecord]:
 @unique
 @coercible
 class Encoding(StringyMixin, str, Enum):
-    """Represents a data output encoding."""
+    """
+    Represents a data output encoding.
+    """
 
     DBN = "dbn"
     CSV = "csv"
@@ -198,7 +208,9 @@ class Encoding(StringyMixin, str, Enum):
 @unique
 @coercible
 class Compression(StringyMixin, str, Enum):
-    """Represents a data compression format (if any)."""
+    """
+    Represents a data compression format (if any).
+    """
 
     NONE = "none"
     ZSTD = "zstd"
@@ -207,7 +219,9 @@ class Compression(StringyMixin, str, Enum):
 @unique
 @coercible
 class SplitDuration(StringyMixin, str, Enum):
-    """Represents the duration before splitting for each batched data file."""
+    """
+    Represents the duration before splitting for each batched data file.
+    """
 
     DAY = "day"
     WEEK = "week"
@@ -218,7 +232,9 @@ class SplitDuration(StringyMixin, str, Enum):
 @unique
 @coercible
 class Packaging(StringyMixin, str, Enum):
-    """Represents the packaging method for batched data files."""
+    """
+    Represents the packaging method for batched data files.
+    """
 
     NONE = "none"
     ZIP = "zip"
@@ -228,7 +244,9 @@ class Packaging(StringyMixin, str, Enum):
 @unique
 @coercible
 class Delivery(StringyMixin, str, Enum):
-    """Represents the delivery mechanism for batched data."""
+    """
+    Represents the delivery mechanism for batched data.
+    """
 
     DOWNLOAD = "download"
     S3 = "s3"
@@ -238,7 +256,9 @@ class Delivery(StringyMixin, str, Enum):
 @unique
 @coercible
 class SType(StringyMixin, str, Enum):
-    """Represents a symbology type."""
+    """
+    Represents a symbology type.
+    """
 
     INSTRUMENT_ID = "instrument_id"
     RAW_SYMBOL = "raw_symbol"
@@ -249,7 +269,9 @@ class SType(StringyMixin, str, Enum):
 @unique
 @coercible
 class RollRule(StringyMixin, str, Enum):
-    """Represents a smart symbology roll rule."""
+    """
+    Represents a smart symbology roll rule.
+    """
 
     VOLUME = "volume"
     OPEN_INTEREST = "open_interst"
@@ -265,6 +287,7 @@ class SymbologyResolution(StringyMixin, str, Enum):
     - OK: All symbol mappings resolved.
     - PARTIAL: One or more symbols did not resolve on at least one date.
     - NOT_FOUND: One or more symbols where not found on any date in range.
+
     """
 
     OK = "ok"
@@ -276,7 +299,8 @@ class SymbologyResolution(StringyMixin, str, Enum):
 @coercible
 # Ignore type to work around mypy bug https://github.com/python/mypy/issues/9319
 class RecordFlags(StringyMixin, IntFlag):  # type: ignore
-    """Represents record flags.
+    """
+    Represents record flags.
 
     F_LAST
         Last message in the packet from the venue for a given `instrument_id`.
@@ -288,6 +312,7 @@ class RecordFlags(StringyMixin, IntFlag):  # type: ignore
         The `ts_recv` value is inaccurate (clock issues or reordering).
 
     Other bits are reserved and have no current meaning.
+
     """
 
     F_LAST = 128

databento/common/parsing.py

@@ -90,8 +90,8 @@ def optional_symbols_list_to_string(
 @optional_symbols_list_to_string.register
 def _(_: None, __: SType) -> str:
     """
-    Dispatch method for optional_symbols_list_to_string.
-    Handles None which defaults to ALL_SYMBOLS.
+    Dispatch method for optional_symbols_list_to_string. Handles None which
+    defaults to ALL_SYMBOLS.
 
     See Also
     --------
@@ -104,9 +104,8 @@ def _(_: None, __: SType) -> str:
 @optional_symbols_list_to_string.register
 def _(symbols: Number, stype_in: SType) -> str:
     """
-    Dispatch method for optional_symbols_list_to_string.
-    Handles numerical types, alerting when an integer is
-    given for STypes that expect strings.
+    Dispatch method for optional_symbols_list_to_string. Handles numerical
+    types, alerting when an integer is given for STypes that expect strings.
 
     See Also
     --------
@@ -124,8 +123,8 @@ def _(symbols: Number, stype_in: SType) -> str:
 @optional_symbols_list_to_string.register
 def _(symbols: str, stype_in: SType) -> str:
     """
-    Dispatch method for optional_symbols_list_to_string.
-    Handles str, splitting on commas and validating smart symbology.
+    Dispatch method for optional_symbols_list_to_string. Handles str, splitting
+    on commas and validating smart symbology.
 
     See Also
     --------
@@ -154,8 +153,8 @@ def _(symbols: str, stype_in: SType) -> str:
 @optional_symbols_list_to_string.register(cls=Iterable)
 def _(symbols: Iterable[str] | Iterable[int], stype_in: SType) -> str:
     """
-    Dispatch method for optional_symbols_list_to_string.
-    Handles Iterables by dispatching the individual members.
+    Dispatch method for optional_symbols_list_to_string. Handles Iterables by
+    dispatching the individual members.
 
     See Also
     --------
@@ -295,7 +294,8 @@ def optional_datetime_to_unix_nanoseconds(
     value: pd.Timestamp | str | int | None,
 ) -> int | None:
     """
-    Return a valid UNIX nanosecond timestamp from the given value (if not None).
+    Return a valid UNIX nanosecond timestamp from the given value (if not
+    None).
 
     Parameters
     ----------

databento/common/symbology.py

@@ -21,6 +21,7 @@ class InstrumentIdMappingInterval:
         The raw symbol value.
     instrument_id : int
         The instrument ID value.
+
     """
 
     start_date: dt.date

databento/common/validation.py

@@ -43,8 +43,8 @@ def validate_enum(
     param: str,
 ) -> E:
     """
-    Validate whether the given value is either the correct Enum type, or a valid
-    value of that enum.
+    Validate whether the given value is either the correct Enum type, or a
+    valid value of that enum.
 
     Parameters
     ----------
@@ -147,6 +147,7 @@ def validate_gateway(
 def validate_semantic_string(value: str, param: str) -> str:
     """
     Validate whether a string contains a semantic value.
+
     A string is considered absent of meaning if:
         - It is empty.
         - It contains only whitespace.

databento/historical/api/metadata.py

@@ -421,8 +421,8 @@ def get_cost(
         limit: int | None = None,
     ) -> float:
         """
-        Request the cost in US dollars for historical streaming or batched files
-        from Databento.
+        Request the cost in US dollars for historical streaming or batched
+        files from Databento.
 
         Makes a `GET /metadata.get_cost` HTTP request.
 

databento/historical/api/timeseries.py

@@ -135,7 +135,8 @@ async def get_range_async(
         path: PathLike[str] | str | None = None,
     ) -> DBNStore:
         """
-        Asynchronously request a historical time series data stream from Databento.
+        Asynchronously request a historical time series data stream from
+        Databento.
 
         Makes a `GET /timeseries.get_range` HTTP request.
 

databento/historical/client.py

@@ -32,6 +32,7 @@ class Historical:
     --------
     > import databento as db
     > client = db.Historical('YOUR_API_KEY')
+
     """
 
     def __init__(