Книга: Написание скриптов для Blender 2.49

Изучение встроенных модулей, функция help()

Изучение встроенных модулей, функция help()

Интерактивная консоль Питона является также хорошей платформой для изучения встроенных модулей. Поскольку Питон поставляется оснащенным двумя очень полезными функциями, help() и dir(), у вас есть мгновенный доступ к большому количеству информации, содержащейся в модулях Блендера (и Питона), как к большой документации, предусмотренной в виде части кода.

Для людей, не знакомых с этими функциями, вот два коротких примера, оба работают из интерактивной консоли Питона. Для того, чтобы получить информацию о специфическом объекте или функции, наберите:

help(Blender.Lamp.Get)

Информация будет выведена в этой же консоли:

Help on built-in function Get in module Blender.Lamp:
Lamp.Get (name = None):
        Return the Lamp Data with the given name,
        None if not found, or Return a list with all
         Lamp Data objects in the current scene,
         if no argument was given.

Перевод:

Помощь по встроенной функции Get в модуле Blender.Lamp:
Lamp.Get (name = None):
Возвращает Данные лампы Lamp с именем name, None
если не она обнаружена, или возвращает список со
всеми объектами данных ламп в текущей сцене, если
вызвана без аргумента.

Функция help() показывает связанную строку документирования функций, классов, или модулей. В предыдущем примере показана информация, предоставленная вместе с методом или функцией Get() класса Lamp. Строка документирования является первой строкой  в определении функции, класса, или модуля. Когда вы определяете ваши собственные функции, было бы хорошо, если бы вы делали также. Это может выглядеть примерно так:

def square(x):
   """
   calculate the square of x.
   (вычисление квадрата x.)
   """
   return x*x

Мы можем теперь применить функцию помощи к нашей вновь определённой функции подобно тому, как мы делали прежде:

help(square)

На выходе появится:

Help on function square in module __main__:
square(x)
    calculate the square of x.

В программах, которые мы разработаем, мы будем использовать этот метод документирования, где это уместно.

Оглавление книги