概要
ということで、Pythonライブラリ自作してみたので、その方法について書いてみました。
……とはいっても、先駆者様が立派な記事を書いていらっしゃるので、基本的に私がつまづいた部分や、オリジナルな部分をメインに書いていこうと思います。
この記事を見れば、
- 自作ライブラリが作れる
- ディレクトリ構成の参考になる
と思うので、ぜひ見ていってください。
環境
たぶん関係ないと思いますが、念のためのっけておきます。
- Windows10
- Python3.8
私のディレクトリ構成
まずは、私のディレクトリ構成を見てもらいたいと思います。
この記事を読んでいけば、この構成の意味がなんとなく分かるようになると思います。。
.
├── .gitignore
├── MANIFEST.in
├── README.md
├── package
│ ├── __init__.py
│ └── func.py
├── notebook
│ └── test.ipynb
├── requirements.txt
└── setup.py
……とは言いましたが、実はほとんどがこちらの記事を見ればわかるような内容になっています。
あとで後悔しないPythonのディレクトリ構成をつくってみる
ということで、この記事に載っていて私が実装しなかったもの、追加したもの、補足等をしていきたいと思います。
あと、実際にこのディレクトリ構成でGithubにあげてみているので、もしよろしければこちらもご覧ください。
実装しなかったもの
コマンドラインでの実行機能
私が作りたかったものはコマンドラインでの実行が不要だったので、削りました。
削ったものは以下になります。
- cli.py
- setup.pyの以下の部分
entry_points = ...
pytest
これはいいなとも思いつつ、今は特別に必要ないかなと思い削りました。
削ったものは以下になります。
- tests/
requirementsのバージョン
これは場合によると思うのですが、バージョン関係なくだいたい動くかな？という時には、バージョン情報まで書かなくてもいいかなと思って削りました。
こうすれば、詳しくはわかりませんが、例えばちょっと古いバージョンで実装しなければいけないときに、自作のライブラリのせいで新しいバージョンにされてしまった……ということが防げるかなぁと思いました。
ですので、私のrequirements.txtは例えばこんな感じになっています。
matplotlib
numpy
scikit-image
追加したもの
Notebook
これはライブラリのためというよりは、こんな感じで実行するよーみたいなのを載せたり、テスト過程を載せたりするものです。
ライブラリには不要ですし、ファイルサイズが大きくなってしまうので、readmeに消してもよい旨なんか書いたほうが親切かもなぁなんて思っています。
また、そのため.gitignoreに以下を追加しています。
.ipynb_checkpoints/
これ必要なのかな？とも思ったのですが、何かと邪魔をすることがあるので、gitにはあげないほうが良いみたいです。
jupyterのcheckpoints関連ファイルをgit管理から外す
補足（というか私がつまづいたこと）
もちろん参考にした記事はとてもわかりやすかったのですが、私の知識不足のためいろいろ調べまわったことを書いていきます。
一人がつまずいたら１００人はつまづく法則があるので（ない）、きっと誰かの役に立つ。
フォルダ構成について
自作ライブラリ以外にも、一般的なフォルダ構成の仕方ってどうやるんだろう？という状況だったので、いろいろと参考にさせていただきました。
プロジェクト構成
プロジェクトの構造化
データ分析をするときのフォルダ構成
importってどうやるんだっけ……？
自分で作った関数とかを別ファイルから読み込むときの方法について迷ったのでまとめておきます。
pythonで自作関数をモジュール化・パッケージ化
Pythonの相対インポートで上位ディレクトリ・サブディレクトリを指定
Python, importの使い方（from, as, PEP8の推奨スタイル, 注意点など）
__init__ってなんだ！
なんとなくでしか知らなかったのでいろいろ調べてみました。
- とりあえずこれを見ればわかる->Python の __init__.py とは何なのか
- モジュール名のカットができる->Python __init__.pyの書き方
また、__all__というのが設定されると、
from package import *
みたいなことができるようになるのですが、__all__を自分で書くのはめんどくさい……というときに__init__に書くコードがありました。
- __all__について-> Pythonの特殊変数__all__について現役エンジニアが解説【初心者向け】
- つっこむ方法-> __init__.pyと同じ階層にあるpythonファイルを全部__all__に突っ込む
ただこの方法、実は環境によって動かないことがあります。
その理由は、windowsとmacでディレクトリのつなぎ方が違うせいなんです……（なぜ統一できなかったのか……）
ということで、以下を参考に書き換えたものをはっておきます。
Pythonで文字列を分割（区切り文字、改行、正規表現、文字数）
import glob
import os
py_list = glob.glob('package/*.py')
__all__ = list(map(lambda file_path: os.path.basename(file_path).split('.', 1)[0], py_list))
__all__.remove('__init__')
ちなみに、これだと全部呼び出せるようになってしまうので、呼び出せるものを選びたいときには、やっぱり手動で書いたり、呼び出したくないものをファイルにまとめておいてそれをallから削除する……というやりかたがいいのかもしれません。
その他
終わりに
ということで、先駆者様より良い記事を書ける自身がなかったので、まとめみたいな感じにさせていただきました。
もし「ここが違うよ！」というところがあったら、教えていただけたら嬉しいです。