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.

Sign up for GitHub

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

Jump to bottom

Add "src" to src default #12454

Closed
charliermarsh opened this issue Jul 22, 2024 · 3 comments · Fixed by #12848
Closed

Add "src" to src default #12454

charliermarsh opened this issue Jul 22, 2024 · 3 comments · Fixed by #12848
Assignees
@charliermarsh
Labels
breaking Breaking API change isort Related to import sorting
Milestone
v0.6

Comments

@charliermarsh
Copy link
Member

We've received a few issues about this, and it's a common source of confusion. Rye actually defaults to this layout, so it's odd that we don't respect it in Ruff.

See, e.g., #12453.
@charliermarsh charliermarsh added breaking Breaking API change isort Related to import sorting labels Jul 22, 2024
@charliermarsh charliermarsh added this to the v0.6 milestone Jul 22, 2024
@charliermarsh charliermarsh mentioned this issue Jul 22, 2024
Closed
@MichaReiser MichaReiser self-assigned this Aug 12, 2024
@MichaReiser
Copy link
Member

@charliermarsh I suspect that you can make the change 10x faster than me. Would you have the time to PR the change. If not, then that's fine and I'll give it a try.

@charliermarsh
Copy link
Member Author

Yeah no worries.

@charliermarsh
Copy link
Member Author

I'll do it today.

@charliermarsh charliermarsh mentioned this issue Aug 12, 2024
Merged
charliermarsh added a commit that referenced this issue Aug 14, 2024
@charliermarsh
Detect imports in src layouts by default (#12848)
1be5212 
## Summary

Occasionally, we receive bug reports that imports in `src` directories
aren't correctly detected. The root of the problem is that we default to
`src = ["."]`, so users have to set `src = ["src"]` explicitly. This PR
extends the default to cover _both_ of them: `src = [".", "src"]`.

Closes #12454.

## Test Plan

I replicated the structure described in
#12453, and verified that the
imports were considered sorted, but that adding `src = ["."]` showed an
error.
AlexWaygood pushed a commit that referenced this issue Aug 14, 2024
@charliermarsh @AlexWaygood
Detect imports in src layouts by default (#12848)
58d5d97 
## Summary

Occasionally, we receive bug reports that imports in `src` directories
aren't correctly detected. The root of the problem is that we default to
`src = ["."]`, so users have to set `src = ["src"]` explicitly. This PR
extends the default to cover _both_ of them: `src = [".", "src"]`.

Closes #12454.

## Test Plan

I replicated the structure described in
#12453, and verified that the
imports were considered sorted, but that adding `src = ["."]` showed an
error.
MichaReiser pushed a commit that referenced this issue Aug 14, 2024
@charliermarsh @MichaReiser
Detect imports in src layouts by default (#12848)
4e5af5c 
## Summary

Occasionally, we receive bug reports that imports in `src` directories
aren't correctly detected. The root of the problem is that we default to
`src = ["."]`, so users have to set `src = ["src"]` explicitly. This PR
extends the default to cover _both_ of them: `src = [".", "src"]`.

Closes #12454.

## Test Plan

I replicated the structure described in
#12453, and verified that the
imports were considered sorted, but that adding `src = ["."]` showed an
error.
MichaReiser pushed a commit that referenced this issue Aug 14, 2024
@charliermarsh @MichaReiser
Detect imports in src layouts by default (#12848)
15aa5a6 
## Summary

Occasionally, we receive bug reports that imports in `src` directories
aren't correctly detected. The root of the problem is that we default to
`src = ["."]`, so users have to set `src = ["src"]` explicitly. This PR
extends the default to cover _both_ of them: `src = [".", "src"]`.

Closes #12454.

## Test Plan

I replicated the structure described in
#12453, and verified that the
imports were considered sorted, but that adding `src = ["."]` showed an
error.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@charliermarsh charliermarsh

Labels
breaking Breaking API change isort Related to import sorting
Projects
None yet
Milestone
v0.6
Development

Successfully merging a pull request may close this issue.

Detect imports in src layouts by default astral-sh/ruff
3 participants
@MichaReiser @charliermarsh @AlexWaygood