PyPDF2 開發(fā)者介紹

安裝要求

pip install -r requirements/dev.txt

運(yùn)行測(cè)試

示例文件 git 子模塊

擁有子模塊的原因sample-files是我們希望保持 PyPDF2 存儲(chǔ)庫(kù)的大小較小，同時(shí)我們還希望擁有一個(gè)廣泛的測(cè)試套件。這兩個(gè)目標(biāo)相互矛盾。

該resources文件夾應(yīng)包含一組精選的核心示例，涵蓋我們通常要測(cè)試的大多數(shù)情況。這sample-files可能涵蓋更多的邊緣情況，當(dāng)文件大小變大時(shí)我們得到的行為，不同的 PDF 制作者。

為了獲取示例文件文件夾，您需要執(zhí)行：

git submodule update --init

工具：git 和預(yù)提交

Git 是用于版本控制的命令行應(yīng)用程序。不會(huì)的可以玩ohmygit學(xué)習(xí)一下。

GitHub 是托管 PyPDF2 項(xiàng)目的服務(wù)。雖然 git 是免費(fèi)和開源的，但 GitHub 是微軟的付費(fèi)服務(wù)——但在很多情況下是免費(fèi)的。

pre-commit是一個(gè)命令行應(yīng)用程序，它使用 git hooks 來(lái)自動(dòng)執(zhí)行代碼。這使您可以避免樣式問(wèn)題和其他代碼質(zhì)量問(wèn)題。當(dāng)你在 PyPDF2 的本地副本中輸入 一次后，它會(huì)在你.pre-commit installgit commit

提交信息

擁有清晰的提交信息可以幫助人們快速理解提交的內(nèi)容，而無(wú)需實(shí)際查看更改。提交消息的第一行用于自動(dòng)生成 CHANGELOG。因此，格式應(yīng)為：

PREFIX: DESCRIPTION

BODY

可以PREFIX是：

• BUG: 修復(fù)了一個(gè)錯(cuò)誤。可能存在一個(gè)或多個(gè)問(wèn)題。然后寫在BODY:其中 123 是 GitHub 上的問(wèn)題編號(hào)。如果您能在這些情況下編寫回歸測(cè)試，那將是絕對(duì)令人驚奇的。如果沒(méi)有修復(fù)，那是一個(gè)會(huì)失敗的測(cè)試。Closes #123

• ENH: 一個(gè)新功能！在正文中描述它的用途。

• DEP: 棄用 - 將某些內(nèi)容標(biāo)記為“這將被刪除”或?qū)嶋H刪除它。

• PI: 性能改進(jìn)。這也可以減少 PyPDF2 生成的 PDF 文件的文件大小。

• ROB：穩(wěn)健性變化。更好地處理?yè)p壞的 PDF 文件。

• DOC: 文檔更改。

• TST: 添加/調(diào)整測(cè)試。

• DEV: 開發(fā)者體驗(yàn)改進(jìn)——例如預(yù)提交或設(shè)置 CI

• MAINT: 很多不同的東西。性能改進(jìn)肯定是這里最有趣的變化。重構(gòu)也是如此。

• STY: 風(fēng)格改變。使 PyPDF2 代碼更加一致的東西。通常是一個(gè)小的變化。

基準(zhǔn)

我們需要關(guān)注性能，因此我們有一些基準(zhǔn)。

參見(jiàn)py-pdf.github.io/PyPDF2/dev/bench