Audit type hints and expose types via PEP561 #44

pipermerriam · 2018-10-17T15:33:27Z

What is wrong?

The library currently uses type hints, however they may be able to be tightened up.

In addition, PEP561 allows us to expose type hints from this library to other libraries which use it.

Definition of done?

Update mypy to the latest stable released version.
Update the mypy run in CI to the following.

mypy --follow-imports=silent --warn-unused-ignores --ignore-missing-imports --no-strict-optional --check-untyped-defs --disallow-incomplete-defs --disallow-untyped-defs --disallow-any-generics -p eth_keys`

Usage of type: ignore (silencing the type checker) is minimized and there's a reasonable explanation for its usage
Update the setup.py to expose this data to other libraries as was done here: Enable discovery of type hints as per PEP561 eth-typing#10

Stretch goals

When this issue is done, stretch goals can be applied (and individually get funded) to tighten type support to qualify:

mypy --strict --follow-imports=silent --ignore-missing-imports --no-strict-optional -p eth_keys

Do what was done in ethereum/eth-typing#10 to allow this data to be exposed when this library is installed as a package.

The text was updated successfully, but these errors were encountered:

gitcoinbot · 2018-10-17T23:10:54Z

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

This issue now has a funding of 120.0 DAI (120.0 USD @ $1.0/DAI) attached to it.

If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
Want to chip in? Add your own contribution here.
Questions? Checkout Gitcoin Help or the Gitcoin Slack
$49,191.98 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot · 2018-10-17T23:24:57Z

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work has been started.

These users each claimed they can complete the work by 3 months, 3 weeks ago.
Please review their action plans below:

1) dimitrivla has applied to start work (Funders only: approve worker | reject worker).

I’ll view its contents, and review them. Look how it will progress.

Learn more on the Gitcoin Issue Details page.

2) bhargavasomu has been approved to start work.

I have already made a PR with completing the tasks mentioned, and waiting for a review.

Learn more on the Gitcoin Issue Details page.

pipermerriam · 2018-10-18T02:08:41Z

@6ug can be approved to work on this (but please get a pull request opened within the next day)

gitcoinbot · 2018-10-22T16:15:51Z

@6ug Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

warning (3 days)
escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot · 2018-10-24T16:16:14Z

@6ug Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

warning (3 days)
escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

rmshea · 2018-10-25T00:30:52Z

Hey @pipermerriam, Ryan from Gitcoin checking in. Looks like @6ug sent over a PR for you to check out!

gitcoinbot · 2018-10-25T16:15:59Z

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

@6ug due to inactivity, we have escalated this issue to Gitcoin's moderation team. Let us know if you believe this has been done in error!

warning (3 days)
escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

6ug · 2018-10-25T16:52:43Z

what does meaning of Escalated for Abandonment of Bounty, should I work for this issue?

pipermerriam · 2018-10-25T16:53:41Z

@6ug you're still clear to work on this, check your PR as I added a commit, rebased it and left a comment.

gitcoinbot · 2018-10-30T16:16:21Z

@6ug Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

warning (3 days)
escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot · 2018-10-31T16:16:53Z

@6ug Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

warning (3 days)
escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot · 2018-11-02T16:16:00Z

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

@6ug due to inactivity, we have escalated this issue to Gitcoin's moderation team. Let us know if you believe this has been done in error!

warning (3 days)
escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

Bhargavasomu · 2018-11-04T04:12:10Z

As this issue has still been unresolved, I would like to work on this. @pipermerriam do I have the permission to go for it? @gitcoinbot could you please reopen this issue?

Bhargavasomu · 2018-11-04T06:13:22Z

@pipermerriam I have made the sufficient changes in #48. Please review the PR and we could close this issue and bounty.

gitcoinbot · 2018-11-05T17:21:46Z

@6ug Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

warning (3 days)
escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

rmshea · 2018-11-08T04:26:47Z

Hey @pipermerriam and @Bhargavasomu, Ryan from Gitcoin here. Looks like 6ug has dropped out -- if you apply to the bounty @Bhargavasomu I'll approve you to work. From there, @pipermerriam can review #48 and close the bounty! Let me know if you have any questions :) 🌮

Bhargavasomu · 2018-11-08T05:21:06Z

@ryan-shea I have applied at gitcoin page, so please approve whenever you get the chance.

spm32 · 2018-11-08T18:39:49Z

@Bhargavasomu just approved you :)

gitcoinbot · 2018-11-12T17:16:30Z

@Bhargavasomu Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

reminder (3 days)
escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

Bhargavasomu · 2018-11-12T18:41:14Z

@gitcoinbot I have completed resolving the issue in PR #48, waiting for @pipermerriam to take a review on this.

pipermerriam · 2018-11-12T20:01:32Z

@gitcoinbot payment for this issue can be issued to @Bhargavasomu

@Bhargavasomu thanks for doing this.

spm32 · 2018-11-12T23:52:13Z

@pipermerriam Glad everything went well, @Bhargavasomu once you formally submit work I can pay you out :)

Bhargavasomu · 2018-11-13T04:45:51Z

@ceresstation @gitcoinbot I am not able to find an option to submit work in gitcoin page. Maybe this is because the status says Warned for Abandonment of Bounty. Could you please look into it and let me know what to do?

Bhargavasomu · 2018-11-14T02:59:14Z

Sorry for the multiple pings @ceresstation , but could you please check the gitcoin page status, as I am not able to submit my work. Thankyou

spm32 · 2018-11-14T04:00:04Z

No problem @Bhargavasomu, looking into this, will pay you out using advanced payout instead if the solution turns out to take a bit more time :)

owocki · 2018-11-14T04:26:40Z

@Bhargavasomu can u try now

Bhargavasomu · 2018-11-14T09:07:39Z

@owocki still I am not able to submit the work because the button is not highlighted. It is something like this.

spm32 · 2018-11-14T20:16:12Z

Hey @Bhargavasomu can you try again? Sorry!

owocki · 2018-11-14T20:23:52Z

just put in a fix for this @Bhargavasomu

gitcoinbot · 2018-11-15T03:38:27Z

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work for 120.0 DAI (120.0 USD @ $1.0/DAI) has been submitted by:

@bhargavasomu

@ceresstation please take a look at the submitted work:

PR by @Bhargavasomu

Learn more on the Gitcoin Issue Details page
Want to chip in? Add your own contribution here.
Questions? Checkout Gitcoin Help or the Gitcoin Slack
$45,535.70 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot · 2018-11-15T03:45:18Z

	⚡️ A Fast Response Kudos has been sent to @Bhargavasomu for this issue from @ceresstation. ⚡️ Nice work @Bhargavasomu! Your Kudos has automatically been sent in the ETH address we have on file.

gitcoinbot · 2018-11-15T03:46:06Z

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

The funding of 120.0 DAI (120.0 USD @ $1.0/DAI) attached to this issue has been approved & issued to @Bhargavasomu.

Learn more on the Gitcoin Issue Details page
Questions? Checkout Gitcoin Help or the Gitcoin Slack
$45,415.70 more funded OSS Work available on the Gitcoin Issue Explorer

spm32 · 2018-11-15T03:46:48Z

Hey @Bhargavasomu thanks for jumping on this so quickly after the other contributor dropped out, and thanks for bearing with us on the payout!

Bhargavasomu · 2018-11-15T03:55:49Z

@ceresstation thankyou.

…n-docs Replace web3 reference with <MODULE_NAME>

pipermerriam changed the title ~~Rudit type hints and expose types via PEP561~~ Audit type hints and expose types via PEP561 Oct 17, 2018

pipermerriam added Good First Issue Good for Bounty labels Oct 17, 2018

This comment has been minimized.

Sign in to view

6ug mentioned this issue Oct 18, 2018

[WIP] Enabling type hinting and updating mypy in tox #45

Closed

Bhargavasomu mentioned this issue Nov 4, 2018

Enable Type Hinting Completely #48

Merged

pipermerriam closed this as completed in #48 Nov 12, 2018

pacrob pushed a commit to pacrob/eth-keys that referenced this issue Dec 20, 2023

Merge pull request ethereum#44 from ethereum/templatize-module-name-i…

582e9aa

…n-docs Replace web3 reference with <MODULE_NAME>

Audit type hints and expose types via PEP561 #44

Audit type hints and expose types via PEP561 #44

Comments

pipermerriam commented Oct 17, 2018 • edited Loading

What is wrong?

Definition of done?

Stretch goals

This comment has been minimized.

gitcoinbot commented Oct 17, 2018

gitcoinbot commented Oct 17, 2018 • edited Loading

pipermerriam commented Oct 18, 2018

gitcoinbot commented Oct 22, 2018

gitcoinbot commented Oct 24, 2018

rmshea commented Oct 25, 2018

gitcoinbot commented Oct 25, 2018

6ug commented Oct 25, 2018

pipermerriam commented Oct 25, 2018

gitcoinbot commented Oct 30, 2018

gitcoinbot commented Oct 31, 2018

gitcoinbot commented Nov 2, 2018

Bhargavasomu commented Nov 4, 2018

Bhargavasomu commented Nov 4, 2018 • edited Loading

gitcoinbot commented Nov 5, 2018

rmshea commented Nov 8, 2018

Bhargavasomu commented Nov 8, 2018

spm32 commented Nov 8, 2018

gitcoinbot commented Nov 12, 2018

Bhargavasomu commented Nov 12, 2018

pipermerriam commented Nov 12, 2018

spm32 commented Nov 12, 2018 • edited Loading

Bhargavasomu commented Nov 13, 2018

Bhargavasomu commented Nov 14, 2018

spm32 commented Nov 14, 2018

owocki commented Nov 14, 2018

Bhargavasomu commented Nov 14, 2018

spm32 commented Nov 14, 2018

owocki commented Nov 14, 2018

gitcoinbot commented Nov 15, 2018

gitcoinbot commented Nov 15, 2018

gitcoinbot commented Nov 15, 2018

spm32 commented Nov 15, 2018

Bhargavasomu commented Nov 15, 2018

pipermerriam commented Oct 17, 2018 •

edited

Loading

gitcoinbot commented Oct 17, 2018 •

edited

Loading

Bhargavasomu commented Nov 4, 2018 •

edited

Loading

spm32 commented Nov 12, 2018 •

edited

Loading