Add type annotations to utils and settings

[bhrutledge]

Related to #231, following a similar process as #469.

This feels more substantial, and exposed some gotchas, particularly around username/password handling, for which I've left TODOs in the code.

Also, the type annotations are duplicating information in docstrings; I don't know if/how the latter should be updated.

I've found the coverage reports somewhat handy, though I don't fully understand them. Happy to tweak/document how those are generated (or remove them prior to merge).

I'm expecting this will cause merge conflicts with other PR's, especially #509.

With all that in mind, it seemed prudent to submit this for review before continuing.

[sigmavirus24]

Also, the type annotations are duplicating information in docstrings; I don't know if/how the latter should be updated.

That's probably best for now. The places that's done is for generated documentation (generated by Sphinx from the docstrings) and it's unclear to me if Sphinx can rely on annotations

[bhrutledge]

Also, the type annotations are duplicating information in docstrings; I don't know if/how the latter should be updated.

That's probably best for now. The places that's done is for generated documentation (generated by Sphinx from the docstrings) and it's unclear to me if Sphinx can rely on annotations

I found https://github.com/agronholm/sphinx-autodoc-typehints, which looks promising at first glance. I'm inclined to open an issue (pending merge of this PR) to try it out. @sigmavirus24 What do you think?

[jaraco]

I'm expecting this will cause merge conflicts with other PR's, especially #509.

Indeed it did, can you refresh based on the update?

[bhrutledge]

Thanks, @jaraco. All set.

[sigmavirus24]

I'm inclined to open an issue (pending merge of this PR) to try it out. @sigmavirus24 What do you think?

Yes, let's investigate that separately

[bhrutledge]

@pypa/twine-maintainers How do y'all feel about merging this? It doesn't have an explicit approval yet.

[jaraco]

I do agree this needs more attention. I'll try to find some time to do that.

[jaraco]

I'd like to merge this, but it's pending review by @sigmavirus24, so I want to be considerate of that request.

[bhrutledge]

@jaraco Thanks for taking care of the merge conflicts. It caught me a little by surprise, because I don't have notifications enabled for PR pushes (but maybe I should).

[bhrutledge]

@jaraco Looks like there's a couple issues to sort out as a result of the merge. There's also a couple new functions that are missing type annotations. I'm happy to fix it up, hopefully in the next couple days.

[jaraco]

That's right. I took a stab at merging, but only through the GitHub UI, so it's possible the merge was broken. Feel free to discard b508e70 and re-merge with master if that helps.

[bhrutledge]

I've resolved the conflicts.

@pypa/twine-maintainers Unless there are any objections, I'm planning to squash & merge this tomorrow morning, so that I can continue adding type coverage.