Функция dir() и области видимости в Python

Обновлено:

1. Функция dir()

Функция dir() позволяет посмотреть, какие имена существуют в текущей области видимости.

Вызовем её в IDLE без аргументов:

dir()

Функция вернёт список строк:

[
    '__annotations__',
    '__builtins__',
    '__doc__',
    '__loader__',
    '__name__',
    '__package__',
    '__spec__'
]

Состав списка может немного отличаться в разных версиях Python и разных программах.

Важно: dir() возвращает именно имена, а не значения объектов.


2. Служебные имена

В начале работы мы видим имена, которые начинаются и заканчиваются двумя нижними подчёркиваниями:

__name__
__builtins__
__doc__

Это служебные имена, которые Python создаёт самостоятельно.

Сейчас подробно разбирать их не нужно. Они понадобятся позже при более глубоком изучении Python.


3. Служебное имя __name__

В IDLE можно обратиться к имени:

__name__

Обычно результат будет таким:

'__main__'

__name__ — это специальное служебное имя.

Позже мы подробнее разберём, зачем оно нужно и почему в нём находится строка '__main__'.


4. Служебное имя __builtins__

Обратимся к имени:

__builtins__

В IDLE мы увидим техническое отображение встроенного модуля Python:

<module 'builtins' (built-in)>

Именно со встроенной областью видимости связаны классы и функции, которыми мы пользуемся без импорта.

Сейчас напрямую работать с __builtins__ не нужно.


5. Как временно скрыть служебные имена

В чистой сессии IDLE первые элементы списка dir() обычно являются служебными именами.

Чтобы временно не показывать их, на уроке используем готовую запись:

dir()[7:]

Результат в начале работы:

[]

Пустой список означает, что мы пока не создали собственных имён в глобальной области видимости.

Запись:

[7:]

является срезом списка.

Срезы мы пока подробно не изучаем. На этом уроке используем эту запись только как готовый способ скрыть первые служебные имена в чистой сессии IDLE.


6. Создание имён в глобальной области видимости

Создадим несколько переменных:

first_name = 'Anna'
age = 25
price = 99.5

Снова вызовем:

dir()[7:]

Результат:

['age', 'first_name', 'price']

Функция dir() показывает имена, которые появились в глобальной области видимости.

Обратите внимание: функция показывает имена переменных:

age
first_name
price

Но она не показывает их значения:

25
'Anna'
99.5

7. Имена выводятся по алфавиту

Переменные были созданы в таком порядке:

first_name = 'Anna'
age = 25
price = 99.5

Но dir() вернула:

['age', 'first_name', 'price']

Имена в результате dir() обычно располагаются в алфавитном порядке.

Это не означает, что переменные создавались именно в таком порядке.


8. Удаление переменных

Удалим две переменные:

del first_name, age

Снова вызовем:

dir()[7:]

Результат:

['price']

Имена:

first_name
age

были удалены из глобальной области видимости.

Поэтому функция dir() их больше не показывает.

Переменная price не была удалена, поэтому её имя осталось в списке.


9. Глобальная область видимости

Глобальная область видимости — это область, в которой находятся имена, созданные на основном уровне файла.

На данном этапе это код, который мы пишем от левой границы файла:

PI = 3.14

first_name = 'Anna'
age = 25

numbers = [10, 20, 30]

print(first_name)

Имена:

PI
first_name
age
numbers

находятся в глобальной области видимости.

Когда мы вызываем dir() на основном уровне файла или в IDLE, функция показывает имена текущей глобальной области видимости.


10. Что такое область видимости

Область видимости определяет, в какой части программы доступно определённое имя.

Например, если в глобальной области создана переменная:

message = 'Hello'

мы можем обратиться к ней ниже:

print(message)

Результат:

Hello

Если удалить переменную:

del message

имя перестанет существовать в этой области видимости.

Обращение к нему приведёт к ошибке:

print(message)

Ошибка:

NameError

11. Встроенная область видимости

Помимо глобальной области видимости, в Python существует встроенная область видимости.

В ней находятся классы и функции, которые Python предоставляет заранее.

Например, изученные классы:

int
float
str
list
tuple

Изученные функции:

print
len
abs
sum
max
min
round
dir

Нам не нужно самостоятельно создавать или импортировать эти имена.

Мы можем сразу использовать их:

number = int('25')
text_length = len('Python')
total = sum([10, 20, 30])
maximum = max([10, 20, 30])
rounded_number = round(3.14)

Это возможно благодаря встроенной области видимости.


12. Глобальная и встроенная области видимости

Создадим переменную:

number = 25

Имя:

number

мы создали самостоятельно. Оно находится в глобальной области видимости.

Но имя:

print

мы не создавали.

Оно уже находится во встроенной области видимости Python.

Поэтому работает такой код:

print(number)

Python находит:

  • number в глобальной области видимости;
  • print во встроенной области видимости.

13. Почему нельзя использовать имена встроенных функций

Неправильно:

print = 'Hello'

Мы создали в глобальной области видимости имя print.

Теперь при обращении к имени print Python сначала найдёт нашу строку, а не встроенную функцию.

Поэтому вызов:

print('Python')

приведёт к ошибке.

То же самое произойдёт с len:

len = 10

После этого:

len('Hello')

приведёт к ошибке.

Наша глобальная переменная перекрыла имя из встроенной области видимости.

Функция dir() помогает увидеть, что имена print или len появились в глобальной области.


14. Не все функции находятся во встроенной области

Во встроенной области находится большое количество полезных функций и классов, но не всё, что существует в Python.

Дополнительные возможности находятся в модулях.

Например, существует модуль:

math

В нём находится функция:

prod

Она перемножает числа внутри итерируемого объекта.

Чтобы получить доступ к этой функции, можно выполнить импорт:

from math import prod

После этого функция становится доступна в нашем файле:

numbers = [2, 3, 4]

result = prod(numbers)

print(result)

Результат:

24

Функция выполнила умножение:

2 * 3 * 4

На этом уроке импорты подробно не изучаем.

Этот пример нужен только для понимания того, что дополнительные функции и классы могут находиться в отдельных модулях.


15. Как импорт влияет на глобальную область

До импорта имени prod в глобальной области нет.

После выполнения:

from math import prod

имя:

prod

появляется в глобальной области видимости текущего файла.

Теперь его можно увидеть с помощью dir().

Например, после импорта и создания переменной:

from math import prod

numbers = [2, 3, 4]

функция dir() будет показывать среди других имён:

numbers
prod

Таким образом, dir() помогает увидеть, какие имена появились после импорта.


16. Что будет с локальными переменными

В будущем мы будем создавать собственные функции.

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

Они не становятся обычными переменными глобальной области.

Подробно локальную область видимости и создание функций мы изучим позже.

Сейчас важно понимать:

  • переменные могут находиться в разных областях видимости;
  • не каждое имя доступно во всей программе;
  • dir() помогает посмотреть имена текущей области.

17. Зачем нужна функция dir()

Функция dir() обычно не является частью основной логики готовой программы.

Например, при разработке сайта, бота или приложения вызов dir() чаще всего не останется в финальной версии проекта.

Но функция очень полезна во время обучения и исследования Python.

Она помогает увидеть:

  • какие имена уже существуют;
  • какие переменные мы создали;
  • какие имена были удалены;
  • какие имена появились после импорта;
  • в какой области видимости находится определённое имя;
  • не перекрыли ли мы случайно встроенную функцию своей переменной.

18. Проверка созданных переменных

Создадим переменные:

first_number = 10
second_number = 20
result = first_number + second_number

С помощью dir() можно проверить, что все три имени появились:

dir()

Среди результатов будут:

'first_number'
'result'
'second_number'

Это помогает увидеть текущее состояние области видимости.


19. Проверка удаления переменной

Создадим переменную:

message = 'Hello'

Функция dir() покажет имя:

'message'

Удалим его:

del message

После нового вызова:

dir()

имени message в списке уже не будет.

Таким способом можно наглядно увидеть результат работы del.


20. Проверка импорта

До импорта имени prod у нас нет.

Выполним:

from math import prod

После этого вызов:

dir()

покажет имя:

'prod'

Так мы видим, что импорт добавил новое имя в текущую область видимости.


21. Поиск случайно перезаписанного имени

Предположим, мы случайно написали:

sum = 100

Теперь имя sum появилось в глобальной области видимости.

Вызов:

dir()

покажет:

'sum'

Это может помочь понять, почему встроенная функция:

sum([10, 20, 30])

перестала работать.

Мы случайно перекрыли встроенное имя своей переменной.


22. Функция-помощник

dir() можно назвать функцией-помощником.

Она не создаёт сайт, не рассчитывает прибыль и не отправляет сообщения пользователям.

Её задача — помочь программисту посмотреть внутрь текущего окружения Python и лучше понять, какие имена сейчас доступны.

Во время обучения она помогает наглядно увидеть:

Что было создано?
Что было удалено?
Что появилось после импорта?
В какой области находится имя?
Почему определённая функция перестала работать?

23. Основные правила урока

Функция без аргументов:

dir()

возвращает список имён текущей области видимости.

В IDLE и на основном уровне файла она помогает посмотреть глобальную область видимости.

Служебные имена:

__name__
__builtins__

Python создаёт самостоятельно.

В глобальной области находятся имена, созданные на основном уровне файла:

age = 25
price = 99.5

Встроенная область содержит заранее доступные классы и функции:

int
float
str
list
tuple
print
len
sum
max
min
round

Дополнительные возможности могут находиться в модулях:

from math import prod

Функция dir() особенно полезна для обучения, проверки областей видимости и поиска случайно перекрытых имён.