ensure every python source dir has an __init__.py file

[kdmccormick]

Description

Several Python source directories in edx-platform are quietly being skipped by pylint because they don’t have an __init__.py file. Furthermore, import-linter requires that every Python source dir have an __init__.py file.

This PR:

• Adds in the missing __init__.py files.
• Fixes or applies amnesty to all pylint violations now coming from directories that were missing __init__.py.
• Adds a shell script & GitHub Action to ensure that every directory has an __init__.py file going forward.

Supporting information

See BOM-2593 for details.

Testing instructions

• Run pylint locally on one of the directories that this PR fixes. Ensure it passes.
• Add a pylint violation (eg, unused variable) to a file in that directory.
• Run pylint locally on the directory again. Ensure it flags the violation you added.

Deadline

None. (On hold until Arbi-BOM is able to pick this work back up)

Sooner is better, though, since new edx-platform directories are regularly created, which will add to the pylint debt.

Other information

Christie took care of some of this already for Aperture-owned directories in https://github.com/edx/edx-platform/pull/27972

Prerequisite to https://github.com/edx/edx-platform/pull/27011 (import linting)

[kdmccormick]

jenkins run python

[arch-bom-gocd-alerts]

📣 💥 Heads-up: You must either rebase onto master or merge master into your branch to avoid breaking the build.

We recently removed diff-quality and introduced lint-amnesty. This means that the automated quality check that has run on your branch doesn't work the same way it will on master. If you have introduced any quality failures, they might pass on the PR but then break the build on master.

This branch has been detected to not have commit 2e33565 as an ancestor. Here's how to see for yourself:

git merge-base --is-ancestor 2e335653 kdmccormick/init-dot-py && echo "You're all set" || echo "Please rebase onto master or merge master to your branch"

If you have any questions, please reach out to the Architecture team (either #edx-shared-architecture on Open edX Slack or #architecture on edX internal).

[edx-status-bot]

Your PR has finished running tests. There were no failures.

[UsamaSadiq]

Tested the newly added directories to be successfully producing pylint warnings on local.

[kdmccormick]

Thanks Usama!

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the production environment.