Skip to content

STYL: a few cleanups in pyi files #46921

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.

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

Merged
merged 4 commits into from
May 3, 2022
Merged

STYL: a few cleanups in pyi files #46921

merged 4 commits into from
May 3, 2022

Conversation

twoertwein
Copy link
Member

Might make sense to run flake8 on pyi files (add flake8-pyi to pre-commit)

Copy link
Member

@simonjayhawkins simonjayhawkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @twoertwein lgtm.

@@ -163,7 +163,7 @@ class HashTable:
na_sentinel: int = ...,
na_value: object = ...,
mask=...,
) -> tuple[np.ndarray, npt.NDArray[np.intp],]: ... # np.ndarray[subclass-specific]
) -> tuple[np.ndarray, npt.NDArray[np.intp]]: ... # np.ndarray[subclass-specific]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_unique above only returns tuple if return_inverse is True, which is how it's called from factorize. The return type of _unique is a Union, but these are more easily avoided with overloads in stubs.

I assume that _unique is intended to be private so we probably shouldn't be calling it from outside, so rather than adding overloads could just remove _unique from the stub.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed _unique but haven't yet added overloads to unique as I embarrassingly couldn't find the implementation.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's created from a template. pandas/_libs/hashtable_class_helper.pxi.in

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Would need to first deprecate return_inverse as a positional argument. Can I just use the normal deprecation decorator in cython (or would that have an unintended performance hit).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt HashTable is part of the public API of pandas but is obviously not private to the module as it is used elsewhere. Can probably just make the arguments keyword only without deprecation. (OK as follow-up, for our internal consistency checking, if we do not have any errors reported then not a priority to add overloads if not public)

@simonjayhawkins simonjayhawkins added the Typing type annotations, mypy/pyright type checking label May 2, 2022
@simonjayhawkins simonjayhawkins added this to the 1.5 milestone May 2, 2022
@simonjayhawkins simonjayhawkins merged commit 0d24370 into pandas-dev:main May 3, 2022
@simonjayhawkins
Copy link
Member

Thanks @twoertwein

@twoertwein twoertwein deleted the pyi branch May 26, 2022 01:59
yehoshuadimarsky pushed a commit to yehoshuadimarsky/pandas that referenced this pull request Jul 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Typing type annotations, mypy/pyright type checking
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants