Adding type hints to OpenStack (starting with Oslo)

Sergey Vilgelm sergey at vilgelm.info
Sat Jan 26 17:06:12 UTC 2019


Cyril,

We have lots of doc strings in rst format and many of them already have the `@param` and `@type` tags. Does the mypy support this format or we should to rewrite doc string and add the `type:` tags just for mypy?

--
Sergey Vilgelm
https://www.vilgelm.info
On Jan 26, 2019, 9:07 AM -0600, Cyril Roelandt <cyril at redhat.com>, wrote:
> Hello Doug,
>
> On 01/26/19 09:02, Doug Hellmann wrote:
> > We're still required to support python 2 through the beginning of the U
> > cycle [5]. Is it possible to apply the type hints in a way that allows
> > us to maintain that support?
> >
> > [5] https://governance.openstack.org/tc/resolutions/20180529-python2-deprecation-timeline.html
>
> There are two ways to apply type hints:
> 1) Use a new syntax that only works with Python 3
> 2) Use comments (see my github branch, where comments starting with
> "type:" can be found)
>
> I used the second approach in order to not break Python 2 compatibility.
>
>
> Regards,
> Cyril
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20190126/96f31732/attachment.html>


More information about the openstack-discuss mailing list