Magnolia Tech

いつもコードのことばかり考えている人のために。

Scalaでネストしたcase classのインスタンスを作るときに気をつけること

きっかけはJson4sの、このissue.

github.com

テストクラスの中で定義したcase classが正しく判定されない、というもの。

いくらJson4sのコードを追いかけてもよく分からなかったところ、いつも色々なことを教えて頂くKenji Yoshidaさん(@xuwei_k)に教えて頂きました。

更に!普通にJson4sのREADMEにも書かれていました…最初から読めよっていう…

github.com

For classes defined in a trait it's a bit difficult to get to their companion object, which is needed to provide default values. We could punt on those but that brings us to the next problem, that the compiler generates an extra field in the constructor of such case classes. The first field in the constructor of those case classes is called $outer and is of type of the defining trait. So somehow we need to get an instance of that object, naively we could scan all classes and collect the ones that are implementing the trait, but when there are more than one: which one to take?

ネストしたcase classのコンストラクタの場合、Scalaのコンパイラが$outerというフィールド名にouter classを入れておいてくれる! Json4sは全てのフィールドのインスタンスを作ってから、case classのインスタンスを作るので、この際にouter classが何も引数を取らないクラスであれば生成できる、というわけです(引数が必要なクラスだと生成に失敗します）。

Json4sでは、そのようなパターンにも対応できるようにouter classのインスタンスを渡す方法が用意されています。詳しくは先ほどのREADMEを参照して下さい。

この、Scalaではinner classのインスタンスがouter classのインスタンスに依存するのは、Scalaの経路依存型、という機能の話になり、以下のサイトが参考になりました。

53ningen.com

ネストしたクラスのインスタンス化について、JavaとScalaで大きく違うところですね。

Akko 3068というメカニカルキーボードを買った

f:id:magnoliak:20190616202733j:plain
Akko 3068

小型のメカニカルキーボードが欲しく、でも自作に手を出すのも時間が足りない…みたいなことで、検索していたら丁度よさそうのを見つけた。Akko 3068というメカニカルキーボードで、Cherry製のキースイッチが採用されていて、茶軸、青軸、赤軸から選べ、Bluetooth接続もできる、というスペック。そして、接続端子がType-C!

値段も日本円で9000円を切るということで試しに赤軸モデルを買ってみた。

www.banggood.com

結論から言うと、「思ってたのと違う」。

キータッチは、さすが赤軸なので、全然問題無し。

問題は接続…付属のケーブルがキーボード側はType-C、反対側がType-Aという、一見すると普通のケーブルなのだけど、このケーブルでしか接続できない！MacBook ProのType-Cポートと直接つないでも充電もされないし、キー入力もできない（Bluetooth接続と有線接続が切り替えられる)。

Bluetooth接続で使う前提だったけど、それでも充電が専用ケーブルオンリーはけっこうキツい感じなので（昔はそうゆうガジェット多かったけど）、積極的にお勧めできるものではないかな。

あと、このキーボードを作っている会社のウェブサイトに行くと、なかなか凄い製品ラインナップでした。

小西康陽 / わたくしのビートルズ

普段、本を読むと言えば技術書ばかりで、あまりコラム集のような、明確な目的の無い本を読むことが無い。

わたくしのビートルズ 小西康陽のコラム1992-2019

わたくしのビートルズ 小西康陽のコラム1992-2019

元ピチカート・ファイヴの…といってもピチカート・ファイヴ解散からもう18年経っているので、さすがにその枕詞はいらないかもしれないけど…小西康陽のコラム集「わたくしのビートルズ」を入手した。

今回もフィクションともノンフィクションともつかない、つかみ所の無いショートストーリーめいたコラムが充実していて、ちょっとした合間の時間に読むのにぴったりの構成。内容よりもリズム感…いつまでも読んでいられる流れるような文章。

1990年代中盤の渋谷系ブームをリアルタイムに経験して、渋谷でレコードばかり買っていた世代としては、小西康陽の名前は特別だ。そして、雑誌や小冊子の、ちょっとしたコラムに小西康陽の名前を見つけると、未だに真っ先に読んでしまう。

約10年おきに刊行される小西康陽のコラム集…「これは恋ではない」「ぼくは散歩と雑学が好きだった」に続く3冊目。以前の2冊の単行本は常に家の本棚の一番いい場所に（ヤン富田の単行本と共に）置かれている。10年後に、新刊のコラム集は刊行されるのだろうか。

ぼくは散歩と雑学が好きだった。 小西康陽のコラム1993-2008

ぼくは散歩と雑学が好きだった。 小西康陽のコラム1993-2008

これは恋ではない―小西康陽のコラム 1984‐1996

これは恋ではない―小西康陽のコラム 1984‐1996

Scala 2.13におけるStringに対するtoIndexedSeqの挙動

Scala 2.12と、2.13で返す型が変わっていますが、ドキュメント上で探すことができませんでしたのでここに書いておきます。

Welcome to Scala 2.12.8 (OpenJDK 64-Bit Server VM, Java 12.0.1).
Type in expressions for evaluation. Or try :help.

scala> val chars = "こんにちは世界".toIndexedSeq
chars: scala.collection.immutable.IndexedSeq[Char] = Vector(こ, ん, に, ち, は, 世, 界)

Welcome to Scala 2.13.0-RC3 (OpenJDK 64-Bit Server VM, Java 12.0.1).
Type in expressions for evaluation. Or try :help.

scala> val chars = "こんにちは世界".toIndexedSeq
chars: IndexedSeq[Char] = こんにちは世界

scala> chars.getClass
res0: Class[_ <: IndexedSeq[Char]] = class scala.collection.immutable.WrappedString

WrappedStringを返す方が余計なコピーも無くてよさそうですね。

scala 2.13から導入されるArraySeq.unsafeWrapArrayは何が'unsafe'なのか?

blog.magnolia.tech

先日のエントリで、ArraySeq.unsafeWrapArrayを取り上げましたが、そもそも何が'unsafe'なの？immutableなデータ構造にラップするので、safeなのでは？と疑問に思ったところ、いつものごとくKenji Yoshida(@xuwei_k)さんに教えて頂きました。

なるほどーいくらラップしても元のArrayがmutableであることには変わりないので、そこは理解して使えよ！ってことのようです。その注意喚起の意味でのunsafeですね。

ちなみにArraySeq.unsafeArrayのscaladocにはそれなりのメソッドの危険性が書かれています。

abstract defunsafeArray: Array[_] The wrapped mutable Array that backs this ArraySeq. Any changes to this array will break the expected immutability. Its element type does not have to be equal to the element type of this ArraySeq. A primitive ArraySeq can be backed by an array of boxed values and a reference ArraySeq can be backed by an array of a supertype or subtype of the element type.

しかしどちらかというと、ArraySeq.unsafeWrapArrayのscaladocに書いて欲しいところですね。

というわけでアドバイスを頂いたこともあり、初めてのScala本体へのPRを書きました。

github.com

レビューは通っているので、Scala 2.13.1あたりには取り込まれるのではないでしょうか。

１行の、ドキュメント追加とはいえ、マージされると嬉しいなぁ。

Scala 2.13からArrayからIndexedSeqへの暗黙の変換が非推奨となる

いよいよ正式リリースが近づいてきたScala 2.13ですが、既存のコードをリリース候補版のScala 2.13でコンパイルすると以下のようなメッセージを見かけるようになりました。

scala> def makeSeq(a: Array[Int]): Seq[Int] = if (a == null) Nil else a
                                                                      ^
       warning: method copyArrayToImmutableIndexedSeq in class LowPriorityImplicits2 is deprecated (since 2.13.0): Implicit conversions from Array to immutable.IndexedSeq are implemented by copying; Use the more efficient non-copying ArraySeq.unsafeWrapArray or an explicit toIndexedSeq call
makeSeq: (a: Array[Int])Seq[Int]

copyArrayToImmutableIndexedSeqなんてメソッド、呼び出していたっけ？LowPriorityImplicits2っていうクラスって何だっけ?そもそも、このメッセージは何を意味しているのか？…調べた結果をまとめました。

まずはScala 2.13へのマイグレーションガイドをチェックします。

https://confadmin.trifork.com/dl/2018/GOTO_Berlin/Migrating_to_Scala_2.13.pdf

20ページに関連する記載が有ります。

Wrapped Java varargs pretend the array is immutable • Using the new s.c.i.ArraySeq • You can do the same with ArraySeq.unsafeWrapArray • A deprecated implicit conversion makes a copy of the array

Scala 2.12までは、ArrayをSeqへ渡すと、scala.collection.mutable.WrappedArrayに変換されていました。これはScala 2.12のscala.Predefで定義されているImplicit Conversionの挙動です。

scala> val r: Seq[Int] = Array(1, 2)
r: Seq[Int] = WrappedArray(1, 2)

Scala 2.13ではSeqがImmutable化されたことを受けて、scala.collection.immutable.ArraySeqに変換されます。

scala> val r: Seq[Int] = Array(1, 2)
                              ^
       warning: method copyArrayToImmutableIndexedSeq in class LowPriorityImplicits2 is deprecated (since 2.13.0): Implicit conversions from Array to immutable.IndexedSeq are implemented by copying; Use the more efficient non-copying ArraySeq.unsafeWrapArray or an explicit toIndexedSeq call
r: Seq[Int] = ArraySeq(1, 2)

これはScala 2.13のscala.Predefで定義が追加された以下のコードによるものです。

private[scala] abstract class LowPriorityImplicits2 {
  @deprecated("Implicit conversions from Array to immutable.IndexedSeq are implemented by copying; Use the more efficient non-copying ArraySeq.unsafeWrapArray or an explicit toIndexedSeq call", "2.13.0")
  implicit def copyArrayToImmutableIndexedSeq[T](xs: Array[T]): IndexedSeq[T] =
    if (xs eq null) null
    else new ArrayOps(xs).toIndexedSeq
}

LowPriorityImplicits2もcopyArrayToImmutableIndexedSeqが出てきました。暗黙の変換によりコピーが発生するので、toIndexedSeqでコピーして変換するか、それではパフォーマンス的に問題になる場合はArraySeq.unsafeWrapArrayを使ってコピー無しにimmutable化するか明示的に示しましょう、ということですね「ArraySeq.unsafeWrapArray」って何がunsafeなの？という話は、また別のエントリを書きます)。

確かに、警告が出なくなります。

scala> val r1: Seq[Int] = Array(1, 2).toIndexedSeq
r1: Seq[Int] = ArraySeq(1, 2)

scala> val r2: Seq[Int] = scala.collection.immutable.ArraySeq.unsafeWrapArray(Array(1, 2))
r2: Seq[Int] = ArraySeq(1, 2)

しかし、元々LowPriorityImplicits2というクラスも、copyArrayToImmutableIndexedSeqというメソッドも、Scala 2.12まではなかったし、Scala 2.13でも明示的に使うものではありません(implicit conversionですしね)。

定義された瞬間に非推奨になってしまうクラスと、メソッド…しかもユーザーコード上には出てきません…「実は、最初からそんなメソッドなんか無かったんですよ…」って言うと何だか押井守っぽいですね。

というわけで上記のメッセージが出たら、明示的に変換方法を指定しましょう、という話でした。