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.

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

An Intersection type? #18

Closed
gvanrossum opened this issue Oct 16, 2014 · 11 comments
Closed

An Intersection type? #18

gvanrossum opened this issue Oct 16, 2014 · 11 comments

Comments

@gvanrossum
Copy link
Member

Sometimes you want to say that an argument must follow two or more different protocols. For example, you might want to state that an argument must be an Iterable and a Container (for example, it could be a Set, a Mapping or a Sequence). It would be nice if this could be spelled like this:

def assertIn(item: T, thing: Intersection[Iterable[T], Container[T]]) -> None:
    if item not in thing:
        # Debug output
        for it in thing:
            print(it)
@gvanrossum
Copy link
Member Author

(In README.text, Łukasz suggested to use Any[] instead of Union[] so that All[] can be used as Intersection[]. Feels a bit cute to me.)

@ambv
Copy link
Contributor

ambv commented Jan 7, 2015

Having intersections is important since we don't have structural sub-classing and protocols will likely not be composable with ABCs.

Any/All is not only cute, it's also shorter to type and more obvious to the reader :)

@gvanrossum
Copy link
Member Author

Łukasz, can you show a few examples of how Any/All would be used? Your README note was rather cryptic. I agree Intersection is verbose, but it sounds like a minor use case, and I don't want to lose unparameterized Any as the top (or is that bottom? :-) of the type tree/graph.

@JukkaL
Copy link
Contributor

JukkaL commented Jan 8, 2015

I think this would be occasionally useful, but clearly this would be a minor feature. I vote for leaving this out for now and waiting until we have seen some real-world use cases that would benefit from intersection types.

@gvanrossum
Copy link
Member Author

Agreed. Let's skip it for now then.

@ambv
Copy link
Contributor

ambv commented Jan 8, 2015

What I proposed is alternative names: Union becomes Any, Intersection becomes All. typevar(values=) could become OneOf, with the bracket syntax, which would be more consistent.

Examples:

AnyStr = OneOf[bytes, str]
def memcache_get(key:AnyStr) -> Optional[AnyStr]:
  ...

OneOrMany = OneOf[AnyStr, List[AnyStr]]
def memcache_set(key:OneOrMany, value:OneOrMany) -> int:
  ...

# but:
def retry(callback:Callable[AnyArgs, Any[int, None]], timeout:Any[int, None]=None, retries=Any[int, None]=None) -> None:
  ...

# equiv:
OptionalInt = Any[int, None]
def retry(callback:Callable[AnyArgs, OptionalInt], timeout:OptionalInt, retries:OptionalInt) -> None:
  ...

Note that All provides a form of structural typing:

# The following absurd function uses retryable.__len__ and retryable.__call__ 
def retry(retryable:All[Sized, Callable]):
  while len(retryable):
    retryable()

Of course, we could provide more sensible ABCs for "file-like" objects, etc.

I deal with cache invalidation for a living, naming things and off-by-one errors are just a hobby.

@gvanrossum
Copy link
Member Author

Sorry, I don't like any of that. Can we just drop it?

  • Using Any[t1, t2, ...] instead of Union[t1, t2, ...] would be confusing if we kept plain Any for its current meaning (it's consistent with everything).
  • Using T = OneOf[t1, t2, ...] instead of TypeVar('T', t1, t2, ...) hides the fact that it is a type variable (and all arguments must match). E.g. def foo(a1: AnyStr, a2: AnyStr): is very different from def foo(a1: Union[str, bytes], a2: Union[str, bytes]):.
  • In An Intersection type? #18 we already decided not to define an intersection type for now. And in Protocols (a.k.a. structural subtyping) #11 we decided not to define protocols for now. So I think they shouldn't be "smuggled back in" this way.
  • Type variables should not use brackets, they should use parentheses. I've explained this already (What's the proper way to spell the type of a callable? #5).

@ambv
Copy link
Contributor

ambv commented Jan 14, 2015

OK, that covers it. No Intersection for now, names stay as they were.

@zevbo
Copy link

zevbo commented May 30, 2023

Its been a number of years since this thread was first opened, so I wanted to bump on it. From my perspective, the lack of an intersection type is one of the key flaws of the python type system at current, and its introduction would be majorly beneficial.

@gvanrossum

@JelleZijlstra
Copy link
Member

There is an open issue about this, #213.

@hauntsaninja
Copy link
Collaborator

+1 comments are better done via emoji than by tagging people. In any case, #213 is the issue tracking this feature.

@python python locked and limited conversation to collaborators May 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants