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

What should our explicit import policy be? #2339

Open
MatthewDaggitt opened this issue Apr 1, 2024 · 4 comments
Open

What should our explicit import policy be? #2339

MatthewDaggitt opened this issue Apr 1, 2024 · 4 comments

Comments

@MatthewDaggitt
Copy link
Contributor

As discussed in #2334 we don't currently have a policy about when imports should use an explicit using statement and when it's fine to open the whole module. We should add something to the style guide.

I have no particularly strong feelings on the matter.....

@JacquesCarette
Copy link
Contributor

We certainly should allow explicit imports, even if they are long, and not remove them once they've been put into place.

To me, there should be some 'core' of the library where explicit imports are required, and an 'upper layer' where they are merely encouraged.

@gallais
Copy link
Member

gallais commented Apr 3, 2024

I would argue in favour of mandatory explicit import lists if they
mention, say, max half a dozen identifiers. Throwing these in as
we touch modules should hopefully help us detect spurious
dependencies (until we get better tooling to do it automatically).

@JacquesCarette
Copy link
Contributor

I'd be happy with mandatory for <= 6. I'd be unhappy to have explicit imports deleted just because they're long.

@jamesmckinna
Copy link
Contributor

I'd be happy with mandatory for <= 6. I'd be unhappy to have explicit imports deleted just because they're long.

NB some recent refactorings do indeed delete 'long' using directives, but usually only to localise them further by removing more names, or to distribute the names they do import over lower-level modules they import from... so I don't think there's unnecessary 'widening' of import interfaces going on here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants