fix up Hashable refs and add tests

Author: Dr-Irv

pandas-stubs/core/frame.pyi

@@ -437,6 +437,24 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
             _str | npt.DTypeLike | Mapping[HashableT2, npt.DTypeLike] | None
         ) = ...,
     ) -> np.recarray: ...
+    @overload
+    def to_stata(
+        self,
+        path: FilePath | WriteBuffer[bytes],
+        *,
+        convert_dates: dict[HashableT1, StataDateFormat] | None = ...,
+        write_index: _bool = ...,
+        byteorder: Literal["<", ">", "little", "big"] | None = ...,
+        time_stamp: dt.datetime | None = ...,
+        data_label: _str | None = ...,
+        variable_labels: dict[HashableT2, str] | None = ...,
+        version: Literal[117, 118, 119],
+        convert_strl: SequenceNotStr[Hashable] | None = ...,
+        compression: CompressionOptions = ...,
+        storage_options: StorageOptions = ...,
+        value_labels: dict[Hashable, dict[float, str]] | None = ...,
+    ) -> None: ...
+    @overload
     def to_stata(
         self,
         path: FilePath | WriteBuffer[bytes],
@@ -448,7 +466,7 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
         data_label: _str | None = ...,
         variable_labels: dict[HashableT2, str] | None = ...,
         version: Literal[114, 117, 118, 119] | None = ...,
-        convert_strl: list[Hashable] | None = ...,
+        convert_strl: None = ...,
         compression: CompressionOptions = ...,
         storage_options: StorageOptions = ...,
         value_labels: dict[Hashable, dict[float, str]] | None = ...,
@@ -498,7 +516,7 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
     def to_html(
         self,
         buf: FilePath | WriteBuffer[str],
-        columns: list[Hashable] | Index | Series | None = ...,
+        columns: SequenceNotStr[Hashable] | Index | Series | None = ...,
         col_space: ColspaceArgType | None = ...,
         header: _bool = ...,
         index: _bool = ...,
@@ -596,8 +614,8 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
         root_name: str = ...,
         row_name: str = ...,
         na_rep: str | None = ...,
-        attr_cols: list[Hashable] | None = ...,
-        elem_cols: list[Hashable] | None = ...,
+        attr_cols: SequenceNotStr[Hashable] | None = ...,
+        elem_cols: SequenceNotStr[Hashable] | None = ...,
         namespaces: dict[str | None, str] | None = ...,
         prefix: str | None = ...,
         encoding: str = ...,
@@ -1690,7 +1708,7 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
     def columns(self) -> Index[str]: ...
     @columns.setter  # setter needs to be right next to getter; otherwise mypy complains
     def columns(
-        self, cols: AnyArrayLike | list[Hashable] | tuple[Hashable, ...]
+        self, cols: AnyArrayLike | SequenceNotStr[Hashable] | tuple[Hashable, ...]
     ) -> None: ...
     @property
     def dtypes(self) -> Series: ...
@@ -2368,8 +2386,8 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
     def to_string(
         self,
         buf: FilePath | WriteBuffer[str],
-        columns: Sequence[Hashable] | Index | Series | None = ...,
-        col_space: int | list[int] | dict[Hashable, int] | None = ...,
+        columns: SequenceNotStr[Hashable] | Index | Series | None = ...,
+        col_space: int | list[int] | dict[HashableT, int] | None = ...,
         header: _bool | list[_str] | tuple[str, ...] = ...,
         index: _bool = ...,
         na_rep: _str = ...,

tests/test_frame.py

@@ -3820,6 +3820,37 @@ def _constructor(self) -> type[MyClass]:
     check(assert_type(df[["a", "b"]], MyClass), MyClass)
 
 
+def test_hashable_args() -> None:
+    # GH 1104
+    df = pd.DataFrame([["abc"]], columns=["test"], index=["ind"])
+    test = ["test"]
+
+    with ensure_clean() as path:
+
+        df.to_stata(path, version=117, convert_strl=test)
+        df.to_stata(path, version=117, convert_strl=["test"])
+
+        df.to_html(path, columns=test)
+        df.to_html(path, columns=["test"])
+
+        df.to_xml(path, attr_cols=test)
+        df.to_xml(path, attr_cols=["test"])
+
+        df.to_xml(path, elem_cols=test)
+        df.to_xml(path, elem_cols=["test"])
+
+    # Next lines should work, but it is a mypy bug
+    # https://github.com/python/mypy/issues/3004
+    # pyright accepts this, so we only type check for pyright,
+    # and also test the code with pytest
+    df.columns = test  # type: ignore[assignment]
+    df.columns = ["test"]  # type: ignore[assignment]
+
+    testDict = {"test": 1}
+    df.to_string("test", col_space=testDict)
+    df.to_string("test", col_space={"test": 1})
+
+
 # GH 906
 @pd.api.extensions.register_dataframe_accessor("geo")
 class GeoAccessor: ...