scala雾中风景(17): toSet()的谜题

看到hackernews上推荐的《scala: the good,the bad and the very ugly》在这篇ppt里,有一个例子挺有意思的:

List(1,2,3).toSet()

猜一下它的结果,直观上我们会认为它返回一个Set类型的集合,实际却不是:

scala> List(1,2,3).toSet()
<console>:8: warning: Adaptation of argument list by inserting () has been deprecated: this is unlikely to be what you want.
    signature: GenSetLike.apply(elem: A): Boolean
  given arguments: <none>
 after adaptation: GenSetLike((): Unit)
          List(1,2,3).toSet()
                           ^
res1: Boolean = false

在repl下测试,在给出警告之后,输出了一个Boolean值。让人大跌眼镜,要想得到预期的结果,方法后边的小括号是不能写的:

scala> List(1,2,3).toSet
res9: scala.collection.immutable.Set[Int] = Set(1, 2, 3)

其实警告信息里已经很明确的说明了,toSet()实际是对toSet的结果再调用的GenSetLike.apply(elem: A),即它相当于

List(1,2,3).toSet.apply()

如果apply方法是无参的,上面的也好理解,但警告信息里提示的是:GenSetLike.apply(elem: A) 明明时带有一个参数的,为什么用空的参数apply()也可以运行?

等等,警告信息里还有2句:

given arguments: <none>
after adaptation: GenSetLike((): Unit)

这两句是说给了一个空参数,被编译器适配成了一个Unit类型的()实例对象,是不是有些匪夷所思?编译器为何要自作聪明?如果我们对Unit类型的谜题还有印象的话,会怀疑是否因为Unit类型用作方法参数引起的:

scala> def foo(u:Unit) { println("ok") }

scala> foo() // 可以运行,同样也会有类似上面的警告信息

参考以前两篇有关Unit的: scala雾中风景(4): Unit类型scala雾中风景(8): 高阶函数与Unit的谜题

不过,这里是否真的就是Unit类型引起的? 虽然警告信息里提示把空参数适配成了Unit类型,但并不是apply方法声明的参数,GenSetLike.apply(elem: A) 参数类型是一个泛型参数,我们先根据直觉判断 List(1,2,3).toSet 之后得到的是Set[Int],所以这里A是Int类型?我们一步步来验证一下:

scala> val s = List(1,2,3).toSet
s: scala.collection.immutable.Set[Int] = Set(1, 2, 3)

scala> s.apply() // 错误,提示缺乏参数!用IDE的话发现编译时就提示错误了

诡异了,分成两步的时候居然又不行了,虽然这时的提示更符合预期,但之前用一句表达 List(1,2,3).toSet.apply() 为什么又可以运行?

经过google之后,发现这竟然是一个很有趣的类型推导问题,参考这篇讨论

scala.collection.immutable.Set是非协变的(实际是invariant的),这点不同于List,Seq,Queue等主流集合的声明。为什么要定义为非协变的,也是由Set自身的函数特征决定的trait Set[A] extends (A => Boolean),可以参考这里的解释

TraversableOnce.toSet方法声明是:

def toSet[B >: A]: immutable.Set[B] = ...

注意,它返回的类型不同于List[A]里的A,而是A的某个父类型B!这里存在一个很常见的类型推导问题:

scala> List(1,2,3).toSet.map(x=>x+1) // 错误,缺乏参数类型

scala> List(1,2,3).toSet.map((x:Int)=>x+1) // 需要显式声明参数类型 
res28: scala.collection.immutable.Set[Int] = Set(2, 3, 4)

scala> List(1,2,3).toSet[Int].map(x=>x+1) // 或在toSet的时候显式的声明元素类型为Int 
res29: scala.collection.immutable.Set[Int] = Set(2, 3, 4)

或分两步,先得到set结果,再map不需要显式声明参数类型:

scala> val s = List(1,2,3).toSet // 先得到set结果
s: scala.collection.immutable.Set[Int] = Set(1, 2, 3)

scala> s.map(x=>x+1)  // OK
res30: scala.collection.immutable.Set[Int] = Set(2, 3, 4)

为啥分开写,跟连着写在toSet阶段的类型推导是不一样的呢,typesafe的开发Adriaan Moors给了解释

You can think of inference as a breadth-first sweep over the expression, collecting constraints (which arise from subtype bounds and required implicit arguments) on type variables, followed by solving those constraints. This approach allows, e.g., implicits to guide type inference. In your example, even though there is a single solution if you only look at the xs.toSet subexpression, later chained calls could introduce constraints that make the system unsatisfiable. The downside of leaving the type variables unsolved is that type inference for closures requires the target type to be known, and will thus fail (it needs something concrete to go on — the required type of the closure and the type of its argument types must not both be unknown).

Now, when delaying solving the constraints makes inference fail, we could backtrack, solve all the type variables, and retry, but this is tricky to implement (and probably quite inefficient).

大致是类型推导是广度优先的方式扫描表达式,搜集类型变量上由子类型界定和隐式参数导致的约束,接下来解释这些约束。。。

所以在一整句连着写List(1,2,3).toSet.apply()toSet阶段因为其上下文约束不同于单句的List(1,2,3).toSet,还未能推导此时Set的元素类型。

我们通过-Ytyper-debug选项可以看到分开写的时候,类型推导的确是明确推导出结果是Set[Int]了:

而连在一起写的时候,并未明确推导出Set的元素类型,这里B类型是Int的父类型:

现在,我们了解到了List(1,2,3).toSeq.apply()在apply()之前因为元素类型还未明确(B是Int的父类型),B可能是一个非常“泛”的类型,比如AnyVal或Any,这样相当于:

scala> val s: Set[Any] = List(1,2,3).toSeq
scala> s.apply()  // 给出警告,但运行OK!

现在问题就变成了,为和一个很宽泛的类型比如AnyAnyRef,用作参数类型的时候,实际调用这个方法时参数可以随意传递?

scala> def foo(a:Any) { println("ok") }
scala> foo(1,2,3) // 给出警告,但运行OK
scala> foo() // 给出警告,但运行OK

其实这个问题跟之前的这篇 scala雾中风景(16): println(1,2,3)为什么work? 属于同一个问题,scala编译器发觉对只有一个参数的方法在调用时参数不一致的情况下,会在最后阶段尝试一次“适配”,简单的说就是用”()”进行tuple化,如果参数多于一个,将整个TupleN当作参数传入,如果参数为0,则tupling得到一个Unit类型实例传入。

对于scala编译器在方法参数上自作聪明的“适配”,应该严格禁止它发生的可能,建议所有的项目编译时,都开启 -Yno-adapted-args 让编译器给出错误,避免混乱。

shell里的|&用法

shell中默认的管道是将前边的命令执行的的标准输出结果传给管道后的命令,而标准错误输出是没有传递的,有些时候,我们想要对前边的命令的标准错误输出也做处理,这样的话就需要将stderr给重定向到stdout了。

不过在高版本的bash里和zsh里现在都支持了 |& 来将标准输出和错误输出一并交给后边的命令处理。举个例子:

$ cat test.sh 
#!/bin/bash
echo "stdout message"
echo "stderr message" 1>&2

我们模拟了2个输出,第一个是标准输出,第二个是错误输出。如果我们用普通的管道 | 来连接的话:

$ ./test.sh | grep stdout
stderr message
stdout message

我们本来只想要过滤包含”stdout”的内容,但错误输出的内容并不会经过管道处理,所以其内容还是完整的打印在了终端上。如果采用 |& 就会把两个输出内容一并交给管道来处理了:

$ ./test.sh |& grep stdout  
stdout message

我不确定bash是从哪个版本开始支持这个特性的,最早是csh/tcsh里有这个特性,被bash和zsh学过来了,ksh里|&是另外一种用法,表示的是协同处理。

如果你的shell不支持这个用法,还是老实的用重定向来解决吧:

$ ./test.sh 2>&1 | grep stdout
stdout message

上面的例子没有实际价值,可能有人说把 2>/dev/null 就可以了,实际应用中,可能是碰到某些命令的输出不确定我们想要的内容是在标准输出里还是在错误输出里,比如我们想看到scalac的选项里包含warn关键字的:

$ scalac -Y |& grep warn 
-Yinline-warnings                       Emit inlining warnings. (Normally surpressed due to high volume)
-Ywarn-adapted-args                     Warn if an argument list is modified to match the receiver.
-Ywarn-dead-code                        Warn when dead code is identified.
-Ywarn-inaccessible                     Warn about inaccessible types in method signatures.
-Ywarn-infer-any                        Warn when a type argument is inferred to be `Any`.
-Ywarn-nullary-override                 Warn when non-nullary `def f()' overrides nullary `def f'.
-Ywarn-nullary-unit                     Warn when nullary methods return Unit.
-Ywarn-numeric-widen                    Warn when numerics are widened.
-Ywarn-unused                           Warn when local and private vals, vars, defs, and types are are unused
-Ywarn-unused-import                    Warn when imports are unused
-Ywarn-value-discard                    Warn when non-Unit expression results are unused.

scala的诊断方法(4) -Ytyper-debug 编译项

在定位之前的那个问题时,发现了-Ytyper-debug选项,可以吧编译器在typer阶段的一些信息打印出来,比-Xprint:typer多出一些类型推导的信息:

$ cat A.scala
object A {
    println(1,2,3)
}

$ scalac -Ytyper-debug  A.scala
|-- <empty> EXPRmode-POLYmode-QUALmode (site: package <root>)
|    \-> <empty>.type
|-- object A BYVALmode-EXPRmode (site: package <empty>)
|    |-- super EXPRmode-POLYmode-QUALmode (silent: <init> in A)
|    |    |-- this EXPRmode (silent: <init> in A)
|    |    |    \-> A.type
|    |    \-> A.type
|    |-- println(1, 2, 3) BYVALmode-EXPRmode (site: value <local A> in A)
|    |    |-- println BYVALmode-EXPRmode-FUNmode-POLYmode (silent: value <local A> in A)
|    |    |    \-> (x: Any)Unit <and> ()Unit
|    |    |-- scala.Tuple3(1, 2, 3) : pt=Any BYVALmode-EXPRmode (silent: value <local A> in A)
|    |    |    |-- scala.Tuple3 BYVALmode-EXPRmode-FUNmode-POLYmode (silent: value <local A> in A)
|    |    |    |    |-- scala.Tuple3.apply BYVALmode-EXPRmode-FUNmode-POLYmode (silent: value <local A> in A)
|    |    |    |    |    [adapt] [T1, T2, T3](_1: T1, _2: T2, _3: T3)(T1, T2, T3) adapted to [T1, T2, T3](_1: T1, _2: T2, _3: T3)(T1, T2, T3)
|    |    |    |    |    \-> (_1: T1, _2: T2, _3: T3)(T1, T2, T3)
|    |    |    |    [adapt] Tuple3.type adapted to [T1, T2, T3](_1: T1, _2: T2, _3: T3)(T1, T2, T3)
|    |    |    |    \-> (_1: T1, _2: T2, _3: T3)(T1, T2, T3)
|    |    |    |-- 1 BYVALmode-EXPRmode-POLYmode (silent: value <local A> in A)
|    |    |    |    \-> Int(1)
|    |    |    |-- 2 BYVALmode-EXPRmode-POLYmode (silent: value <local A> in A)
|    |    |    |    \-> Int(2)
|    |    |    |-- 3 BYVALmode-EXPRmode-POLYmode (silent: value <local A> in A)
|    |    |    |    \-> Int(3)
|    |    |    solving for (T1: ?T1, T2: ?T2, T3: ?T3)
|    |    |    \-> (Int, Int, Int)
|    |    \-> Unit
|    \-> [object A] A.type
|-- (_1: <?>, _2: <?>, _3: <?>)(T1, T2, T3) EXPRmode-FUNmode-POLYmode-TAPPmode (site: object A) implicits disabled
|    |-- new (Int, Int, Int) EXPRmode-POLYmode-QUALmode (site: object A) implicits disabled
|    |    \-> (Int, Int, Int)
|    \-> (_1: Int, _2: Int, _3: Int)(Int, Int, Int)

在解析的时候,对println(1,2,3)里的参数执行了Tuple3(1,2,3)最终参数识别成了Tuple3[Int,Int,Int]类型。暂没发现更大的价值,先记下来以后再补充。

scala雾中风景(16): println(1,2,3)为什么work?

Console的println方法只有一个参数,但执行println(1,2,3)却可以打印出”(1,2,3)” 而不是报错:

scala> println(1,2,3)
(1,2,3)

编译器为什么会自作聪明的把里面的三个参数当成一个Tuple?

google了一下找到了这个issue, 在Typers.scala 里可以看到注释:

/** Try packing all arguments into a Tuple and apply `fun'
 *  to that. This is the last thing which is tried (after
 *  default arguments)
 */
def tryTupleApply: Option[Tree] = {
    // if 1 formal, 1 arg (a tuple), otherwise unmodified args
    val tupleArgs = actualArgs(tree.pos.makeTransparent, args, formals.length)
    ...
}

在编译的typer阶段,最后发现参数与方法定义要求的不匹配时,如果方法只有一个参数,编译器最后会尝试把所有参数打包为一个Tuple,把这个Tuple传递给方法。

这个特性之前没有在规范里明确定义出来。不过编译器有选项可以给出警告或报错的:

$ cat A.scala
object A {
    println(1,2,3)
}

$ scalac -Ywarn-adapted-args A.scala
A.scala:2: warning: Adapting argument list by creating a 3-tuple: this may not be what you want.
    signature: Predef.println(x: Any): Unit
given arguments: 1, 2, 3
after adaptation: Predef.println((1, 2, 3): (Int, Int, Int))
println(1,2,3)
        ^
one warning found

如果严格一些,可以使用-Yno-adapted-args选项禁止这个特性,这样编译时将报错:

$ scalac -Yno-adapted-args  A.scala
A.scala:2: error: too many arguments for method println: (x: Any)Unit
    println(1,2,3)
            ^
one error found

-Xlint里已经包含了-Ywarn-adapted-args,在编译时用-Xlint就可以发现这个警告了。

另外,auto-tupling的特性只能针对方法参数不超过一个情况,如果方法存在重载的且参数有超过2个的话将不起作用:

scala> def foo(p1:Any) { println(p1) }
foo: (p1: Any)Unit

scala> def foo(p1:Any, p2:Any) { println(p1.toString + p2.toString) }
foo: (p1: Any, p2: Any)Unit

scala> foo(1,2,3)
<console>:9: error: too many arguments for method foo: (p1: Any, p2: Any)Unit
          foo(1,2,3)
             ^