Следующая тема:  СП1. Сборный проект

Вернуться в раздел: Сборный Проект — 1

Вернуться в оглавление: Я.Практикум

Как работать с документацией

У каждого языка программирования есть описание его синтаксиса и функций — документация. На жаргоне её называют «дока». Обычно дока есть в открытом доступе.
 
Если вы столкнулись с ошибкой в коде и не понимаете, в чём дело — смело смотрите в доку.
 
Найти документацию нужного языка программирования просто: достаточно набрать в поисковой строке «<название языка программирования> документация».
 
Если запрос «<название языка программирования> документация» в поисковой строке вас не удовлетворяет, конкретизируйте. Например, включите название функции: «Python функция len() документация». В ответ поисковик выдаёт ссылку на официальную документацию языка: https://docs.python.org/3/library/functions.html.
 
Изучим, из чего состоит документация:
 
image
Ссылки на официальную документацию:
Не всегда разобраться в документации просто. Поэтому есть сайты, где разработчики обмениваются опытом написания кода: определяют проблемы и предлагают решения. Самый популярный ресурс — Stack Overflow.
 
Stack Overflow устроен, как система «вопрос-ответы», и доступен на русском и английском языках.
 
Stack Overflow представляет собой коллекцию вопросов с подборками ответов, на разных языках.
 
Часто в ответах можно найти фрагмент рабочего кода. Как бы ни был велик соблазн немедленно скопировать и вставить его в свою работу, не делайте этого. Сперва проверьте, как именно заимствованный код решает вашу задачу. И убедитесь, что вы понимаете, как он работает. Если код останется для вас чёрным ящиком, спустя время вы не сумеете вспомнить, как он устроен.
 
Помимо Stack Overflow и подобных ему сайтов, можно обратиться к GitHub. Это хранилище кода. На GitHub разработчики со всего мира выкладывают решения своих задач, а если повезёт — подробно описывают, почему их код устроен именно так. Как и с решениями, опубликованными на Stack Overflow, с GitHub-кодом следует быть настороже и избегать бездумного копирования.
 
Знакомиться с работой других разработчиков полезно для расширения знаний и кругозора. Если документация и другие сайты не помогли найти решение, попробуйте задать вопрос коллеге.
 

Как читать ошибки

Кратко:

  • Traceback-сообщения в Python помогают определить ошибку и место ее возникновения.
  • В ошибках обычно есть стрелки, указывающие на фактическое место ошибки.
  • Python подсказывает тип ошибки, например, IndexError или SyntaxError.
  • Для более подробного анализа ошибок можно обратиться к официальной документации.
  • Наиболее частые типы ошибок: SyntaxError, IndentationError, NameError и IndexError
Ошибки в Python называют traceback-сообщениями (англ. traceback — «трассировка»). Трассировка значит, что написанная программа проверяется на каждом шаге выполнения. Если что-то пойдёт не так, Python сообщит об ошибке.
 
Рассмотрим пример
:
 
image
Обычно в ошибках есть стрелки. Последняя стрелка указывает на фактическое место ошибки.
 
Не пугайтесь длинных трассировок! Это значит, что программа выполнила много функций, прежде чем дошла до ошибки. Смотрите на последнюю стрелку — там корень проблемы.
 
Python — змей дружелюбный, поэтому подсказывает тип ошибки. В примере это IndexError, или ошибка индекса.
 
Иногда подсказок Python недостаточно. Чтобы разобрать ошибки подробнее, обратитесь к официальной документации, раздел о значениях ошибок: https://docs.python.org/3/library/exceptions.html.
 
Узнаем, какие ещё бывают ошибки:
 
SyntaxError: invalid syntax («ошибка синтаксиса: неверный синтаксис»)
 
Эта ошибка случается, когда вы забыли поставить скобку, двоеточие или запятую. Python помогает найти проблему быстро — указывает на место ошибки и строчку, где она произошла.
 
image
IndentationError: unexpected indent («ошибка отступов: внезапный отступ»)
 
Отступы... Сколько раз с ними приходилось разбираться! В Python они важны, и никуда от этого не деться. Эта ошибка появляется при неправильном количестве отступов:
 
image
NameError: name 'c' is not defined («ошибка имени: имя 'c' не определено»)
 
Когда вы пытаетесь обратиться к необъявленной переменной, возникает ошибка NameError:
 
image
Например, при опечатках:
 
image
IndexError: list/string index out of range («ошибка индекса: индекс вне диапазона»)
 
Если вы пытаетесь получить элемент, которого нет в списке или словаре, ошибка IndexError даст о себе знать. Проверьте искомый элемент и количество элементов.
 
image
Резюме:
  • Traceback-сообщения могут выглядеть устрашающе. Однако они дают полезную информацию о том, что пошло не так. Например, показывают, где произошла ошибка и какого она типа.
  • Наиболее частые типы ошибок: SyntaxError, IndentationError, NameError и IndexError.
  • SyntaxError — ошибка с синтаксисом программы
  • IndentationError — неверное количество отступов
  • NameError — попытка обратиться к несуществующей переменной
  • IndexError — попытка доступа к несуществующему элементу в словаре или списке

 

Следующая тема:  СП1. Сборный проект

Вернуться в раздел: Сборный Проект — 1

Вернуться в оглавление: Я.Практикум