python - SQLAlchemy create_engine 如何导入 Engine 类？

Question

我对 python 比较陌生，正在尝试使用 SQLAlchemy。我注意到，要创建引擎，我必须使用 create_engine() 函数，该函数通过 from sqlalchemy import create_engine 导入。

现在，create_engine 函数返回 sqlalchemy.engine.base.Engine 类的一个实例。但是我从来没有导入这个类，我只导入了 create_engine 模块。那么，Python 是如何知道 sqlalchemy.engine.base.Engine 类的呢？

Answer 1

您可能不了解导入的作用。

Python 导入模块全局。有一个称为 sys.modules 的结构，它将导入的模块存储为字典:

>>> import sys
>>> sys.modules
{'builtins': <module 'builtins' (built-in)>, 'sys': <module 'sys' (built-in)>, '_frozen_importlib': <module 'importlib._bootstrap' (frozen)>, '_imp': <module '_imp' (built-in)>, ...}

当您导入 SQLAlchemy 时，您导入了一个包，一个包含多个模块的结构，一次导入会触发更多导入。所有这些导入的模块都存储在同一个地方:

>>> import sqlalchemy
>>> [name for name in sys.modules if 'sqlalchemy' in name]
['sqlalchemy', 'sqlalchemy.sql', 'sqlalchemy.sql.expression', 'sqlalchemy.sql.visitors', 'sqlalchemy.util', 'sqlalchemy.util.compat', 'sqlalchemy.util._collections', 'sqlalchemy.util.langhelpers', 'sqlalchemy.exc', 'sqlalchemy.util.deprecations', 'sqlalchemy.sql.functions', 'sqlalchemy.sql.sqltypes', 'sqlalchemy.sql.elements', 'sqlalchemy.inspection', 'sqlalchemy.sql.type_api', 'sqlalchemy.sql.operators', 'sqlalchemy.sql.base', 'sqlalchemy.sql.annotation', 'sqlalchemy.processors', 'sqlalchemy.cprocessors', 'sqlalchemy.event', 'sqlalchemy.event.api', 'sqlalchemy.event.base', 'sqlalchemy.event.attr', 'sqlalchemy.event.registry', 'sqlalchemy.event.legacy', 'sqlalchemy.sql.schema', 'sqlalchemy.sql.selectable', 'sqlalchemy.sql.ddl', 'sqlalchemy.util.topological', 'sqlalchemy.sql.util', 'sqlalchemy.sql.dml', 'sqlalchemy.sql.default_comparator', 'sqlalchemy.sql.naming', 'sqlalchemy.events', 'sqlalchemy.pool', 'sqlalchemy.log', 'sqlalchemy.interfaces', 'sqlalchemy.util.queue', 'sqlalchemy.engine', 'sqlalchemy.engine.interfaces', 'sqlalchemy.sql.compiler', 'sqlalchemy.sql.crud', 'sqlalchemy.engine.base', 'sqlalchemy.engine.util', 'sqlalchemy.cutils', 'sqlalchemy.engine.result', 'sqlalchemy.cresultproxy', 'sqlalchemy.engine.strategies', 'sqlalchemy.engine.threadlocal', 'sqlalchemy.engine.url', 'sqlalchemy.dialects', 'sqlalchemy.types', 'sqlalchemy.schema', 'sqlalchemy.engine.default', 'sqlalchemy.engine.reflection']

一旦模块从磁盘加载并添加到该结构中，Python 就不需要再次加载它。点在层次结构中分隔模块名称，因此以 sqlalchemy. 开头的所有内容都作为树结构存在于 sqlalchemy 包中。这里有很多sqlalchemy模块，这是一个大项目，它们都是由root package module, sqlalchemy/__init__.py加载(直接或间接)的。 .

import 做的另一件事是在您当前的命名空间中绑定(bind)一个名称。每个模块都是一个“全局”命名空间，该命名空间中的所有名称在该命名空间中都是可见的。您的 Python 脚本作为 __main__ 命名空间导入，其中的所有名称都可用于您的脚本。如果您创建一个模块 foo，那么它就是一个具有自己名称的独立命名空间。 import 将名称从另一个模块添加到您的全局命名空间。在 Python 中，名称​​只是引用；这些名称中的每一个引用的实际对象都存在于内存中的一大堆中，称为堆。

线

from sqlalchemy import create_engine

首先确保对象 sys.modules['sqlalchemy'] 存在，并将名称 create_engine 添加到您当前的命名空间，对 sqlalchemy 的引用.create_engine，就好像执行了行 create_engine = sys.modules['sqlalchemy'].create_engine:

>>> sys.modules['sqlalchemy'].create_engine
<function create_engine at 0x10188bbf8>
>>> from sqlalchemy import create_engine
>>> create_engine is sys.modules['sqlalchemy'].create_engine
True

同样，Python 中的所有名称​​只是对内存中一大堆对象的引用。

当您调用 create_engine() 函数时，将执行该函数的代码，并且该函数可以访问定义它的命名空间中的所有全局变量。在这种情况下，该函数是在 sqlalchemy.engine 模块中定义(顶级 sqlalchemy 模块本身已将其导入为 from sqlalchemy.engine import create_engine 因此您可以访问从更方便的位置):

>>> create_engine.__module__
'sqlalchemy.engine'
>>> sys.modules['sqlalchemy.engine']
<module 'sqlalchemy.engine' from '/Users/mjpieters/Development/venvs/stackoverflow-3.6/lib/python3.6/site-packages/sqlalchemy/engine/__init__.py'>
>>> sorted(vars(sys.modules['sqlalchemy.engine']))
['BaseRowProxy', 'BufferedColumnResultProxy', 'BufferedColumnRow', 'BufferedRowResultProxy', 'Compiled', 'Connectable', 'Connection', 'CreateEnginePlugin', 'Dialect', 'Engine', 'ExceptionContext', 'ExecutionContext', 'FullyBufferedResultProxy', 'NestedTransaction', 'ResultProxy', 'RootTransaction', 'RowProxy', 'Transaction', 'TwoPhaseTransaction', 'TypeCompiler', '__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', 'base', 'connection_memoize', 'create_engine', 'ddl', 'default', 'default_strategy', 'engine_from_config', 'interfaces', 'reflection', 'result', 'strategies', 'threadlocal', 'url', 'util']

该名称列表是定义在与 create_engine 相同的模块中的所有名称。当您导入 sqlalchemy 模块时，该模块已由执行的代码加载.该函数可以访问所有这些对象，并可以返回任何此类对象。您会注意到这是在那里定义的 Engine 名称:

>>> sys.modules['sqlalchemy.engine'].Engine
<class 'sqlalchemy.engine.base.Engine'>

因此该对象已经加载到 Python 内存中。该函数所做的只是为您创建该类的一个实例并将其返回:

>>> engine = create_engine('sqlite:///:memory:')
>>> engine
Engine(sqlite:///:memory:)
>>> type(engine)
<class 'sqlalchemy.engine.base.Engine'>

如果您想了解有关 Python 和名称的更多信息，我建议您阅读 Ned Batchelder 在 Facts and myths about Python names and values 上发表的文章.