ชื่อเงาที่กำหนดไว้ในขอบเขตด้านนอกนั้นแย่แค่ไหน?

ฉันเพิ่งเปลี่ยนมาใช้ Pycharm และฉันมีความสุขมากเกี่ยวกับคำเตือนทั้งหมดและคำแนะนำที่ให้ฉันปรับปรุงรหัสของฉัน ยกเว้นอันนี้ซึ่งฉันไม่เข้าใจ:

This inspection detects shadowing names defined in outer scopes.

ฉันรู้ว่ามันเป็นแนวปฏิบัติที่ไม่ดีในการเข้าถึงตัวแปรจากขอบเขตด้านนอก แต่ปัญหาของ Shadowing ขอบเขตด้านนอกคืออะไร

นี่คือตัวอย่างหนึ่งที่ Pycharm ส่งข้อความเตือนให้ฉัน:

data = [4, 5, 6]

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

print_data(data)

ไม่มีเรื่องใหญ่ในตัวอย่างข้างต้นของคุณ แต่ลองจินตนาการถึงฟังก์ชั่นที่มีอาร์กิวเมนต์เพิ่มขึ้นเล็กน้อยและโค้ดอีกไม่กี่บรรทัด จากนั้นคุณตัดสินใจที่จะเปลี่ยนชื่อdataอาร์กิวเมนต์ของคุณเป็นyaddaแต่คิดถึงหนึ่งในสถานที่ที่ใช้ในเนื้อหาของฟังก์ชั่น ... ตอนนี้dataหมายถึงทั่วโลกและคุณเริ่มมีพฤติกรรมแปลก ๆ - ที่คุณจะมีความชัดเจนมากขึ้นNameErrorถ้าคุณไม่ได้ dataมีชื่อระดับโลก

โปรดจำไว้ว่าใน Python ทุกอย่างเป็นวัตถุ (รวมถึงโมดูลคลาสและฟังก์ชั่น) ดังนั้นจึงไม่มีเนมสเปซที่แตกต่างกันสำหรับฟังก์ชั่นโมดูลหรือคลาส อีกสถานการณ์หนึ่งคือคุณนำเข้าฟังก์ชั่นfooที่ด้านบนของโมดูลของคุณและใช้ที่ใดก็ได้ในร่างกายของคุณฟังก์ชั่น จากนั้นคุณเพิ่มอาร์กิวเมนต์ใหม่ในการทำงานของคุณและตั้งชื่อมัน - โชคดี foo-

ในที่สุดฟังก์ชั่นและประเภทในตัวก็ยังอยู่ในเนมสเปซเดียวกันและสามารถเป็นเงาในแบบเดียวกัน

สิ่งเหล่านี้ไม่มีปัญหาหากคุณมีฟังก์ชั่นสั้นการตั้งชื่อที่ดีและการครอบคลุมที่เหมาะสม แต่บางครั้งคุณต้องรักษารหัสน้อยกว่าที่สมบูรณ์แบบและการเตือนเกี่ยวกับปัญหาที่อาจเกิดขึ้นอาจช่วยได้

คำตอบที่ได้รับการโหวตมากที่สุดและเป็นที่ยอมรับและคำตอบส่วนใหญ่ที่นี่พลาดประเด็นไป

ไม่สำคัญว่าฟังก์ชั่นของคุณจะใช้งานได้นานแค่ไหนหรือคุณตั้งชื่อตัวแปรของคุณอย่างมีความหมาย (หวังว่าจะลดโอกาสที่จะเกิดการชนกันของชื่อ)

ความจริงที่ว่าตัวแปรโลคัลของฟังก์ชันหรือพารามิเตอร์ของฟังก์ชันของคุณเกิดขึ้นเพื่อใช้ชื่อร่วมกันในขอบเขตส่วนกลางนั้นไม่เกี่ยวข้องอย่างสมบูรณ์ และในความเป็นจริงไม่ว่าคุณจะเลือกชื่อตัวแปรท้องถิ่นอย่างระมัดระวังเพียงใดฟังก์ชั่นของคุณจะไม่สามารถคาดการณ์ได้ว่าyaddaจะใช้ชื่อเย็นของฉันเป็นตัวแปรทั่วโลกในอนาคตหรือไม่ " การแก้ไขปัญหา? ไม่ต้องห่วงเรื่องนั้น! ความคิดที่ถูกต้องคือการออกแบบฟังก์ชั่นของคุณให้ใช้อินพุตจากพารามิเตอร์เฉพาะในลายเซ็นด้วยวิธีนี้คุณไม่จำเป็นต้องสนใจสิ่งที่ (หรือจะเป็น) ในขอบเขตทั่วโลกจากนั้นเงาจะไม่เป็นปัญหาเลย

กล่าวอีกนัยหนึ่งปัญหาการแรเงาจะเกิดขึ้นเมื่อฟังก์ชันของคุณจำเป็นต้องใช้ตัวแปรโลคอลชื่อเดียวกันและตัวแปรกลางเท่านั้น แต่คุณควรหลีกเลี่ยงการออกแบบในตอนแรก รหัสของ OP ไม่มีปัญหาการออกแบบดังกล่าว มันเป็นเพียงแค่ PyCharm ที่ไม่ฉลาดพอและให้คำเตือนในกรณีที่ ดังนั้นเพื่อให้ PyCharm มีความสุขและทำให้รหัสของเราสะอาดดูโซลูชันนี้โดยอ้างอิงจากคำตอบของ silyevskเพื่อลบตัวแปรทั่วโลกอย่างสมบูรณ์

def print_data(data):
    print data

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

main()

นี่เป็นวิธีที่เหมาะสมในการ "แก้ปัญหา" โดยแก้ไข / ลบสิ่งที่เป็นส่วนกลางของคุณไม่ปรับฟังก์ชันท้องถิ่นปัจจุบันของคุณ

วิธีแก้ปัญหาที่ดีในบางกรณีอาจเป็นการย้าย vars + code ไปยังฟังก์ชันอื่น:

def print_data(data):
    print data

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

main()

ขึ้นอยู่กับระยะเวลาของฟังก์ชั่น ยิ่งฟังก์ชั่นทำงานนานขึ้นโอกาสที่ใครบางคนดัดแปลงมันในอนาคตจะเขียนdataความคิดว่ามันหมายถึงทั่วโลก ในความเป็นจริงมันหมายถึงท้องถิ่น แต่เนื่องจากฟังก์ชั่นนั้นยาวมากจึงไม่ชัดเจนว่ามีชื่อท้องถิ่นนั้นอยู่

สำหรับฟังก์ชั่นตัวอย่างของคุณฉันคิดว่าเงาของโลกนั้นไม่เลวเลย

ทำเช่นนี้:

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)

ฉันชอบที่จะเห็นเห็บสีเขียวที่มุมขวาบนของพิชมาร์ ฉันต่อท้ายชื่อตัวแปรด้วยการขีดเส้นใต้เพียงเพื่อล้างคำเตือนนี้เพื่อให้ฉันสามารถมุ่งเน้นไปที่คำเตือนที่สำคัญ

data = [4, 5, 6]

def print_data(data_): 
    print(data_)

print_data(data)

ดูเหมือนว่ารูปแบบรหัส pytest 100%

ดู:

https://docs.pytest.org/en/latest/fixture.html#conftest-py-sharing-fixture-functions

ฉันมีปัญหาเดียวกันกับนี่คือเหตุผลที่ฉันพบโพสต์นี้;)

# ./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 และทุกคน