İşlev dönüş türü ve bağımsız değişken türleri nasıl öğrenilir?

Python'un ördek-yazma kavramının farkında olsam da, bazen işlevlerin argümanlarının türü veya işlevin dönüş değerinin türü ile mücadele ediyorum.

Şimdi, işlevi kendim yazarsam, türleri bilirim. Peki ya biri benim işlevlerimi kullanmak ve çağırmak isterse, türleri bilmesi nasıl beklenir? Genellikle tür bilgilerini işlevin belge dizesine koyarım (örneğin: "...the id argument should be an integer..."ve "... the function will return a (string, [integer]) tuple.")

Ama dokümandaki bilgiye bakmak (ve onu kodlayıcı olarak oraya koymak) gerçekten yapılması gerektiği gibi mi?

Düzenleme: Cevapların çoğu "evet, belge!" Bunun "karmaşık" tipler için her zaman çok kolay olmadığını düşünüyorum.
Örneğin: bir dokümantasyon dizesinde, bir işlevin formun her bir demetiyle (düğüm_kimliği, düğüm_adı, çalışma_dakika) bir demet listesi döndürdüğünü ve öğelerin sırasıyla bir dizge, dizge ve tamsayı olduğunu kısaca nasıl açıklayabilirim ?
Docstring PEP dokümantasyonu bu konuda herhangi bir talimat vermez.
Sanırım karşı argüman, bu durumda sınıfların kullanılması gerektiğidir, ancak python'u çok esnek buluyorum çünkü bu şeyleri listeler ve tuple kullanarak, yani sınıflar olmadan geçmeye izin veriyor .

2011'den beri işler biraz değişti! Artık Python 3.5'te argümanlara açıklama eklemek ve işlevinizin türünü döndürmek için kullanabileceğiniz tür ipuçları var . Örneğin bu:

def greeting(name):
  return 'Hello, {}'.format(name)

artık şu şekilde yazılabilir:

def greeting(name: str) -> str:
  return 'Hello, {}'.format(name)

Artık türleri görebileceğiniz gibi, size ve tür denetleyicinize kodunuzu araştırmanıza yardımcı olacak bir tür isteğe bağlı statik tür denetimi vardır.

Daha fazla açıklama için PyCharm blogundaki tip ipuçları hakkındaki blog gönderisine bir göz atmanızı öneririm .

Dinamik diller bu şekilde çalışır. Her zaman iyi bir şey değildir, özellikle de dokümantasyon zayıfsa - kimse kötü bir şekilde belgelenmiş bir python çerçevesi kullanmaya çalıştı mı? Bazen kaynağı okumaya geri dönmeniz gerekir.

Ördek yazmayla ilgili sorunları önlemek için bazı stratejiler şunlardır:

• sorun etki alanınız için bir dil oluşturun
• bu, şeyleri doğru bir şekilde adlandırmanıza yardımcı olur
• etki alanı dilinizdeki kavramları temsil etmek için türleri kullanın
• etki alanı dili sözlüğünü kullanan ad işlevi parametreleri

Ayrıca en önemli noktalardan biri:

• verileri olabildiğince yerel tutun!

Sadece birkaç iyi tanımlanmış ve belgelenmiş tür aktarılmalıdır. Koda bakarak başka her şey açık olmalıdır: Kodun çevresine bakarak anlayamayacağınız, çok uzaklardan gelen garip parametre türlerine sahip olmayın ...

İlgili (ve ayrıca docstrings ile ilgili), python adında bir teknik var doctests. Yöntemlerinizin nasıl kullanılmasının beklendiğini belgelemek ve aynı zamanda güzel bir birim testi kapsamı elde etmek için bunu kullanın!

Bir kurs kursuna katıldım, ders vardı ki, bize tasarım tarifi öğretildi.

Docstring formatının altında preety'yi yararlı buldum.

def alanı (taban, yükseklik):
    '' '(sayı, sayı) -> sayı # ** TypeContract **
    # ** Açıklama ** taban ölçüleriyle bir tringin alanını döndür
    ve yükseklik

    >>> alan (10,5) # ** Örnek **
    25.0
    >> alan (2.5,3)
    3.75
    '' '
    dönüş (taban * yükseklik) / 2 

Bence dokümanlar bu şekilde yazılırsa, geliştiricilere çok yardımcı olabilir.

Video bağlantısı [ Videoyu izleyin] : https://www.youtube.com/watch?v=QAPg6Vb_LgI

Evet, sınıflarınızı ve işlevlerinizi diğer programcılar için daha kolay hale getirmek için docstrings kullanmalısınız:

Daha fazla: http://www.python.org/dev/peps/pep-0257/#what-is-a-docstring

Bazı editörler yazarken docstrings görmenize izin verir, bu yüzden işi gerçekten kolaylaştırır.

Evet öyle.

Python'da bir işlevin her zaman aynı türden bir değişken döndürmesi gerekmez (ancak işlevleriniz her zaman aynı türü döndürürse kodunuz daha okunaklı olacaktır). Bu, işlev için tek bir dönüş türü belirtemeyeceğiniz anlamına gelir.

Aynı şekilde, parametrelerin de her zaman aynı türde olması gerekmez.

Örneğin: bir dokümantasyon dizesinde, bir işlevin formun her bir demetiyle (düğüm_kimliği, düğüm_adı, çalışma süresi_dakika) bir demet listesi döndürdüğünü ve öğelerin sırasıyla bir dizge, dizge ve tamsayı olduğunu kısaca nasıl açıklayabilirim?

Um ... Bunun "kısa" bir açıklaması yok. Karmaşık. Karmaşık olacak şekilde tasarladınız. Ve docstring'de karmaşık belgeler gerektirir.

Maalesef karmaşıklık - iyi - karmaşık.

Evet, dinamik bir yazı dili olduğu için;)

Referans için bunu okuyun: PEP 257

Belgeler (ve genel olarak belgeler). Python 3, PEP 3107'de açıklandığı gibi (isteğe bağlı) işlev açıklamaları sunar (ancak belge dizilerini dışarıda bırakmayın)