Skip to content

make the edit_distance package optional - #5573

Merged
adamnovak merged 1 commit into
masterfrom
optional-edit_distance
Aug 25, 2026
Merged

make the edit_distance package optional#5573
adamnovak merged 1 commit into
masterfrom
optional-edit_distance

Conversation

@mr-c

@mr-c mr-c commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Changelog Entry

To be copied to the draft changelog by merger:

  • PR submitter writes their recommendation for a changelog entry here

Reviewer Checklist

  • Make sure it is coming from issues/XXXX-fix-the-thing in the Toil repo, or from an external repo.
    • If it is coming from an external repo, make sure to pull it in for CI with:
      contrib/admin/test-pr otheruser theirbranchname issues/XXXX-fix-the-thing
      
    • If there is no associated issue, create one.
  • Read through the code changes. Make sure that it doesn't have:
    • Addition of trailing whitespace.
    • New variable or member names in camelCase that want to be in snake_case.
    • New functions without type hints.
    • New functions or classes without informative docstrings.
    • Changes to semantics not reflected in the relevant docstrings.
    • New or changed command line options for Toil workflows that are not reflected in docs/running/{cliOptions,cwl,wdl}.rst
    • New features without tests.
  • Comment on the lines of code where problems exist with a review comment. You can shift-click the line numbers in the diff to select multiple lines.
  • Finish the review with an overall description of your opinion.

Merger Checklist

  • Make sure the PR passed tests, including the Gitlab tests, for the most recent commit in its branch.
  • Make sure the PR has been reviewed. If not, review it. If it has been reviewed and any requested changes seem to have been addressed, proceed.
  • Merge with the Github "Squash and merge" feature.
    • If there are multiple authors' commits, add Co-authored-by to give credit to all contributing authors.
  • Copy its recommended changelog entry to the Draft Changelog.
  • Append the issue number in parentheses to the changelog entry.

@adamnovak

Copy link
Copy Markdown
Member

This makes it less important to have, but it's still in requirements-dev.txt and will still be installed when we install the test-time dependencies.

Does it need to be really optional, where it's not a dependency or it's behind an extra and the tests check for availability before running the test?

Why do you want this to be exactly this amount optional?

@mr-c

mr-c commented Aug 24, 2026

Copy link
Copy Markdown
Contributor Author

This makes it less important to have, but it's still in requirements-dev.txt and will still be installed when we install the test-time dependencies.

Does it need to be really optional, where it's not a dependency or it's behind an extra and the tests check for availability before running the test?

Why do you want this to be exactly this amount optional?

We don't have edit_distance packaged for Debian, and running the tests without this patch results in a pytest error when it attempts to load this file.

If you want I could add a @pytest.mark.skipif(…) to test_file_hints(); but we don't need it for Debian, -k not test_file_hints is working for us

@adamnovak
adamnovak merged commit 7bf1a0c into master Aug 25, 2026
3 checks passed
@adamnovak
adamnovak deleted the optional-edit_distance branch August 25, 2026 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants