Python Docstring: yükseltmek vs yükseltmek

Question

PEP0257 uyumlu docstrings işçiliği yardımcı olan PyCharm IDE'yi kullanıyorum. Ben tamamen arasındaki ayrım/kullanabilecekleri anlamıyorum iki nitelik sağlar: :raise Exception: exception explanation here

:raises Exception: exception explanation here

benim docstringe içinde raises için karşı çıkması nedeniyle ben raise kullanmak

• ? Spesifik olarak, bir sınıf sağlanmayan bir argüman gerektiriyorsa ve bunu belgelemek için kullanılmalı olan bir TypeError'u yükseltiyorsa?

Answer 1

TL; DR

raises olası istisnalar ortaya atılan tanımlamak için kullanılır. raise, autodoc çalışırken Sphinx tarafından tanınır ve raises ile aynıdır.

Tam Açıklama

pycharm yorumlarınızı docstringe birkaç farklı stilleri kullanarak yardımcı olur. Sık sık kullanmak

Üç şunlardır: Bunların hepsinde

1. NumPy Format
2. Google Format
3. Sphinx (bir biçimden çok daha fazla)

Raises için özel bir bölüm var PyCharm kod testlerinin eski bir versiyonunda görebileceğiniz:

1. Simple NumPy
2. Simple Google

SphinxDocString için uygulama yapabiliriz orada tanınabilir sayısız anahtar kelime var see here. Bu etiketler daha sonra here bulunabilir RAISES_TAGS listesine link.

Umarım bu bilgi yararlıdır.