[ruff] Add analyze.string-imports-min-dots to settings#20375
Merged
MichaReiser merged 1 commit intoastral-sh:mainfrom Sep 16, 2025
Merged
[ruff] Add analyze.string-imports-min-dots to settings#20375MichaReiser merged 1 commit intoastral-sh:mainfrom
ruff] Add analyze.string-imports-min-dots to settings#20375MichaReiser merged 1 commit intoastral-sh:mainfrom
Conversation
Contributor
|
MichaReiser
approved these changes
Sep 16, 2025
Member
MichaReiser
left a comment
There was a problem hiding this comment.
This looks good but I think we should rename the option to match the CLI
| root.child("ruff.toml").write_str(indoc::indoc! {r#" | ||
| [analyze] | ||
| detect-string-imports = true | ||
| string-imports-min-dots = 1 |
Member
There was a problem hiding this comment.
I think this should be min-dots for consistency with the CLI
Options:
--direction <DIRECTION> The direction of the import map. By default, generates a dependency map, i.e., a map from file to files that it depends on. Use `--direction
dependents` to generate a map from file to files that depend on it [default: dependencies] [possible values: dependencies, dependents]
--detect-string-imports Attempt to detect imports from string literals
--min-dots <MIN_DOTS> The minimum number of dots in a string import to consider it a valid import
--preview Enable preview mode. Use `--no-preview` to disable
--target-version <TARGET_VERSION> The minimum Python version that should be supported [possible values: py37, py38, py39, py310, py311, py312, py313, py314]
--python <PYTHON> Path to a virtual environment to use for resolving additional dependencies
-h, --help
Contributor
Author
There was a problem hiding this comment.
Ok. I have renamed it to min-dots!
ruff] Add analyze.string-imports-min-dots to settings docsruff] Add analyze.min-dots to settings docs
ruff] Add analyze.min-dots to settings docsruff] Add analyze.min-dots to settings
Member
|
Oh wait, I made a mistake. I assumed you added the new option but that isn't the case. This is a pre-existing option (if I understand your summary correctly) and this PR only adds documentation. If that's the case, then we shouldn't rename the option because that would break existing users |
ruff] Add analyze.min-dots to settingsruff] Add analyze.string-imports-min-dots to settings
18e61e6 to
9e0ad2d
Compare
Contributor
Author
|
@MichaReiser Thanks for the clarification. I had the same concern, so I didn’t rename the option; I’ll keep the existing name as is. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #20110
string_imports_min_dotswas introduced in #19538, so the option has been available since then; this PR adds documentation and a config test.Test Plan
Add integration test
string_detection_from_configto verify the config setting works.