bpo-44732: Rename types.Union to types.UnionType #27342

AliyevH · 2021-07-24T23:53:26Z

https://bugs.python.org/issue44732

FFY00

A plain rename from Union to UnionType would be a big breaking change, it should be deprecated IMO.

We could do that in types.__getattr__, by adding the following to the types module.

import warnings

...

def __getattr__(name):
    if name == 'Union':
        warnings.warn('types.Union is deprecated and should be replaced with types.UnionType, it will get removed in X time', DeprecationWarning)
        return UnionType
    raise AttributeError(f'module {__name__} has no attribute {name}')

FFY00 · 2021-07-25T00:27:16Z

Misc/NEWS.d/next/Core and Builtins/2021-07-19-19-53-46.bpo-44676.WgIMvh.rst

@@ -1,2 +1,2 @@
-Add ability to serialise ``types.Union`` objects. Patch provided by Yurii
+Add ability to serialise ``types.UnionType`` objects. Patch provided by Yurii


We should not change this news entry 😛

Didn't know about it 😕

Oh wait, maybe we do actually want this changed as it hasn't been released yet 🤦. Sorry!

no problem.
Can you please tell me X time in deprecation warning?😬

I don't know, that's up to the core devs, ask in https://bugs.python.org/issue44732 if we should have a deprecation period and if so, how long.

Okey thanks 😄

Fidget-Spinner · 2021-07-25T02:21:28Z

A plain rename from Union to UnionType would be a big breaking change, it should be deprecated IMO.

From what I understand, it won't be. It looks like Serhiy is planning to backport the changes to 3.10 too where Union was first introduced. Hasan, please wait a bit to see what he has to say about the PR. Thanks!

AliyevH · 2021-07-25T12:25:10Z

Thanks @Fidget-Spinner . Okey let's wait 😃

serhiy-storchaka

LGTM!

JelleZijlstra · 2021-07-26T04:51:48Z

I don't see a NEWS entry in the PR but bedevere passed, am I missing something?

I do think there should be a NEWS entry for this.

gvanrossum · 2021-07-26T04:56:05Z

I don't see a NEWS entry in the PR but bedevere passed, am I missing something?

I do think there should be a NEWS entry for this.

The OP updated all of the existing NEWS entries that mention types.Union. That's creative, but I don't think it should be done that way. We need a new NEWS entry describing the renaming.

AliyevH · 2021-07-26T07:18:29Z

As i understand, we don't touch news files and add a new one with a description of renaming types.Union to types.UnionType.
I will update this today.

uriyyo · 2021-07-26T12:27:13Z

Lib/types.py

@@ -2,6 +2,7 @@
 Define names for built-in types that aren't directly accessible as a builtin.
 """
 import sys
+import warnings


Do we need import warnings? I can not see the usage of this module at types.py.

No :) I forgot about it

uriyyo

LGTM💫

Fidget-Spinner

LGTM. Thanks for your contribution!

Minor note: in the future please don't force-push as it overrides commit history @AliyevH. Just commit normally, the core devs will squash and merge the PR.

https://devguide.python.org/pullrequest/#quick-guide

Fidget-Spinner

Wait, the docs here need updating too https://docs.python.org/3.10/library/types.html#types.Union.

AliyevH · 2021-07-26T13:23:18Z

cs he

LGTM. Thanks for your contribution!

Minor note: in the future please don't force-push as it overrides commit history @AliyevH. Just commit normally, the core devs will squash and merge the PR.

https://devguide.python.org/pullrequest/#quick-guide

Got it. Thanks for support )

Misc/NEWS.d/next/Core and Builtins/2021-07-26-15-27-03.bpo-44732.IxObt3.rst

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

bedevere-bot · 2021-07-26T16:00:24Z

@ambv: Please replace # with GH- in the commit message next time. Thanks!

miss-islington · 2021-07-26T16:00:24Z

Thanks @AliyevH for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

bedevere-bot · 2021-07-26T16:00:35Z

GH-27365 is a backport of this pull request to the 3.10 branch.

Co-authored-by: Łukasz Langa <lukasz@langa.pl> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 2b8ad9e) Co-authored-by: Hasan <hasan.aleeyev@gmail.com>

Recently, `types.Union` was renamed to `types.UnionType` on the HEAD of 3.10 (refs: python/cpython#27342). After this change, sphinx-build has been crashed because of ImportError.

orsenthil · 2021-08-12T02:50:46Z

As it is already referenced in this ticket, it broke (the stable version of )sphinx-build and multiple documentation projects are going to be affected by this change.

This is the trackback from sphinx-build command line.

  File "/Users/senthilx/venvs/cpython/bin/sphinx-quickstart", line 5, in <module>
    from sphinx.cmd.quickstart import main
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/senthilx/venvs/cpython/lib/python3.11/site-packages/sphinx/cmd/quickstart.py", line 38, in <module>
    from sphinx.util.console import bold, color_terminal, colorize, nocolor, red  # type: ignore
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/senthilx/venvs/cpython/lib/python3.11/site-packages/sphinx/util/__init__.py", line 41, in <module>
    from sphinx.util.typing import PathMatcher
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/senthilx/venvs/cpython/lib/python3.11/site-packages/sphinx/util/typing.py", line 37, in <module>
    from types import Union as types_Union
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ImportError: cannot import name 'Union' from 'types' (/Users/senthilx/git/cpython/Lib/types.py)

Sphinx has already fixed it in master (sphinx-doc/sphinx#9513) - The fix (aliasing to UnionType) doesn't seem great too.

If we get more complaints, I think, either CPython or Sphinx project need to address this by communication / guidance.

It was hard to track down this failure with the trace back.

Fidget-Spinner · 2021-08-12T15:02:13Z

@orsenthil that's sad to hear :(. Is there some better place to make such changes known to the wider community?

This change was discussed and agreed upon on python-dev, but that's centered around CPython so I don't think there's much visibility. It also doesn't get a What's New because it was a change during pre-release versions.

AliyevH requested a review from gvanrossum as a code owner July 24, 2021 23:53

bedevere-bot added the awaiting review label Jul 24, 2021

the-knights-who-say-ni added the CLA signed label Jul 24, 2021

FFY00 requested changes Jul 25, 2021

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Jul 25, 2021

FFY00 reviewed Jul 25, 2021

View reviewed changes

serhiy-storchaka approved these changes Jul 25, 2021

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Jul 25, 2021

serhiy-storchaka added the needs backport to 3.10 only security fixes label Jul 25, 2021

serhiy-storchaka requested a review from pablogsal July 25, 2021 20:23

uriyyo reviewed Jul 26, 2021

View reviewed changes

bpo-44732: Rename types.Union to types.UnionType

1dc1ff0

uriyyo approved these changes Jul 26, 2021

View reviewed changes

Fidget-Spinner approved these changes Jul 26, 2021

View reviewed changes

Fidget-Spinner requested changes Jul 26, 2021

View reviewed changes

bpo-44732: Updated Union to UnionType in doc

a21c490

JelleZijlstra reviewed Jul 26, 2021

View reviewed changes

Misc/NEWS.d/next/Core and Builtins/2021-07-26-15-27-03.bpo-44732.IxObt3.rst Outdated Show resolved Hide resolved

Make the NEWS entry a full sentence

3c35f62

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

ambv merged commit 2b8ad9e into python:main Jul 26, 2021

bedevere-bot removed the awaiting merge label Jul 26, 2021

bedevere-bot removed the needs backport to 3.10 only security fixes label Jul 26, 2021

tk0miya mentioned this pull request Jul 29, 2021

types.Union was renamed to types.UnionType on the HEAD of 3.10 sphinx-doc/sphinx#9512

Closed

tk0miya mentioned this pull request Jul 29, 2021

Fix #9512: sphinx-build: crashed with the HEAD of Python 3.10 sphinx-doc/sphinx#9513

Merged

skshetry mentioned this pull request Aug 13, 2021

bump Scheduled weekly dependency update for week 32 skshetry/webdav4#48

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bpo-44732: Rename types.Union to types.UnionType #27342

bpo-44732: Rename types.Union to types.UnionType #27342

AliyevH commented Jul 24, 2021 •

edited by bedevere-bot

Loading

FFY00 left a comment •

edited

Loading

FFY00 Jul 25, 2021

AliyevH Jul 25, 2021

FFY00 Jul 25, 2021 •

edited

Loading

AliyevH Jul 25, 2021 •

edited

Loading

FFY00 Jul 25, 2021

AliyevH Jul 25, 2021

Fidget-Spinner commented Jul 25, 2021 •

edited

Loading

AliyevH commented Jul 25, 2021

serhiy-storchaka left a comment

JelleZijlstra commented Jul 26, 2021

gvanrossum commented Jul 26, 2021

AliyevH commented Jul 26, 2021

uriyyo Jul 26, 2021

AliyevH Jul 26, 2021

AliyevH Jul 26, 2021

uriyyo left a comment •

edited

Loading

Fidget-Spinner left a comment

Fidget-Spinner left a comment

AliyevH commented Jul 26, 2021

bedevere-bot commented Jul 26, 2021

miss-islington commented Jul 26, 2021

bedevere-bot commented Jul 26, 2021

orsenthil commented Aug 12, 2021

Fidget-Spinner commented Aug 12, 2021 •

edited

Loading

		@@ -1,2 +1,2 @@
		Add ability to serialise ``types.Union`` objects. Patch provided by Yurii
		Add ability to serialise ``types.UnionType`` objects. Patch provided by Yurii

bpo-44732: Rename types.Union to types.UnionType #27342

bpo-44732: Rename types.Union to types.UnionType #27342

Conversation

AliyevH commented Jul 24, 2021 • edited by bedevere-bot Loading

FFY00 left a comment • edited Loading

Choose a reason for hiding this comment

FFY00 Jul 25, 2021

Choose a reason for hiding this comment

AliyevH Jul 25, 2021

Choose a reason for hiding this comment

FFY00 Jul 25, 2021 • edited Loading

Choose a reason for hiding this comment

AliyevH Jul 25, 2021 • edited Loading

Choose a reason for hiding this comment

FFY00 Jul 25, 2021

Choose a reason for hiding this comment

AliyevH Jul 25, 2021

Choose a reason for hiding this comment

Fidget-Spinner commented Jul 25, 2021 • edited Loading

AliyevH commented Jul 25, 2021

serhiy-storchaka left a comment

Choose a reason for hiding this comment

JelleZijlstra commented Jul 26, 2021

gvanrossum commented Jul 26, 2021

AliyevH commented Jul 26, 2021

uriyyo Jul 26, 2021

Choose a reason for hiding this comment

AliyevH Jul 26, 2021

Choose a reason for hiding this comment

AliyevH Jul 26, 2021

Choose a reason for hiding this comment

uriyyo left a comment • edited Loading

Choose a reason for hiding this comment

Fidget-Spinner left a comment

Choose a reason for hiding this comment

Fidget-Spinner left a comment

Choose a reason for hiding this comment

AliyevH commented Jul 26, 2021

bedevere-bot commented Jul 26, 2021

miss-islington commented Jul 26, 2021

bedevere-bot commented Jul 26, 2021

orsenthil commented Aug 12, 2021

Fidget-Spinner commented Aug 12, 2021 • edited Loading

AliyevH commented Jul 24, 2021 •

edited by bedevere-bot

Loading

FFY00 left a comment •

edited

Loading

FFY00 Jul 25, 2021 •

edited

Loading

AliyevH Jul 25, 2021 •

edited

Loading

Fidget-Spinner commented Jul 25, 2021 •

edited

Loading

uriyyo left a comment •

edited

Loading

Fidget-Spinner commented Aug 12, 2021 •

edited

Loading