wip

Author: MarcoGorelli

check_completeness.py

@@ -61,7 +61,7 @@
     "Sequence",
     "column_object",
     "dataframe_object",
-    "group_by_object",
+    "groupby_object",
     "DType",
 }
 spec = [i for i in dataframe_api.__dir__() if i not in exclude and not i.startswith("_")]

dataframe_api_compat/pandas_standard/pandas_standard.py

@@ -517,7 +517,7 @@ def group_by(self, keys: Sequence[str]) -> PandasGroupBy:
         if isinstance(keys, str):
             raise TypeError("Expected sequence of strings, got: str")
         for key in keys:
-            if key not in self.get_column_names():
+            if key not in self.column_names:
                 raise KeyError(f"key {key} not present in DataFrame's columns")
         return PandasGroupBy(self.dataframe, keys, api_version=self._api_version)
 
@@ -605,12 +605,16 @@ def rename_columns(self, mapping: Mapping[str, str]) -> PandasDataFrame:
             self.dataframe.rename(columns=mapping), api_version=self._api_version
         )
 
-    def get_column_names(self) -> list[str]:
+    def get_column_names(self) -> list[str]:  # pragma: no cover
         # DO NOT REMOVE
         # This one is used in upstream tests - even if deprecated,
         # just leave it in for backwards compatibility
         return self.dataframe.columns.tolist()
 
+    @property
+    def column_names(self) -> list[str]:
+        return self.dataframe.columns.tolist()
+
     def sorted_indices(
         self,
         keys: Sequence[str] | None = None,

dataframe_api_compat/polars_standard/polars_standard.py

@@ -939,12 +939,16 @@ def rename_columns(self, mapping: Mapping[str, str]) -> PolarsDataFrame:
             self.dataframe.rename(dict(mapping)), api_version=self._api_version
         )
 
-    def get_column_names(self) -> list[str]:
+    def get_column_names(self) -> list[str]:  # pragma: no cover
         # DO NOT REMOVE
         # This one is used in upstream tests - even if deprecated,
         # just leave it in for backwards compatibility
         return self.dataframe.columns
 
+    @property
+    def column_names(self) -> list[str]:
+        return self.dataframe.columns
+
     def __eq__(  # type: ignore[override]
         self,
         other: Any,
@@ -1033,9 +1037,7 @@ def __floordiv__(self, other: Any) -> PolarsDataFrame:
 
     def __pow__(self, other: Any) -> PolarsDataFrame:
         original_type = self.dataframe.schema
-        ret = self.dataframe.select(
-            [pl.col(col).pow(other) for col in self.get_column_names()]
-        )
+        ret = self.dataframe.select([pl.col(col).pow(other) for col in self.column_names])
         for column in self.dataframe.columns:
             if _is_integer_dtype(original_type[column]) and isinstance(other, int):
                 if other < 0:  # pragma: no cover (todo)

t.py

@@ -14,7 +14,7 @@ def my_dataframe_agnostic_function(df):
     mask = df.get_column_by_name("species") != "setosa"
     df = df.filter(mask)
 
-    for column_name in df.get_column_names():
+    for column_name in df.column_names:
         if column_name == "species":
             continue
         new_column = df.get_column_by_name(column_name)

tests/dataframe/get_column_names_test.py

@@ -5,5 +5,5 @@
 
 def test_get_column_names(library: str) -> None:
     df = integer_dataframe_1(library)
-    result = df.get_column_names()
+    result = df.column_names
     assert list(result) == ["a", "b"]

tests/namespace/column_names_test.py

@@ -13,15 +13,15 @@ def test_column_names(library: str, request: pytest.FixtureRequest) -> None:
     ser = df.get_column_by_name("a")
     namespace = ser.__column_namespace__()
     result = namespace.dataframe_from_dict({"result": ser})
-    assert result.get_column_names() == ["result"]
+    assert result.column_names == ["result"]
     assert result.get_column_by_name("result").name == "result"
 
     # named column
     ser = namespace.column_from_sequence(
         [1, 2, 3], dtype=namespace.Float64(), name="result"
     )
     result = namespace.dataframe_from_dict({"result": ser})
-    assert result.get_column_names() == ["result"]
+    assert result.column_names == ["result"]
     assert result.get_column_by_name("result").name == "result"
 
     # named column (different name)

tests/namespace/is_dtype_test.py

@@ -23,7 +23,7 @@ def test_is_dtype(library: str, dtype: str, expected: list[str]) -> None:
     namespace = df.__dataframe_namespace__()
     result = [
         i
-        for i in df.get_column_names()
+        for i in df.column_names
         if namespace.is_dtype(df.get_column_by_name(i).dtype, dtype)
     ]
     assert result == expected