Как перемещаться по документации API библиотеки Python

Question

Мне интересно, как правильно следовать документации Python API библиотеки.

Допустим, я хочу использовать matplotlib.axes.Axes.imshow. Я go здесь:

https://matplotlib.org/api/_as_gen/matplotlib.axes.Axes.imshow.html

и вижу, что imshow возвращает объект AxesImage. Итак, я go здесь:

https://matplotlib.org/api/image_api.html#matplotlib .image.AxesImage

и смотрю на все методы объекта AxesImage. На этой странице нигде не задокументированы get_array и get_alpha, но они являются методами объекта. В этом примере документация неполная? Я что-то упускаю?

Answer 1

Если вы не можете найти метод, указанный в документации класса, скорее всего, этот метод унаследован от какого-то родительского класса, как здесь.

К сожалению, это может сбить с толку, если вы при просмотре документации не знакомы с шаблоном построения классов на классах на классах.

Глядя на документацию для AxesImage, мы видим, что AxesImage является подклассом класса _ImageBase , который является подклассом matplotlib.artist.Artist и matplotlib.cm.ScalarMappable.

Еще немного покопавшись в документации , я понял, что matplotlib.cm.ScalarMappable является источником get_array и get_alpha методы.

https://matplotlib.org/3.1.1/api/cm_api.html#matplotlib .cm.ScalarMappable.get_alpha https://matplotlib.org/3.1.1/api/cm_api.html#matplotlib .cm.ScalarMappable.get_array