Pythonで最速のULIDライブラリを作った話(C++拡張)

# TL;DR
卍爆速卍なPythonのULIDライブラリ"[fast_ulid](https://github.com/nagataaaas/fast-ulid)"を作った
使い方は[ここ](https://github.com/nagataaaas/fast-ulid#installation)

# ULIDとは

みなさんは**ULID**をご存知でしょうか？
ULIDはUUIDの代替となるべく策定されたもので

- UUIDと128ビット互換
- 1ミリ秒ごとに1.21e24のユニークなULIDを作成できる
- 辞書順にソート可能
- 36文字のUUIDに対して、26文字でエンコードされる
- Crockford's base32という、可読性の高いエンコード方式
- ケースインセンシティブ
- 特殊文字を使わないので、URLセーフ
- 単調増加なバイト列(正しい生成順にソートされる)

というものです。上と被る部分もありますが、現状最新とされる**UUID4**は

- 文字効率が悪い(128bitを36文字で表す)
- ソート不可能

ということで、少々使い勝手が悪いようです。

## ULIDの何がうれしいのか

純粋に文字長が短いことで、より可読性が高くなります。
さらには、そのものにミリ秒単位でタイムスタンプが含まれていることで、例えばデータベースのPrimary Keyにしながらタイムスタンプのカラムを減らすことができます。
また、ULIDをPrimary Keyに使うと自動的にソータブルになるのでインデックスが挿入順に綺麗に並び、さらに挿入時のパフォーマンスがauto_incrementと同様に高速です。

# 少々問題が

ありました。

データベースのPrimary Keyにするべく使っており、テストデータの生成を行っていたのですが、Python内でのデータ生成段階からなんとなく... 遅い？

PythonでULIDを使おうと思った時には、大体

- [python-ulid](https://github.com/mdomke/python-ulid) ([mdomke](https://github.com/mdomke)さん)
- [ulid-py](https://github.com/ahawker/ulid) ([ahawker](https://github.com/ahawker)さん)
- [ulid](https://github.com/mdipierro/ulid) ([mdipierro](https://github.com/mdipierro)さん)

のどれかになると思います。
2022/2/23時点でそれぞれのスターの数は、上から76, 289, 34となっており、[ulid-py](https://github.com/ahawker/ulid)が優勢なので私もこれを使っていたのですが、大体ULIDを1,000,000個生成して`str`にするときに私の環境では5, 6秒かかっていました。

プログラマというのは技術に対して貪欲で、作れると思ったものは作らないとうずうずしてしまいますので、もっと高速なULIDライブラリを作ってみようと思い立ちました。

# C++拡張

Pythonには、複数の拡張方法があります。
純粋にPythonでコードを書いてもいいですし、もしパフォーマンスにこだわるのであれば、[CやC++拡張](https://docs.python.org/ja/3/extending/extending.html)を使うのも手です。

今回は(私の技術力の範囲内で)全力で高速化するために、後者の拡張方法を用いたいと思います。

初めはCで拡張しようと思っていましたが、どうやらタイムスタンプに用いるミリ秒取得が環境によって上手くいったりいかなかったり、非推奨だったりでよくわかんないことになっているので、C++を使うことにしました。

以下に技術的につまったところを上げていこうと思います。

## METH_FASTCALL
Python3.7から追加された引数の受け取り方です。以前までは`METH_VARARGS`を使用していました。
`METH_FASTCALL`を用いることで、[かなり高速になりました](https://github.com/nagataaaas/fast-ulid/commit/0c5a1dfc1e2431659a275e0a57ce3cd38071a39e#diff-5b6647180f6bfdbf419824b0ba0fa534b0551c27e73f1ffac95eb3363d49f380)(2倍程度)

しかし、この受け取り方を用いることによって、かなりコードを書き換える必要が出てきます。
具体的にいうと、`METH_VARARGS`を用いる際は引数に`引数のTupleを表すPyObject`が与えられますが、`METH_FASTCALL`では`引数のPyObjectの配列`が与えられます。
ですので、引数をパースする便利関数の`PyArg_ParseTuple`などが使えず、そのあたりを手作業で行う必要があります。

## Python3.6以下でUTC Timezone
Python3.7からは`PyDateTime_TimeZone_UTC`で`UTC`を表すタイムゾーンのシングルトンを取得できるのですが、Python3.6ではそういった機能はありません。
Pythonにおける`datetime.datetime.fromtimestamp`はタイムゾーンを指定した方が断然早いので、パフォーマンスを重視する今回はつけない選択肢はありませんでした。

そこで今回は、PythonをC++から呼び出して、タイムゾーンオブジェクトを取得する方式としました(なんかもっといい方法ありそう。。。)

```c++
PyObject* timezone_utc;

void create_utc_tz() {
  PyObject* pytz = PyImport_ImportModule("datetime");
  if (!pytz) {
    return;
  }
  PyObject* pytz_tz = PyObject_GetAttrString(pytz, "timezone");  // datetime.timezone を取得
  Py_DECREF(pytz);                                               // datetime自体の参照を減らす
  if (!pytz_tz) {
    return;
  }
  PyObject* pytz_tz_utc = PyObject_GetAttrString(pytz_utc, "utc"); // datetime.timezone.utc を取得
  Py_DECREF(pytz_tz);                                              // datetime.timezoneも同様
  timezone_utc = pytz_tz_utc;
  Py_DECREF(pytz_tz_utc);
}
```

という感じになってます。
もっといい方法あるよって方がいらっしゃれば、是非コメントで教えてください。

# 完成したのでベンチマーク

完成しました。
血と汗と涙と睡眠時間と等価交換で、ライブラリ一つを錬成するのは非常に効率が悪いですね
GitHub Copilotくん、README.mdからコードを自動生成してくれ。

さて、ここでベンチマークを行ってみます。
Python実装の5倍程度で及第点、10倍で御の字ですかね。今回作成したライブラリが`fast-ulid`で、他の二つが比較対象です。[ulid](https://github.com/mdipierro/ulid)だけ群を抜いて遅かった(いいえ、他二つがPythonなのに早すぎるだけ)ので、二つのみを比較対象にしました。

それぞれ左から

- ULID文字列作成
- `datetime.datetime`オブジェクトからULID文字列作成
- タイムスタンプ(`float`)からULID文字列作成
- ULID文字列から`datetime.datetime`オブジェクト作成
- ULID文字列からタイムスタンプ(`float`)作成

となっており、1,000,000の連続試行を10回繰り返した平均時間です。

![Benchmark](https://github.com/nagataaaas/fast-ulid/raw/main/assets/bench_result.png "benchmark")

俺うれしい...😢
もっともスコアの低い"`datetime.datetime`オブジェクトからULID文字列作成" でも10倍弱、もっともスコアの良い"ULID文字列からタイムスタンプ(`float`)作成"では50倍程度の速度になっています。
総じてスコアが低めなのは`datetime.datetime`オブジェクトを用いるもので、どうしてもPythonとしてオブジェクトの操作を行う必要があるところから、オーバーヘッドとなってしまっています。

ちなみに、内部的にULIDを作成したりパースしたりする部分はC++しか絡んでないので、(当然といえば当然ですが)これの`fast_ulid`の数十倍速いです。

# 使い方
以下モロマ(モロマーケティング)です。
GitHub: [fast_ulid](https://github.com/nagataaaas/fast-ulid)

    $ pip install fast_ulid

でインストール
実行例は以下の通り

```python
import fast_ulid
import time
import datetime

# ulid.ulid()で、現在のタイムスタンプからULIDを作成
ulid = fast_ulid.ulid()

# timestamp や datetime オブジェクトを与えることも可能
# timestampのミリ秒部は小数点以下に配置しなければなりません
# JavaScriptのようなほかの言語では、整数部に来ます
ulid = fast_ulid.ulid(datetime.datetime.now())
ulid = fast_ulid.ulid(time.time())

print(ulid) # str が返されます
# 01FVY4F1TYP63XM1YVHBVVCBSB

# timestamp や datetime.datetime を ULID から取得することも可能
print(fast_ulid.decode_timestamp(ulid))
# 1644910053.214
print(fast_ulid.decode_datetime(ulid))
# 2022-02-15 07:27:33.214000+00:00
```

これですべての機能説明ですが、[`Simple is better than Complex`](https://www.python.org/dev/peps/pep-0020/) ですよね！

是非便利にお使いください！