Dış kapsamlarda gölgelendirme adları ne kadar kötü tanımlanır?

Sadece Pycharm'a geçtim ve kodumu geliştirmem için bana sağladığı tüm uyarı ve ipuçlarından çok memnunum. Anlamadığım bu hariç:

This inspection detects shadowing names defined in outer scopes.

Değişkene dış kapsamdan erişmenin kötü bir uygulama olduğunu biliyorum ama dış kapsamın gölgelenmesiyle ilgili sorun nedir?

İşte bir örnek, Pycharm bana uyarı mesajı veriyor:

data = [4, 5, 6]

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

print_data(data)

Yukarıdaki snippet'inizde büyük bir anlaşma yok, ancak birkaç argüman ve birkaç kod satırı daha olan bir fonksiyon düşünün. O zaman dataargümanınızı yeniden adlandırmaya karar veriyorsunuz yaddaancak fonksiyonun vücudunda kullanılan yerlerden birini kaçırıyorsunuz ... Şimdi dataküresel olana atıfta bulunuyorsunuz ve garip davranışlara başlıyorsunuz - NameErroreğer yapmazsanız çok daha açık olacağınız global bir isme sahip olmak data.

Ayrıca Python'da her şeyin bir nesne olduğunu (modüller, sınıflar ve işlevler dahil) unutmayın, bu nedenle işlevler, modüller veya sınıflar için ayrı bir ad alanı yoktur. Başka bir senaryo, foomodülü modülünüzün üst kısmına içe aktarmanız ve işlev gövdenizde bir yerde kullanmanızdır. Sonra işlevinize yeni bir argüman eklediniz ve buna - kötü şans - adını verdiniz foo.

Son olarak, yerleşik işlevler ve türler de aynı ad alanında yaşar ve aynı şekilde gölgelenebilir.

Kısa işlevleriniz, iyi adlandırma ve iyi bir birim testi kapsamı varsa bunların hiçbiri sorun değildir, ancak bazen mükemmel koddan daha azını korumak zorunda kalırsınız ve bu tür olası konular hakkında uyarılmak yardımcı olabilir.

Şu anda en çok oylanan ve kabul edilen cevap ve çoğu cevap burada özlüyor.

İşlevinizin ne kadar uzun olduğu veya değişkeninizi tanımlayıcı olarak nasıl adlandırdığınız önemli değildir (umarım potansiyel isim çarpışma olasılığını en aza indirmek için).

İşlevinizin yerel değişkeninin veya parametresinin genel kapsamda bir ad paylaşması gerçeğiyle tamamen ilgisizdir. Ve aslında, yerel değişken adını ne kadar dikkatli seçerseniz seçin, fonksiyonunuz "serin ismimin yaddagelecekte küresel bir değişken olarak da kullanıp kullanmayacağını" asla öngöremez . Çözüm? Bunun için endişelenme! Doğru zihniyet, işlevinizi yalnızca imzadaki parametrelerinden ve yalnızca parametrelerinden girdi tüketecek şekilde tasarlamaktır , böylece küresel kapsamda ne olduğunu (veya olacağını) önemsemenize gerek kalmaz ve daha sonra gölgeleme hiç sorun olmaz.

Başka bir deyişle, gölgeleme sorunu yalnızca işlevinizin aynı adı yerel değişkeni VE global değişkeni kullanması gerektiğinde önemlidir. Ancak ilk etapta böyle bir tasarımdan kaçınmalısınız. OP'nin kodunda böyle bir tasarım problemi YOKTUR. Sadece PyCharm yeterince akıllı değildir ve her ihtimale karşı bir uyarı verir. Bu nedenle, sadece PyCharm'ı mutlu etmek ve kodumuzu temizlemek için, küresel değişkeni tamamen kaldırmak için silyevsk'in cevabından alıntı yapan bu çözüme bakın .

def print_data(data):
    print data

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

main()

Bu, mevcut yerel işlevinizi ayarlayarak değil, küresel olanı düzelterek / kaldırarak bu sorunu "çözmek" için uygun yoldur.

Bazı durumlarda iyi bir geçici çözüm vars + kodunu başka bir işleve taşımak olabilir:

def print_data(data):
    print data

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

main()

Bu fonksiyonun ne kadar sürdüğüne bağlıdır. İşlev ne kadar uzun olursa, gelecekte birisinin onu değiştirmesi data, bunun küresel anlamına geldiğini düşünerek daha fazla şansı yazacaktır . Aslında yerel anlamına gelir, ancak işlev çok uzun olduğu için, bu ada sahip bir yerel var olduğu açık değildir.

Örnek fonksiyonunuz için, küresel gölgelemenin hiç de fena olmadığını düşünüyorum.

Bunu yap:

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)

Pycharm'ın sağ üst köşesinde yeşil bir onay işareti görmek istiyorum. Önemli uyarılara odaklanabilmek için bu uyarıyı temizlemek için değişken adlarını alt çizgiyle ekliyorum.

data = [4, 5, 6]

def print_data(data_): 
    print(data_)

print_data(data)

% 100 pytest kod kalıbı gibi görünüyor

görmek:

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

Ben de aynı sorunu vardı, bu yüzden bu yazı bulundu;)

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

Ve uyarır This inspection detects shadowing names defined in outer scopes.

Bunu düzeltmek için twitterfikstürünüzü./tests/conftest.py

# ./tests/conftest.py
import pytest

from syntropy import db


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

Ve twitterfikstürü./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

Bu mutlu QA, Pycharm ve herkesi mutlu edecek