PyPDF2 棄用過(guò)程

語(yǔ)義版本控制

PyPDF2 使用語(yǔ)義版本控制。如果您想避免破壞性更改，請(qǐng)使用依賴(lài)固定（也稱(chēng)為版本固定）。在 Python 中，這是通過(guò)在文件中指定要使用的確切版本來(lái)完成的 requirements.txt?？梢灾С帜墓ぞ?code>pip-compile來(lái)自 pip-tools.

如果您使用的是Poetry，則文件已完成 poetry.lock。

PyPDF2 如何棄用功能

假設(shè) PyPDF2 的當(dāng)前版本是x.y.z. 經(jīng)過(guò)討論（例如通過(guò) GitHub 問(wèn)題），我們決定刪除一個(gè)類(lèi)/函數(shù)/方法。這是我們的做法：

1. x.y.(z+1): 添加棄用警告。如果有替換，也會(huì)引入替換，并且警告會(huì)告知更改及其發(fā)生的時(shí)間。這些文檔讓用戶(hù)了解棄用、棄用的時(shí)間和新功能。CHANGELOG 通知它。

2. (x+1).0.0：通過(guò)將 DeprecationWarnings 替換為 DeprecationErrors，以破壞性方式刪除/更改代碼。我們這樣做是為了幫助那些以前沒(méi)有看過(guò)警告的人。CHANGELOG 通知它。

3. (x+2).0.0：刪除了 DeprecationErrors。

這意味著用戶(hù)在 CHANGELOG 中有 3 個(gè)警告，一個(gè) DeprecationWarning 直到下一個(gè)主要版本，一個(gè) DeprecationError 直到那個(gè)之后的主要版本。

請(qǐng)注意，添加警告對(duì)于某些用戶(hù)來(lái)說(shuō)可能是一項(xiàng)重大更改；很可能只是在 CI 中。這意味著需要對(duì)其進(jìn)行適當(dāng)記錄。