在外部作用域中定义的阴影名称有什么问题？

问题描述：

我刚刚切换到 PyCharm，我很高兴它为我提供的所有警告和提示都可以改善我的代码。除了这个我不明白的：

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

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

下面是一个示例，PyCharm 向我提供了警告消息：

data = [4, 5, 6]

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

print_data(data)

解决方案 1：

上面的代码片段没有什么大不了的，但想象一下一个函数，它有更多参数和更多代码行。然后你决定将data参数重命名为yadda，但错过了函数主体中使用它的地方之一……现在data指的是全局变量，你开始出现奇怪的行为——NameError如果你没有全局名称，你会有一个更明显的行为data。

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

最后，内置函数和类型也位于同一个命名空间中，并且可以以相同的方式进行隐藏。

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

解决方案 2：

目前获得最多赞成和接受的答案以及这里的大多数答案都没有切中要点。

你的函数有多长或者你如何描述性地命名你的变量并不重要（以尽量减少潜在名称冲突的机会）。

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

换句话说，只有当您的函数需要使用同名局部变量和全局变量时，阴影问题才会出现。但您首先应该避免这种设计。OP 的代码实际上没有这样的设计问题。只是 PyCharm 不够智能，它以防万一发出警告。因此，为了让 PyC​​harm 满意，也为了让我们的代码干净，请参阅此解决方案，引用silyevsk 的答案以完全删除全局变量。

def print_data(data):
    print data

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

main()

这是“解决”此问题的正确方法，即修复/删除全局内容，而不是调整当前的本地功能。

解决方案 3：

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

def print_data(data):
    print data

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

main()

解决方案 4：

这取决于函数的长度。函数越长，将来有人修改它时，data认为它是指全局函数的可能性就越大。事实上，它是指本地函数，但由于函数太长，他们并不清楚存在一个同名的本地函数。

对于您的示例函数，我认为隐藏全局变量一点也不坏。

解决方案 5：

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

data = [4, 5, 6]

def print_data(data_):
    print(data_)

print_data(data)

解决方案 6：

我认为这条规则没什么帮助。我只需转到“设置” -> “编辑器” -> “检查”，然后勾选以下规则即可禁用它：从外部范围遮蔽名称

解决方案 7：

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

看：

pytest 装置：显式、模块化、可扩展

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

# ./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 和每个人都感到高兴。

解决方案 8：

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)

解决方案 9：

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

# noinspection PyShadowingNames

解决方案 10：

这样做：

data = [4, 5, 6]

def print_data():
    global data
    print(data)

print_data()

解决方案 11：

这也可能是一条微妙的警告，表示您的函数被定义为另一个函数的内部函数，而您并非有意为之。也许是因为缩进不当，而这又是由于缺乏咖啡因造成的。换句话说，您可能会看到这条消息显示“您的范围不是您想象的那样，年轻的 Padawan”

解决方案 12：

在您的代码中，警告“从外部作用域遮蔽‘数据’”表示函数 print_data 中的参数数据与全局变量数据同名。这可能会导致更复杂的程序出现混乱或错误，因为无法立即确定函数内部引用了哪些数据。

要解决此警告，您只需将函数中的参数重命名为其他名称，例如 data_list：

数据 = [4, 5, 6]

def print_data（数据列表）：打印（数据列表）

打印数据（数据）

现在，全局变量data和函数内的参数data_list之间不再有歧义。