Copy from microsoft/python-type-stubs

Author: Dr-Irv

pyproject.toml

@@ -0,0 +1,88 @@
+[tool.black]
+line_length = 88
+target_version = ["py39"]
+
+[tool.isort]
+profile = "black"
+combine_as_imports = true
+line_length = 88
+extra_standard_library = [
+    "typing_extensions",
+    "_typeshed",
+    # Extra modules not recognized by isort
+    "_compression",
+    "_csv",
+    "_curses",
+    "_markupbase",
+    "_random",
+    "_weakrefset",
+    "genericpath",
+    "opcode",
+    "pyexpat",
+    # Python 2 modules
+    "__builtin__",
+    "cookielib",
+    "cStringIO",
+    "httplib",
+    "mimetools",
+    "rfc822",
+    "thread",
+    "urllib2",
+    "urlparse",
+    "BaseHTTPServer",
+    "Queue",
+    "SimpleHTTPServer",
+    "SocketServer",
+    "StringIO",
+    "UserDict",
+    "UserList",
+    "UserString",
+]
+
+[tool.mypy]
+# Import discovery
+mypy_path = "typings"
+namespace_packages = false
+explicit_package_bases = false
+ignore_missing_imports = true
+follow_imports = "normal"
+follow_imports_for_stubs = false
+no_site_packages = false
+no_silence_site_packages = false
+# Platform configuration
+python_version = "3.8"
+# Disallow dynamic typing
+disallow_any_unimported = false # TODO
+disallow_any_expr = false # TODO
+disallow_any_decorated = false # TODO
+disallow_any_explicit = false # TODO
+disallow_any_generics = false # TODO
+disallow_subclassing_any = false # TODO
+# Untyped definitions and calls
+disallow_untyped_calls = false # TODO
+disallow_untyped_defs = false # TODO
+disallow_incomplete_defs = false # TODO
+check_untyped_defs = true
+disallow_untyped_decorators = true
+# None and Optional handling
+no_implicit_optional = true
+strict_optional = true
+# Configuring warnings
+warn_redundant_casts = true
+warn_unused_ignores = false # Change from pandas
+warn_no_return = true
+warn_return_any = false # TODO
+warn_unreachable = false # GH#27396
+# Suppressing errors
+show_none_errors = true
+ignore_errors = false
+# Miscellaneous strictness flags
+allow_untyped_globals = false
+allow_redefinition = false
+local_partial_types = false
+implicit_reexport = true
+strict_equality = true
+# Configuring error messages
+show_error_context = false
+show_column_numbers = false
+show_error_codes = true

pyrighttestconfig.json

@@ -0,0 +1,8 @@
+{
+    "typeCheckingMode": "basic",
+    "include": [ "tests" ],
+    "reportMissingModuleSource": false,
+    "reportUnusedVariable": false,
+    "useLibraryCodeForTypes": true,
+    "reportUnknownArgumentType": true
+}

tests/__init__.py

@@ -0,0 +1,3 @@
+These tests originally came from https://github.com/VirtusLab/pandas-stubs.
+
+

tests/pandas/README.md

@@ -0,0 +1,114 @@
+from typing import Union, Optional, Type, TYPE_CHECKING
+import numpy as np
+import numpy.typing as npt
+
+import pandas as pd
+
+from pandas._typing import Dtype
+
+
+# The purpose of these checkers is twofold:
+# 1) The type checker will see that the right result was returned
+# 2) When using pytest, we can check that the result in the pyi file
+#    corresponds to what pandas returns
+
+
+def check_dataframe_result(result: pd.DataFrame):
+    assert isinstance(result, pd.DataFrame)
+
+
+def check_series_result(result: pd.Series, dtype: Optional[Dtype] = None):
+    """
+    Check that the result is a Series, and that the dtype is the specified dtype
+
+    Since pandas doesn't support typing of a Series, we can check the type
+    in pytest instead.
+
+    Parameters
+    ----------
+    result : pd.Series
+        result to check
+    dtype : Optional[Dtype], optional
+        expected dtype, by default None, which means don't check the dtype
+    """
+    assert isinstance(result, pd.Series)
+    if dtype is not None:
+        assert result.dtype == dtype
+
+
+def check_index_result(result: pd.Index, dtype: Optional[Dtype] = None):
+    """
+    Check that the result is a Index, and that the dtype is the specified dtype
+
+    Since pandas doesn't support typing of a Index, we can check the type
+    in pytest instead.
+
+    Parameters
+    ----------
+    result : pd.Index
+        result to check
+    dtype : Optional[Dtype], optional
+        expected dtype, by default None, which means don't check the dtype
+    """
+    assert isinstance(result, pd.Index)
+    if dtype is not None:
+        assert result.dtype == dtype
+
+
+def check_multiindex_result(result: pd.MultiIndex):
+    """
+    Check that the result is a MultiIndex
+
+    Parameters
+    ----------
+    result : pd.MultiIndex
+        A multiindex
+    """
+
+    assert isinstance(result, pd.MultiIndex)
+
+
+def check_datetimeindex_result(result: pd.DatetimeIndex):
+    """
+    Check that the result is a DatetimeIndex
+
+    Parameters
+    ----------
+    result : pd.DatetimeIndex
+       result to check
+    """
+    assert isinstance(result, pd.DatetimeIndex)
+
+
+def check_numpy_result(result: np.ndarray, dtype: Optional[Union[Type[np.int64], Type[np.bool_], Type[np.str_]]] = None):
+    assert isinstance(result, np.ndarray)
+    if dtype is not None:
+        assert result.dtype == dtype
+
+
+def check_timedelta_result(result: pd.Timedelta):
+    assert isinstance(result, pd.Timedelta)
+
+
+def check_timestamp_result(result: pd.Timestamp):
+    assert isinstance(result, pd.Timestamp)
+
+
+def check_interval_result(
+    result: pd.Interval, dtype: Optional[Union[Type[pd.Timestamp], Type[pd.Timedelta], Type[int], Type[float]]]
+):
+    assert isinstance(result, pd.Interval)
+    if dtype is not None:
+        assert isinstance(result.left, dtype)
+
+
+def check_int_result(result: int):
+    assert isinstance(result, int)
+
+
+def check_float_result(result: float):
+    assert isinstance(result, float)
+
+
+def check_bool_result(result: bool):
+    assert isinstance(result, bool)