Import modules properly
(reasons: recovering old modules)
|(11 intermediate revisions by 3 users not shown)|
Revision as of 12:21, 11 May 2012
Haskell has a lot of variants of importing identifiers from other modules. However not all of them are as comfortable as they seem to be at the first glance. We recommend to focus on the following two forms of import:
import qualified Very.Special.Module as VSM import Another.Important.Module (printf, (<|>), )
import Very.Special.Module import Another.Important.Module hiding (open, close, )
There are four different kind of reasons for this.
- Style: If you read ,printfor<|>in the program you can find out easily where the identifier comes from. In the second case you don't know if these identifiers are fromVSM.open,Very.Special.Moduleor even other modules. Mind you that grep won't help, becauseAnother.Important.ModuleandVery.Special.Modulemight just re-export other modules. You might guess the origin ofAnother.Important.Moduleaccording to its name, but for the infix operatorprintfyou will certainly have no idea.<|>
- Compatibility: In the second case, if new identifiers are added to the imported modules they might clash with names of other modules. Thus updating imported modules may break your code. If you import a package A with version a.b.c.d that follows the Package versioning policy then within versions with the same a.b it is allowed to add identifiers. This means that if you import the suggested way, you can safely specify
A >= a.b.c && <a.b+1in your Cabal file. Otherwise you have to chose the smaller range
A >= a.b.c && <a.b.c+1. It may also be thatwas deprecated when you hid it, and with a module update removing that identifier, your import fails. That is, an identifier that you never needed but only annoyed you, annoys you again, when it was meant to not bother you any longer! The first variant of import does not suffer from these problems.Another.Important.Module.open
- Correctness: I once found a bug in the StorableVector package by converting anonymous imports to explicit imports. I found out that the function was imported, although functions from this module always have to calculate with unit "element" not "byte". That is,Foreign.Ptr.plusPtrmust be used instead. Actually, theadvancePtrfunction usedreverseand this was wrong. A misbehaviour could only be observed for sub-vectors and elements with size greater than 1 byte. The test suite did miss that.plusPtr
- Maintenance: All too often I find an old module that cannot be compiled any longer since it uses identifiers that do no longer exist. If the module imports implicitly und without qualification I have little chance to find out where the identifiers originally came from, what they meant and how they must be replaced.
2 Exception from the ruleSince the Prelude is intended to be fixed for the future, it should be safe to use the
Actually if you do not mention Prelude it will be imported anonymously.
3 Clashing of module name abbreviations
In Haskell it is possible to use the same abbreviation for different modules:
import qualified Data.List as List import qualified Data.List.Extra as List
This is discouraged for the same reasons as above:
- Style: The identifier may refer to eitherList.intercalateorData.List. The reader of that module has to check these modules in order to find it out.Data.List.Extra
- Compatibility: The function may be currently defined only inList.intercalate. However after many people found it useful, it is also added toData.List.Extra. ThenData.Listcan no longer be resolved.List.intercalate
4 Counter-arguments to explicit import lists
The issue of whether to use explicit import lists is not always clear-cut, however. Here are some reasons you might not want to do this:
- Development is slower: almost every change is accompanied by an import list change, especially if you want to keep your code warning-clean.
- When working on a project with multiple developers, explicit import lists can cause spurious conflicts, since two otherwise-unrelated changes to a file may both require changes to the same import list.
For these reasons amongst others, the GHC project decided to drop the use of explicit import lists. We recommend using explicit import lists when importing from other packages, but not when importing modules within the same package.
Qualified use of identifiers does not suffer from the above problems.
5 See also
- This page addresses an aspect of Haskell style, which is to some extent a matter of taste. Just pick what you find appropriate for you and ignore the rest.