Type hints for mypy

[jolaf]

I've created .pyi type hints (for Python 3) for this library and I would like to submit them to python/typeshed.
What do you think about it?

[txomon]

I would be very interested in this, what's the status?

[oschwald]

I apologize for not responding earlier, but having the type hints submitted there would be great!

[jolaf]

Added via python/typeshed#3245

[jolaf]

@oschwald
Could you please help with maxmind/GeoIP2-python#70 too?

[oschwald]

One thing to note on the type hints, as of 1.5.0, get (and the new get_with_prefix_len) support ipaddress.IPv4Address and ipaddress.IPv6Address as arguments in addition to a string. See #48.

[jolaf]

In future when modifying the library API you can simultaneously update the stubs in typeshed via pull requests to https://github.com/python/typeshed/tree/master/third_party/3/maxminddb

[srittau]

Also, when and if you are committed to keeping the stubs updated yourself, you could consider shipping them with maxminddb. This way the stubs would always match the installed version and updated cause less friction. In that case, feel free to ping me to review the stubs or if you need assistance. But we are also happy to continue hosting the stubs in typeshed.

[oschwald]

Thanks!