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

Guard against breaking changes in isort's Python API #262

Closed
akaihola opened this issue Jan 25, 2022 · 0 comments · Fixed by #296
Closed

Guard against breaking changes in isort's Python API #262

akaihola opened this issue Jan 25, 2022 · 0 comments · Fixed by #296
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@akaihola
Copy link
Owner

akaihola commented Jan 25, 2022

The GitHub Action script currently allows the user to pin Darker itself to a given version using the version: option (see action/main.py).

Darker's dependencies, however, only specify minimum versions in install_requires and extras_require in setup.cfg, such as:

    black>=21.5b1
    isort>=5.0.1

We use internal Python APIs from both of those packages. Black doesn't even define a public Python API (yet; see psf/black#779). We use Python APIs instead of calling these tools as subprocesses for performance and flexibility reasons.

Breaking changes have occurred in the past for both Black and isort, see:

Since Darker 1.4.1, we now do guard against backwards incompatible internal changes in Black by running a test-future workflow weekly and also as part of push triggered builds. So we will get an early warning if it seems an incompatibility is coming up in the next Black release. See #186 and #284 for details.

For isort we don't currently have the same mechanism in place.

We should thus either

@akaihola akaihola self-assigned this Feb 10, 2022
@akaihola akaihola added the enhancement New feature or request label Feb 10, 2022
@akaihola akaihola modified the milestones: 1.4.1, 1.4.2 Feb 10, 2022
@akaihola akaihola changed the title Pin isort in the GitHub Action image Guard against breaking changes in isort's Python API Feb 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant