Skip to content

Commit 8798066

Browse files
author
zbigniewkrolikowski
committed
Included information about pandas-stubs
1 parent e218f05 commit 8798066

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

doc/source/ecosystem.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -575,3 +575,20 @@ Library Accessor Classes Description
575575
.. _composeml: https://github.com/alteryx/compose
576576
.. _datatest: https://datatest.readthedocs.io/
577577
.. _woodwork: https://github.com/alteryx/woodwork
578+
579+
580+
Type stubs
581+
----------------------------
582+
583+
`pandas-stubs <https://github.com/VirtusLab/pandas-stubs>`__
584+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
585+
586+
pandas by itself doesn't expose any type information to the user.
587+
This means that in pandas-dependant projects the type checkers like Mypy won't perform like expected
588+
and will treat all pandas objects as they were of type ``Any``.
589+
Learn more by reading through these issues `14468 <https://github.com/pandas-dev/pandas/issues/14468>`_ ,
590+
`26766 <https://github.com/pandas-dev/pandas/issues/26766>`_, `28142 <https://github.com/pandas-dev/pandas/issues/28142>`_.
591+
592+
pandas-stubs are meant to alleviate this issue by providing rudimentary type coverage of pandas API.
593+
After installing it using ``pip`` or ``conda``, the ``.pyi`` files will be
594+
placed alongside the pandas ``.py`` files and be available for the type checker.

0 commit comments

Comments
 (0)