Adding black formatter pre-commit

[nmerket]

Pull Request Description

Adding pre-commit and black code formatter.

Checklist

Not all may apply

• Code changes (must work)
• Tests exercising your feature/bug fix (check coverage report on Checks -> BuildStockBatch Tests -> Artifacts)
• Coverage has increased or at least not decreased. Update minimum_coverage in .github/workflows/ci.yml as necessary.
• All other unit and integration tests passing
• Update validation for project config yaml file changes
• Update existing documentation
• Run a small batch run on Eagle to make sure it all works if you made changes that will affect Eagle
• Add to the changelog_dev.rst file and propose migration text in the pull request

[github-actions]

File	Coverage
All files	86%	✅
base.py	90%	✅
eagle.py	77%	✅
exc.py	57%	✅
local.py	70%	✅
postprocessing.py	84%	✅
utils.py	96%	✅
sampler/base.py	79%	✅
sampler/downselect.py	33%	✅
sampler/precomputed.py	93%	✅
sampler/residential_quota.py	61%	✅
test/test_docker.py	33%	✅
test/test_validation.py	97%	✅
workflow_generator/base.py	90%	✅
workflow_generator/commercial.py	53%	✅
workflow_generator/residential_hpxml.py	86%	✅

Minimum allowed coverage is 33%

Generated by 🐒 cobertura-action against ba56460

[shorowit]

Note that as an alternative to developers having to install pre-commit, there are services that will run the pre-commit automatically. Like this one. It's free and integrates with GitHub.

[shorowit]

https://github.com/pre-commit/action even says:

"this action is in maintenance-only mode and will not be accepting new features.

generally you want to use pre-commit.ci which is faster and has more features."

[lixiliu]

LGTM. Though you might want to update bsb documentation to show how to activate the pre-commit hook.

[rajeee]

Can we keep 120 line length and avoid excessive reformatting of the code base?

[nmerket]

@rajee I'm open to it. It looks like to set a custom line length, I'd need to use a pyproject.toml. However, buildstockbatch is using setup.py. We'll need to convert the setup.py into a pyproject.toml. Would you be able to take a stab at that?

[rajeee]

@rajee I'm open to it. It looks like to set a custom line length, I'd need to use a pyproject.toml. However, buildstockbatch is using setup.py. We'll need to convert the setup.py into a pyproject.toml. Would you be able to take a stab at that?

Glad you got it sorted without switching the whole project into pyproject.toml. I don't have a good experience with pyproject.toml - I tried using it for buildstock-query but had to revert back to setup.py because at that time, the toml version didn't support editable mode installation.