Add separate_packages option #2313
Conversation
Adds the ability to separate packages within a section with blank lines. --------- Co-authored-by: Lucas <[email protected]>
chore: use python 3.8-style typing
|
Any chance of merging this one? It would really help me. Now I had to write a very ugly hack for the config file to simulate this behavior. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2313 +/- ##
=======================================
Coverage 99.16% 99.16%
=======================================
Files 40 40
Lines 3101 3128 +27
Branches 680 687 +7
=======================================
+ Hits 3075 3102 +27
Misses 15 15
Partials 11 11 |
There was a problem hiding this comment.
Thanks a lot for your contributing @alex-liang3. I made some comments with suggestions of how to better benefit from the new option.
| @@ -149,6 +153,38 @@ def sorted_imports( | |||
| section_output.append("") # Empty line for black compatibility | |||
| section_output.append(section_comment_end) | |||
|
|
|||
| if section in config.separate_packages: | |||
There was a problem hiding this comment.
Thanks a lot for this @alex-liang3. I know the complexy of this method was already high, but this pirce of code you added here is a perfect candidate for an extract method. With that we could start the needed refactor here to reduce the complexity. Could you please do this refactor?
isort/output.py
Outdated
| from .settings import DEFAULT_CONFIG, Config | ||
|
|
||
|
|
||
| # Ignore DeepSource cyclomatic complexity check for this function. It was |
There was a problem hiding this comment.
I believe we dont need to add those lines (see my next comment).
| @@ -1039,6 +1039,16 @@ If `True` isort will automatically create section groups by the top-level packag | |||
| **Python & Config File Name:** group_by_package | |||
| **CLI Flags:** **Not Supported** | |||
|
|
|||
| ## Separate Packages | |||
|
|
|||
| Separate packages within the listed sections with newlines. | |||
There was a problem hiding this comment.
Would you mind adding an example here to make it more clear?
* Revert "ci: ignore PY-R1000" * refactor: breakout logic into separate function * docs: add examples
|
Thanks for the review @staticdev, and all your efforts on this project so far! I've made the requested changes now, but unfortunately the function call itself still adds +1 to the cyclomatic complexity (the criticality threshold is 50). Let me know what you think of the changes :) |
Resolves #2104 by adding a separate_packages config option. This should also cover #2262.
Sections provided in this field will have the packages within them be separated by a blank line. This also works with custom known_OTHER sections; see tests for examples.
For reference, these changes increase the cyclomatic complexity (PY-R1000) of this function from 68 to 75, so I'm proposing to ignore the check on this function for the same reason as in https://github.com/PyCQA/isort/pull/2340/files#diff-d97e563d18af5b82fdf3bbb340c60da3e6955177a064fcbaf7e8676589933ddaR243