search

materialsproject / fireworks

The Fireworks Workflow Management Repo.
https://materialsproject.github.io/fireworks
Other
351 stars 184 forks source link

Interest in adding type annotations? #459

Open berquist opened 2 years ago

berquist commented 2 years ago

Is there interest in adding type annotations to all functions and methods? Checking them with mypy could be done incrementally, using the same nice framework as in #457.

I'm asking because the types in docstrings are already quite complete and are a good starting point, but introspection is improved by adding annotations and I'd be willing to add them.

mkhorton commented 2 years ago

As a user of FireWorks, I would be strongly in favor of this and think it’s a great idea. I find type annotations very helpful when debugging.

On Oct 15, 2021 at 11:44:06 AM, Eric Berquist @.***> wrote:

Is there interest in adding type annotations https://docs.python.org/3/library/typing.html to all functions and methods? Checking them with mypy could be done incrementally, using the same nice framework as in #457 https://github.com/materialsproject/fireworks/pull/457.

I'm asking because the types in docstrings are already quite complete and are a good starting point, but introspection is improved by adding annotations and I'd be willing to add them.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/materialsproject/fireworks/issues/459, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAWWWRHDE4TYOLO5UVIVWWDUHBY7NANCNFSM5GCRR72Q .

janosh commented 2 years ago

As a user of FireWorks, I would be strongly in favor of this and think it’s a great idea. I find type annotations very helpful when debugging.

Same.