海外PyCon発表修行レポート2015

第3回 EuroPython 2015参加レポートと,Sphinxに関する発表(前編)

この記事を読むのに必要な時間:およそ 5 分

そのほかの発表

筆者は,他にも多くのセッションに参加しました。全ては紹介できませんので,ここではいくつかの概要を紹介したいと思います。

Writing quality code

Writing quality code

発表は,コードの品質には外側の品質と内側の品質があり,内側の品質をどうやって測って,基準をもって維持,改善していくかという内容でした。読みやすさ,メンテナンスのしやすさ,といった品質の種類を紹介し,そういった品質がいかに開発にとって重要なのか,図とグラフを用いてとてもわかりやすく紹介していました。

発表の後半では,いくつかの指標と測定ツール,サポートツールなどが紹介されていました。測定ができて,指標があれば,コードの維持はずっとやりやすくなります。筆者もそれらをさっそく試してみているところです。

紹介されたツール:

How you can benefit from type hints

How you can benefit from type hints

発表者は,PyCharmの開発者で,Type Hints (PEP 484)の策定にも貢献している方です。発表では,⁠よくあるドキュメントは言葉が多すぎるし,各引数の型や値の意味をそれぞれ文章で説明していて,とてもわかりにくい。」と,型を文章で説明するしかない現状の問題点について紹介していました。Type Hintsがあれば自動生成ドキュメントに読みやすい明確な型情報を含められ,またPyCharmの型チェック機能の精度もあがります。

発表の後半では,APIへの型情報の設定方法や,外部ライブラリ等の編集できないコードにType Hints情報を付け加えるにはどうすればいいのか,といった実践的な課題の解決方法を紹介していました。

RinohType, a document processor inspired by LaTeX

RinohType, a document processor inspired by LaTeX

RinohTypeは,外部ライブラリへの依存を最小にした,reStructuredTextからPDFへの変換ツールです。依存ライブラリはdocutilsのみで,それ以外はTeXLiveなどにも依存していません。単体で動作するだけでなく,Sphinxのビルダー拡張としても動作するため,SphinxドキュメントをRinohTypeを使ってPDF出力できます。

この発表にはとても興奮しました。SphinxのPDF出力はLaTeXを経由して行うのが一般的ですが,LaTeXはとても複雑で利用する難易度が高いため,RinohTypeが今後多くのシーンで利用できるようになって欲しいと思います。発表を聞きながらさっそく試してみたところ,その時点では日本語などの非ASCII文字にはまだ対応していませんでした。今後,どのように開発が進んでいくのか,とても楽しみです。

次回

次回は,EuroPythonの発表者支援プログラム,筆者の発表(Sphinxのautodocに関するもの⁠⁠,パーティー,そしてSprintの様子について紹介します。

著者プロフィール

清水川貴之(しみずかわたかゆき)

ドキュメンテーションツールSphinxのメンテナ。2003年にZope2と出会い,それがオープンソース等のコミュニティー活動を始めるきっかけとなった。

Sphinx-users.jp運営。一般社団法人PyConJP理事。株式会社ビープラウド所属。

著書/訳書:「Pythonプロフェッショナルプログラミング第2版」「Sphinxをはじめよう」「Pythonプロフェッショナルプログラミング」「エキスパートPythonプログラミング」。

運営・参加イベント:Python mini Hack-a-thon主催,Sphinx+翻訳Hack-a-thon主催,PyCon JP 2011-2014運営

サイト:http://清水川.jp/
Twitter:@shimizukawa