Skip to main content

Cleaner and compatible way to use typing features.

Project description

https://github.com/brunonicko/tippo/workflows/MyPy/badge.svg https://github.com/brunonicko/tippo/workflows/Lint/badge.svg https://github.com/brunonicko/tippo/workflows/Tests/badge.svg https://readthedocs.org/projects/tippo/badge/?version=stable https://img.shields.io/github/license/brunonicko/tippo?color=light-green https://static.pepy.tech/personalized-badge/tippo?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads https://img.shields.io/pypi/pyversions/tippo?color=light-green&style=flat

Overview

Tippo provides a cleaner and compatible way to use features from both typing and typing_extension across a wide range of Python versions, including Python 2.7.

Example

Instead of using an ugly try block for forwards compatibility…

>>> try:
...     from typing import Generic
... except ImportError:
...     from typing_extensions import Generic
...
>>> try:
...     from typing import final
... except ImportError:
...     from typing_extensions import final
...

…just import directly from tippo!

>>> from tippo import Generic, final

Generic Fixes

Tippo patches GenericMeta to fix known bugs for the Python 2.7 version of typing that were not addressed since it’s not officially supported anymore.

Generic class comparison:

>>> from tippo import Mapping
>>> assert Mapping[str, int] == Mapping[str, int]  # passes
>>> assert not (Mapping[str, int] != Mapping[str, int])  # passes

Subclassing a generic class with a __weakref__ slot:

>>> from weakref import ref
>>> from tippo import Generic, TypeVar
>>> T = TypeVar("T")
>>> class MyGeneric(Generic[T]):
...     __slots__ = ("__weakref__",)
...
>>> class SubClass(MyGeneric[T]):  # does not error out
...     __slots__ = ()
...
>>> instance = SubClass()
>>> instance_ref = ref(instance)

Also, in order to maintain the same interface, GenericMeta points to type when imported from tippo in newer versions of Python.

Missing Features

Tippo back-ports some features from future versions of Python to older ones, such as TypeAlias, ClassVar, NewType, get_origin, and get_args.

>>> from tippo import Mapping, get_args, get_name
>>> mapping_type = Mapping[str, int]
>>> [get_name(a) for a in get_args(mapping_type)]
['str', 'int']

Generic Weak Structures

Tippo also implements generic versions of weak data structures that work with older Python versions’ type annotations without the need to defer their evaluation:

>>> from tippo import Any, ReferenceType, WeakSet, WeakKeyDictionary, WeakValueDictionary
>>> class Foo(object):
...     pass
>>> weak_ref = ReferenceType[Foo](Foo())
>>> weak_set = WeakSet[Foo]({Foo()})
>>> weak_key_dict = WeakKeyDictionary[Foo, Any]({Foo(): "foo"})
>>> weak_value_dict = WeakValueDictionary[Any, Foo]({"foo": Foo()})

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tippo-3.6.0.tar.gz (13.9 kB view hashes)

Uploaded Source

Built Distribution

tippo-3.6.0-py2.py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page