Навигация в документации Python. Трюки и советы.

Введение

Что такое docstring и типы документации на python?

Об атрибуте __doc__

print(dir(str))
		

print("".__doc__)
		

str(object='') -> str
str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or
errors is specified, then the object must expose a data buffer
that will be decoded using the given encoding and error handler.
Otherwise, returns the result of object.__str__() (if defined)
or repr(object).
encoding defaults to sys.getdefaultencoding().
errors defaults to 'strict'.
		

Типы документации для языка python

• Встроенная в интерпритатор python, команда help.
• Сгенерированная pydoc (как в терминале, так и для браузера)
• Сгенерированная другими инструментами.

Встроенная команда help

Документация сгенерированная pydoc

pydoc -b
		

pydoc str
		

str(object='') -> str
str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or
errors is specified, then the object must expose a data buffer
that will be decoded using the given encoding and error handler.
Otherwise, returns the result of object.__str__() (if defined)
or repr(object).
encoding defaults to sys.getdefaultencoding().
errors defaults to 'strict'.
		

Документация сгенерированная другими генераторами

pdoc3

Sphinx

MkDoc

Полезные фишки при работе со встроенной документацией

Получение списка доступных модулей

[Раскрыть]

help('modules')
			

Получение списка ключевых слов

[Раскрыть]

from keyword import kwlist
print(*kwlist, sep='\n')
			

Получение списка build-in ф-ий

[Раскрыть]

import buildins
print(*buildins.__dict__.keys(), sep='\n')
			

Получение аттрибутов и методов класса объекта класса или самого класса

[Раскрыть]

dir(int)
			

Как ориентироваться и пользоваться документацией по python

Google лучший друг

site:https://example.com intext:"text" keyword1 keyword2

site:https://docs.aiogram.dev/en/latest/ intext:"keyboard" build inline
		

site:https://example.com intext:"text" OR intitle:"alt_text"

site:https://docs.djangoproject.com/en/5.0/intext:"pants"
		

site:https://docs.djangoproject.com/en/5.0/ intext:"pants" OR intitle:"Template"
		

site:https://example.com intext:"text" AND intitle:"alt_text"

site:https://docs.djangoproject.com/en/5.0/ intext:"pants" AND intitle:"Template"
		

Другие поисковые операторы. Полный список.

• “search term” Для точного совпадения с поисковой фразой.
• OR Вернёт результаты либо для одного, либо для двух поисковых фраз.
• AND Вернёт результаты только для двух поисковых фраз.
• - Удалит поисковую фразу из поиска
• * Подстановочный знак. Будет соответствовать любому слову или фразе.
• ( ) Группирует несколько поисковых фраз или операторов для контроля, того как поиска отображает результаты.
• $ Поиск цен.
• define: Отображает значение слова.
• Cache: Возвращает самую последнюю версию веб-страницы.
• filetype: Показывает только страницы определённого типа (PDF, DOCX, TXT, PPT, ...)
• site: Ограничивает поиск одним сайтом.
• related: Находит похожие сайты.
• intitle: Находит страницы с определёнными словами в заголовке.
• allintitle: Находит страницы в которых присутствуют все слова в заголовке.
• inurl: Находит страницы в URL которых входит та или иная фраза/слово.
• allinurl: Находит страницы в URL которых входит полностью, та или иная фраза/слово.
• intext: Находит страницы в теле тексте которых, присутствуют определённые слова.
• allintext: Находит страницы в теле тексте которых, присутствуют все определённые слова.
• AROUND(X) Возвращает только те страницы количество вхождений слов/фраз которых ровно X.
• weather: Ищет погоду в определённой локации.
• stocks: Возвращает информацию об запасах.
• map: Просмотр результатов на карте для поиска местоположения.
• movie: Поиск кино.
• in Конвертирует одну величину в другую. Валюта, единицы измерения
• source: Поиск по Google News.

Автодополнение кода, подсказки в редакторе

Поиск в документации на сайтах

• Ищите содержание. Оно поможет вам узнать структуру проекта, его масштаб.
• Если вы нашли для себя нужную страницу, пользуйтесь поиском по странице CTRL+F. Так быстрее и проще найти нужную информацию.
• В футере всегда есть что-нибудь интересное.
• Сделайте шаг выше. Возможно рядом с документацией (или в ней), вы сможете найти небольшие гайды и туториалы. Они помогут начать.

Заключение

Внешние ссылки