Ruff D: Docstring fixes

Author: evertlammerts

duckdb/experimental/spark/exception.py

@@ -1,7 +1,7 @@
 class ContributionsAcceptedError(NotImplementedError):
     """This method is not planned to be implemented, if you would like to implement this method
     or show your interest in this method to other members of the community,
-    feel free to open up a PR or a Discussion over on https://github.com/duckdb/duckdb
+    feel free to open up a PR or a Discussion over on https://github.com/duckdb/duckdb.
     """
 
     def __init__(self, message=None) -> None:

duckdb/experimental/spark/sql/column.py

@@ -29,7 +29,7 @@ def _unary_op(
     name: str,
     doc: str = "unary operator",
 ) -> Callable[["Column"], "Column"]:
-    """Create a method for given unary operator"""
+    """Create a method for given unary operator."""
 
     def _(self: "Column") -> "Column":
         # Call the function identified by 'name' on the internal Expression object
@@ -44,7 +44,7 @@ def _bin_op(
     name: str,
     doc: str = "binary operator",
 ) -> Callable[["Column", Union["Column", "LiteralType", "DecimalLiteral", "DateTimeLiteral"]], "Column"]:
-    """Create a method for given binary operator"""
+    """Create a method for given binary operator."""
 
     def _(
         self: "Column",
@@ -62,7 +62,7 @@ def _bin_func(
     name: str,
     doc: str = "binary function",
 ) -> Callable[["Column", Union["Column", "LiteralType", "DecimalLiteral", "DateTimeLiteral"]], "Column"]:
-    """Create a function expression for the given binary function"""
+    """Create a function expression for the given binary function."""
 
     def _(
         self: "Column",
@@ -245,14 +245,14 @@ def __eq__(  # type: ignore[override]
         self,
         other: Union["Column", "LiteralType", "DecimalLiteral", "DateTimeLiteral"],
     ) -> "Column":
-        """Binary function"""
+        """Binary function."""
         return Column(self.expr == (_get_expr(other)))
 
     def __ne__(  # type: ignore[override]
         self,
         other: object,
     ) -> "Column":
-        """Binary function"""
+        """Binary function."""
         return Column(self.expr != (_get_expr(other)))
 
     __lt__ = _bin_op("__lt__")

duckdb/experimental/spark/sql/dataframe.py

@@ -845,7 +845,7 @@ def limit(self, num: int) -> "DataFrame":
         return DataFrame(rel, self.session)
 
     def __contains__(self, item: str) -> bool:
-        """Check if the :class:`DataFrame` contains a column by the name of `item`"""
+        """Check if the :class:`DataFrame` contains a column by the name of `item`."""
         return item in self.relation
 
     @property

duckdb/experimental/spark/sql/functions.py

@@ -164,7 +164,7 @@ def _to_column_expr(col: ColumnOrName) -> Expression:
 
 
 def regexp_replace(str: "ColumnOrName", pattern: str, replacement: str) -> Column:
-    r"""Replace all substrings of the specified string value that match regexp with rep.
+    """Replace all substrings of the specified string value that match regexp with rep.
 
     .. versionadded:: 1.5.0
 
@@ -1487,7 +1487,7 @@ def approx_count_distinct(col: "ColumnOrName", rsd: Optional[float] = None) -> C
 
 
 def approxCountDistinct(col: "ColumnOrName", rsd: Optional[float] = None) -> Column:
-    """.. versionadded:: 1.3.0
+    """.. versionadded:: 1.3.0.
 
     .. versionchanged:: 3.4.0
         Supports Spark Connect.
@@ -2059,7 +2059,7 @@ def cbrt(col: "ColumnOrName") -> Column:
 
 def char(col: "ColumnOrName") -> Column:
     """Returns the ASCII character having the binary equivalent to `col`. If col is larger than 256 the
-    result is equivalent to char(col % 256)
+    result is equivalent to char(col % 256).
 
     .. versionadded:: 3.5.0
 
@@ -2373,7 +2373,7 @@ def rand(seed: Optional[int] = None) -> Column:
 
 
 def regexp(str: "ColumnOrName", regexp: "ColumnOrName") -> Column:
-    r"""Returns true if `str` matches the Java regex `regexp`, or false otherwise.
+    """Returns true if `str` matches the Java regex `regexp`, or false otherwise.
 
     .. versionadded:: 3.5.0
 
@@ -2425,7 +2425,7 @@ def regexp(str: "ColumnOrName", regexp: "ColumnOrName") -> Column:
 
 
 def regexp_count(str: "ColumnOrName", regexp: "ColumnOrName") -> Column:
-    r"""Returns a count of the number of times that the Java regex pattern `regexp` is matched
+    """Returns a count of the number of times that the Java regex pattern `regexp` is matched
     in the string `str`.
 
     .. versionadded:: 3.5.0
@@ -2456,7 +2456,7 @@ def regexp_count(str: "ColumnOrName", regexp: "ColumnOrName") -> Column:
 
 
 def regexp_extract(str: "ColumnOrName", pattern: str, idx: int) -> Column:
-    r"""Extract a specific group matched by the Java regex `regexp`, from the specified string column.
+    """Extract a specific group matched by the Java regex `regexp`, from the specified string column.
     If the regex did not match, or the specified group did not match, an empty string is returned.
 
     .. versionadded:: 1.5.0
@@ -2496,7 +2496,7 @@ def regexp_extract(str: "ColumnOrName", pattern: str, idx: int) -> Column:
 
 
 def regexp_extract_all(str: "ColumnOrName", regexp: "ColumnOrName", idx: Optional[Union[int, Column]] = None) -> Column:
-    r"""Extract all strings in the `str` that match the Java regex `regexp`
+    """Extract all strings in the `str` that match the Java regex `regexp`
     and corresponding to the regex group index.
 
     .. versionadded:: 3.5.0
@@ -2535,7 +2535,7 @@ def regexp_extract_all(str: "ColumnOrName", regexp: "ColumnOrName", idx: Optiona
 
 
 def regexp_like(str: "ColumnOrName", regexp: "ColumnOrName") -> Column:
-    r"""Returns true if `str` matches the Java regex `regexp`, or false otherwise.
+    """Returns true if `str` matches the Java regex `regexp`, or false otherwise.
 
     .. versionadded:: 3.5.0
 
@@ -2587,7 +2587,7 @@ def regexp_like(str: "ColumnOrName", regexp: "ColumnOrName") -> Column:
 
 
 def regexp_substr(str: "ColumnOrName", regexp: "ColumnOrName") -> Column:
-    r"""Returns the substring that matches the Java regex `regexp` within the string `str`.
+    """Returns the substring that matches the Java regex `regexp` within the string `str`.
     If the regular expression is not found, the result is null.
 
     .. versionadded:: 3.5.0
@@ -3996,7 +3996,7 @@ def month(col: "ColumnOrName") -> Column:
 
 def dayofweek(col: "ColumnOrName") -> Column:
     """Extract the day of the week of a given date/timestamp as integer.
-    Ranges from 1 for a Sunday through to 7 for a Saturday
+    Ranges from 1 for a Sunday through to 7 for a Saturday.
 
     .. versionadded:: 2.3.0
 
@@ -4187,7 +4187,7 @@ def second(col: "ColumnOrName") -> Column:
 def weekofyear(col: "ColumnOrName") -> Column:
     """Extract the week number of a given date as integer.
     A week is considered to start on a Monday and week 1 is the first week with more than 3 days,
-    as defined by ISO 8601
+    as defined by ISO 8601.
 
     .. versionadded:: 1.5.0
 
@@ -4609,7 +4609,7 @@ def atan(col: "ColumnOrName") -> Column:
 
 
 def atan2(col1: Union["ColumnOrName", float], col2: Union["ColumnOrName", float]) -> Column:
-    """.. versionadded:: 1.4.0
+    """.. versionadded:: 1.4.0.
 
     .. versionchanged:: 3.4.0
         Supports Spark Connect.
@@ -5577,7 +5577,7 @@ def var_samp(col: "ColumnOrName") -> Column:
 
 
 def variance(col: "ColumnOrName") -> Column:
-    """Aggregate function: alias for var_samp
+    """Aggregate function: alias for var_samp.
 
     .. versionadded:: 1.6.0
 
@@ -6242,7 +6242,7 @@ def instr(str: "ColumnOrName", substr: str) -> Column:
 
 
 def expr(str: str) -> Column:
-    """Parses the expression string into the column that it represents
+    """Parses the expression string into the column that it represents.
 
     .. versionadded:: 1.5.0
 

duckdb/experimental/spark/sql/types.py

@@ -113,7 +113,7 @@ def fromInternal(self, obj: Any) -> Any:
 # This singleton pattern does not work with pickle, you will get
 # another object after pickle and unpickle
 class DataTypeSingleton(type):
-    """Metaclass for DataType"""
+    """Metaclass for DataType."""
 
     _instances: ClassVar[dict[type["DataTypeSingleton"], "DataTypeSingleton"]] = {}
 
@@ -855,7 +855,7 @@ def add(
         return self
 
     def __iter__(self) -> Iterator[StructField]:
-        """Iterate the fields"""
+        """Iterate the fields."""
         return iter(self.fields)
 
     def __len__(self) -> int:
@@ -1147,7 +1147,7 @@ def __new__(cls, *args: Optional[str], **kwargs: Optional[Any]) -> "Row":
             return tuple.__new__(cls, args)
 
     def asDict(self, recursive: bool = False) -> dict[str, Any]:
-        """Return as a dict
+        """Return as a dict.
 
         Parameters
         ----------
@@ -1200,7 +1200,7 @@ def __contains__(self, item: Any) -> bool:
 
     # let object acts like class
     def __call__(self, *args: Any) -> "Row":
-        """Create new Row object"""
+        """Create new Row object."""
         if len(args) > len(self):
             raise ValueError(
                 "Can not create Row with fields %s, expected %d values but got %s" % (self, len(self), args)

duckdb/udf.py

@@ -1,5 +1,5 @@
 def vectorized(func):
-    """Decorate a function with annotated function parameters, so DuckDB can infer that the function should be provided with pyarrow arrays and should expect pyarrow array(s) as output"""
+    """Decorate a function with annotated function parameters, so DuckDB can infer that the function should be provided with pyarrow arrays and should expect pyarrow array(s) as output."""
     import types
     from inspect import signature
 

sqllogic/conftest.py

@@ -271,7 +271,7 @@ def pytest_collection_modifyitems(session: pytest.Session, config: pytest.Config
 
 
 def pytest_runtest_setup(item: pytest.Item):
-    """Show the test index after the test name"""
+    """Show the test index after the test name."""
 
     def get_from_tuple_list(tuples, key):
         for t in tuples:

tests/fast/spark/test_spark_dataframe.py

@@ -339,7 +339,7 @@ def test_df_columns(self, spark):
         assert "OtherInfo" in updatedDF.columns
 
     def test_array_and_map_type(self, spark):
-        """Array & Map"""
+        """Array & Map."""
         arrayStructureSchema = StructType(
             [
                 StructField(

tests/fast/test_json_logging.py

@@ -6,7 +6,7 @@
 
 
 def _parse_json_func(error_prefix: str):
-    """Helper to check that the error message is indeed parsable json"""
+    """Helper to check that the error message is indeed parsable json."""
 
     def parse_func(exception):
         msg = exception.args[0]

tests/fast/test_pypi_cleanup.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-"""Unit tests for pypi_cleanup.py
+"""Unit tests for pypi_cleanup.py.
 
 Run with: python -m pytest test_pypi_cleanup.py -v
 """