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

Add typing to ducktape #413

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Add typing to ducktape #413

wants to merge 6 commits into from

Conversation

imcdo
Copy link
Member

@imcdo imcdo commented Jun 26, 2024

  1. Start to type objects in ducktape and give it annotations and make it a bit easier to work with.
  2. Update Paramiko
  3. Use ruff for formatting and style checking.

@imcdo imcdo requested a review from a team as a code owner June 26, 2024 19:04
Copy link

cla-assistant bot commented Jun 26, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

cla-assistant bot commented Jun 26, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@dotnwat
Copy link

dotnwat commented Sep 23, 2024

@imcdo

Very supportive of adding type annotations and official formatting. Are you planning to merge this PR?

Use ruff for formatting and style checking.

My understanding is that ruff and black are compatible, right? Is the tree large enough to require the faster version of ruff? I was able to format the entire ducktape tree in 0.5s.

@imcdo
Copy link
Member Author

imcdo commented Sep 23, 2024

@dotnwat id be happy to merge it, though i need a review and will need a sanity check. Black rules are compatible with ruff

@dotnwat
Copy link

dotnwat commented Sep 26, 2024

@imcdo perhaps we could merge the ruff formatting in a PR (or a dedicated commit) separate from the type annotations? not having the reformatting noise would make reviewing the type annotations much easier. even having github ignore whitespace produces an enormous diff.

@imcdo
Copy link
Member Author

imcdo commented Sep 26, 2024

@dotnwat that would basicly require redoing the work and i dont have any bandwith right now, though I invite anyone who is interested in doing this.

@dotnwat
Copy link

dotnwat commented Sep 26, 2024

@imcdo even something simple would be helpful:

pip install ruff==0.4.10
git checkout ian/types~
git checkout ian/types -- ruff.toml
ruff format --config ruff.toml docs .
git commit -a -m "format"
git diff ..ian/types | patch -p1
git add -A
git commit -a -m “other”
git diff ian/types

will produce two commits. the first is 1500+ LOC that can be ignored as reformatting. the second is half the size of this PR, and is much easier to inspect.

@confluent-cla-assistant
Copy link

🎉 All Contributor License Agreements have been signed. Ready to merge.
Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.

@imcdo imcdo enabled auto-merge (squash) October 1, 2024 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants