在外部范围中定义的阴影名称有啥问题？

Posted 2023-03-28

【中文标题】在外部范围中定义的阴影名称有啥问题？

【英文标题】：What is the problem with shadowing names defined in outer scopes?在外部范围中定义的阴影名称有什么问题？

【发布时间】：2013-12-06 04:06:25

【问题描述】：

我刚刚切换到 PyCharm，我对它为我改进代码提供的所有警告和提示感到非常高兴。除了这个我不明白的：

此检查检测在外部范围中定义的阴影名称。

我知道从外部范围访问变量是不好的做法，但是隐藏外部范围有什么问题？

这是一个例子，PyCharm 给了我警告信息：

data = [4, 5, 6]

def print_data(data): # <-- Warning: "Shadows 'data' from outer scope
    print data

print_data(data)

【问题讨论】：

我也搜索了字符串“此检查检测到...”，但在 pycharm 在线帮助中一无所获：jetbrains.com/pycharm/webhelp/getting-help.html

在 PyCharm 中关闭此消息：++s（设置）、Editor、Inspections, "从外部作用域中隐藏名称"。取消选中。

【参考方案1】：

上面的 sn-p 没有什么大不了的，但是想象一个带有更多参数和更多代码行的函数。然后你决定将你的data 参数重命名为yadda，但是错过了它在函数体中使用的地方之一......现在data 指的是全局，你开始有奇怪的行为——你会在哪里如果您没有全局名称 data，则使用更明显的 NameError。

还要记住，在 Python 中，一切都是对象（包括模块、类和函数），因此函数、模块或类没有不同的命名空间。另一种情况是您在模块顶部导入函数foo，并在函数体的某处使用它。然后向函数添加一个新参数并将其命名为 - 运气不好 - foo。

最后，内置函数和类型也存在于同一个命名空间中，并且可以以同样的方式被隐藏。

如果您有简短的函数、良好的命名和良好的单元测试覆盖率，那么这些都不是什么大问题，但是，有时您必须维护不完美的代码，并且被警告此类可能出现的问题可能会有所帮助。

【讨论】：

幸运的是，PyCharm（由 OP 使用）有一个非常好的重命名操作，可以在同一范围内的任何地方重命名变量，从而减少重命名错误的可能性。

除了 PyCharm 的重命名操作之外，我还希望为引用外部范围的变量提供特殊的语法亮点。这两个应该使这个耗时的阴影分辨率游戏变得无关紧要。

旁注：您可以使用nonlocal 关键字来明确引用外部分数（如闭包中）。请注意，这与遮蔽不同，因为它不会显式遮蔽外部变量。

我认为这不是正确的答案，也没有提出解决方案。我相信这应该是答案：***.com/a/40008745/2424587

@HananShteingart 我已经评论了为什么您认为答案不是，这也是我自己答案的一部分。

【参考方案2】：

The currently most up-voted and accepted answer 和这里的大多数答案都没有抓住重点。

无论你的函数有多长，或者你如何描述性地命名你的变量（希望尽量减少潜在的名称冲突的机会）。

您的函数的局部变量或其参数恰好在全局范围内共享一个名称这一事实完全无关紧要。而事实上，无论你如何仔细选择局部变量名，你的函数永远无法预见“我的酷名yadda将来是否也会被用作全局变量？”。解决方案？根本不用担心！ 正确的思维方式是设计您的函数以使用来自且仅来自其签名中的参数的输入。这样您就不需要关心全局范围内是（或将是）什么，然后阴影就完全不是问题了。

换句话说，阴影问题仅在您的函数需要使用同名的局部变量和全局变量时才重要。但是你应该首先避免这样的设计。 OP 的代码确实没有真的有这样的设计问题。只是 PyCharm 不够聪明，它会发出警告以防万一。所以，为了让 PyC​​harm 开心，也让我们的代码更干净，请参阅引用 silyevsk's answer 的此解决方案以完全删除全局变量。

def print_data(data):
    print data

def main():
    data = [4, 5, 6]
    print_data(data)

main()

这是“解决”这个问题的正确方法，通过修复/删除你的全局事物，而不是调整你当前的本地函数。

【讨论】：

好吧，当然，在一个完美的世界里，你永远不会打错字，或者当你改变参数时忘记你的搜索替换，但是错误发生了，这就是 PyCharm 所说的 - “警告 -技术上没有任何错误，但这很容易成为问题”

我完全同意函数应该尽可能“纯”的事实，但你完全错过了两个重要的点：没有办法限制 Python 在封闭范围内查找名称，如果它是不是本地定义的，并且一切（模块、函数、类等）是一个对象，并且与任何其他“变量”位于相同的命名空间中。在您上面的 sn-p 中，print_data 是一个全局变量。想一想……

我最终选择了这个线程，因为我正在使用函数中定义的函数，以使外部函数更具可读性，而不会弄乱全局命名空间或过度使用单独的文件。此示例不适用于非局部非全局变量被遮蔽的一般情况。

同意。这里的问题是 Python 范围。对当前范围之外的对象的非显式访问是自找麻烦。谁会想要那个！很遗憾，否则 Python 是一种经过深思熟虑的语言（在模块命名方面也没有类似的歧义）。

@florianH ，我不使用 PyCharm，也许你可以在 main() 的末尾设置一个断点？

【参考方案3】：

在某些情况下，一个好的解决方法可能是将变量和代码移动到另一个函数：

def print_data(data):
    print data

def main():
    data = [4, 5, 6]
    print_data(data)

main()

【讨论】：

是的。我认为一个好的 ide 能够通过重构来处理局部变量和全局变量。您的提示确实有助于消除原始 ide 的此类潜在风险

【参考方案4】：

我喜欢在 PyCharm 的右上角看到一个绿色的勾号。我在变量名后面加上下划线只是为了清除这个警告，这样我就可以专注于重要的警告。

data = [4, 5, 6]

def print_data(data_):
    print(data_)

print_data(data)

【讨论】：

忘记_时容易出错

我最初对此表示赞同，并且也这样做了。我现在正在恢复我所有项目中的代码以有意影响全局（当我不想要或不需要它时）。我同意@eyaler，这非常容易出错。

# noinspection PyShadowingNames

【参考方案5】：

这取决于函数的持续时间。函数越长，将来修改它的人就越有可能写data 认为它意味着全局。其实就是local的意思，但是因为函数太长了，他们看不出来有那个名字的local。

对于您的示例函数，我认为遮蔽全局一点也不差。

【参考方案6】：

这样做：

data = [4, 5, 6]

def print_data():
    global data
    print(data)

print_data()

【参考方案7】：

data = [4, 5, 6] # Your global variable

def print_data(data): # <-- Pass in a parameter called "data"
    print data  # <-- Note: You can access global variable inside your function, BUT for now, which is which? the parameter or the global variable? Confused, huh?

print_data(data)

【讨论】：

我并不感到困惑。很明显是参数。

@delnan 你可能不会对这个简单的例子感到困惑，但如果附近定义的其他函数使用全局data，都在几百行代码之内怎么办？

@HevyLight 我不需要看附近的其他功能。我只看这个函数，可以看到 data 是 this 函数中的一个本地名称，所以我什至不费心检查/记住同名的全局 是否存在，更不用说它包含的内容了。

我不认为这种推理是有效的，仅仅是因为要使用全局，您需要在函数内部定义“全局数据”。否则，全局不可访问。

@CodyF False - 如果您没有定义，但只是尝试使用data，它会在范围内查找直到找到一个，所以它确实找到全局data。 data = [1, 2, 3]; def foo(): print(data); foo()

【参考方案8】：

看起来它是 100% 的 pytest 代码模式。

见：

pytest fixtures: explicit, modular, scalable

我遇到了同样的问题，这就是我找到这篇文章的原因；）

# ./tests/test_twitter1.py
import os
import pytest

from mylib import db
# ...

@pytest.fixture
def twitter():
    twitter_ = db.Twitter()
    twitter_._debug = True
    return twitter_

@pytest.mark.parametrize("query,expected", [
    ("BANCO PROVINCIAL", 8),
    ("name", 6),
    ("castlabs", 42),
])
def test_search(twitter: db.Twitter, query: str, expected: int):

    for query in queries:
        res = twitter.search(query)
        print(res)
        assert res

它会警告This inspection detects shadowing names defined in outer scopes.

要解决这个问题，只需将您的 twitter 固定装置移动到 ./tests/conftest.py

# ./tests/conftest.py
import pytest

from syntropy import db


@pytest.fixture
def twitter():
    twitter_ = db.Twitter()
    twitter_._debug = True
    return twitter_

并删除twitter 固定装置，如./tests/test_twitter2.py：

# ./tests/test_twitter2.py
import os
import pytest

from mylib import db
# ...

@pytest.mark.parametrize("query,expected", [
    ("BANCO PROVINCIAL", 8),
    ("name", 6),
    ("castlabs", 42),
])
def test_search(twitter: db.Twitter, query: str, expected: int):

    for query in queries:
        res = twitter.search(query)
        print(res)
        assert res

这将使 QA、PyCharm 和每个人都感到高兴。

【参考方案9】：

要忽略警告，正如 Chistopher 在评论中所说，您可以在其上方发表评论

# noinspection PyShadowingNames