Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: local py.typed for users #44228

Merged
merged 7 commits into from
Dec 17, 2021
Merged

DOC: local py.typed for users #44228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
40cb8ae
DOC: local py.typed for development and users
twoertwein Oct 29, 2021
cc95463
fix heading
twoertwein Oct 29, 2021
fea9d1c
remove incorrect VSCode integration comment
twoertwein Oct 29, 2021
dd6d1d4
re-pharse note and add the same note to whatsnew
twoertwein Oct 31, 2021
26d3e89
fix urls
twoertwein Oct 31, 2021
c4b6f3c
hedging
twoertwein Dec 11, 2021
81f5f18
move to contributing_codebase
twoertwein Dec 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ dist
*.egg-info
.eggs
.pypirc
# type checkers
pandas/py.typed

# tox testing tool
.tox
Expand Down
20 changes: 20 additions & 0 deletions doc/source/development/contributing_codebase.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,26 @@ A recent version of ``numpy`` (>=1.21.0) is required for type validation.

.. _contributing.ci:

Testing type hints in code using pandas
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. warning::

* Pandas is not yet a py.typed library (:pep:`561`)!
The primary purpose of locally declaring pandas as a py.typed library is to test and
improve the pandas-builtin type annotations.

Until pandas becomes a py.typed library, it is possible to easily experiment with the type
annotations shipped with pandas by creating an empty file named "py.typed" in the pandas
installation folder:

.. code-block:: none

python -c "import pandas; import pathlib; (pathlib.Path(pandas.__path__[0]) / 'py.typed').touch()"

The existence of the py.typed file signals to type checkers that pandas is already a py.typed
library. This makes type checkers aware of the type annotations shipped with pandas.

Testing with continuous integration
-----------------------------------

Expand Down