python - Pythonモジュールをインポートせずに存在するかどうかを確認する方法

Question

インポートせずに、Python モジュールが存在するかどうかを知る必要があります。

存在しない可能性のあるものをインポートする（私が欲しいものではない）：

try:
    import eggs
except ImportError:
    pass

Answer 1

Python2

インポートがpython2で何かを見つけることができるかどうかを確認するには、次を使用しますimp

import imp
try:
    imp.find_module('eggs')
    found = True
except ImportError:
    found = False

ドット付きインポートを見つけるには、さらに行う必要があります。

import imp
try:
    spam_info = imp.find_module('spam')
    spam = imp.load_module('spam', *spam_info)
    imp.find_module('eggs', spam.__path__) # __path__ is already a list
    found = True
except ImportError:
    found = False

使用することもできますpkgutil.find_loader(多かれ少なかれ python3 の部分と同じです

import pkgutil
eggs_loader = pkgutil.find_loader('eggs')
found = eggs_loader is not None

Python3

Python3 ≤ 3.3

を使用する必要がありますimportlib。これを行う方法は次のとおりです。

import importlib
spam_loader = importlib.find_loader('spam')
found = spam_loader is not None

私の期待は、ローダーを見つけることができれば、それは存在するということです。受け入れるローダーを除外するなど、もう少し賢くすることもできます。例えば：

import importlib
spam_loader = importlib.find_loader('spam')
# only accept it as valid if there is a source file for the module - no bytecode only.
found = issubclass(type(spam_loader), importlib.machinery.SourceFileLoader)

Python3 ≥ 3.4

Python3.4 では、importlib.find_loader python docsが推奨されなくなりましたimportlib.util.find_spec。おすすめの方法は、importlib.util.find_spec. のようなものもありimportlib.machinery.FileFinderます。これは、特定のファイルをロードしたい場合に役立ちます。それらをどのように使用するかを理解することは、この範囲を超えています。

import importlib
spam_spec = importlib.util.find_spec("spam")
found = spam_spec is not None

これは相対インポートでも機能しますが、開始パッケージを提供する必要があるため、次のこともできます。

import importlib
spam_spec = importlib.util.find_spec("..spam", package="eggs.bar")
found = spam_spec is not None
spam_spec.name == "eggs.spam"

これを行う理由があると確信していますが、それが何であるかはわかりません。

警告

サブモジュールを見つけようとすると、親モジュールがインポートされます (上記のすべてのメソッドに対して)!

food/
  |- __init__.py
  |- eggs.py

## __init__.py
print("module food loaded")

## eggs.py
print("module eggs")

were you then to run
>>> import importlib
>>> spam_spec = importlib.find_spec("food.eggs")
module food loaded
ModuleSpec(name='food.eggs', loader=<_frozen_importlib.SourceFileLoader object at 0x10221df28>, origin='/home/user/food/eggs.py')

これを回避するためのコメント歓迎

謝辞

• importlibの@rvighne
• @lucas-guido for python3.3+ 廃止予定find_loader
• python2.7 での pkgutils.find_loader の動作については @enpenax

Answer 2

ImportError に依存しない Python 2

現在の回答が更新されるまで、これがPython 2の方法です

import pkgutil
import importlib

if pkgutil.find_loader(mod) is not None:
    return importlib.import_module(mod)
return None

なぜ別の答えを？

多くの答えは、キャッチを利用していImportErrorます。それに関する問題は、何がスローされるのかを知ることができないということImportErrorです。

既存のモジュールをインポートした場合ImportError、モジュールに . ImportErrorモジュールが存在し、モジュールがキャッチされて静かに失敗することを理解するには、かなりの量のバックトラックが必要です。

Answer 3

モジュールがコマンドラインからロードされているかどうかを確認する方法を探しているときに、この質問に出くわしました 。私の後に来て同じものを探している人たちのために私の考えを共有したいと思います:

Linux/UNIX スクリプト ファイル メソッド: ファイルを作成module_help.py:

#!/usr/bin/env python

help('modules')

次に、実行可能であることを確認します。chmod u+x module_help.py

そしてそれをpipetoで呼び出しますgrep:

./module_help.py | grep module_name

組み込みのヘルプ システムを呼び出します。(この関数はインタラクティブな使用を目的としています。) 引数が指定されていない場合、インタプリタ コンソールでインタラクティブ ヘルプ システムが開始されます。引数が文字列の場合、文字列はモジュール、関数、クラス、メソッド、キーワード、またはドキュメント トピックの名前として検索され、ヘルプ ページがコンソールに出力されます。引数が他の種類のオブジェクトの場合、オブジェクトに関するヘルプ ページが生成されます。

インタラクティブな方法: コンソール ロードでpython

>>> help('module_name')

見つかった場合は、次のように入力して読み取りq
を終了します。Python インタラクティブ セッションを終了するには、Ctrl+を押します。D

Windows スクリプト ファイル方式も Linux/UNIX と互換性があり、全体的に優れています。

#!/usr/bin/env python

import sys

help(sys.argv[1])

次のようなコマンドから呼び出します。

python module_help.py site  

出力します：

モジュール サイトのヘルプ:

NAME site - サードパーティ パッケージのモジュール検索パスを sys.path に追加します。

FILE /usr/lib/python2.7/site.py

MODULE DOCS http://docs.python.org/library/site

DESCRIPTION
...
:

q対話モードを終了するに は、 を押す必要があります。

それを使用して不明なモジュール:

python module_help.py lkajshdflkahsodf

出力します：

「lkajshdflkahsodf」の Python ドキュメントが見つかりません

そして終了します。

Answer 4

私はこのヘルパー関数を書きました:

def is_module_available(module_name):
    if sys.version_info < (3, 0):
        # python 2
        import importlib
        torch_loader = importlib.find_loader(module_name)
    elif sys.version_info <= (3, 3):
        # python 3.0 to 3.3
        import pkgutil
        torch_loader = pkgutil.find_loader(module_name)
    elif sys.version_info >= (3, 4):
        # python 3.4 and above
        import importlib
        torch_loader = importlib.util.find_spec(module_name)

    return torch_loader is not None

Answer 5

たとえば、pkgutilの関数の 1 つを使用します。

from pkgutil import iter_modules

def module_exists(module_name):
    return module_name in (name for loader, name, ispkg in iter_modules())

Answer 6

親パッケージをインポートせずに「ドット付きモジュール」がインポート可能かどうかを確実に確認する方法はありません。とは言っても、「Pythonモジュールが存在するかどうかを確認する方法」の問題には、多くの解決策があります。

以下の解決策は、インポートされたモジュールが存在する場合でも ImportError を発生させる可能性がある問題に対処します。その状況と、モジュールが存在しない状況を区別したいと思います。

パイソン 2 :

import importlib
import pkgutil
import sys

def find_module(full_module_name):
    """
    Returns module object if module `full_module_name` can be imported. 

    Returns None if module does not exist. 

    Exception is raised if (existing) module raises exception during its import.
    """
    module = sys.modules.get(full_module_name)
    if module is None:
        module_path_tail = full_module_name.split('.')
        module_path_head = []
        loader = True
        while module_path_tail and loader:
            module_path_head.append(module_path_tail.pop(0))
            module_name = ".".join(module_path_head)
            loader = bool(pkgutil.find_loader(module_name))
            if not loader:
                # Double check if module realy does not exist
                # (case: full_module_name == 'paste.deploy')
                try:
                    importlib.import_module(module_name)
                except ImportError:
                    pass
                else:
                    loader = True
        if loader:
            module = importlib.import_module(full_module_name)
    return module

パイソン 3 :

import importlib

def find_module(full_module_name):
    """
    Returns module object if module `full_module_name` can be imported. 

    Returns None if module does not exist. 

    Exception is raised if (existing) module raises exception during its import.
    """
    try:
        return importlib.import_module(full_module_name)
    except ImportError as exc:
        if not (full_module_name + '.').startswith(exc.name + '.'):
            raise

Answer 7

django.utils.module_loading.module_has_submodule で

import sys
import os
import imp

def module_has_submodule(package, module_name):
    """
    check module in package
    django.utils.module_loading.module_has_submodule
    """
    name = ".".join([package.__name__, module_name])
    try:
        # None indicates a cached miss; see mark_miss() in Python/import.c.
        return sys.modules[name] is not None
    except KeyError:
        pass
    try:
        package_path = package.__path__   # No __path__, then not a package.
    except AttributeError:
        # Since the remainder of this function assumes that we're dealing with
        # a package (module with a __path__), so if it's not, then bail here.
        return False
    for finder in sys.meta_path:
        if finder.find_module(name, package_path):
            return True
    for entry in package_path:
        try:
            # Try the cached finder.
            finder = sys.path_importer_cache[entry]
            if finder is None:
                # Implicit import machinery should be used.
                try:
                    file_, _, _ = imp.find_module(module_name, [entry])
                    if file_:
                        file_.close()
                    return True
                except ImportError:
                    continue
            # Else see if the finder knows of a loader.
            elif finder.find_module(name):
                return True
            else:
                continue
        except KeyError:
            # No cached finder, so try and make one.
            for hook in sys.path_hooks:
                try:
                    finder = hook(entry)
                    # XXX Could cache in sys.path_importer_cache
                    if finder.find_module(name):
                        return True
                    else:
                        # Once a finder is found, stop the search.
                        break
                except ImportError:
                    # Continue the search for a finder.
                    continue
            else:
                # No finder found.
                # Try the implicit import machinery if searching a directory.
                if os.path.isdir(entry):
                    try:
                        file_, _, _ = imp.find_module(module_name, [entry])
                        if file_:
                            file_.close()
                        return True
                    except ImportError:
                        pass
                # XXX Could insert None or NullImporter
    else:
        # Exhausted the search, so the module cannot be found.
        return False