Skip to content

Home Администрирование Справка по специальным функциям
Справка по специальным функциям

Как мы уже говорили, оболочка IPython обладает весьма широкими возможностями. Такая широта обусловлена наличием просто огромного числа встроенных специальных функций. Так что же такое специальная функция? В документации к IPython говорится:

Оболочка IPython рассматривает любую строку, начинающуюся с символа %, как вызов «специальной» функции. Эти функции позволяют управлять поведением самой оболочки IPython и добавляют ряд особенностей для работы с системой. Все имена специальных функций начинаются с символа %, при этом параметры передаются без использования круглых скобок или кавычек.

Пример: выполнение команды '%cd mydir' (без кавычек) изменит рабочий каталог на «mydir», если таковой существует.

Просмотреть и разобраться в этом многообразии дополнительных возможностей вам помогут две «специальные» функции. Первая специальная справочная функция, которую мы рассмотрим, - это функция Ismagic. Функция Ismagic выводит список всех «специальных» функций. Ниже приводится результат работы функции Ismagic:

Как видите, существует огромное число доступных для вас специальных функций. Фактически, к моменту написания этих строк, существовало 69 специальных функций. Вы могли бы счесть более удобным получить список специальных функций следующим способом:

Ввод последовательности %-ТАВ в результате дает отформатированный список 69 специальных функций. Одним словом, функция Ismagic и комбинация %-ТАВ позволят вам быстро получить список всех имеющихся специальных функций, когда вы ищете что-то определенное или чтобы ознакомиться с тем, что вам доступно. Но список без описания не в состоянии помочь вам понять, для чего предназначена каждая функция.

Здесь к вам на помощь придет другая специальная справочная функция. Эта функция называется magic. Функция magic позволяет получить справочное описание всех специальных функций, встроенных в оболочку IPython. В справочную информацию включаются имя функции, порядок ее использования (область применения) и описание принципа действия функции. Ниже приводится описание функции page:

В зависимости от используемой программы постраничного просмотра вы можете выполнять поиск и прокручивать результаты работы функции magic. Это может пригодиться, если вы знаете, что искать, чтобы перейти сразу к нужной странице вместо того, чтобы прокручивать описание к нужному месту. Описания функций упорядочены по алфавиту, что поможет вам быстро отыскать нужную функцию.

Можно также использовать и другой метод получения справочной информации, с которым мы познакомимся ниже В этом разделе. Если ввести имя специальной функции и знак вопроса после нее (?), вы получите практически ту же самую информацию, что и с помощью функции %magic. Ниже приводится результат выполнения команды %раgе?:

И, наконец, еще одна справочная функция IPython, которая выводит сводный отчет об использовании различных возможностей, а также информацию о самих специальных функциях. Если в строке приглашения IPython ввести команду %quickref, вы получите справочник, который начинается со следующих строк:

и заканчивается следующими строками:

В самом начале вывода, получаемого от функции %guickref, приводится справочная информация о различных функциональных возможностях оболочки IPython. Остальная часть справочника %quickref представляет собой краткое описание всех специальных функций. Это краткое описание включает в себя первую строку из полной справки по каждой специальной функции. Например, ниже приводится полное описание функции %who:

Справочная информация о функции %who, присутствующая в выводе функции %quickref, полностью идентична первой строке в разделе Doc-string в блоке информации, которая возвращается командой %who ?.

Комментарии (0)

RSS feed Comments

Написать комментарий

smaller | bigger

busy
 

Регистрация




Top