Содержание:
Данная статья посвящена теме пространств имен в Python. Это структуры, которые используются для организации символических имен, присваиваемых объектам в программе.
В Python понятие объекта является ключевым. Они везде! Фактически все, что программа Python создает или с чем работает, — это объект.
Выражение присваивания создает символическое имя, которое вы можете использовать для ссылки на объект. Так выражение x = 'foo'
создает символическое имя x
, которое ссылается на строковый объект 'foo'
.
В более сложных программах вам предстоит создавать сотни или тысячи подобных имен, указывающих на конкретные объекты. Как же Python отслеживает все эти имена и предотвращает их путаницу?
Изучив данную статью, вы узнаете:
Пространство имен — это совокупность определенных в настоящий момент символических имен и информации об объектах, на которые они ссылаются. Вы можете рассматривать такое пространство как словарь, в котором ключи являются именами объектов, а значения — самими объектами. Каждая пара ключ-значение соотносит имя с соответствующим ему объектом.
Пространства имен — отличная штука! Будем использовать их чаще! — Тим Петерс в “Дзен Python”.
Как утверждает Тим Петерс, пространства имен — отличная штука, которую активно использует Python. Существует 4 типа пространств имен:
Они обладают разными жизненными циклами. По мере выполнения программы Python создает необходимые пространства имен и удаляет их, когда потребность в них пропадает. Как правило, в любой момент времени существует множество пространств имен.
Встроенное пространство имен содержит имена всех встроенных объектов, которые всегда доступны при работе в Python. Вы можете перечислить объекты во встроенном пространстве с помощью следующей команды:
>>> dir(__builtins__)
['ArithmeticError', 'AssertionError', 'AttributeError',
'BaseException','BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning', 'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError', 'ConnectionRefusedError', 'ConnectionResetError',
'DeprecationWarning', 'EOFError', 'Ellipsis', 'EnvironmentError',
'Exception', 'False', 'FileExistsError', 'FileNotFoundError',
'FloatingPointError', 'FutureWarning', 'GeneratorExit', 'IOError',
'ImportError', 'ImportWarning', 'IndentationError', 'IndexError',
'InterruptedError', 'IsADirectoryError', 'KeyError', 'KeyboardInterrupt',
'LookupError', 'MemoryError', 'ModuleNotFoundError', 'NameError', 'None',
'NotADirectoryError', 'NotImplemented', NotImplementedError', 'OSError',
'OverflowError', 'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError', 'RecursionError', 'ReferenceError', 'ResourceWarning',
'RuntimeError', 'RuntimeWarning', 'StopAsyncIteration', 'StopIteration',
'SyntaxError', 'SyntaxWarning', 'SystemError', 'SystemExit', 'TabError',
'TimeoutError', 'True', 'TypeError', 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError', 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning', 'ValueError',
'Warning', 'ZeroDivisionError', '_', '__build_class__', '__debug__', '__doc__', '__import__', '__loader__', '__name__', '__package__', '__spec__', 'abs', 'all', 'any', 'ascii', 'bin', 'bool', 'bytearray',
'bytes', 'callable', 'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits', 'delattr', 'dict', 'dir', 'divmod', 'enumerate',
'eval', 'exec', 'exit', 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr', 'hash', 'help', 'hex', 'id', 'input',
'int', 'isinstance', 'issubclass', 'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview', 'min', 'next', 'object', 'oct',
'open', 'ord', 'pow', 'print', 'property', 'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice', 'sorted', 'staticmethod',
'str', 'sum', 'super', 'tuple', 'type', 'vars', 'zip']
Перечень включает, например, исключение StopIteration
, такие встроенные функции, как max()
и len()
, а также типы объектов — int
и str
.
При запуске интерпретатор Python создает встроенное пространство имен. Оно сохраняется до тех пор, пока интерпретатор не завершит работу.
Глобальное пространство имен содержит имена, определенные на уровне основной программы, и создаётся сразу при запуске тела этой программы. Сохраняется же оно до момента завершения работы интерпретатора.
Строго говоря, могут существовать и другие глобальные пространства имен. Интерпретатор также создает пространство данного типа для любого модуля, загружаемого программой при помощи выражения import
.
Теперь, встречая понятие “глобальное пространство имен”, вы будете знать, что оно принадлежит основной программе.
Интерпретатор создает новое пространство имен при каждом выполнении функции. Это пространство является локальным для функции и сохраняется до момента завершения ее действия.
Функции не существуют независимо друг от друга только на уровне основной программы. Вы также можете определять одну функцию внутри другой.
1 >>> def f():
2 ... print('Start f()')
3 ...
4 ... def g():
5 ... print('Start g()')
6 ... print('End g()')
7 ... return
8 ...
9 ... g()
10 ...
11 ... print('End f()')
12 ... return
13 ...
14
15 >>> f()
16 Start f()
17 Start g()
18 End g()
19 End f()
В этом примере функция g()
определена внутри тела f()
. Вот что происходит в данном коде:
f()
, объемлющую функцию. g()
, вложенную функцию. f()
. f()
вызывает g()
. Когда основная программа вызывает f()
, Python создает для нее новое пространство имен. Аналогичным образом, когда f()
вызывает g()
, последняя получает свое собственное отдельное пространство. Пространство, созданное для g()
, является локальным, а пространство, созданное для f()
, — объемлющим.
Все эти пространства существуют до тех пор, пока выполняются соответствующие им функции. По завершении же этих функций Python может не сразу отозвать их из памяти, но при этом все ссылки на содержащиеся в них объекты сразу становятся недоступными.
Наличие нескольких отличных пространств имен означает, что в процессе выполнения программы Python несколько разных экземпляров одного имени могут существовать одновременно. Пока каждый из них находится в собственном пространстве, все они обслуживаются по отдельности, и путаницы не происходит.
Но тут возникает вопрос. Предположим, что вы ссылаетесь на имя x
в коде, а оно существует в нескольких пространствах. Как Python узнает, какое именно вы имеете в виду?
Ответ кроется в понятии области видимости имени, представляющей из себя часть программы, в которой данное имя обладает значением. Интерпретатор определяет эту область в среде выполнения, основываясь на том, где располагается определение имени и из какого места в коде на него ссылаются.
С более детальной информацией об области видимости в программировании вы можете ознакомиться на соответствующей странице Википедии.
Отвечая на заданный выше вопрос, отметим, что если ваш код ссылается на имя x
, то Python будет искать его следующих областях видимости в таком порядке:
x
внутри функции, то интерпретатор сначала ищет его в самой внутренней области, локальной для этой функции. x
не находится в локальной области, но появляется в функции, располагающейся внутри другой функции, то интерпретатор ищет его в области видимости объемлющей функции. x
где-либо еще, то он направляет поиски во встроенную область видимости. Эта последовательность составляет суть правила областей видимости LEGB, как его обычно называют в публикациях о Python (хотя, на самом деле, данный термин не встречается в его официальной документации). Интерпретатор начинает поиски имени изнутри, последовательно переходя от локальной области видимости к объемлющей, затем к глобальной и в завершении к встроенной.
Если интерпретатор не находит имя ни в одной из этих областей, то Python вызывает исключение NameError
.
Ниже представлен ряд примеров с правилом LEGB. В каждом из них самая внутренняя вложенная функция g()
пытается вывести в консоль значение переменной с именем x
. Обратите внимание, как в каждом примере происходит вывод разного значения x
в зависимости от области видимости.
Пример 1. Одно определение
В этом примере имя x
определено только в одной области. Оно находится за пределами функций f()
и g()
и поэтому относится к глобальной области видимости.
1 >>> x = 'global'
2
3 >>> def f():
4 ...
5 ... def g():
6 ... print(x)
7 ...
8 ... g()
9 ...
10
11 >>> f()
12 global
Выражение print()
в строке 6 может ссылаться только на одно возможное имя x
. Оно отображает объект x
, определенный в глобальном пространстве имен, которым является строка 'global'
.
Пример 2. Двойное определение
В следующем примере определение x
появляется в двух местах: одно — вне f()
и другое — внутри f()
, но за пределами g()
.
1 >>> x = 'global'
2
3 >>> def f():
4 ... x = 'enclosing'
5 ...
6 ... def g():
7 ... print(x)
8 ...
9 ... g()
10 ...
11
12 >>> f()
13 enclosing
Как и в предыдущем примере g()
ссылается на x
. Но на этот раз предполагается выбор из двух определений:
x
в глобальной области видимости. x
снова в объемлющей области видимости.Согласно правилу LEGB интерпретатор находит значение в объемлющей области перед тем, как искать в глобальной. Поэтому выражение print()
в строке 7 отображает 'enclosing'
вместо 'global'
.
Пример 3. Тройное определение
Теперь рассмотрим ситуацию, в которой x
определен везде и всюду. Одно определение находится вне f()
, другое — внутри f()
, но за пределами g()
, а третье — внутри g()
.
1 >>> x = 'global'
2
3 >>> def f():
4 ... x = 'enclosing'
5 ...
6 ... def g():
7 ... x = 'local'
8 ... print(x)
9 ...
10 ... g()
11 ...
12
13 >>> f()
14 local
Теперь выражение print()
в строке 8 должно выбрать из трех возможных вариантов:
x
в глобальной области видимости. x
в объемлющей области видимости.x
в третий раз в локальной области g()
. В данном случае правило LEGB утверждает, что g()
сначала видит свое собственное значение x
, определенное в локальной области видимости. Поэтому выражение print()
отображает 'local'
.
Пример 4. Отсутствие определения
В заключительном примере рассмотрим случай, в котором g()
пытается вывести значение x
, но x
нигде не определен, поэтому мы получим ошибку.
1 >>> def f():
2 ...
3 ... def g():
4 ... print(x)
5 ...
6 ... g()
7 ...
8
9 >>> f()
10 Traceback (most recent call last):
11 File "<stdin>", line 1, in <module>
12 File "<stdin>", line 6, in f
13 File "<stdin>", line 4, in g
14 NameError: name 'x' is not defined
На этот раз Python не находит x
ни в одном из пространств имен, поэтому выражение print()
в строке 4 выдает исключение NameError
.
В первом разделе мы уже рекомендовали вам рассматривать пространство имен как словарь, в котором ключи — это имена объектов, а значения — сами объекты. По сути, для глобальных и локальных пространств они именно таковыми и являются! Python действительно реализует их как словари.
Примечание. Встроенное пространство работает не как словарь. Python реализует его как модуль.
Python предоставляет встроенные функции globals()
и locals()
, обеспечивающие доступ к глобальным и локальным словарям пространств имен.
globals()
Встроенная функция globals()
возвращает ссылку на текущий словарь глобального пространства имен. Ее можно использовать для обращения к объектам в этом пространстве. Посмотрим, как это будет выглядеть при запуске основной программы.
>>> type(globals())
<class 'dict'>
>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None,
'__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None,'__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>}
Как видно из примера, интерпретатор уже поместил ряд записей в globals()
. В зависимости от версии Python и операционной системы в вашей среде это может выглядеть несколько иначе, но в целом все равно будет похоже.
Теперь посмотрим, что происходит при определении переменной в глобальной области видимости.
>>> x = 'foo'
>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None,
'__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None,'__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>,
'x': 'foo'}
Вслед за выражением присваивания x = 'foo'
в словаре глобального пространства имен появляется новый элемент. Ключ словаря — это имя объекта, т. е. x
, а его значение — значение объекта, а именно 'foo'
.
Как правило, вы обращаетесь к этому объекту обычным способом, ссылаясь на его символическое имя x
. Но можно получить к нему доступ косвенным путем посредством словаря глобального пространства имен.
1 >>> x
2 'foo'
3 >>> globals()['x']
4 'foo'
5
6 >>> x is globals()['x']
7 True
Оператор проверки типов is
в строке 6 подтверждает, что в действительности это один и тот же объект.
Вы можете создавать и изменять записи в глобальном пространстве имен, также используя функцию globals()
.
1 >>> globals()['y'] = 100
2
3 >>> globals()
4 {'__name__': '__main__', '__doc__': None, '__package__': None,
5 '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None, 6 '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>,
7 'x': 'foo', 'y': 100}
8
9 >>> y
10 100
11
12 >>> globals()['y'] = 3.14159
13
14 >>> y
15 3.14159
Выражение в строке 1 равнозначно выражениюy = 100
, а в строке 12 — выражению y = 3.14159
.
Этот способ создания и изменения объектов в глобальной области видимости выглядит немного оригинальным, учитывая, что с этой задачей справятся и простые выражения присваивания. Но он работает и прекрасно отражает идею.
locals()
Pyhton также предоставляет соответствующую встроенную функцию locals()
. Она похожа на globals()
, но отличается от нее тем, что обращается к объектам в локальном пространстве имен.
>>> def f(x, y):
... s = 'foo'
... print(locals())
...
>>> f(10, 0.5)
{'s': 'foo', 'y': 0.5, 'x': 10}
Когда locals()
вызывается внутри f()
, она возвращает словарь, представляющий локальное пространство имен функции. Обратите внимание, что помимо локально определенной переменной s
это пространство включает параметры функций x
и y
, поскольку они также являются локальными для f()
.
Если вы вызываете locals()
за пределами функции в основой программе, то она ведет себя так же как и globals()
.
Между globals()
и locals()
существует небольшое отличие, о котором вам будет полезно узнать.
globals()
возвращает актуальную ссылку на словарь, содержащий глобальное пространство имен. Это значит, что если вы вызываете globals()
, сохраняете возвращаемое значение и после этого определяете дополнительные переменные, то эти новые переменные появятся в словаре, на который указывает сохраненное возвращаемое значение.
1 >>> g = globals()
2 >>> g
3 {'__name__': '__main__', '__doc__': None, '__package__': None,
4 '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None, 5 '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>,
6 'g': {...}}
7
8 >>> x = 'foo'
9 >>> y = 29
10 >>> g
11 {'__name__': '__main__', '__doc__': None, '__package__': None,
12 '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None,13 '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>,
14 'g': {...}, 'x': 'foo', 'y': 29}
В этом примере g
является ссылкой на словарь глобального пространства имен. После выражений присваивания в строках 8 и 9 x
и y
появляются в словаре, на который указывает g
.
В свою очередь, locals()
возвращает словарь, являющийся текущей копией локального пространства имен, а не ссылкой на него. Дальнейшие дополнения к локальному пространству не повлияют на предыдущее возвращаемое значение locals()
до момента ее повторного вызова. Кроме того, вы не можете изменять объекты в текущем локальном пространстве имен, используя возвращаемое значение locals()
.
1 >>> def f():
2 ... s = 'foo'
3 ... loc = locals()
4 ... print(loc)
5 ...
6 ... x = 20
7 ... print(loc)
8 ...
9 ... loc['s'] = 'bar'
10 ... print(s)
11 ...
12
13 >>> f()
14 {'s': 'foo'}
15 {'s': 'foo'}
16 foo
В этом примере loc
указывает на возвращаемое значение locals()
, являющееся копией локального пространства. Выражение x = 20
в строке 6 добавляет x
в локальное пространство, а не в копию, на которую указывает loc
. Аналогично этому, выражение в строке 9 изменяет значение для ключа 's'
в копии, на которую указывает loc
, но это никак не влияет на значение s
в текущем локальном пространстве имен.
Это едва уловимое отличие может доставить вам хлопот, если вы его не запомните.
Как вам известно, передача аргументов функции в Python может проходить двумя способами: по значению и по ссылке. Иногда функция может изменить свой аргумент в среде вызова, внося коррективы в соответствующий параметр, а иногда у нее такой возможности нет:
Похожая ситуация возникает, когда функция пытается изменить переменную вне своей локальной области, ведь изменение неизменяемого объекта вне ее границ ей недоступно.
1 >>> x = 20
2 >>> def f():
3 ... x = 40
4 ... print(x)
5 ...
6
7 >>> f()
8 40
9 >>> x
10 20
Когда f()
выполняет выражение присваивания x = 40
в строке 3, она создает новую локальную ссылку на объект целого числа со значением 40
. На этом этапе f()
теряет ссылку на объект с именем x
в глобальном пространстве имен. Таким образом, выражение присваивания не влияет на глобальный объект.
Примечание. Когда функция f()
выполняет print(x)
в строке 4, она отображает 40
, значение своей собственной локальной переменной x
. Но после завершения действия f()
значение x
в глобальной области видимости по прежнему 20
.
Функция может скорректировать объект изменяемого типа, находящийся за пределами ее локальной области видимости, если изменит его внутри:
>>> my_list = ['foo', 'bar', 'baz']
>>> def f():
... my_list[1] = 'quux'
...
>>> f()
>>> my_list
['foo', 'quux', 'baz']
В этом случае my_list
— это список, а списки являются изменяемыми типами данных. f()
может вносить изменения внутрь my_list
, даже если он находится вне локальной области видимости. Но если f()
стремится полностью переназначить my_list
, то она создаст новый локальный объект и не изменит глобальный my_list
.
>>> my_list = ['foo', 'bar', 'baz']
>>> def f():
... my_list = ['qux', 'quux']
...
>>> f()
>>> my_list
['foo', 'bar', 'baz']
Это похоже на процесс, при котором f()
стремится модифицировать изменяемый аргумент функции.
global
А что если вам действительно необходимо изменить значение в глобальной области видимости изнутри f()
? Python делает это возможным благодаря использованию объявления global
.
>>> x = 20
>>> def f():
... global x
... x = 40
... print(x)
...
>>> f()
40
>>> x
40
Выражение global x
указывает на то, что пока выполняется f()
, ссылки на имя x
будут вести к x
, находящемуся в глобальном пространстве имен. Это значит, что присваивание x = 40
не создает новую ссылку. Вместо этого оно присваивает новое значение x
в глобальной области видимости.
Как видите, globals()
возвращает ссылку на словарь глобального пространства имен. При желании, вместо использования выражения global
, можно было бы осуществить то же самое, применив globals()
:
>>> x = 20
>>> def f():
... globals()['x'] = 40
... print(x)
...
>>> f()
40
>>> x
40
Но особых причин делать это таким способом у нас нет, поскольку объявление global
, вероятно, точнее отражает наше намерение. Но тем не менее этот вариант позволяет продемонстрировать принцип работы globals()
.
Если же имя, определенное в объявлении global
, не существует в глобальной области при запуске функции, то его создаст комбинация выражений global
и присваивания.
1 >>> y
2 Traceback (most recent call last):
3 File "<pyshell#79>", line 1, in <module>
4 y
5 NameError: name 'y' is not defined
6
7 >>> def g():
8 ... global y
9 ... y = 20
10 ...
11
12 >>> g()
13 >>> y
14 20
В этом примере при запуске g()
в глобальной области нет объекта с именем y
, но g()
создаст его с помощью выражения global y
в строке 8.
Вы также можете указать несколько имен, разделенных запятыми, в одном объявлении global
.
1 >>> x, y, z = 10, 20, 30
2
3 >>> def f():
4 ... global x, y, z
5 ...
Здесь x
, y
и z
объявляются для ссылок на объекты в глобальной области видимости посредством одного выражения global
в строке 4.
Имя, определенное в объявлении global
, не может появиться в функции раньше выражения global
.
1 >>> def f():
2 ... print(x)
3 ... global x
4 ...
5 File "<stdin>", line 3
6 SyntaxError: name 'x' is used prior to global declaration
Цель выражения global x
в строке 3 состоит в том, чтобы ссылки на x
вели к объекту в глобальной области видимости. Но выражение print()
в строке 2 ссылается на x
до объявления global
, что приводит к выводу исключения SyntaxError
.
nonlocal
Схожая ситуация наблюдается с определениями вложенных функций. Объявление global
позволяет функции обращаться к объекту в глобальной области видимости и менять его. А что если вложенной функции необходимо изменить объект в объемлющей области? Рассмотрим пример:
1 >>> def f():
2 ... x = 20
3 ...
4 ... def g():
5 ... x = 40
6 ...
7 ... g()
8 ... print(x)
9 ...
10
11 >>> f()
12 20
В этом примере первое определение x
дано в объемлющей области, а не в глобальной. Точно так же, как g()
не может напрямую изменить переменную в глобальной области, она не способна изменить x
в объемлющей области функции. После присваивания x = 40
в строке 5 x
в объемлющей области остается 20
.
Ключевое слово global
не способствует решению этой ситуации:
>>> def f():
... x = 20
...
... def g():
... global x
... x = 40
...
... g()
... print(x)
...
>>> f()
20
Поскольку x
находится в объемлющей области функции, а не в глобальной, ключевое слово global
здесь не сработает. После завершения действия g()
значение x
в объемлющей области остается 20
.
На самом деле, в этом примере выражение global x
не только не предоставляет доступ к x
в объемлющей области, но также создает объект с именем x
в глобальной области со значением 40
.
>>> def f():
... x = 20
...
... def g():
... global x
... x = 40
...
... g()
... print(x)
...
>>> f()
20
>>> x
40
Для модификации x
в объемлющей области изнутри g()
вам потребуется аналогичное ключевое слово nonlocal
. Имена, определенные после nonlocal
, ссылаются на переменные в ближайшей объемлющей области.
1 >>> def f():
2 ... x = 20
3 ...
4 ... def g():
5 ... nonlocal x
6 ... x = 40
7 ...
8 ... g()
9 ... print(x)
10 ...
11
12 >>> f()
13 40
После выражения nonlocal x
в строке 5, когда g()
ссылается на x
, оно обращается к x
в ближайшей объемлющей области, чье определение дано внутри f()
в строке 2.
Выражение print()
в завершении f()
в строке 9 подтверждает, что вызов g()
изменил значение x
в объемлющей области на 40
.
Несмотря на то, что Python предоставляет ключевые слова global
и nonlocal
, бывают ситуации, когда их использование не рекомендовано.
Когда функция меняет данные вне локальной области, используя ключевые слова (global
или nonlocal
) или напрямую преобразуя изменяемый тип внутри, то это своего рода побочный эффект, аналогичный ситуации с изменением функцией одного из своих аргументов. Частая модификация глобальных переменных обычно не приветствуется ни в Python, ни в других языках программирования.
Как и со многими другими аспектами жизни, это, скорее всего, дело вкуса. Бывают ситуации, когда разумный подход к изменению глобальных переменных помогает уменьшить сложность программы.
По крайней мере, использование ключевого слова global
в Python явно свидетельствует об изменении функцией глобальной переменной. Во многих других языках функция может менять глобальную переменную только посредством присваивания, не объявляя об этом каким-либо образом. Вследствие чего становится довольно сложно отследить, где происходит изменение глобальных данных.
В общем, изменение переменных за пределами локальной области видимости обычно не требуется. Почти всегда существует лучший способ — обычно с возвращаемыми значениями функции.
Фактически все, что программа Python использует или с чем работает, — это объект. Даже будучи короткой, она создаст много разных объектов. А в более сложной программе их количество исчисляется тысячами. Python должен отслеживать все эти объекты и их имена, и помогают ему в этом пространства имен.
Теперь вы знаете:
Перевод статьи Prateek Phoenix: How to improve the build speed of your Android projects
Комментарии