Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Request: Truthiness of Result, Correct way to filter over Iterable[Result]

未关闭
#874 6 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
20/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
python
领域
tooling

调研方向

从文档中的 Result/Option 示例以及 issue 中提到的 returns.iterables 和 Fold.collect_all 入口开始。将规范的过滤指导与关于 truthiness、ok 属性、Filter 和文档标题的提议进行比较;当明确确定了一项建议或范围明确的 API/文档变更时,即视为完成。

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

描述

Not sure if this is a question, feature request, recommendation, documenting request, or whatnot.

Love what you folks are doing with this library. However, I've been going through the docs and examples and I'm not sure how to handle Result/Option at the boundary with less-functional-style Python. Take the example of filtering over some failure-prone operation.

from returns.result import Result, Success, Failure

def half(x: int) -> Result:
    if x & 1: 
        return Failure('not an even number')
    return Success(x // 2)

results = [half(i) for i in range(5)] 
results

out:

[<Success: 0>,
 <Failure: not an even number>,
 <Success: 1>,
 <Failure: not an even number>,
 <Success: 2>]

Alright, now I want to obtain only the successful results. My very first instinct is to reach for something like [el for el in results if el] / filter(lambda x: x, results), however Failure and Nothing are both Truthy. Alright, I can see how that interface makes sense, but then I want to reach for [el for el in results if el.ok], alas that doesn't exist.

Looking around the repo for inspiration, I find pipeline.is_successful. Alright, that basically casts an UnwrapFailedError to a bool. I suppose I could do that, but seems rather clunky and not that performant. Alternatively, I could do bool(result.unwrap_or(False)), but...ew. Checking isinstance(result, Failure) fails cause Failure is a function, and _Failure is private and thus discouraged.

Ok there's Fold surely there's from returns.iterables import Filter....mmm nope. A list-like container with a .filter method would also suffice, but I'm not seeing anything built-in. Maybe I'm supposed to use something like Fold.collect(results, ??)? But I can't get the accumulator right. Fold.collect(results, Some(())) just gives me a single Failure. I suspect I'd need some sort of iterable.List which acts like list() but supports the Container interface.

Pipelining is all well and good, but in some places I want to start getting my feet wet with Maybes and Results, and it's a very shallow interface between lots of traditional imperative Python.

First, a question: What is the current canonical/recommended way to filter over a sequence of Results/Maybes? (see edit below)

My recommendations:

  • I think the most pythonic and intuitive approach would be to define __bool__() for Nothing and Failure to return False. Nothing is very obviously Falsy, but Failure is a little less clear-cut, though my gut is it's Falsy. This gives the nice advantage of filter works identically over Result and Maybe. Law of least surprisal. Etc.
  • If you aren't keen on that, definitely add some .ok property (preferred) or .ok() method. I can't think of any reason not to.
  • It would also be cool to have iterables.Filter and iterables.ImmutableList or even iterables.List if you want to be a filthy heathen, just to be able to .map() over lists.
  • Pair container is actually pretty cool and I can think of a few uses. It would be nice if that were in iterables rather than just in the test suite.

I'd be willing to take a stab at writing up and PR-ing any of the above if you are interested.

Edit: Ok I'm a bit of a goofus, apparently I wanted Fold.collect_all(results, Success(())). This still seems a little roundabout. I still think a convenience method Fold.filter(results) makes sense here, whether it's just sugar for Fold.collect_all(foo: List[Bar[Spam]], Bar(())), or checking for truthiness, or whatever.

Might also be good to have a bolded header for Filtering an iterable of containers just below
Collecting an iterable of containers into a single container for, erm, the more oblivious developers out there ;)

主要语言
Python
星标
4.4k
派生
154
平均合并
3 小时 5 分钟
30 天内合并 PR
22

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

dry-python/returns 的其他 Issue

查看 dry-python/returns 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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