haskell / haskell/binary

Alternative instance for Get does not respect identity law in error situations

未关闭
#203 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Haskell
星标
120
派生
70
PR 合并指标
30 天内没有已合并 PR

描述

Hello,

While trying to combine `Get` parsers using `asum`, I found out that `instance Alternative Get` is not lawful: `x <|> empty` is not the same as `x` with respect to failure. `x <|> empty` errors with `"Data.Binary.Get(Alternative).empty"`, overriding the error message from `x`.

For me, an unfortunate consequence is that the implementation of `asum` leaks through: `asum [x, y] = x <|> y <|> empty` provides less helpful parse errors than `x <|> y`.

I have attached a minimal working example, also hosted on this Gist: https://gist.github.com/sugarbleat/4f30751feedf8d3e06911deae7ef4a5a, which can be run with `cabal run Main.hs`. For reference, a similar test with Parsec shows no violation of identity.

Thanks for the great work on the library, by the way!

```haskell
#!/usr/bin/env cabal
{- cabal:
build-depends: base ^>= 4.15
, bytestring ^>= 0.10.12
, binary == 0.8.9.1
-}
module Main (main) where

import Control.Applicative (Alternative (..))
import Data.Binary (Get, Word8, get)
import Data.Binary.Get (runGetOrFail)
import qualified Data.ByteString.Lazy as B
import Data.Foldable (asum)

testGet :: Show a => Get a -> B.ByteString -> IO ()
testGet p s = do
putStrLn "p"
print $ runGetOrFail p s

putStrLn "p <|> empty"
print $ runGetOrFail (p <|> empty) s

putStrLn "asum [p]"
print $ runGetOrFail (asum [p]) s

main :: IO ()
main = testGet (get :: Get Word8) B.empty

{-
Output:
p
Left ("",0,"not enough bytes")
p <|> empty
Left ("",0,"Data.Binary.Get(Alternative).empty")
asum [p]
Left ("",0,"Data.Binary.Get(Alternative).empty")
-}
```

贡献指南

这个仓库没有索引到贡献指南

调研方向

从 Main.hs 中的最小示例开始,并使用 `cabal run Main.hs` 运行它,重点关注 `Alternative Get` 和 `runGetOrFail` 的结果。当 `p <|> empty` 保留 `p` 的失败结果,且 `asum [p]` 不再用 `empty` 的错误替换该失败结果时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
haskell
领域
backend
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。