[FC-0099] chore: implement format command for easier quality management

[mariajgrimaldi]

Description

This PR #100 has a substantial amount of changes, and each time I try to run black, more and more changes come up. The idea is that before merging a PR we run make format to avoid this.

[openedx-webhooks]

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/committers-openedx-authz.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

---

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[bmtcril]

I always love these commands. It looks like black isn't added to requirements, and I think that if we're going to move to black we should replace all of the pycodestyle references in requirements and tox.ini with it as well so they don't disagree on things and cause incompatible issues.

[mariajgrimaldi]

Ups, I forgot to add it as a requirement. Thanks!

Why would using black (compatible with pycodestyle, but it does the formatting automatically) mean replacing pycodestyle?

[BryanttV]

Thank you! @mariajgrimaldi, this is a very useful command to keep us aligned on code quality. I just have 2 comments:

1. Why not use ruff? Currently, we are using it in openedx hooks repos.

   format:
       ruff format openedx_authz tests --line-length 120
       ruff check --select I --fix --line-length 120

   I added the line-length 120 because, for now, that is the limit defined according to the Open edX Python Style Guide, but I don't see a big problem with limiting it to 79.

In any case, regardless of the package we use, I believe it should be consistent throughout the plugin. For example, pycodestyle is configured to have a max-length of 120.

[bmtcril]

I agree with what @BryanttV said regarding how the settings can drift between packages. I've seen in other packages where we have custom pycodestyle settings that don't exist in black, so they conflict. I have a slight preference for ruff over black but also don't much care as long as we're using the same thing with the same settings to do the formatting and the checking.

[mariajgrimaldi]

~I'd also prefer ruff but I don't have the time to migrate or test it so maybe later we can consider it as part of a maintenance effort. ~

I went with ruff...

[mariajgrimaldi]

@BryanttV: I'm going forward with ruff. What other configurations would we need to comply with pycodestyle?

[BryanttV]

@mariajgrimaldi I think with the line-length 120 in the ruff command is enough to align us with pycodestyle for now.

Later on, we can implement a standardized configuration using a ruff.toml file.

[mariajgrimaldi]

Done!!! @bmtcril @BryanttV

Thank you both :)

[BryanttV]

LGTM, thanks!

[bmtcril]

Should be all good if you can update tox.ini as well, thank you!

[mariajgrimaldi]

@BryanttV @bmtcril: remember when I said I didn't have time to migrate to ruff... well I did 😄

[bmtcril]

Yay! Thanks for this.