プロジェクトステータスのマーカ群

注釈

この仕様は、元々は PEP 792 で定義されました。

注釈

PEP 792 には、 HTML および JSON API に対する変更が含まれます。これらの変更は、 HTML - プロジェクトの詳細 と JSON - プロジェクトの詳細 のもとで シンプルなリポジトリ API の中で文書化されています。

仕様

プロジェクトは、常にただひとつの状態 <status> を持ちます。状態が明示的に示されていない場合は、プロジェクトは active 状態にあるものと見做されます。

インデックスは、自らの必要に応じて、指定された状態 <status> のマーカーのサブセットを実装しても 構いません 。

この標準は、 どの 主導者 (すなわち、プロジェクト保守者、インデックス管理者、その他) が、どの状態 <status> を設定したり設定解除したりすることを許されるかについて規定するものではありません。

active

説明: プロジェクトはアクティブです。これは、プロジェクトのデフォルトの状態です。

インデックスでの意味:

  • プロジェクトをホストしているインデックスは、 プロジェクトに対する新たな配布物のアップロードを許さなければ なりません 。

  • インデックスは、プロジェクトの既存の配布物をダウンロード用に提供しなければ なりません 。

インストーラの意味論: なし。

archived

説明: 当該プロジェクトは、将来において更新されることが期待できません。

インデックスでの意味:

  • プロジェクトをホストするインデックスは、プロジェクトの新しい配布物のアップロードを許しては なりません 。

  • インデックスは、プロジェクトの既存の配布物をダウンロード用に提供しなければ なりません 。

インストーラの意味論:

  • インストーラは、プロジェクトの古い記録 <archival> について警告を発生させても 構いません 。

quarantined

説明: プロジェクトは、たとえばマルウェアなどのせいで、一般に使用には安全ではないと考えられています。

インデックスでの意味:

  • プロジェクトをホストするインデックスは、プロジェクトの新しい配布物のアップロードを許しては なりません 。

  • インテックスは、 当該プロジェクトの配布物をどれひとつとしてダウンロード用に提供しては なりません 。

インストーラの意味論:

  • (インデックスがインストール用に配布物を提供することがないので) そのようにしても現実的には意味はありませんが、インストーラは、プロジェクトの検疫について警告を発生させても 構いません 。

deprecated

説明: プロジェクトは使われなくなった <obsolete> ものと見做されており、すでに他のプロジェクトによって代替されているかもしれません。

インデックスでの意味:

  • この状態は、 active 状態と意味を同じくします。

インストーラの意味論:

  • インストーラは、プロジェクトが非推奨であることについて警告を発生させても 構いません 。