Skip to content

Commit

Permalink
refactor(api)!: align signatures of Backend.table method; name is…
Browse files Browse the repository at this point in the history
… positional-only; everything else is required-keyword
  • Loading branch information
cpcloud committed Feb 5, 2025
1 parent f5fae11 commit 22de2b5
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion ibis/backends/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1020,7 +1020,7 @@ def list_tables(

@abc.abstractmethod
def table(
self, name: str, database: tuple[str, str] | str | None = None
self, name: str, /, *, database: tuple[str, str] | str | None = None
) -> ir.Table:
"""Construct a table expression.
Expand Down
3 changes: 1 addition & 2 deletions ibis/backends/athena/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ def create_table(

return self.table(orig_table_ref.name, database=(catalog, db))

def table(self, name: str, database: str | None = None) -> ir.Table:
def table(self, name: str, /, *, database: str | None = None) -> ir.Table:
"""Construct a table expression.
Parameters
Expand All @@ -223,7 +223,6 @@ def table(self, name: str, database: str | None = None) -> ir.Table:
-------
Table
Table expression
"""
table_loc = self._to_sqlglot_table(database)

Expand Down
2 changes: 2 additions & 0 deletions ibis/backends/bigquery/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,8 @@ def drop_database(
def table(
self,
name: str,
/,
*,
database: str | None = None,
) -> ir.Table:
table_loc = self._to_sqlglot_table(database)
Expand Down
2 changes: 1 addition & 1 deletion ibis/backends/databricks/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ def create_table(

return self.table(name, database=(catalog, database))

def table(self, name: str, database: str | None = None) -> ir.Table:
def table(self, name: str, /, *, database: str | None = None) -> ir.Table:
"""Construct a table expression.
Parameters
Expand Down
2 changes: 1 addition & 1 deletion ibis/backends/duckdb/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ def create_table(

return self.table(name, database=(catalog, database))

def table(self, name: str, database: str | None = None) -> ir.Table:
def table(self, name: str, /, *, database: str | None = None) -> ir.Table:
"""Construct a table expression.
Parameters
Expand Down
2 changes: 2 additions & 0 deletions ibis/backends/flink/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,8 @@ def list_views(
def table(
self,
name: str,
/,
*,
database: str | None = None,
catalog: str | None = None,
) -> ir.Table:
Expand Down
2 changes: 1 addition & 1 deletion ibis/backends/polars/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ def version(self) -> str:
def list_tables(self, like=None, database=None):
return self._filter_with_like(list(self._tables.keys()), like)

def table(self, name: str, database: None = None) -> ir.Table:
def table(self, name: str, /, *, database: None = None) -> ir.Table:
if database is not None:
raise com.IbisError(
"Passing `database` to the Polars backend's `table()` method is not "
Expand Down
4 changes: 1 addition & 3 deletions ibis/backends/sql/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,7 @@ def _fetch_from_cursor(self, cursor, schema: sch.Schema) -> pd.DataFrame:
return df

def table(
self,
name: str,
database: tuple[str, str] | str | None = None,
self, name: str, /, *, database: tuple[str, str] | str | None = None
) -> ir.Table:
"""Construct a table expression.
Expand Down

0 comments on commit 22de2b5

Please sign in to comment.