Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct BValue typing #1

Merged
merged 3 commits into from
Sep 27, 2022
Merged

Correct BValue typing #1

merged 3 commits into from
Sep 27, 2022

Conversation

moreal
Copy link
Contributor

@moreal moreal commented Sep 18, 2022

In Mypy development build (master branch), it became to support recursive types. (See python/mypy#731 (comment), python/mypy#13297).

This pull request makes the bencodex-python package apply it with the development build.

@moreal moreal force-pushed the correct-bvalue branch 4 times, most recently from 1fe7468 to 44d0fe2 Compare September 18, 2022 08:51
@moreal moreal self-assigned this Sep 18, 2022
@moreal moreal marked this pull request as ready for review September 18, 2022 09:04
@moreal moreal requested a review from dahlia September 18, 2022 09:04
Copy link
Contributor

@dahlia dahlia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the way, if this patch requires a bleeding-edge version of Mypy, does it mean consumers who use both this package and Mypy also need to install the same (or higher) version of Mypy?

.github/workflows/build.yaml Outdated Show resolved Hide resolved
@moreal
Copy link
Contributor Author

moreal commented Sep 18, 2022

By the way, if this patch requires a bleeding-edge version of Mypy, does it mean consumers who use both this package and Mypy also need to install the same (or higher) version of Mypy?

Yes. Because it requires bleeding-edge version of Mypy, it may be better to turn this pull request as draft until a new Mypy release introduced.

@dahlia
Copy link
Contributor

dahlia commented Sep 18, 2022

The last release of Mypy (0.971 in 2022-07-19) took about two months after its previous release (0.960 in 2022-05-16). Hmm… IMHO it's likely to be soon, and we could wait for the next release!

@moreal moreal marked this pull request as draft September 19, 2022 01:13
@dahlia
Copy link
Contributor

dahlia commented Sep 27, 2022

@moreal Mypy 0.981 which introduced general recursive types was released today. Let's upgrade Mypy to 0.981!

@pull-request-quantifier-deprecated

This PR has 18 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Small
Size       : +12 -6
Percentile : 7.2%

Total files changed: 4

Change summary by file extension:
.rst : +2 -0
.py : +8 -4
.ini : +2 -2

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@moreal moreal marked this pull request as ready for review September 27, 2022 05:46
@moreal moreal requested a review from dahlia September 27, 2022 05:46
@moreal moreal merged commit 88afd3f into planetarium:main Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants