style(docstrings): format docstrings according to black style

ibis-project · Sep 12, 2023 · 9e1109b · 9e1109b
1 parent 5ed750f
commit 9e1109b
Show file tree

Hide file tree

Showing 34 changed files with 431 additions and 284 deletions.
diff --git a/ibis/backends/base/__init__.py b/ibis/backends/base/__init__.py
@@ -175,7 +175,7 @@ class TablesAccessor(collections.abc.Mapping):
     Examples
     --------
     >>> con = ibis.sqlite.connect("example.db")
-    >>> people = con.tables['people']  # access via index
+    >>> people = con.tables["people"]  # access via index
     >>> people = con.tables.people  # access via attribute
     """
 
@@ -848,7 +848,7 @@ def tables(self):
         Examples
         --------
         >>> con = ibis.sqlite.connect("example.db")
-        >>> people = con.tables['people']  # access via index
+        >>> people = con.tables["people"]  # access via index
         >>> people = con.tables.people  # access via attribute
         """
         return TablesAccessor(self)
@@ -1202,11 +1202,15 @@ def connect(resource: Path | str, **kwargs: Any) -> BaseBackend:
 
     Connect to a PostgreSQL server:
 
-    >>> con = ibis.connect("postgres://user:password@hostname:5432")  # quartodoc: +SKIP # doctest: +SKIP
+    >>> con = ibis.connect(
+    ...     "postgres://user:password@hostname:5432"
+    ... )  # quartodoc: +SKIP # doctest: +SKIP
 
     Connect to BigQuery:
 
-    >>> con = ibis.connect("bigquery://my-project/my-dataset")  # quartodoc: +SKIP # doctest: +SKIP
+    >>> con = ibis.connect(
+    ...     "bigquery://my-project/my-dataset"
+    ... )  # quartodoc: +SKIP # doctest: +SKIP
     """
     url = resource = str(resource)
 

diff --git a/ibis/backends/base/df/timecontext.py b/ibis/backends/base/df/timecontext.py
@@ -162,30 +162,30 @@ def construct_time_context_aware_series(
     Examples
     --------
     >>> import pandas as pd
-    >>> from ibis.backends.base.df.timecontext import construct_time_context_aware_series
+    >>> from ibis.backends.base.df.timecontext import (
+    ...     construct_time_context_aware_series,
+    ... )
     >>> df = pd.DataFrame(
     ...     {
-    ...         'time': pd.Series(
-    ...             pd.date_range(
-    ...                 start='2017-01-02', periods=3
-    ...             ).values
-    ...         ),
-    ...         'id': [1,2,3],
-    ...         'value': [1.1, 2.2, 3.3],
+    ...         "time": pd.Series(pd.date_range(start="2017-01-02", periods=3).values),
+    ...         "id": [1, 2, 3],
+    ...         "value": [1.1, 2.2, 3.3],
     ...     }
     ... )
     >>> df
             time  id  value
     0 2017-01-02   1    1.1
     1 2017-01-03   2    2.2
     2 2017-01-04   3    3.3
-    >>> series = df['value']
+    >>> series = df["value"]
     >>> series
     0    1.1
     1    2.2
     2    3.3
     Name: value, dtype: float64
-    >>> construct_time_context_aware_series(series, df)  # quartodoc: +SKIP # doctest: +SKIP
+    >>> construct_time_context_aware_series(
+    ...     series, df
+    ... )  # quartodoc: +SKIP # doctest: +SKIP
        time
     0  2017-01-02    1.1
     1  2017-01-03    2.2
@@ -203,7 +203,9 @@ def construct_time_context_aware_series(
     2  2017-01-04    3.3
     Name: value, dtype: float64
 
-    >>> construct_time_context_aware_series(timed_series, df)  # quartodoc: +SKIP # doctest: +SKIP
+    >>> construct_time_context_aware_series(
+    ...     timed_series, df
+    ... )  # quartodoc: +SKIP # doctest: +SKIP
        time
     0  2017-01-02    1.1
     1  2017-01-03    2.2

diff --git a/ibis/backends/base/sql/__init__.py b/ibis/backends/base/sql/__init__.py
@@ -171,6 +171,7 @@ def raw_sql(self, query: str):
         >>> con = ibis.connect("duckdb://")
         >>> with con.raw_sql("SELECT 1") as cursor:
         ...     result = cursor.fetchall()
+        ...
         >>> result
         [(1,)]
         >>> cursor.closed

diff --git a/ibis/backends/bigquery/client.py b/ibis/backends/bigquery/client.py
@@ -178,8 +178,7 @@ def parse_project_and_dataset(project: str, dataset: str = "") -> tuple[str, str
     Examples
     --------
     >>> data_project, billing_project, dataset = parse_project_and_dataset(
-    ...     'ibis-gbq',
-    ...     'foo-bar.my_dataset'
+    ...     "ibis-gbq", "foo-bar.my_dataset"
     ... )
     >>> data_project
     'foo-bar'
@@ -188,18 +187,15 @@ def parse_project_and_dataset(project: str, dataset: str = "") -> tuple[str, str
     >>> dataset
     'my_dataset'
     >>> data_project, billing_project, dataset = parse_project_and_dataset(
-    ...     'ibis-gbq',
-    ...     'my_dataset'
+    ...     "ibis-gbq", "my_dataset"
     ... )
     >>> data_project
     'ibis-gbq'
     >>> billing_project
     'ibis-gbq'
     >>> dataset
     'my_dataset'
-    >>> data_project, billing_project, _ = parse_project_and_dataset(
-    ...     'ibis-gbq'
-    ... )
+    >>> data_project, billing_project, _ = parse_project_and_dataset("ibis-gbq")
     >>> data_project
     'ibis-gbq'
     """

diff --git a/ibis/backends/bigquery/udf/__init__.py b/ibis/backends/bigquery/udf/__init__.py
@@ -87,6 +87,7 @@ def python(
         >>> @udf.python(input_type=[dt.double], output_type=dt.double)
         ... def add_one(x):
         ...     return x + 1
+        ...
         >>> print(add_one.sql)
         CREATE TEMPORARY FUNCTION add_one_0(x FLOAT64)
         RETURNS FLOAT64
@@ -97,14 +98,16 @@ def python(
         }
         return add_one(x);
         """;
-        >>> @udf.python(input_type=[dt.double, dt.double],
-        ...      output_type=dt.Array(dt.double))
+        >>> @udf.python(
+        ...     input_type=[dt.double, dt.double], output_type=dt.Array(dt.double)
+        ... )
         ... def my_range(start, stop):
         ...     def gen(start, stop):
         ...         curr = start
         ...         while curr < stop:
         ...             yield curr
         ...             curr += 1
+        ...
         ...     result = []
         ...     for value in gen(start, stop):
         ...         result.append(value)
@@ -132,9 +135,9 @@ def python(
         """;
         >>> @udf.python(
         ...     input_type=[dt.double, dt.double],
-        ...     output_type=dt.Struct.from_tuples([
-        ...         ('width', 'double'), ('height', 'double')
-        ...     ])
+        ...     output_type=dt.Struct.from_tuples(
+        ...         [("width", "double"), ("height", "double")]
+        ...     ),
         ... )
         ... def my_rectangle(width, height):
         ...     class Rectangle:
@@ -247,7 +250,7 @@ def js(
         ...     name="add_one",
         ...     params={"a": dt.double},
         ...     output_type=dt.double,
-        ...     body="return x + 1"
+        ...     body="return x + 1",
         ... )
         >>> print(add_one.sql)
         CREATE TEMPORARY FUNCTION add_one_0(x FLOAT64)
@@ -356,10 +359,10 @@ def sql(
         >>> from ibis.backends.bigquery import udf
         >>> import ibis.expr.datatypes as dt
         >>> add_one = udf.sql(
-        ...    name="add_one",
-        ...    params={'x': dt.double},
-        ...    output_type=dt.double,
-        ...    sql_expression="x + 1"
+        ...     name="add_one",
+        ...     params={"x": dt.double},
+        ...     output_type=dt.double,
+        ...     sql_expression="x + 1",
         ... )
         >>> print(add_one.sql)
         CREATE TEMPORARY FUNCTION add_one_0(x FLOAT64)

diff --git a/ibis/backends/bigquery/udf/find.py b/ibis/backends/bigquery/udf/find.py
@@ -44,7 +44,7 @@ def find_names(node: ast.AST) -> list[ast.Name]:
     Examples
     --------
     >>> import ast
-    >>> node = ast.parse('a + b')
+    >>> node = ast.parse("a + b")
     >>> names = find_names(node)
     >>> names
     [<....Name object at 0x...>, <....Name object at 0x...>]

diff --git a/ibis/backends/dask/execution/util.py b/ibis/backends/dask/execution/util.py
@@ -115,12 +115,12 @@ def coerce_to_output(
     >>> coerce_to_output(1, expr)  # quartodoc: +SKIP # doctest: +SKIP
     0    1
     Name: result, dtype: int64
-    >>> coerce_to_output(1, expr, [1,2,3])  # quartodoc: +SKIP # doctest: +SKIP
+    >>> coerce_to_output(1, expr, [1, 2, 3])  # quartodoc: +SKIP # doctest: +SKIP
     1    1
     2    1
     3    1
     Name: result, dtype: int64
-    >>> coerce_to_output([1,2,3], expr)  # quartodoc: +SKIP # doctest: +SKIP
+    >>> coerce_to_output([1, 2, 3], expr)  # quartodoc: +SKIP # doctest: +SKIP
     0    [1, 2, 3]
     Name: result, dtype: object
     """

diff --git a/ibis/backends/duckdb/__init__.py b/ibis/backends/duckdb/__init__.py
@@ -759,6 +759,7 @@ def read_sqlite(self, path: str | Path, table_name: str | None = None) -> ir.Tab
         ...     _ = con.execute("DROP TABLE IF EXISTS t")
         ...     _ = con.execute("CREATE TABLE t (a INT, b TEXT)")
         ...     _ = con.execute("INSERT INTO t VALUES (1, 'a'), (2, 'b'), (3, 'c')")
+        ...
         >>> con = ibis.connect("duckdb://")
         >>> t = con.read_sqlite("/tmp/sqlite.db", table_name="t")
         >>> t
@@ -809,6 +810,7 @@ def attach_sqlite(
         ...     _ = con.execute("DROP TABLE IF EXISTS t")
         ...     _ = con.execute("CREATE TABLE t (a INT, b TEXT)")
         ...     _ = con.execute("INSERT INTO t VALUES (1, 'a'), (2, 'b'), (3, 'c')")
+        ...
         >>> con = ibis.connect("duckdb://")
         >>> con.list_tables()
         []
@@ -995,7 +997,9 @@ def to_parquet(
 
         Partition on multiple columns.
 
-        >>> con.to_parquet(penguins, tempfile.mkdtemp(), partition_by=("year", "island"))
+        >>> con.to_parquet(
+        ...     penguins, tempfile.mkdtemp(), partition_by=("year", "island")
+        ... )
         """
         self._run_pre_execute_hooks(expr)
         query = self._to_sql(expr, params=params)

diff --git a/ibis/backends/impala/__init__.py b/ibis/backends/impala/__init__.py
@@ -272,10 +272,10 @@ def do_connect(
         --------
         >>> import os
         >>> import ibis
-        >>> hdfs_host = os.environ.get('IBIS_TEST_NN_HOST', 'localhost')
-        >>> hdfs_port = int(os.environ.get('IBIS_TEST_NN_PORT', 50070))
-        >>> impala_host = os.environ.get('IBIS_TEST_IMPALA_HOST', 'localhost')
-        >>> impala_port = int(os.environ.get('IBIS_TEST_IMPALA_PORT', 21050))
+        >>> hdfs_host = os.environ.get("IBIS_TEST_NN_HOST", "localhost")
+        >>> hdfs_port = int(os.environ.get("IBIS_TEST_NN_PORT", 50070))
+        >>> impala_host = os.environ.get("IBIS_TEST_IMPALA_HOST", "localhost")
+        >>> impala_port = int(os.environ.get("IBIS_TEST_IMPALA_PORT", 21050))
         >>> hdfs = ibis.impala.hdfs_connect(host=hdfs_host, port=hdfs_port)
         >>> client = ibis.impala.connect(
         ...     host=impala_host,
@@ -927,11 +927,13 @@ def insert(
 
         Examples
         --------
-        >>> table = 'my_table'
+        >>> table = "my_table"
         >>> con.insert(table, table_expr)  # quartodoc: +SKIP # doctest: +SKIP
 
         Completely overwrite contents
-        >>> con.insert(table, table_expr, overwrite=True)  # quartodoc: +SKIP # doctest: +SKIP
+        >>> con.insert(
+        ...     table, table_expr, overwrite=True
+        ... )  # quartodoc: +SKIP # doctest: +SKIP
         """
         table = self.table(table_name, database=database)
         return table.insert(
@@ -958,9 +960,11 @@ def drop_table(
 
         Examples
         --------
-        >>> table = 'my_table'
-        >>> db = 'operations'
-        >>> con.drop_table(table, database=db, force=True)  # quartodoc: +SKIP # doctest: +SKIP
+        >>> table = "my_table"
+        >>> db = "operations"
+        >>> con.drop_table(
+        ...     table, database=db, force=True
+        ... )  # quartodoc: +SKIP # doctest: +SKIP
         """
         statement = DropTable(name, database=database, must_exist=not force)
         self._safe_exec_sql(statement)
@@ -1015,10 +1019,12 @@ def cache_table(self, table_name, *, database=None, pool="default"):
 
         Examples
         --------
-        >>> table = 'my_table'
-        >>> db = 'operations'
-        >>> pool = 'op_4GB_pool'
-        >>> con.cache_table('my_table', database=db, pool=pool)  # quartodoc: +SKIP # doctest: +SKIP
+        >>> table = "my_table"
+        >>> db = "operations"
+        >>> pool = "op_4GB_pool"
+        >>> con.cache_table(
+        ...     "my_table", database=db, pool=pool
+        ... )  # quartodoc: +SKIP # doctest: +SKIP
         """
         statement = ddl.CacheTable(table_name, database=database, pool=pool)
         self._safe_exec_sql(statement)

diff --git a/ibis/backends/mysql/__init__.py b/ibis/backends/mysql/__init__.py
@@ -65,20 +65,14 @@ def do_connect(
         --------
         >>> import os
         >>> import getpass
-        >>> host = os.environ.get('IBIS_TEST_MYSQL_HOST', 'localhost')
-        >>> user = os.environ.get('IBIS_TEST_MYSQL_USER', getpass.getuser())
-        >>> password = os.environ.get('IBIS_TEST_MYSQL_PASSWORD')
-        >>> database = os.environ.get('IBIS_TEST_MYSQL_DATABASE',
-        ...                           'ibis_testing')
-        >>> con = connect(
-        ...     database=database,
-        ...     host=host,
-        ...     user=user,
-        ...     password=password
-        ... )
+        >>> host = os.environ.get("IBIS_TEST_MYSQL_HOST", "localhost")
+        >>> user = os.environ.get("IBIS_TEST_MYSQL_USER", getpass.getuser())
+        >>> password = os.environ.get("IBIS_TEST_MYSQL_PASSWORD")
+        >>> database = os.environ.get("IBIS_TEST_MYSQL_DATABASE", "ibis_testing")
+        >>> con = connect(database=database, host=host, user=user, password=password)
         >>> con.list_tables()  # doctest: +ELLIPSIS
         [...]
-        >>> t = con.table('functional_alltypes')
+        >>> t = con.table("functional_alltypes")
         >>> t
         MySQLTable[table]
           name: functional_alltypes