ENH: adding casting option to numpy.stack. #21627

jhonatancunha · 2022-05-28T22:50:09Z

See #20959

np.concatenate and np.stack are similar methods, but only np.concatenate has the casting option.

This PR puts the casting option into the np.stack method to control what kind of data casting may occur

See numpy#20959

seberg

Thanks, great start. If we add casting=, maybe we should probably also add dtype= to match `concatenate.

You accidentally checked in a generated C file, might be missing from .gitignore... Please make sure to not include it.

Further we definitely need some basic tests here (pretty basic should be fine, since it just forwards to concatenate).

numpy/core/shape_base.py

numpy/core/shape_base.pyi

numpy/core/src/umath/loops_modulo.dispatch.c

See numpy#20959

… into add_casting_to_stack

See numpy#20959

seberg

@jhonatancunha we still need basic tests and those style changes undone in the pyi file (even if they are auto-inserted maybe, my guess is the pep8 rules should not quite apply for stub files here).

Further, a very brief release note may be good (even a single bullet point), the instruction for those are in https://github.com/numpy/numpy/blob/main/doc/release/upcoming_changes/README.rst

The last thing I am wondering is if we should make sure to cover vstack, hstack etc. here, or just focus on stack since it is to some degree a preferred API probably.

numpy/core/shape_base.py

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

… method stack. See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

seberg

Thanks, looks good to me, the tests are probably even more thorough then necessary :).
The only thing might be polishing the release note a bit more, I think (we may also just do that as maintainers before merging though).

The one other thing is, that now that we started this, should we look into the other stacking functions as well? That would be a good followup (unless we want to explicitly not do that).

doc/release/upcoming_changes/21627.new_feature.rst

numpy/core/tests/test_shape_base.py

numpy/core/shape_base.pyi

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

…umpy.hstack. See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

…g keyword arguments. See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

numpy/core/shape_base.pyi

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

BvB93 · 2022-06-06T18:26:07Z

numpy/core/shape_base.pyi

 ) -> NDArray[Any]: ...
 @overload
 def stack(
    arrays: Sequence[ArrayLike],
    axis: SupportsIndex = ...,
-    out: _ArrayType = ...,
+    out: None = ...,


Suggested change

out: None = ...,

out: _ArrayType = ...,

This specific out type has to be changed back here to its previous value.
All other annotation-related changes now look good to go, in my opinion.

Point of clarification: I'm referring to the out type of this specific overload.

@BvB93 sorry for that, we already pushed the changes for this error. Thanks for your patience.

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: jhonatancunha <jhonatancunha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

melissawm

This looks good to me, thanks @jhonatancunha! I'll wait for @seberg to merge though.

melissawm · 2022-06-08T11:38:36Z

doc/release/upcoming_changes/21627.new_feature.rst

@@ -0,0 +1,16 @@
+``casting`` and ``dtype`` keyword arguments for `numpy.stack`
+-------------------------------------------------------------
+The ``casting`` and ``dtype`` keyword arguments is now available for `numpy.stack`. 


Suggested change

The ``casting`` and ``dtype`` keyword arguments is now available for `numpy.stack`.

The ``casting`` and ``dtype`` keyword arguments are now available for `numpy.stack`.

(Same for all release notes below)

melissawm · 2022-06-08T11:38:58Z

doc/release/upcoming_changes/21627.new_feature.rst

+``casting`` and ``dtype`` keyword arguments for `numpy.stack`
+-------------------------------------------------------------
+The ``casting`` and ``dtype`` keyword arguments is now available for `numpy.stack`. 
+To use it, write ``np.stack(..., dtype=None, casting='same_kind')``.


Suggested change

To use it, write ``np.stack(..., dtype=None, casting='same_kind')``.

To use them, write ``np.stack(..., dtype=None, casting='same_kind')``.

Thanks @melissawm, we already pushed the commits with those changes!

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

… into add_casting_to_stack

seberg · 2022-06-08T22:06:53Z

Agreed, thanks everyone and Melissa for the review, lets put this in!

A few final notes, which would be nice to follow up on, but it is OK if it doesn't happen.

We also have dstack (in a different file)!
There is also np.ma.stack (etc.). For me MA is in a weird state were we hope for a better replacement, but followups to fix it up would be great anyway.
Only if we follow-up with dstack: I think it might make sense to slim the release note down to a single heading and just list all of the stacking functions individually in the text.

Xref numpy#21627

ENH: adding casting option to numpy.stack.

ea75651

See numpy#20959

github-actions bot added the 01 - Enhancement label May 28, 2022

seberg reviewed May 29, 2022

View reviewed changes

numpy/core/shape_base.py Outdated Show resolved Hide resolved

numpy/core/shape_base.pyi Outdated Show resolved Hide resolved

BvB93 reviewed May 29, 2022

View reviewed changes

numpy/core/src/umath/loops_modulo.dispatch.c Outdated Show resolved Hide resolved

BvB93 added 56 - Needs Release Note. Needs an entry in doc/release/upcoming_changes 59 - Needs tests labels May 29, 2022

JessePires and others added 5 commits May 30, 2022 20:58

ENH: adding dtype option to numpy.stack.

5a252a9

See numpy#20959

ENH: adding dtype option to numpy.stack.

2c921e0

See numpy#20959

REV: removing auto-generated file loops_modulo.dispatch.c

c6ec33e

See numpy#20959

Merge branch 'add_casting_to_stack' of github.com:jhonatancunha/numpy…

a05c709

… into add_casting_to_stack

REV: removing auto-generated file loops_modulo.dispatch.c

48101bc

See numpy#20959

jhonatancunha requested review from seberg and BvB93 May 31, 2022 02:24

seberg reviewed May 31, 2022

View reviewed changes

numpy/core/shape_base.py Show resolved Hide resolved

jhonatancunha and others added 5 commits June 2, 2022 20:56

REV: removing inserted newlines

c0b3b2e

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

DOC: inserting versionadded info in dtype and casting parameters.

ec714a3

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

TST: writing tests to stack method with dtype and casting options

653aa1a

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

DOC: adding upcoming_change file for new options casting and dtype in…

9b8d4cd

… method stack. See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

REV: reverting lint errors.

df2c73f

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

jhonatancunha requested a review from seberg June 3, 2022 01:58

seberg approved these changes Jun 3, 2022

View reviewed changes

doc/release/upcoming_changes/21627.new_feature.rst Outdated Show resolved Hide resolved

doc/release/upcoming_changes/21627.new_feature.rst Outdated Show resolved Hide resolved

numpy/core/tests/test_shape_base.py Show resolved Hide resolved

BvB93 reviewed Jun 3, 2022

View reviewed changes

numpy/core/shape_base.pyi Outdated Show resolved Hide resolved

numpy/core/shape_base.pyi Outdated Show resolved Hide resolved

jhonatancunha and others added 3 commits June 4, 2022 14:55

DOC: inserting hstack and vstack methods in upcoming changes

da11545

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

ENH: adding dtype and casting keyword arguments to numpy.vstack and n…

8296c43

…umpy.hstack. See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

jhonatancunha requested review from BvB93 and seberg June 4, 2022 18:54

BvB93 reviewed Jun 4, 2022

View reviewed changes

numpy/core/shape_base.pyi Outdated Show resolved Hide resolved

REV: reverting the 'out' option type in stack method.

ce0ae35

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

jhonatancunha requested a review from BvB93 June 6, 2022 17:49

BvB93 reviewed Jun 6, 2022

View reviewed changes

REV: Reverting out type changes in overload of shape_base.pyi file.

1e94f43

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: jhonatancunha <jhonatancunha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

seberg removed 56 - Needs Release Note. Needs an entry in doc/release/upcoming_changes 59 - Needs tests labels Jun 6, 2022

jhonatancunha requested a review from BvB93 June 6, 2022 22:29

melissawm approved these changes Jun 8, 2022

View reviewed changes

jhonatancunha and others added 2 commits June 8, 2022 10:48

DOC: correcting some english erros in upcoming_changes file.

43eadef

See numpy#20959 Co-authored-by: alescrocaro <alescrocaro@gmail.com> Co-authored-by: JessePires <jesserocha@alunos.utfpr.edu.br> Co-authored-by: patriarka <matheussantanapatriarca2019@outlook.com>

Merge branch 'add_casting_to_stack' of github.com:jhonatancunha/numpy…

94eb6c1

… into add_casting_to_stack

seberg added the 62 - Python API Changes or additions to the Python API. Mailing list should usually be notified. label Jun 8, 2022

seberg merged commit 126046f into numpy:main Jun 8, 2022

pllim mentioned this pull request Jun 10, 2022

TST: Fix numpy-dev failure astropy/astropy#13322

Merged

10 tasks

BvB93 added a commit to BvB93/numpy that referenced this pull request Nov 14, 2022

TYP,ENH: Improve the dtype-overload of stack, hstack and vstack

473b80f

Xref numpy#21627

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENH: adding casting option to numpy.stack. #21627

ENH: adding casting option to numpy.stack. #21627

jhonatancunha commented May 28, 2022

seberg left a comment

seberg left a comment

seberg left a comment

BvB93 Jun 6, 2022 •

edited

BvB93 Jun 6, 2022

jhonatancunha Jun 6, 2022

melissawm left a comment

melissawm Jun 8, 2022

melissawm Jun 8, 2022

melissawm Jun 8, 2022

jhonatancunha Jun 8, 2022

seberg commented Jun 8, 2022

	The ``casting`` and ``dtype`` keyword arguments is now available for `numpy.stack`.
	The ``casting`` and ``dtype`` keyword arguments are now available for `numpy.stack`.

	To use it, write ``np.stack(..., dtype=None, casting='same_kind')``.
	To use them, write ``np.stack(..., dtype=None, casting='same_kind')``.

ENH: adding casting option to numpy.stack. #21627

ENH: adding casting option to numpy.stack. #21627

Conversation

jhonatancunha commented May 28, 2022

seberg left a comment

Choose a reason for hiding this comment

seberg left a comment

Choose a reason for hiding this comment

seberg left a comment

Choose a reason for hiding this comment

BvB93 Jun 6, 2022 • edited

Choose a reason for hiding this comment

BvB93 Jun 6, 2022

Choose a reason for hiding this comment

jhonatancunha Jun 6, 2022

Choose a reason for hiding this comment

melissawm left a comment

Choose a reason for hiding this comment

melissawm Jun 8, 2022

Choose a reason for hiding this comment

melissawm Jun 8, 2022

Choose a reason for hiding this comment

melissawm Jun 8, 2022

Choose a reason for hiding this comment

jhonatancunha Jun 8, 2022

Choose a reason for hiding this comment

seberg commented Jun 8, 2022

BvB93 Jun 6, 2022 •

edited