Djangoのユーザモジュールの配置場所について

Question

いつも回答くださるエンジニア様にはお世話になっております。

Djangoで開発を行っているのですが、自作のライブラリなどはどのようなパスに置くのが良いのでしょうか。
※バッチがメインです
ドキュメントすべて洗ったわけではありませんがぱっと見、記述が見当たらなかったもので。。。

現在はアプリケーション共通のモジュール郡は

project/lib

アプリケーションごとにモジュール分けしているものについては

project/application/management/commands/lib

こんな感じで分けていています。
でもimportする際になんとなく「イケてない」感があるのです。

from lib.fugafuga import *
from application.management.commands.lib.piyopiyo import *

もしかして、

project/application/management/commands/hogehoge.py

のバッチにひとまとまりになるよう詰め込むべきでしょうか？
モノによってはクラスが煩雑し、それこそ可読性を下げそうなのですが・・・

ご意見、そもそもマニュアルにあるなど有りましたらご教授ください。

Answer 1

私の管理していたプロジェクトでDjangoを使用した時のルールは下記のようなものでした。
・複数アプリケーションで共通のモジュールはプロジェクトディレクトリ以下
・各アプリケーションでしか使用しないモジュールはアプリケーションディレクトリ以下

from application.management.commands.lib import *

としているところを見るとmanage.pyからのコマンド実行に関係するライブラリを格納していると想像しますが、このライブラリが実行コマンドからのみ参照されるのであれば問題ないと思います。

私が実装する場合は、上記のルールに従い下記のようにします。
ライブラリが参照される範囲を意識するとユニットテスト（tests.py）が書きやすいです。

# プロジェクト共通（settings.pyやurls.pyと同階層にlibディレクトリを作成する）
from project.lib import hogehoge

# アプリケーション共通（各アプリケーションのviews.pyと同階層にlibディレクトリを作成する）
from application.lib import hugahuga

Comments

[al_aya_yuka]

御返事遅くなりましたが、アドバイス有難うございます。
確かに、その方法がとてもスッキリしていると思います。
今後は参考にしてみたいと思います。

Answer 2

お邪魔します。

pythonは何を差し置いても明示的で読みやすく間違いが起こりにくいようであることを大切にする言語です。
それなので、「別にイケてなくない」と思います。
ドメインが違う共通処理が違ったパッケージ階層のモジュールに配置されているのは当然のことです。
まあやろうと思えば色々とhackはできるのですが、醜いと思います。

どちらかというと

from lib.fugafuga import *
from application.management.commands.lib.piyopiyo import *

のように書かいていらっしゃるのですが、*で何をインポートしたか明示的でないことの方が問題視されると思われます。（使われているものが、どのソースに書かれているか一目でわかる、ということの方が重要だということ）

※個人的な雑感としてはapplication.management.commands.lib.piyopiyoは少し長いな、とは思いました。
application.lib.piyopiyoとかapplication.commands.piyopiyoとかのレベルでいいような気がします。そしてモジュール名を、管理用のバッチ処理だと明示的にわかるものにするのがいいかなと。

パッケージの分け方について参考になるもの、ですが、djangoには1.4からproject templateという仕組みがあります。
いろんな人がpypiやgit hubやbitbucketに自作project templateをあげていたりするので、
上記サイトで「django project template」と検索してみると、参考になるパッケージの分け方が見られるかもしれません。

---

(追記)
hackについてですが、醜い方法をひとつ例としてあげておきます。(笑)

# モジュールの呼び出し元に対してimportと同等の処理を実行させる
# Aモジュールをインポートしたら、勝手にBモジュールもインポートされるようにする、というhack
# 質問者さんのコードに合わせて、アスタリスクでのモジュールインポートを模倣
import inspect
import lib.fugafuga as module
caller = inspect.getmodule(inspect.stack()[1][0])
for member in inspect.getmembers(module)
    if(not member[0].startswith('_')): #アンダースコアから始まっているメンバは対象外
        setattr(caller, member[0], member[1])

参考になれば幸いです。

Comments

[al_aya_yuka]

お返事遅れましてごめんなさい。
アドバイスありがとうございました。

import *
については、簡略して記載してしまった結果です。
PEP8でも推奨されない書き方だったと思いますので、
実際に運用しているコードにはそのようなものはありません。
今後新しいコードを書くときは参考にさせていただきたいと思います。

ありがとうございました。