Наскільки погано визначено затінення імен у зовнішніх областях?

Я щойно перейшов на Pycharm, і я дуже радий усім попередженням та підказкам, які він дає мені покращити свій код. За винятком цього, якого я не розумію:

This inspection detects shadowing names defined in outer scopes.

Я знаю, що це погана практика доступу до змінної із зовнішньої області, але яка проблема в затіненні зовнішньої області?

Ось один приклад, коли 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також буде використовуватися як глобальна змінна в майбутньому?". Рішення? Просто не хвилюйтеся з цього приводу! Правильний спосіб мислення полягає в тому, щоб розробити свою функцію для споживання вхідних даних і тільки з їхніх параметрів на підпис , таким чином вам не потрібно дбати про те, що є (або буде) у глобальному масштабі, і тоді затінення не стає взагалі проблемою.

Іншими словами, проблема тінізації має значення лише тоді, коли вашій функції потрібно використовувати ту ж ім'я локальної змінної І глобальну змінну. Але вам слід уникати такого дизайну в першу чергу. Код ОП насправді не має такої дизайнерської проблеми. Просто PyCharm недостатньо розумний, і він видає попередження про всяк випадок. Отже, щоб зробити PyCharm щасливим, а також зробити наш код чистим, дивіться це рішення з цитуванням відповіді Сілєвська, щоб повністю видалити глобальну змінну.

def print_data(data):
    print data

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

main()

Це правильний спосіб "вирішити" цю проблему шляхом виправлення / видалення вашої глобальної речі, не коригуючи поточну локальну функцію.

Хорошим рішенням у деяких випадках може бути переміщення коду vars + на іншу функцію:

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)

Схоже, це 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 та всі