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

Use mirror to run black with pre-commit #95605

Merged
merged 1 commit into from
Aug 3, 2023

Conversation

cdce8p
Copy link
Member

@cdce8p cdce8p commented Jun 30, 2023

Proposed change

black recently started publishing mypyc compiled wheels to PyPI. Those improve performance quite noticeably. To use those wheels, we need use a pre-commit mirror like we already do for other packages (ruff or prettier). An alternative would be use the local installed version, like we do for mypy and pylint.

Unfortunately, there isn't an "official" mirror yet. However a contributor for mypy has create one that we can use. There would also be the option to create our own mirror with the help of https://github.com/pre-commit/pre-commit-mirror-maker.

https://github.com/hauntsaninja/black-pre-commit-mirror

Edit
The pre-commit mirror repo was moved to https://github.com/psf/black-pre-commit-mirror

Speed comparison
Besides the CI runs, this will also improve local pre-commit times.

Time
Current ~ 5:14min
With PR ~ 2:57min

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant home-assistant bot added cla-signed small-pr PRs with less than 30 lines. labels Jun 30, 2023
@frenck
Copy link
Member

frenck commented Jul 4, 2023

Opinion: I like it to be faster, I don't like to change to some random repo spawned to speed it up. 🤷

@cdce8p
Copy link
Member Author

cdce8p commented Jul 4, 2023

Opinion: I like it to be faster, I don't like to change to some random repo spawned to speed it up. 🤷

Exactly my thought as well. It's trivial to set up a mirror package with https://github.com/pre-commit/pre-commit-mirror-maker. We / I could create a mirror in the Home Assistant org if that's better.

@cdce8p
Copy link
Member Author

cdce8p commented Jul 4, 2023

I don't like to change to some random repo spawned to speed it up. 🤷

The author is also a collaborator on the black repo, so it's not completely random. It's really unfortunate that there is no "official" mirror.

See also: psf/black#3405

@frenck
Copy link
Member

frenck commented Jul 4, 2023

The author is also a collaborator on the black repo, so it's not completely random.

I've seen, still random for me.

In my personal opinion, we should not use that random repo. That said, we can hopefully drop black soon.

../Frenck

@frenck frenck marked this pull request as draft July 7, 2023 13:51
@frenck
Copy link
Member

frenck commented Jul 7, 2023

Drafting this PR, as there is activity upstream.

@cdce8p cdce8p marked this pull request as ready for review August 2, 2023 15:51
@cdce8p
Copy link
Member Author

cdce8p commented Aug 2, 2023

The black pre-commit mirror repo was moved to the psf org.
https://github.com/psf/black-pre-commit-mirror

@cdce8p cdce8p requested a review from frenck August 2, 2023 15:51
@cdce8p cdce8p added the smash Indicator this PR is close to finish for merging or closing label Aug 3, 2023
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @cdce8p 👍

../Frenck

@frenck frenck merged commit 1fa6695 into home-assistant:dev Aug 3, 2023
31 checks passed
@cdce8p cdce8p deleted the update-black-pre-commit branch August 3, 2023 11:22
@github-actions github-actions bot locked and limited conversation to collaborators Aug 4, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed small-pr PRs with less than 30 lines. smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants