予約導線をささえるPython製バックエンドをLuigi+pandas+Scrapyで作ったハナシ

この記事は [Retty Advent Calendar 2017](https://qiita.com/advent-calendar/2017/retty) 24日目です.
昨日は@udoooom さんの 「[カワイイはつくれる](https://qiita.com/udoooom/items/4e487e81c135b8fbe6f4)」 でした.

Rettyのサーバサイドエンジニア兼魚料理担当のnakagawa([@shinyorke](https://twitter.com/shinyorke))ともうします.

好きな魚料理は「青魚の南蛮漬け」[^fish],趣味は野球のデータ分析です.[^yakiu]

気がつけば[Retty Advent Calendar 2017](https://qiita.com/advent-calendar/2017/retty)三回目の登場です,今日もPythonのハナシで吟じます,よろしくお願いします:bow: 

# テーマ「Pythonでのバックエンド開発」

一言で言うと, **Pythonでバックエンド（バッチ処理）をオールインワンで作った時のノウハウ**となります.

* 他社様のサービスとデータ連携する基盤をPython + Docker + AWS ECSで作った＆運用している（今年から）
* Pythonライブラリ（Jupyter notebook, requests, pandas）を駆使してプロトタイピング
* バックエンドのタスク管理（Pipeline）をLuigiで作成
* 大きめ（数GB）のファイル（csv）をpandasで処理
* API呼び出しはScrapy

OSSライブラリ・フレームワークの組み合わせの一例として参考になれば幸いです.

# あらすじ〜Rettyにおける予約導線について

RettyのWebサイトやアプリのお店詳細画面・まとめページには,提携させて頂いている他社サービスの情報を元に,

* 予約ボタン
* クーポン
* 予約に関する情報（コースや空席など）

を表示しています.

これらの予約に関する導線（予約導線）はユーザーさんにとって素敵な食の体験ができるよう,いち早く新しい情報を届ける（かつ,予約出来ない・行きたいお店が満席だった等の「負」を無くす）役割を果たしています.

これらの情報は提携サービスからの配信情報があるので,

* 提携しているサービスの情報を取得
* 更新した情報をRettyのレストラン情報などとマッピング

といったオペレーションを1日複数回行うためのバックエンドを作ろう！という企画が上がり,今シーズン中に構築・運用をはじめようという事になりました.

開発は10月スタートで,年内（2017）稼働が目標でした.

# 最初にやったこと「プロトタイピングと開発スコープの明確化」

提携先サービスを使った予約導線構築・改善プロジェクトが始動してからやったのは,

* プロトタイピング
* 開発スコープの明確化

でした.

## Jupyter + requests + pandasでプロトタイピング

プロトタイピングは,

* Jupyter notebookでお試しコード記述&動作確認
* requestsでREST APIを呼び出し,挙動やデータ型の確認
* Retty本体とのマージを想定したデータセット（おためし版）をpandasで作る

といった手法を取りました.

具体的なノウハウ・例は以下のエントリーにまとめているのでご興味ある方はぜひご覧ください.

[Webなエンジニアのための「Pythonデータラングリング」入門](https://qiita.com/shinichi-nakagawa-r/items/324646f9d0e716f5449e)

※[Retty Advent Calendar 2017](https://qiita.com/advent-calendar/2017/retty)4日目のネタです

## 開発スコープの明確化は「Design Doc」

プランナーや他のエンジニアと,都度確認するようなこと（仕様調整やスケジュール管理）はSlackやGithub ISSUEで行いましたが,これらの「フロー型情報」では,

* なぜこのプロジェクトをやるのか
* 全体的な目標やKGI/KPI
* インフラや使用するアーキテクチャのコア情報

といった,流れちゃいけない＆コロコロ変わっては困るような「ストック型情報」が残らない・流れるといった不幸が起きてしまうので,Design DocをQiita Teamに記述＆共有,こちらをベースに合意形成をとりました.

特にインフラやアーキテクチャは作り始めてからちゃぶ台が返ると悲惨なことになるので,絵図（と言ってもホワイトボードの写真ですが）を交えてしっかり作って合意をいただきました.

また,バックエンド開発が私一人で,進捗がブラックボックスになる懸念もあったので,

* 朝会で具体的なTask・ゴールを宣言
* 動いているモノを見せる.具体的にはLuigiの画面スクショ（Pipelineの進行状況がわかるエビデンス）をSlackで共有したり,処理状況をSlack botで流したりetc...

他チーム連携および,「ちゃんと進んでるね」「もうすぐできそう」的な安心感（＆ヤバイ時のアラートを即上げる）を担保するよう,心がけたつもりです.

# 全体像

作ったものの全体像です.

インフラとPipelineをベースに解説します.

## インフラ（含む提携サービス）

複数の提携サービスに対して,一つのバッチアプリケーション(Docker上で運用,ECSを利用)で捌く構成にしました.

### 図

![luigi-scrapy-batch.png](https://qiita-image-store.s3.amazonaws.com/0/159145/39b42fa9-4350-a6e5-f39e-49064aa4abd7.png)

### 構成と提携サービスの情報（ざっくり）

構成はざっくりこんな感じです

* インフラはAWS ECS
* Dockerでアプリケーションを構築,ベースのイメージはPython 3.6の公式イメージ
* ライブラリ管理はpip, pip-toolsでベースのライブラリとバージョン管理[^pip]
* バッチアプリからDB（RDS)を操作する際は,SQLAlchemy（SQL操作ライブラリ）[^SQLAlchemy], pymysql（MySQLコネクタ）を活用[^pymysql]
* バッチはLuigi, API呼び出しはScrapy, データの処理でpandas（後述）

なお,提携サービスは

* APIはすべてREST,戻り値はJSON
* 一部データがアーカイブ（zip）で配布, **２つの大きいcsvファイル（数GB）で構成**

このcsvファイルが結構強敵でした.

## Pipeline

いきなりLuigiの話をする前に,実際出来上がったモノのPipelineを見てもらったほう早いかも,ということで披露します.

このエントリーでのPipelineは,

* データ取得→前処理・加工→保存→後処理
* それぞれのTaskをパイプで繋ぐもの

ぐらいで見てもらえると見やすいかもです.

なお,サービス名ややってることが見えそうな所はモザイクにしてます:bow: 

### 全体

最大で8つのworkerが同時に起動して並列処理をしています.

![01_luigi_scrapy_batch.png](https://qiita-image-store.s3.amazonaws.com/0/159145/5e1d78dc-c50b-c1ae-52d6-81da644f6c83.png)

### 役割分担

複数の提携サービスのAPI・データを同時に処理した後,最後にMapping（後処理）を実施して終わらせています.

![02_luigi_scrapy_batch.png](https://qiita-image-store.s3.amazonaws.com/0/159145/51c83e9d-bc60-30de-4cd5-0ecd76064a41.png)

# Python製バックエンドの勘どころ

お待たせしました,ここでようやっとPythonの登場です

## Luigiによるバッチ構築

### Luigi #とは

[Luigi](https://github.com/spotify/luigi)はひと言で言うと,

**データフローを制御するためのFramework**

で,[Spotify](https://github.com/spotify)が開発, OSS化しています.

ちなみに名前の由来は,[世界一有名な赤帽子の配管工](https://ja.wikipedia.org/wiki/%E3%83%9E%E3%83%AA%E3%82%AA_(%E3%82%B2%E3%83%BC%E3%83%A0%E3%82%AD%E3%83%A3%E3%83%A9%E3%82%AF%E3%82%BF%E3%83%BC))さん...の[双子の弟](https://ja.wikipedia.org/wiki/%E3%83%AB%E3%82%A4%E3%83%BC%E3%82%B8_(%E3%82%B2%E3%83%BC%E3%83%A0%E3%82%AD%E3%83%A3%E3%83%A9%E3%82%AF%E3%82%BF%E3%83%BC))と,[PyPI](https://pypi.python.org/pypi/luigi/1.0.1)のドキュメントにもそっと記述されています.[^mario]

最近は機械学習プロジェクトにおけるデータパイプライン（前処理→学習→モデル作成→デプロイ,的な）で使われる機会が多いですが,Airflow[^Airflow]やRundeck同様,サービスのバックエンドとしても有効です.

### 特徴

* Pipelineの構築・保守はすべてPythonのコードで行う
* 処理単位（Task）はPythonで記述
* かなり軽量で,覚えたら気楽にサクッと作れる
* 処理状況を監視するUI（割とかっこいい）が最初から用意されている ※Pipelineのスクショがそれ

### 実際の運用は

* supervisordでluigi daemonを立ち上げて運用
* 決まった時間にluigiコマンドでPipeline処理実行,なお処理のトリガーはcrontab[^crontab]
* 各処理をTaskからkickする仕様にしている,Scrapyもデータ処理も

なお,Rettyではデータ集計の基盤などで以前からLuigiが使われており,他のメンバーに引き継いだりContributeを促す際もやりやすい,という利点もありました.[^contribute]

### 使い方（雰囲気サンプル）

公式サイトに,[SpotifyのTopアーティストをとるサンプル](http://luigi.readthedocs.io/en/stable/example_top_artists.html#)などもありますが,めっちゃ単純なサンプルだとこんな感じです.

個人的には,ベースとなる処理を書いて継承した方が楽だったのでそんな書き方してます.

```py3:tasks/tasks.luigi_sample.py
import os
import logging
from datetime import datetime as dt

import luigi
from luigi import Task


class LuigiSampleBaseTask(Task):
    """
    親クラス(あってもなくてもいい)
    """

    # 共通して使うパラメータを指定(今回は日付と出力先)
    date = luigi.DateParameter()
    output_dir = luigi.Parameter()

    # 中で使うformat
    OUTPUT_PATH_FROMAT = '{dir}/{filename}.txt'
    TIMESTAMP_FORMAT = '%Y/%m/%d %H:%M:%S'

    def process_start(self):
        timestamp = dt.now().strftime(self.TIMESTAMP_FORMAT)
        logging.info('Process Start:{}'.format(timestamp))

    def process_done(self):
        timestamp = dt.now().strftime(self.TIMESTAMP_FORMAT)
        if not os.path.exists(self.output_dir):
            os.makedirs(self.output_dir)

        with open(self.OUTPUT_PATH_FROMAT.format(dir=self.output_dir, filename=self.__class__.__name__), 'w') as f:
            f.write(timestamp)

    def output(self):
        # 処理が終わったらクラス名を使ってファイルを作る(ファイルの有無でタスク実行判断)
        return luigi.LocalTarget(
            self.OUTPUT_PATH_FROMAT.format(dir=self.output_dir, filename=self.__class__.__name__)
        )


class Sample1stTask(LuigiSampleBaseTask):
    """
    最初のTask
    """

    def requires(self):
        # 依存関係を書く,スタートなのでナシ
        return None

    def run(self):
        self.process_start()
        # TODO 一番目の処理
        self.process_done()


class Sample2ndTask(LuigiSampleBaseTask):
    """
    2番目のTask
    """

    def requires(self):
        # 依存関係を書く,1stが終わったら処理(以下同じ
        return Sample1stTask(
            date=self.date,
            output_dir=self.output_dir,
        )

    def run(self):
        self.process_start()
        # TODO 二番目の処理
        self.process_done()


class Sample3rdTaskA(LuigiSampleBaseTask):
    """
    3番目のTask(その1)
    """

    def requires(self):
        return Sample2ndTask(
            date=self.date,
            output_dir=self.output_dir,
        )

    def run(self):
        self.process_start()
        # TODO 三番目の処理 ※Sample3rdTaskBと同時並行
        self.process_done()


class Sample3rdTaskB(LuigiSampleBaseTask):
    """
    3番目のTask(その2)
    """

    def requires(self):
        return Sample2ndTask(
            date=self.date,
            output_dir=self.output_dir,
        )

    def run(self):
        self.process_start()
        # TODO 三番目の処理 ※Sample3rdTaskAと同時並行
        self.process_done()


class SampleLastTask(LuigiSampleBaseTask):
    """
    4番目のTask(終了処理)
    """

    def requires(self):
        # 3番目のTask２つ(A, B)が終わったらやる(listで指定)
        return [
            Sample3rdTaskA(
                date=self.date,
                output_dir=self.output_dir,
            ),
            Sample3rdTaskB(
                date=self.date,
                output_dir=self.output_dir,
            ),

        ]

    def run(self):
        self.process_start()
        # TODO 三番目の処理 ※Sample3rdTaskAと同時並行
        self.process_done()


if __name__ == '__main__':
    luigi.run()

```

コマンドを叩いて実行すると,こんなワークフローになります,シンプルですね.

```bash
$ luigi --module tasks.luigi_sample SampleLastTask --workers 2 --date 2017-12-24 --output-dir /tmp
```

![luigi_sample.png](https://qiita-image-store.s3.amazonaws.com/0/159145/21b12bcd-5aee-117e-dd9e-53b938e4dfc6.png)



## pandasで大きめのテキストファイルを処理する方法（サンプル）

> 一部データがアーカイブ（zip）で配布, **２つの大きいcsvファイル（数GB）で構成**

これと戦う為,pandasを活用しました.

流石にGBを超えるとオンメモリで処理が辛いですし,一括処理するためだけにメモリのためにお高いEC2インスタンスは使いたくありません.[^csv]

pandasのコントリビューター, [@sinhrks](https://twitter.com/sinhrks)さんのブログ記事「[pandas でメモリに乗らない 大容量ファイルを上手に扱う](http://sinhrks.hatenablog.com/entry/2014/11/21/231534)」を参考に,以下の対策でメモリに依存する処理を回避しました.

* **read_csvする時に「chunksize」オプションを指定して,　DataFrameを分割読み込み**
* **queryで絞って対象データが確定した時点で,DataFrameを複製せず,「inplace=True」オプションでDataFrameを直接書き込み**

LuigiのTaskとして,

1. 数GBのcsvファイルをchunksize指定でreas_csvして,分割した単位で別のcsvに保存(オンメモリで処理して差し支えない程度の小さいファイルに分割)
1. 「1.」のタスク後,分割したcsvファイルを読み込んで処理するTaskを並列実行,処理時にqueryで絞ってinplaceでデータサイズを圧縮

この２つを数珠つなぎに実行するPiplineを作って処理をしました.

Jupyter notebookなどで普段使ってる時はオンメモリで良くても,実務仕様の時はオンメモリとストレージをバランス良く使いたいよね,ということで覚えたほうが良いtipsだと思いました.

### 使い方（雰囲気サンプル）

部分的なスニペットとなります,雰囲気が伝われば幸いです.

#### chunksizeで分割して保存

```py3:pd_sample_chunksize.py
import pandas as pd

# 大きいファイルを10万行毎にDataFrame化してcsvとして保存
no = 0
for r in pd.read_csv('/tmp/hoge/big_stanton.csv', chunksize=100000):
    # TODO 何かしらの前処理
    filename = '{no}_mini_gordon.csv'.format(no=no)
    r.to_csv(filename, index=False)  # DataFrame.indexを引き継ぐ必要ない時は,indexを含めないほうがファイルサイズ的にもお得
    no += 1
```

#### queryで絞った後,inplaceでダイエット

```py3:pd_sample_inplace.py

import pandas as pd

df = pd.read_csv('/tmp/hoge/big_stanton.csv')
# DataFrame内に日付があったと仮定して
expr = 'date >= {from_date} and date <= {to_date}'.format(from_date=20171224, to_date=20171225)

# query条件(expr)に合致したデータのみ残る,外れたデータは消える
df.query(expr, inplace=True)
```

## Scrapyによる,データ取得(API呼び出し)と保存

提携サービス（今回は２つ）毎にScrapyアプリを構築し, API呼び出しとデータ保存を行いました.

Scrapyを使ったAPI呼び出しサンプルと背景については,これも[Retty Advent Calendar 2017](https://qiita.com/advent-calendar/2017/retty)で紹介させていただいています（20日目）

[REST API提供者と自分にやさしいAPIクライアントをPythonでいい感じに作る方法](https://qiita.com/shinichi-nakagawa-r/items/b95b806797de2acb636b)

今回はLuigiのTask（Pythonクラス）から呼び出す為,scrapyコマンド...ではなく,ScrapyのPythonコードI/F,具体的には[CrawlerProcess](https://doc.scrapy.org/en/latest/topics/api.html#scrapy.crawler.CrawlerProcess)を使っています.[^scrapy]

### サンプルコード

[【Github】scrapy-connpass/blob/master/connpass/connpass/run.py](https://github.com/Shinichi-Nakagawa/scrapy-connpass/blob/master/connpass/connpass/run.py)より.

```py3:connpass/run.py
# 事実上,デバッグ用のツール

from scrapy.crawler import CrawlerProcess
from scrapy.utils.project import get_project_settings


from connpass.spiders.api import ApiSpider


def search_my_event(nickname='shinyorke', count=100):
    settings = get_project_settings()
    crawler = CrawlerProcess(settings)
    crawler.crawl(ApiSpider, nickname=nickname, count=count)
    crawler.start()


if __name__ == '__main__':
    search_my_event()
```

Pythonのクラスから書けるということは,LuigiのTaskから呼び出すのも結構楽にできます(雰囲気コードです).

```py3:luigi_task_scrapy.py

from luigi import Task

from scrapy.crawler import CrawlerProcess
from scrapy.utils.project import get_project_settings

from connpass.spiders.api import ApiSpider


class SampleScrapyTask(Task):
    """
    Luigi TaskからScrapyを呼び出すサンプル
    """

    def requires(self):
        # 依存関係を書いてね(便宜上省略)
        pass

    def run(self):
        settings = get_project_settings()
        crawler = CrawlerProcess(settings)
        crawler.crawl(ApiSpider, nickname='shinyorke', count=10)
        crawler.start()

    def output(self):
        # ファイル等のアウトプットを実装する(Luigiのお作法)
        pass
```

# 結び

結果的に,ほぼ納期通りにバッチは運用開始,要件も満たした上で日々ユーザーさんにとって良い食体験をするお手伝いを基盤レベルで出来始めたかな？と思っています.

運用当初は処理が終わりきらない・アラートが上がる...度にソルジャー的な処理をしてましたが,最近はSlack通知も落ち着き[^slack],安定運用なフェーズに入りました,良かったよかった:smiley: 

今後の展開・宿題としては,

* 現時点で構築・運用者が私一人なのでさっさと増やす・引き継ぐ（教育含めて）
* 連携サービスは今後も増えるので,スケールに備えた構成にしたい. LuigiアプリとScrapyアプリの間で機能レベルの依存はしていないが,結局呼び出したりしてる箇所での依存はあるので切り離していい感じにすることが必要[^package]
* まあまあ大きいアプリになったので,コンテナ単位で分割を考える（つまりマイクロサービス化）
* 今回はScrapyおよびLuigiのJOB Queueや非同期処理に頼ったが,マイクロサービスにする時に備えてQueueとかの運用をいい感じにする（でないとマイクロサービスにはできない）
* 他の予約導線や他社連携バッチへの横展開（アーキテクトやノウハウ他）

私はPythonistaなのですべてPythonでやりきる回答を出しましたが,他にもイケてるアプローチなどあったら是非コメントとかいただけると幸いです.

今年のアドベントカレンダーも明日がラスト.

明日はRetty CTO @taru0216 さんがラストを締めくくります.

良いメリー・クリスマス・イヴを:santa:[^xmas]

[^fish]: 魚が美味しいお店は南蛮漬け（洋食系だとエスカベッシュ）が美味い,という揺るぎない持論とこだわりがあります←
[^yakiu]: 野球の人と呼ばれています #察し
[^pip]: pip-toolsのハナシは[この辺](https://qiita.com/ryu22e/items/ad3f8f3df30886d23661)を参照,Rubyで言うところのgemとbundlerみたいな事をしています.
[^SQLAlchemy]: わかりにくい公式ドキュメント...をいい感じにした[モノタロウ増田さんのスライド](https://www.slideshare.net/YasushiMasuda/playsqlalchemy-sqlalchemy)がメチャクチャ参考になりました！
[^pymysql]: PyMySQLはPythonのみでできているMySQLコネクタで...という解説は,[別のエントリー](http://shinyorke.hatenablog.com/entry/jupyter-and-baseball)で紹介させていただいています（手前味噌）
[^mario]: 「Also it should be mentioned that Luigi is named after the pipeline-running friend of Super Mario.」, PyPIより引用.
[^Airflow]: Airflowを使うことも考えましたが,機能がリッチすぎるのと,保守できるメンバー育成に課題がありそうだったので断念しました.余談ですが,AirflowのDockerイメージを使って運用は個人的なプロダクトでやってます（[こちらのエントリー](http://shinyorke.hatenablog.com/entry/airflow-docker)を参照）.
[^crontab]: Airflowだとcrontabに限らず独力で実行可能,ここぐらいかなイケてないのは
[^contribute]: というより,そんなメンバーの皆様からLuigiを教わりました
[^csv]: TB超えのデータであれば,Spark等に逃して並列処理も検討してました...が,そこまでやるほどのサイズでもないのでpandasで頑張りました.
[^scrapy]: コードのコメントにある通り,例えばPyCharmでデバッグする際のデバッグ用コードとしてもすごく便利です.
[^slack]: 文章の都合上,本文中では触れていませんがタスク単位でSlack通知,異常時は教えてくれる仕組みにしています.
[^package]: パッケージ構成は申し訳ないですが非公開で:pray: 
[^xmas]: このエントリーが出る頃,私は歩いて山手線を一周していることでしょう（そんなイベントに参加している予定）:train: