第七色在线视频,2021少妇久久久久久久久久,亚洲欧洲精品成人久久av18,亚洲国产精品特色大片观看完整版,孙宇晨将参加特朗普的晚宴

為了賬號(hào)安全,請(qǐng)及時(shí)綁定郵箱和手機(jī)立即綁定
已解決430363個(gè)問(wèn)題,去搜搜看,總會(huì)有你想問(wèn)的

將函數(shù)簽名與文檔字符串進(jìn)行比較的工具

將函數(shù)簽名與文檔字符串進(jìn)行比較的工具

慕尼黑8549860 2023-07-11 14:51:23
是否有工具可以檢查文檔字符串中列出的參數(shù)是否與函數(shù)調(diào)用的簽名匹配?它應(yīng)該能夠處理 numpy 風(fēng)格的文檔字符串。我經(jīng)常使用 R CMD CHECK,它可以發(fā)現(xiàn) R 中的文檔/代碼不匹配,這非常有幫助。如果 Python 中有類(lèi)似的東西那就太好了,但我還沒(méi)有找到任何東西。
查看完整描述

3 回答

?
PIPIONE

TA貢獻(xiàn)1829條經(jīng)驗(yàn) 獲得超9個(gè)贊

我剛剛創(chuàng)建了一個(gè)工具來(lái)實(shí)現(xiàn)這一目標(biāo),稱(chēng)為pydoctest.

它將嘗試推斷文檔字符串中的類(lèi)型(不僅僅是詞法比較)并報(bào)告參數(shù)數(shù)量、參數(shù)名稱(chēng)、參數(shù)類(lèi)型、返回類(lèi)型之間的不匹配,(可選)如果缺少文檔字符串等則拋出錯(cuò)誤。

它目前支持 google、sphinx 和 numpy 文檔字符串格式,但可以很容易地使用其他格式進(jìn)行擴(kuò)展。

例子:

def func_type_mismatch(self, a: int) -> int:

? ? """[summary]


? ? Args:

? ? ? ? a (float): [description]? ? ? ? <-- float is not int


? ? Returns:

? ? ? ? int: [description]

? ? """

? ? pass

在此函數(shù)上運(yùn)行 pydoctest 會(huì)給出以下輸出:

Function: <function IncorrectTestClass.func_type_mismatch at 0x7f9a8b52c8c8> FAIL | Argument type differ. Argument 'a' was expected (from signature) to have type '<class 'int'>', but has (in docs) type '<class 'float'>'

http://img4.sycdn.imooc.com/64acfc1e000103e805990372.jpg

查看完整回答
反對(duì) 回復(fù) 2023-07-11
?
動(dòng)漫人物

TA貢獻(xiàn)1815條經(jīng)驗(yàn) 獲得超10個(gè)贊

pip install docsig

然后運(yùn)行docsig .它就會(huì)為你檢查這一點(diǎn)

/path/to/project

-----------------------

def function(?*args) -> ?List[str]:

? ? """...


? ? :param None: ?

? ? :return: ?

? ? """


E103: parameters missing

目前還有8個(gè)錯(cuò)誤


查看完整回答
反對(duì) 回復(fù) 2023-07-11
?
BIG陽(yáng)

TA貢獻(xiàn)1859條經(jīng)驗(yàn) 獲得超6個(gè)贊

除了其他答案中提到的pydoctest和docsig之外,至少還有這些工具:

  • pydoclint與?pydocstyle或ruff一起使用

  • Pylint 的docparams 擴(kuò)展

  • flake8-文檔字符串-完整

  • darglit2(對(duì)于大型項(xiàng)目來(lái)說(shuō)速度慢得驚人)


查看完整回答
反對(duì) 回復(fù) 2023-07-11
  • 3 回答
  • 0 關(guān)注
  • 189 瀏覽
慕課專(zhuān)欄
更多

添加回答

舉報(bào)

0/150
提交
取消
微信客服

購(gòu)課補(bǔ)貼
聯(lián)系客服咨詢(xún)優(yōu)惠詳情

幫助反饋 APP下載

慕課網(wǎng)APP
您的移動(dòng)學(xué)習(xí)伙伴

公眾號(hào)

掃描二維碼
關(guān)注慕課網(wǎng)微信公眾號(hào)