Python

Python - モジュールのヘルプの参照方法、インストールパスを調べる方法

Python モジュールの使い方を調べるときに、知っていると便利なことをまとめました。

ドキュメントを読む

>>> from google.cloud import vision
>>> help(vision)
Help on package google.cloud.vision in google.cloud:

NAME
    google.cloud.vision

FILE
    /Users/hoge/anaconda3/envs/py27/lib/python2.7/site-packages/google/cloud/vision/__init__.py

DESCRIPTION
    # Copyright 2017, Google LLC All rights reserved.
...

インタラクティブシェルでモジュールのオブジェクト一覧表示

http://pypi.python.org/pypi/pbp.scripts から「pbp.scripts-0.2.5.tar.gz」をダウンロードします。

$ tar zxvf pbp.scripts-0.2.5.tar.gz
$ cp -p pbp.scripts-0.2.5/pbp/scripts/pythonstartup.py ~/.pythonstartup
$ export PYTHONSTARTUP=~/.pythonstartup

[Tab]キーを押すとオブジェクト一覧が表示されます。

>>> from google.cloud import vision
>>> vision.[Tab]
vision.Client(                vision.__init__(              vision.__subclasshook__(      vision.enums
vision.ImageAnnotatorClient(  vision.__name__               vision.__version__            vision.face
vision.__all__                vision.__new__(               vision._gax                   vision.feature
vision.__class__(             vision.__package__            vision._http                  vision.geometry
vision.__delattr__(           vision.__path__               vision.absolute_import        vision.get_distribution(
vision.__dict__               vision.__reduce__(            vision.annotations            vision.image
vision.__doc__                vision.__reduce_ex__(         vision.batch                  vision.likelihood
vision.__file__               vision.__repr__(              vision.client                 vision.safe_search
vision.__format__(            vision.__setattr__(           vision.color                  vision.text
vision.__getattribute__(      vision.__sizeof__(            vision.crop_hint              vision.types
vision.__hash__(              vision.__str__(               vision.entity                 vision.web

モジュールの属性リストを取得

>>> dir(vision)
['Client', 'ImageAnnotatorClient', '__all__', '__builtins__', '__doc__', '__file__', '__name__', '__package__', '__path__', '__version__', '_gax', '_http', 'absolute_import', 'annotations', 'batch', 'client', 'color', 'crop_hint', 'entity', 'enums', 'face', 'feature', 'geometry', 'get_distribution', 'image', 'likelihood', 'safe_search', 'text', 'types', 'web']

モジュールのパス確認

>>> vision.__path__
['/Users/hoge/anaconda3/envs/py27/lib/python2.7/site-packages/google/cloud/vision']