Functor-Applicative-Monad Proposal
From HaskellWiki
Lambda Fairy (Talk | contribs) (Rewrite the page!) |
(→Future-proofing current code: - Brought up to date with #8004) |
||
(12 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | + | Haskell calls a couple of historical accidents its own. While some of them, such as the "number classes" hierarchy, can be justified by pragmatism or lack of a strictly better suggestion, there is one thing that stands out as, well, not that: Applicative not being a superclass of Monad. | |
− | This article | + | The topic has been discussed multiple times in the past (cf. link section at the very end). '''This article was updated to describe the current, and very likely to succeed, Haskell 2014 Applicative => Monad proposal (AMP)'''. |
− | + | Some relevant links: | |
+ | * [https://github.com/quchen/articles/blob/master/applicative_monad.md Initial text of the Haskell 2014 AMP] | ||
+ | * [http://article.gmane.org/gmane.comp.lang.haskell.libraries/19482 AMP mailing list discussion] | ||
+ | * Phase one: ticket [http://hackage.haskell.org/trac/ghc/ticket/8004 #8004] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | == Proposal contents == | |
− | + | The list of changes is as follows: | |
− | + | # Applicative becomes a superclass of Monad, and is added to the Prelude. | |
+ | # Alternative becomes a superclass of MonadPlus (in addition to Monad, of course). | ||
+ | # <hask>join</hask> is promoted into the Monad typeclass. | ||
− | + | The general rationale behind these changes: | |
− | + | # ''Break as little code as possible.'' For example, do not move <hask>return</hask> to Applicative and remove <hask>pure</hask>. Instead, leave <hask>return</hask> in Monad, and give it <hask>pure</hask> as default implementation. | |
+ | # ''Change only things that are closely related to the proposal.'' For example, using <hask>join</hask> in a monad definition requires it to be a functor, so it goes hand in hand with the AMP. On the other hand, removing <hask>fail</hask> has nothing to do with what we're trying to accomplish. | ||
− | |||
+ | |||
+ | == Future-proofing current code == | ||
+ | |||
+ | GHC 7.8 will issue two types of warnings in order to encourage wide-scale code fixing. The following describes how to get rid of them, and as a result ensuring your code builds both now and after the AMP is finished. | ||
+ | |||
+ | === Missing superclasses === | ||
+ | |||
+ | (Warnings of the type "Warning: X is an instance of C, but not D") | ||
+ | |||
+ | * Add Applicative/Functor instances for all your Monads. You can simply derive these instances from the Monad by adding the following code: | ||
<haskell> | <haskell> | ||
− | + | import Control.Applicative (Applicative(..)) | |
− | + | import Control.Monad (liftM, ap) | |
− | + | ||
− | + | -- Monad m | |
− | + | ||
− | + | instance Functor m where | |
+ | fmap = liftM | ||
+ | |||
+ | instance Applicative m where | ||
+ | pure = return | ||
+ | (<*>) = ap | ||
</haskell> | </haskell> | ||
− | + | * Add an Alternative instance for all instances of MonadPlus. This can again be done easily using | |
+ | <haskell> | ||
+ | import Control.Applicative (Alternative(..)) | ||
+ | import Control.Monad (mzero, mplus) | ||
− | + | -- MonadPlus m | |
− | + | instance Alternative m where | |
+ | (<|>) = mplus | ||
+ | empty = mzero | ||
+ | </haskell> | ||
− | + | === Future Prelude names === | |
− | + | "The name X clashes with a future Prelude name" - Prelude will export functions called <hask><*></hask>, <hask>join</hask> and <hask>pure</hask>, so if a module defines its own versions of them, there will be name clashes. There are multiple ways of getting rid of this type of warning. | |
− | * <hask>>> | + | # Change your code to not define functions named <hask><*></hask>, <hask>join</hask> or <hask>pure</hask>. |
+ | # Import Prelude definitions you need explicitly. For example, <hask>import Prelude (map, (+))</hask> would not import <hask>join</hask>, so no warning is issued as the module is compatible with the Prelude exporting <hask>join</hask>. ''Note:'' due to how GHC handles <hask>hiding</hask> statements, it impossible to make <hask>import Prelude hiding (join)</hask> not create a warning when the hidden name is not actually exported. In other words, you can't use <hask>hiding</hask>. | ||
+ | # As a last resort, you can use the compiler option <code>-fno-warn-amp</code>, which silences all AMP warnings. Be careful with this though, because once 7.10 hits that module will break if the AMP issues haven't been fixed properly. | ||
− | + | == Discussion and consequences == | |
− | |||
− | === | + | === It's the right thing to do™ === |
− | + | Math. You've all heard this one, it's good and compelling so I don't need to spell it out. | |
− | |||
− | + | === Redundant functions === | |
− | * | + | * <hask>pure</hask> and <hask>return</hask> do the same thing. |
+ | * <hask>>></hask> and <hask>*></hask> are identical. | ||
+ | * <hask>liftM</hask> and <hask>liftA</hask> are <hask>fmap</hask>. The <hask>liftM*</hask> are <hask>liftA*</hask>, <hask><*></hask> is <hask>ap</hask>. | ||
+ | * Prelude's <hask>sequence</hask> requres <hask>Monad</hask> right now, while <hask>Applicative</hask> is sufficient to implement it. The more general version of this issue is captured by <hask>Data.Traversable</hask>, whose main typeclass implements the *same* functionality twice, namely <hask>traverse</hask> and <hask>mapM</hask>, and <hask>sequenceA</hask> and <hask>sequence</hask>. | ||
+ | * The <hask>WrappedMonad</hask> type from <hask>Control.Applicative</hask> provides a semi-automatic way to using Functor/Applicative/Alternative functions for Monad/MonadPlus instances as a makeshift patch. | ||
− | + | That very much violates the "don't repeat yourself" principle, and even more so it ''forces'' the programmer to repeat himself to achieve maximal generality. It may be too late to take all redundancies out, but at least we can prevent new ones from being created. | |
− | + | (Note that it is not proposed to remove any functions for compatibility reasons. Maybe some of them can be phased out in the long run, but that's beyond scope here.) | |
− | + | ||
− | + | ||
− | + | ||
− | |||
− | == | + | === Using Functor/Applicative functions in monadic code === |
− | + | Whenever there's Monad code, you can use Functor/Applicative functions, without introducing an additional constraint. Keep in mind that "Functor/Applicative functions" does not only include what their typeclasses define but many more, for example <hask>void</hask>, <hask>(<$>)</hask>, <hask>(<**>)</hask>. | |
− | == | + | Even if you think you have monadic code, strictly using the least restrictive functions may result in something that requires only Applicative. This is similar to writing a function that needs <hask>Int</hask>, but it turns out any <hask>Integral</hask> will do - more polymorphism for free. |
+ | |||
+ | |||
+ | === Compatibility issues === | ||
+ | |||
+ | These are the kinds of issues to be expected: | ||
+ | |||
+ | # Monads lacking Functor or Applicative instances. This is easily fixable by either setting <hask>fmap = liftM</hask>, <hask>pure = return</hask> and <hask>(<*>) = ap</hask>, although more efficient implementations may exist, or by moving an already existing definition from <hask>Control.Applicative</hask> to the appropriate module. | ||
+ | # This one is specific to building GHC: importing <hask>Control.Monad/Applicative</hask> introduces a circular module dependency. In this case, one can rely on handwritten implementations of the desired function, e.g. <hask>ap f x = f >>= ...</hask>. | ||
+ | # Libraries using their own <hask>(<*>)</hask>. This one is potentially the most laborious consequence. For building GHC though, this only concerns Hoopl, and a handful of renames. | ||
+ | |||
+ | |||
+ | |||
+ | === Beginner friendliness === | ||
+ | |||
+ | How often did you say ... | ||
+ | |||
+ | * "A Monad is always an Applicative but due to historical reasons it's not but you can easily verify it by setting <hask>pure = return</hask> and <hask>(<*>) = ap</hask>" | ||
+ | * "<hask>liftM</hask> is <hask>fmap</hask> but not really." - "So when should I use <hask>fmap</hask> and when <hask>liftM</hask>?" - *sigh* | ||
+ | |||
+ | With the new hierarchy, the answer would *always* be "use the least restrictive one". | ||
+ | |||
+ | |||
+ | |||
+ | == Applying the AMP to GHC and then Haskell in practice == | ||
+ | |||
+ | Proposed is a gradual introduction of the AMP in three phases: | ||
+ | |||
+ | |||
+ | === '''Current stage''': Prepare GHC === | ||
+ | |||
+ | Using a GHC fork with the full patch applied, find and fix all compilation errors introduced by the change by adding Functor/Applicative instances for all Monads. | ||
+ | |||
+ | According to SPJ, adding an ad-hoc warning of sorts "Monad without Applicative detected" is not a problem, which will be crucial for the next phase. More specifically, issue a warning if: | ||
+ | |||
+ | * Monad without Applicative | ||
+ | * MonadPlus without Alternative | ||
+ | * One of <hask><*></hask>, <hask>pure</hask>, <hask>join</hask> is defined in a different context to avoid naming conflicts, as these functions will go into the Prelude | ||
+ | |||
+ | === Prepare Hackage === | ||
+ | |||
+ | The warning just mentioned will hint to all authors that they should fix (or help others fix) the non-complying packages. This will ideally lead to libraries eventually adding Applicative instances, and changing their APIs if they redefine operators like <hask><*></hask>. | ||
+ | |||
+ | After enough time has passed by so libraries adapted to the circumstances, move on to the next phase. | ||
− | |||
− | |||
− | |||
− | |||
− | + | === Apply the proposal === | |
− | + | Once Hackage is prepared, applying the changes to the Base package is painless. However, this is not primarily a GHC, but a Haskell change. The previous steps were basically preparing the landscape, and when we've (hopefully) found out that it is a good idea to go through with it, it can be proposed to go into the Report. If we make it this far, the AMP should pass quite easily. | |
− | |||
− | |||
− | == | + | == Previous proposals == |
− | * | + | * Early 2011: [http://hackage.haskell.org/trac/ghc/ticket/4834 GHC ticket] – changes similar to this proposal, but closed as "not GHC, but Haskell". See [http://thread.gmane.org/gmane.comp.lang.haskell.libraries/14883/focus=14905 here] for the associated discussion. |
− | + | ||
* [[The Other Prelude]] | * [[The Other Prelude]] | ||
− | |||
[[Category:Proposals]] | [[Category:Proposals]] |
Revision as of 23:32, 13 September 2013
Haskell calls a couple of historical accidents its own. While some of them, such as the "number classes" hierarchy, can be justified by pragmatism or lack of a strictly better suggestion, there is one thing that stands out as, well, not that: Applicative not being a superclass of Monad.
The topic has been discussed multiple times in the past (cf. link section at the very end). This article was updated to describe the current, and very likely to succeed, Haskell 2014 Applicative => Monad proposal (AMP).
Some relevant links:
- Initial text of the Haskell 2014 AMP
- AMP mailing list discussion
- Phase one: ticket #8004
Contents |
1 Proposal contents
The list of changes is as follows:
- Applicative becomes a superclass of Monad, and is added to the Prelude.
- Alternative becomes a superclass of MonadPlus (in addition to Monad, of course).
- is promoted into the Monad typeclass.join
The general rationale behind these changes:
- Break as little code as possible. For example, do not move to Applicative and removereturn. Instead, leavepurein Monad, and give itreturnas default implementation.pure
- Change only things that are closely related to the proposal. For example, using in a monad definition requires it to be a functor, so it goes hand in hand with the AMP. On the other hand, removingjoinhas nothing to do with what we're trying to accomplish.fail
2 Future-proofing current code
GHC 7.8 will issue two types of warnings in order to encourage wide-scale code fixing. The following describes how to get rid of them, and as a result ensuring your code builds both now and after the AMP is finished.
2.1 Missing superclasses
(Warnings of the type "Warning: X is an instance of C, but not D")
- Add Applicative/Functor instances for all your Monads. You can simply derive these instances from the Monad by adding the following code:
import Control.Applicative (Applicative(..)) import Control.Monad (liftM, ap) -- Monad m instance Functor m where fmap = liftM instance Applicative m where pure = return (<*>) = ap
- Add an Alternative instance for all instances of MonadPlus. This can again be done easily using
import Control.Applicative (Alternative(..)) import Control.Monad (mzero, mplus) -- MonadPlus m instance Alternative m where (<|>) = mplus empty = mzero
2.2 Future Prelude names
"The name X clashes with a future Prelude name" - Prelude will export functions called- Change your code to not define functions named ,<*>orjoin.pure
- Import Prelude definitions you need explicitly. For example, would not importimport Prelude (map, (+)), so no warning is issued as the module is compatible with the Prelude exportingjoin. Note: due to how GHC handlesjoinstatements, it impossible to makehidingnot create a warning when the hidden name is not actually exported. In other words, you can't useimport Prelude hiding (join).hiding
- As a last resort, you can use the compiler option
-fno-warn-amp
, which silences all AMP warnings. Be careful with this though, because once 7.10 hits that module will break if the AMP issues haven't been fixed properly.
3 Discussion and consequences
3.1 It's the right thing to do™
Math. You've all heard this one, it's good and compelling so I don't need to spell it out.
3.2 Redundant functions
- andpuredo the same thing.return
- and>>are identical.*>
- andliftMareliftA. ThefmapareliftM*,liftA*is<*>.ap
- Prelude's requressequenceright now, whileMonadis sufficient to implement it. The more general version of this issue is captured byApplicative, whose main typeclass implements the *same* functionality twice, namelyData.Traversableandtraverse, andmapMandsequenceA.sequence
- The type fromWrappedMonadprovides a semi-automatic way to using Functor/Applicative/Alternative functions for Monad/MonadPlus instances as a makeshift patch.Control.Applicative
That very much violates the "don't repeat yourself" principle, and even more so it forces the programmer to repeat himself to achieve maximal generality. It may be too late to take all redundancies out, but at least we can prevent new ones from being created.
(Note that it is not proposed to remove any functions for compatibility reasons. Maybe some of them can be phased out in the long run, but that's beyond scope here.)
3.3 Using Functor/Applicative functions in monadic code
Whenever there's Monad code, you can use Functor/Applicative functions, without introducing an additional constraint. Keep in mind that "Functor/Applicative functions" does not only include what their typeclasses define but many more, for example
3.4 Compatibility issues
These are the kinds of issues to be expected:
- Monads lacking Functor or Applicative instances. This is easily fixable by either setting ,fmap = liftMandpure = return, although more efficient implementations may exist, or by moving an already existing definition from(<*>) = apto the appropriate module.Control.Applicative
- This one is specific to building GHC: importing introduces a circular module dependency. In this case, one can rely on handwritten implementations of the desired function, e.g.Control.Monad/Applicative.ap f x = f >>= ...
- Libraries using their own . This one is potentially the most laborious consequence. For building GHC though, this only concerns Hoopl, and a handful of renames.(<*>)
3.5 Beginner friendliness
How often did you say ...
- "A Monad is always an Applicative but due to historical reasons it's not but you can easily verify it by setting andpure = return"(<*>) = ap
- "isliftMbut not really." - "So when should I usefmapand whenfmap?" - *sigh*liftM
With the new hierarchy, the answer would *always* be "use the least restrictive one".
4 Applying the AMP to GHC and then Haskell in practice
Proposed is a gradual introduction of the AMP in three phases:
4.1 Current stage: Prepare GHC
Using a GHC fork with the full patch applied, find and fix all compilation errors introduced by the change by adding Functor/Applicative instances for all Monads.
According to SPJ, adding an ad-hoc warning of sorts "Monad without Applicative detected" is not a problem, which will be crucial for the next phase. More specifically, issue a warning if:
- Monad without Applicative
- MonadPlus without Alternative
- One of ,<*>,pureis defined in a different context to avoid naming conflicts, as these functions will go into the Preludejoin
4.2 Prepare Hackage
The warning just mentioned will hint to all authors that they should fix (or help others fix) the non-complying packages. This will ideally lead to libraries eventually adding Applicative instances, and changing their APIs if they redefine operators likeAfter enough time has passed by so libraries adapted to the circumstances, move on to the next phase.
4.3 Apply the proposal
Once Hackage is prepared, applying the changes to the Base package is painless. However, this is not primarily a GHC, but a Haskell change. The previous steps were basically preparing the landscape, and when we've (hopefully) found out that it is a good idea to go through with it, it can be proposed to go into the Report. If we make it this far, the AMP should pass quite easily.
5 Previous proposals
- Early 2011: GHC ticket – changes similar to this proposal, but closed as "not GHC, but Haskell". See here for the associated discussion.
- The Other Prelude