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

Implement preferred_import_style #788

Merged
merged 7 commits into from
Nov 17, 2024
Merged

Conversation

lieryan
Copy link
Member

@lieryan lieryan commented Apr 4, 2024

Description

Added a new setting (imports.preferred_import_style) that controls how rope inserts new import statements.

It can be set to:

  • normal-import (default) which will insert imports as import <package>
  • from-module which will insert imports as from <package> import <module>
  • from-global which will insert imports as from <package>.<module> import <object>

Credit: the solution here is based on nicoolas25's work on #696, but implements the config settings in a slightly different way.

Checklist (delete if not relevant):

  • I have added tests that prove my fix is effective or that my feature works
  • I have updated CHANGELOG.md
  • I have made corresponding changes to user documentation for new features

Copy link

codecov bot commented Apr 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.98%. Comparing base (33d596a) to head (3460498).
Report is 8 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #788      +/-   ##
==========================================
+ Coverage   94.97%   94.98%   +0.01%     
==========================================
  Files         135      135              
  Lines       26404    26480      +76     
==========================================
+ Hits        25076    25152      +76     
  Misses       1328     1328              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lieryan lieryan force-pushed the lieryan-preferred-import-style branch from 1d13e5d to c4469af Compare April 4, 2024 17:38
docs/configuration.rst Outdated Show resolved Hide resolved
@lheckemann
Copy link

Just tested this, it works nicely and results in much smaller diffs :) thanks!

@nip3o
Copy link

nip3o commented Nov 15, 2024

@lieryan it would be pretty awesome to be able to use this. Is there something that prevents it from being merged? Anything we could contribute with?

@lieryan lieryan merged commit cd3ab6a into master Nov 17, 2024
36 checks passed
@lieryan lieryan deleted the lieryan-preferred-import-style branch November 17, 2024 12:08
@lieryan lieryan added this to the 1.14.0 milestone Nov 17, 2024
@lieryan
Copy link
Member Author

lieryan commented Nov 17, 2024

Thanks for checking this PR out, @lheckemann.

@nip3o nothing that I recall, I'll merge this now and include this in a release soon.

@lieryan lieryan mentioned this pull request Nov 17, 2024
2 tasks
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.

3 participants