Merge branch 'main' of github.com:loicdiridollou/pandas-stubs into gh613_comment_ci

Author: loicdiridollou

.github/setup/action.yaml

@@ -1,17 +1,17 @@
 name: Install project dependencies
+description: Install project dependencies
 
 inputs:
   python-version:
+    description: The python version to use
     required: true
   os:
-    required: true
-  numpy-version:
+    description: The OS to run on
     required: true
 
 runs:
   using: composite
   steps:
-
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
@@ -35,7 +35,3 @@ runs:
     - name: Install project dependencies
       shell: bash
       run: poetry install -vvv --no-root
-      
-    - name: Set numpy version
-      shell: bash
-      run: pip install numpy"${{ inputs. numpy-version }}"

.github/workflows/test.yml

@@ -19,13 +19,9 @@ jobs:
       matrix:
         # Don't use macos-latest because it is arm64
         os: [ubuntu-latest, windows-latest, macos-13]
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
-        include:
-          - numpy-version: "<2.0"
-          - numpy-version: ">= 2.0"
-            os: ubuntu-latest
+        python-version: ["3.10", "3.11", "3.12"]
 
-    name: OS ${{ matrix.os }} - Python ${{ matrix.python-version }} - Numpy ${{ matrix.numpy-version }}
+    name: OS ${{ matrix.os }} - Python ${{ matrix.python-version }}
 
     steps:
       - uses: actions/checkout@v3
@@ -35,7 +31,6 @@ jobs:
         with:
           os: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
-          numpy-version: ${{ matrix.numpy-version }}
 
       - name: Run mypy on 'tests' (using the local stubs) and on the local stubs
         run: poetry run poe mypy

conftest.py

@@ -0,0 +1,36 @@
+import gc
+
+import pytest
+
+
+@pytest.fixture
+def mpl_cleanup():
+    """
+    Ensure Matplotlib is cleaned up around a test.
+
+    Before a test is run:
+
+    1) Set the backend to "template" to avoid requiring a GUI.
+
+    After a test is run:
+
+    1) Reset units registry
+    2) Reset rc_context
+    3) Close all figures
+
+    See matplotlib/testing/decorators.py#L24.
+    """
+    mpl = pytest.importorskip("matplotlib")
+    mpl_units = pytest.importorskip("matplotlib.units")
+    plt = pytest.importorskip("matplotlib.pyplot")
+    orig_units_registry = mpl_units.registry.copy()
+    try:
+        with mpl.rc_context():
+            mpl.use("template")
+            yield
+    finally:
+        mpl_units.registry.clear()
+        mpl_units.registry.update(orig_units_registry)
+        plt.close("all")
+        # https://matplotlib.org/stable/users/prev_whats_new/whats_new_3.6.0.html#garbage-collection-is-no-longer-run-on-figure-close
+        gc.collect(1)

docs/release_procedure.md

@@ -7,13 +7,12 @@
 
 ```shell
 rm dist/*
-poetry publish --build  # you will get prompted for your pypi username/password
+poetry build
+twine upload dist/*  # Requires having the pypi API token allowing uploads
 git commit -a -m "Version a.b.c.yymmdd"
 git push upstream main
 git tag va.b.c.yymmdd
 git push upstream --tags
 ```
 
 The conda bots will recognize that a new version has been uploaded to pypi, and generate a pull request sent to the maintainers to approve it.
-
-Note - Changes will need to be made to use pypi API tokens in the near future.

docs/setup.md

@@ -1,7 +1,7 @@
 ## Set Up Environment
 
-- Make sure you have `python >= 3.9` installed.
-- Install poetry: `pip install 'poetry>=1.2'`
+- Make sure you have `python >= 3.10` installed.
+- Install poetry: `pip install 'poetry>=1.8'`
 - Install the project dependencies: `poetry update`
 - Enter the virtual environment: `poetry shell`
 - Run all tests: `poe test_all`

pandas-stubs/_testing/__init__.pyi

@@ -1,65 +1,117 @@
-from collections.abc import Generator
+from collections.abc import (
+    Container,
+    Generator,
+    Iterable,
+)
 from contextlib import contextmanager
 from typing import (
     Any,
     Literal,
     overload,
 )
+import warnings
 
+from matplotlib.artist import Artist
+import numpy as np
 from pandas import (
+    Categorical,
     DataFrame,
     Index,
     Series,
 )
+from pandas.arrays import (
+    DatetimeArray,
+    IntervalArray,
+    PeriodArray,
+    SparseArray,
+    TimedeltaArray,
+)
+from pandas.core.arrays.base import ExtensionArray
+
+from pandas._typing import (
+    AnyArrayLike,
+    T,
+)
 
 def assert_almost_equal(
-    left,
-    right,
-    check_dtype: bool | str = ...,
-    check_less_precise: bool | int = ...,
+    left: T,
+    right: T,
+    check_dtype: bool | Literal["equiv"] = ...,
+    rtol: float = ...,
+    atol: float = ...,
     **kwargs,
-): ...
-def assert_dict_equal(left, right, compare_keys: bool = ...): ...
-def assert_index_equal(left: Index, right: Index) -> None: ...
-def assert_class_equal(left, right, exact: bool | str = ..., obj=...): ...
-def assert_attr_equal(attr, left, right, obj: str = ...): ...
-def assert_is_valid_plot_return_object(objs) -> None: ...
-def assert_is_sorted(seq) -> None: ...
+) -> None: ...
+def assert_dict_equal(left: dict, right: dict, compare_keys: bool = ...) -> None: ...
+def assert_index_equal(
+    left: Index,
+    right: Index,
+    exact: bool | Literal["equiv"] = ...,
+    check_names: bool = ...,
+    check_exact: bool = ...,
+    check_categorical: bool = ...,
+    check_order: bool = ...,
+    rtol: float = ...,
+    atol: float = ...,
+    obj: str = ...,
+) -> None: ...
+def assert_class_equal(
+    left: T, right: T, exact: bool | Literal["equiv"] = ..., obj: str = ...
+) -> None: ...
+def assert_attr_equal(
+    attr: str, left: object, right: object, obj: str = ...
+) -> None: ...
+def assert_is_valid_plot_return_object(
+    objs: Series | np.ndarray | Artist | tuple | dict,
+) -> None: ...
+def assert_is_sorted(seq: AnyArrayLike) -> None: ...
 def assert_categorical_equal(
-    left,
-    right,
+    left: Categorical,
+    right: Categorical,
     check_dtype: bool = ...,
     check_category_order: bool = ...,
     obj: str = ...,
 ) -> None: ...
 def assert_interval_array_equal(
-    left, right, exact: str = ..., obj: str = ...
+    left: IntervalArray,
+    right: IntervalArray,
+    exact: bool | Literal["equiv"] = ...,
+    obj: str = ...,
+) -> None: ...
+def assert_period_array_equal(
+    left: PeriodArray, right: PeriodArray, obj: str = ...
+) -> None: ...
+def assert_datetime_array_equal(
+    left: DatetimeArray, right: DatetimeArray, check_freq: bool = ...
+) -> None: ...
+def assert_timedelta_array_equal(
+    left: TimedeltaArray, right: TimedeltaArray, check_freq: bool = ...
 ) -> None: ...
-def assert_period_array_equal(left, right, obj: str = ...) -> None: ...
-def assert_datetime_array_equal(left, right, obj: str = ...) -> None: ...
-def assert_timedelta_array_equal(left, right, obj: str = ...) -> None: ...
 def assert_numpy_array_equal(
     left,
     right,
     strict_nan: bool = ...,
-    check_dtype: bool = ...,
-    err_msg=...,
-    check_same=...,
+    check_dtype: bool | Literal["equiv"] = ...,
+    err_msg: str | None = ...,
+    check_same: Literal["copy", "same"] | None = ...,
     obj: str = ...,
-): ...
+    index_values: Index | np.ndarray | None = ...,
+) -> None: ...
 def assert_extension_array_equal(
-    left,
-    right,
-    check_dtype: bool = ...,
-    check_less_precise: bool = ...,
+    left: ExtensionArray,
+    right: ExtensionArray,
+    check_dtype: bool | Literal["equiv"] = ...,
+    index_values: Index | np.ndarray | None = ...,
     check_exact: bool = ...,
+    rtol: float = ...,
+    atol: float = ...,
+    obj: str = ...,
 ) -> None: ...
 @overload
 def assert_series_equal(
     left: Series,
     right: Series,
-    check_dtype: bool = ...,
-    check_index_type: bool | str = ...,
+    check_dtype: bool | Literal["equiv"] = ...,
+    check_index_type: bool | Literal["equiv"] = ...,
     check_series_type: bool = ...,
     check_names: bool = ...,
     check_exact: bool = ...,
@@ -79,8 +131,8 @@ def assert_series_equal(
 def assert_series_equal(
     left: Series,
     right: Series,
-    check_dtype: bool = ...,
-    check_index_type: bool | str = ...,
+    check_dtype: bool | Literal["equiv"] = ...,
+    check_index_type: bool | Literal["equiv"] = ...,
     check_series_type: bool = ...,
     check_names: bool = ...,
     check_exact: bool = ...,
@@ -103,37 +155,34 @@ def assert_frame_equal(
     check_index_type: bool | Literal["equiv"] = ...,
     check_column_type: bool | Literal["equiv"] = ...,
     check_frame_type: bool = ...,
-    check_less_precise: int | bool = ...,
     check_names: bool = ...,
     by_blocks: bool = ...,
     check_exact: bool = ...,
     check_datetimelike_compat: bool = ...,
     check_categorical: bool = ...,
     check_like: bool = ...,
     check_freq: bool = ...,
-    check_flag: bool = ...,
+    check_flags: bool = ...,
     rtol: float = ...,
     atol: float = ...,
     obj: str = ...,
 ) -> None: ...
 def assert_equal(left, right, **kwargs) -> None: ...
-def assert_sp_array_equal(
-    left,
-    right,
-    check_dtype: bool = ...,
-    check_kind: bool = ...,
-    check_fill_value: bool = ...,
-    consolidate_block_indices: bool = ...,
-) -> None: ...
-def assert_contains_all(iterable, dic) -> None: ...
-def assert_copy(iter1, iter2, **eql_kwargs) -> None: ...
+def assert_sp_array_equal(left: SparseArray, right: SparseArray) -> None: ...
+def assert_contains_all(iterable: Iterable[T], dic: Container[T]) -> None: ...
+def assert_copy(iter1: Iterable[T], iter2: Iterable[T], **eql_kwargs) -> None: ...
+@contextmanager
 def assert_produces_warning(
-    expected_warning=...,
-    filter_level: str = ...,
-    clear=...,
+    expected_warning: (
+        type[Warning] | Literal[False] | tuple[type[Warning], ...] | None
+    ) = ...,
+    filter_level: Literal[
+        "error", "ignore", "always", "default", "module", "once"
+    ] = ...,
     check_stacklevel: bool = ...,
     raise_on_extra_warnings: bool = ...,
-) -> None: ...
+    match: str | None = None,
+) -> Generator[list[warnings.WarningMessage], None, None]: ...
 @contextmanager
 def ensure_clean(
     filename: str | None = ..., return_filelike: bool = ..., **kwargs: Any

pandas-stubs/core/dtypes/base.pyi

@@ -16,7 +16,7 @@ class ExtensionDtype:
     @property
     def kind(
         self,
-    ) -> Literal["b", "i", "u", "f", "c", "m", "M", "O", "S", "U", "V"]: ...
+    ) -> Literal["b", "i", "u", "f", "c", "m", "M", "O", "S", "U", "V", "T"]: ...
     @property
     def names(self) -> list[str] | None: ...
     def empty(self, size: int | tuple[int, ...]) -> type_t[ExtensionArray]: ...

pandas-stubs/core/frame.pyi

@@ -259,6 +259,7 @@ class DataFrame(NDFrame, OpsMixin):
     def __dataframe__(
         self, nan_as_null: bool = ..., allow_copy: bool = ...
     ) -> DataFrameXchg: ...
+    def __arrow_c_stream__(self, requested_schema: object | None = None) -> object: ...
     @property
     def axes(self) -> list[Index]: ...
     @property
@@ -1632,8 +1633,8 @@ class DataFrame(NDFrame, OpsMixin):
     ) -> DataFrame: ...
     def clip(
         self,
-        lower: float | None = ...,
-        upper: float | None = ...,
+        lower: float | AnyArrayLike | None = ...,
+        upper: float | AnyArrayLike | None = ...,
         *,
         axis: Axis | None = ...,
         inplace: _bool = ...,

pandas-stubs/core/indexes/datetimelike.pyi

@@ -19,7 +19,7 @@ class DatetimeIndexOpsMixin(ExtensionIndex[S1]):
     def argmin(self, axis=..., skipna: bool = ..., *args, **kwargs): ...
     def max(self, axis=..., skipna: bool = ..., *args, **kwargs): ...
     def argmax(self, axis=..., skipna: bool = ..., *args, **kwargs): ...
-    def __rsub__(  # type: ignore[override]
+    def __rsub__(  # type: ignore[override] # pyright: ignore[reportIncompatibleMethodOverride]
         self, other: DatetimeIndexOpsMixin
     ) -> TimedeltaIndex: ...