Làm thế nào xấu là bóng tên được xác định trong phạm vi bên ngoài?

Tôi mới chuyển sang Pycharm và tôi rất vui về tất cả các cảnh báo và gợi ý nó cung cấp cho tôi để cải thiện mã của mình. Ngoại trừ điều này mà tôi không hiểu:

This inspection detects shadowing names defined in outer scopes.

Tôi biết đó là thực tế xấu để truy cập biến từ phạm vi bên ngoài nhưng vấn đề với bóng tối phạm vi bên ngoài là gì?

Đây là một ví dụ, nơi Pycharm đưa cho tôi thông điệp cảnh báo:

data = [4, 5, 6]

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

print_data(data)

Không có vấn đề lớn trong đoạn trích trên của bạn, nhưng hãy tưởng tượng một hàm có thêm một vài đối số và khá nhiều dòng mã. Sau đó, bạn quyết định đổi tên datađối số của mình thành yaddanhưng bỏ lỡ một trong những vị trí được sử dụng trong cơ thể của hàm ... Bây giờ datađề cập đến toàn cầu và bạn bắt đầu có hành vi kỳ lạ - nơi bạn sẽ rõ ràng hơn nhiều NameErrornếu bạn không có tên toàn cầu data.

Cũng cần nhớ rằng trong Python, mọi thứ đều là một đối tượng (bao gồm các mô-đun, lớp và hàm) vì vậy không có không gian tên riêng biệt cho các hàm, mô-đun hoặc lớp. Một kịch bản khác là bạn nhập hàm fooở đầu mô-đun và sử dụng nó ở đâu đó trong thân hàm. Sau đó, bạn thêm một đối số mới cho chức năng của mình và đặt tên cho nó - thật không may - foo.

Cuối cùng, các hàm và kiểu dựng sẵn cũng sống trong cùng một không gian tên và có thể bị che khuất theo cùng một cách.

Không có vấn đề gì trong số này là vấn đề nếu bạn có các chức năng ngắn, đặt tên tốt và phạm vi bảo hiểm không đáng tin cậy, nhưng tốt, đôi khi bạn phải duy trì ít hơn mã hoàn hảo và được cảnh báo về các vấn đề có thể có thể giúp ích.

Các câu trả lời hiện đang được bình chọn và chấp nhận nhiều nhất và hầu hết các câu trả lời ở đây bỏ lỡ điểm.

Không quan trọng chức năng của bạn là bao lâu hoặc cách bạn đặt tên cho biến của mình một cách mô tả (để hy vọng giảm thiểu khả năng xảy ra xung đột tên).

Thực tế là biến cục bộ của hàm hoặc tham số của hàm xảy ra để chia sẻ tên trong phạm vi toàn cục là hoàn toàn không liên quan. Và trên thực tế, cho dù bạn chọn tên biến địa phương cẩn thận đến mức nào, chức năng của bạn không bao giờ có thể thấy trước "liệu tên mát mẻ của tôi yaddacũng sẽ được sử dụng làm biến toàn cầu trong tương lai?". Giải pháp? Đơn giản là đừng lo lắng về điều đó! Suy nghĩ đúng đắn là thiết kế chức năng của bạn để tiêu thụ đầu vào từ và chỉ từ các tham số của nó trong chữ ký , theo cách đó bạn không cần quan tâm cái gì (hoặc sẽ) trong phạm vi toàn cầu, và sau đó, bóng tối hoàn toàn không phải là vấn đề.

Nói cách khác, vấn đề đổ bóng chỉ quan trọng khi hàm của bạn cần sử dụng cùng tên biến cục bộ VÀ biến toàn cục. Nhưng bạn nên tránh thiết kế như vậy ở nơi đầu tiên. Mã của OP KHÔNG thực sự có vấn đề thiết kế như vậy. Chỉ là PyCharm không đủ thông minh và nó đưa ra cảnh báo chỉ trong trường hợp. Vì vậy, chỉ để làm cho PyCharm hài lòng và cũng làm cho mã của chúng tôi sạch sẽ, hãy xem giải pháp này trích dẫn từ câu trả lời của silyevsk để loại bỏ hoàn toàn biến toàn cục.

def print_data(data):
    print data

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

main()

Đây là cách thích hợp để "giải quyết" vấn đề này, bằng cách sửa / xóa thứ toàn cầu của bạn, không điều chỉnh chức năng cục bộ hiện tại của bạn.

Một cách giải quyết tốt trong một số trường hợp có thể là di chuyển mã vars + sang chức năng khác:

def print_data(data):
    print data

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

main()

Nó phụ thuộc vào thời gian của chức năng. Chức năng càng dài, càng có nhiều cơ hội để ai đó sửa đổi nó trong tương lai sẽ viết datasuy nghĩ rằng nó có nghĩa là toàn cầu. Trong thực tế, nó có nghĩa là địa phương nhưng vì chức năng quá dài nên họ không rõ ràng rằng có tồn tại một địa phương có tên đó.

Đối với chức năng ví dụ của bạn, tôi nghĩ rằng phủ bóng toàn cầu không tệ chút nào.

Làm cái này:

data = [4, 5, 6]

def print_data():
    global data
    print(data)

print_data()

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)

Tôi thích nhìn thấy một đánh dấu màu xanh lá cây ở góc trên bên phải trong pycharm. Tôi nối các tên biến với dấu gạch dưới chỉ để xóa cảnh báo này để tôi có thể tập trung vào các cảnh báo quan trọng.

data = [4, 5, 6]

def print_data(data_): 
    print(data_)

print_data(data)

Có vẻ như mẫu mã 100% pytest

xem:

https://docs.pytest.org/en/latest/fixture.html#conftest-py-shaming-fixture-fifts

Tôi đã có cùng một vấn đề với, đây là lý do tại sao tôi tìm thấy bài đăng này;)

# ./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

Và nó sẽ cảnh báo với This inspection detects shadowing names defined in outer scopes.

Để khắc phục điều đó, chỉ cần di chuyển twittervật cố của bạn vào./tests/conftest.py

# ./tests/conftest.py
import pytest

from syntropy import db


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

Và loại bỏ twittervật cố định như trong./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

Điều này sẽ làm cho QA, Pycharm và mọi người hạnh phúc