magicalimportというライブラリを作ってました

magicalimportというライブラリを作ってました。

はじめに

これは何をするライブラリかというと物理的なファイル名を指定して、指定したファイルをpython moduleとしてimportするためのライブラリです。

用途

例えばconfigファイルの読み込みに便利かもしれません。

• flaskの設定ファイルのimportの例

使い方

例えば、以下のようなファイル構造の時に、以下のようなfoo.pyがあった時に。

.
├── a
│   └── b
│       └── c
│           └── foo.py
└── main.py

a/b/c/foo.py

name = "foo"
_age = "*secret*"

main.pyでは以下の様なコードでfoo.pyを読み込むことができます。

from magicalimport import import_from_physical_path

foo = import_from_physical_path("./a/b/c/foo.py")

ちなみに、importするmodule名を指定する事もできて、 as_ オプションを付けます。sys.modulesに登録されるのでその後は普通にimportできます。

from magicalimport import import_from_physical_path

foo = import_from_physical_path("./a/b/c/foo.py", as_="foo2")
import foo2
# fooとfoo2は同じもの

注意点

moduleの階層構造に関係なくimportしているところがあるので読み込んだ先のファイルでrelative importなどは上手くいかないです。

例えば、以下のような設定ファイルの構造でlocal.py,test.pyがbase.pyの設定を共有したいときなどに。

config
├── base.py
├── test.py
└── local.py

普通にrelative importしたくなりますがこれは動きません。

from .base import *

以下の様に書く必要があります。star importする場合にはexpose_all_membersを使うと便利です。

# 以下はだいたい `from .base import *` と同じ
import magicalimport
import os.path


here = os.path.dirname(os.path.abspath(__file__))
base = magicalimport.import_from_physical_path(os.path.join(here, "./base.py"), as_="base")
magicalimport.expose_all_members(base)

moduleの"_"で始まるものはimportされないですが。

追記

python2もサポートしました

追記

here オプションをサポートしました。以下の様に書ける様になりました。

import magicalimport


base = magicalimport.import_from_physical_path("base.py", as_="base", here=__file__)
magicalimport.expose_all_members(base)