API-stabilitet¶
Django Ă€r engagerat i API-stabilitet och framĂ„tkompatibilitet. I ett nötskal betyder detta att kod som du utvecklar mot en version av Django kommer att fortsĂ€tta att fungera med framtida utgĂ„vor. Du kan behöva göra mindre Ă€ndringar nĂ€r du uppgraderar den version av Django som ditt projekt anvĂ€nder: se avsnittet âBakĂ„tkompatibla Ă€ndringarâ i release note för den version eller de versioner som du uppgraderar till.
Samtidigt som API-stabilitet Ă€r en mycket hög prioritet, Ă€r Django ocksĂ„ engagerat i stĂ€ndiga förbĂ€ttringar, tillsammans med mĂ„let att âett sĂ€tt att göra detâ (sĂ„ smĂ„ningom) i de API: er vi tillhandahĂ„ller. Detta innebĂ€r att nĂ€r vi upptĂ€cker klart överlĂ€gsna sĂ€tt att göra saker, kommer vi att avskriva och sĂ„ smĂ„ningom ta bort de gamla sĂ€tten. VĂ„rt mĂ„l Ă€r att tillhandahĂ„lla ett modernt, pĂ„litligt webbramverk av högsta kvalitet som uppmuntrar till bĂ€sta praxis i alla projekt som anvĂ€nder det. Genom att anvĂ€nda stegvisa förbĂ€ttringar försöker vi undvika bĂ„de stagnation och stora omvĂ€lvande uppgraderingar.
Vad âstabilâ innebĂ€r¶
I detta sammanhang betyder stabil:
Alla offentliga API:er (allt i den hÀr dokumentationen) kommer inte att flyttas eller byta namn utan att tillhandahÄlla bakÄtkompatibla alias.
Om nya funktioner lĂ€ggs till i dessa API:er - vilket Ă€r fullt möjligt - kommer de inte att bryta eller Ă€ndra betydelsen av befintliga metoder. Med andra ord betyder âstabilâ inte (nödvĂ€ndigtvis) âkomplettâ
Om ett API som förklarats stabilt av nÄgon anledning mÄste tas bort eller ersÀttas, kommer det att förklaras som förÄldrat men kommer att finnas kvar i API:et i minst tvÄ funktionsversioner. Varningar kommer att utfÀrdas nÀr den förÄldrade metoden anropas.
Se Officiella utgivningar för mer information om hur Djangos versionsnumreringssystem fungerar och hur funktioner kommer att avskrivas.
Vi kommer endast att bryta bakÄtkompatibiliteten för dessa API:er utan en utfasningsprocess om en bugg eller ett sÀkerhetshÄl gör det helt oundvikligt.
Stabila API:er¶
I allmÀnhet anses allt som omfattas av dokumentationen - med undantag för allt som finns i internals-omrÄdet - vara stabilt.
Undantag¶
Det finns nÄgra fÄ undantag frÄn detta löfte om stabilitet och bakÄtkompatibilitet.
SÀkerhetsfixar¶
Om vi blir medvetna om ett sÀkerhetsproblem - förhoppningsvis genom att nÄgon följer vÄr sÀkerhetsrapporteringspolicy - kommer vi att göra allt som krÀvs för att ÄtgÀrda det. Detta kan innebÀra att vi bryter bakÄtkompatibiliteten; sÀkerhet trumfar kompatibilitetsgarantin.
API:er markerade som interna¶
Vissa API:er Ă€r uttryckligen markerade som âinternaâ pĂ„ ett par olika sĂ€tt:
I viss dokumentation hÀnvisas till interndelar och de omnÀmns som sÄdana. Om det i dokumentationen stÄr att nÄgot Àr internt förbehÄller vi oss rÀtten att Àndra det.
Funktioner, metoder och andra objekt som inleds med ett inledande understreck (
_). Detta Àr Pythons standardmetod för att ange att nÄgot Àr privat; om en metod börjar med en enda_Àr det ett internt API.