Parametry z wartością domyślną, która nie jest read-only

[cameel]

Moim zdaniem powinniśmy zabronić tego w Coding Style i dodać wyjaśnienie dlaczego. Moja wstępna propozycja:

• Unikamy nadawania parametrom funkcji wartości domyślnych, które są obiektami, które da się zmodyfikować. W szczególności chodzi o wartości takie jak [],{}. Zamiast tego nadajemy im wartość None i wewnątrz funkcji nadajemy już docelową wartość domyślną..
  • Przykład:

    def myfunc(value=None):
        if value is None:
            value = []
        # modify value here

  • Przyczyną jest to, że wartość domyślna jest wyliczana tylko raz, w momencie definiowania funkcji i wszystkie zmiany dokonane w niej przez funkcję zachowują się między wywołaniami, co zwykle jest niepożądanym i nieintuicyjnym zachowaniem.
  • Nie ma tego problemu z wartościami prostymi jak liczby, wartości logiczne, stringi. One są niemodyfikowalne - ich "modyfikacja" zawsze powoduje utworzenie w pamięci nowego obiektu, a nie zmodifykowanie istniejącego.
  • Więcej na ten temat: Default Parameter Values in Python.

Jeżeli ktoś chciałby to przeformułować, rozszerzyć albo dodać przykłady, proszę o propozycje w komentarzach.

[rwrzesien]

:+1:

[dybi]

@cameel, bardzo dobry pomysł. Dorzuciłbym przykład z linka:

def myfunc(value=None):
    if value is None:
        value = []
    # modify value here

bo jak znam życie, to co druga osoba nie kliknie/nie przeczyta ;)

Oprócz tego, myślę, że warto byłoby napisać o NIE nadawaniu wartości domyślnych wszystkim argumentom w funkcjach. W kodzie mamy sporo funkcji typu:

def weird_fun(param1=None, param2=None):
    assert param1 is not None
    assert isinstance(param2, str)
   # some code 

[cameel]

OK.

Co do nadużywania wartości domyślnych to też zupełnie się zgadzam. Ale może zaproponuj konkretne sformułowanie dla tej zasady w osobnym issue.

[dybi]

zrobiłem issue: https://github.com/Code-Poets/coding-style/issues/4

[Jakub89]

:+1:

[dybi]

To też chyba można już śmiało dodać ;)

[dybi]

@cameel, zmodyfikowałem Twojego posta - dodałęm do niego przykład z linka