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

Change formatter to black to strongly enforce pep8 style #744

Closed
wants to merge 7 commits into from

Conversation

jsfreischuetz
Copy link
Contributor

@jsfreischuetz jsfreischuetz commented May 17, 2024

Previously this project used autopep8. This did not automatically enforce many aspects of style causing many files to use different styles. Additionally not all standards in pep8 were being enforced.

This PR attempts to solve this by switching to black, a more aggressive style formatter, while also bringing all files in compliance to ensure a uniform style.

All changes outside of the makefile, and .vscode were made using the formatted itself.

@jsfreischuetz
Copy link
Contributor Author

@jsfreischuetz please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree

@jsfreischuetz jsfreischuetz changed the title Change formatter to be more aggressive and strongly enforce pep8 style Change formatter to black to strongly enforce pep8 style May 17, 2024
Makefile Show resolved Hide resolved
SECURITY.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@bpkroth
Copy link
Contributor

bpkroth commented May 17, 2024

When we're done with this one, let's add a new .gitrevisions entry so we don't mess with the history too much.

@bpkroth
Copy link
Contributor

bpkroth commented May 20, 2024

Playing with this locally atm.
I have some changes to the Makefile rules prepped.
Also we'll need to add config options in pyproject.toml which will cause other required changes elsewhere, so I'll try and prep those first and then come back to this.

@bpkroth
Copy link
Contributor

bpkroth commented Jun 28, 2024

Playing with this locally atm. I have some changes to the Makefile rules prepped. Also we'll need to add config options in pyproject.toml which will cause other required changes elsewhere, so I'll try and prep those first and then come back to this.

#762 and #763 have some Makefile improvements to prepare for this.
#764 introduces pyproject.toml changes
#766 prepares isort and black format checkers

Will take up the actual reformatting and enablement of those after those are thru.

Closing this one for now.

@bpkroth bpkroth closed this Jun 28, 2024
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.

2 participants