Üretim kodunda yanlış adlandırılmış bir fonksiyonla nasıl başa çıkılır?

Geçenlerde GitHub'daki bir Python kütüphanesine rastladım. Kitaplık harika, ancak bir işlev adında göze çarpan bir yazım hatası var. dummy_fuction()Olması gerektiği gibi arayalım dummy_function(). Bu işlev kesinlikle "vahşi" durumda ve gömülü sistemlerde büyük olasılıkla kullanılıyor.

İlk akla gelen şey, işlevin ikinci bir sürümünü doğru adla eklemek ve bir sonraki sürüm için ilk sürüme bir kullanımdan çıkarma uyarısı eklemek.

Üç soru:

1. Yukarıdaki yaklaşımın istenmeyen herhangi bir sonucu olabilir mi?
2. Bu tür bir soruna standart bir yaklaşım var mı?
3. Herhangi bir amortisman uyarısı ne kadar süre yerinde bırakılmalıdır?

İlk ve en önemlisi, politika koruyucuya bağlıdır.

Bence sorunuz ilginç ama çoğunlukla görüşe dayalı.

Benim kişisel görüşüme göre yaklaşımınız sağlam - işlevi yeniden adlandırın ve yanlış yazılmış sürümü doğru olana yönlendirerek kullanımdan kaldırılmış bir eser olarak bırakın.

Yukarıdaki yaklaşımın istenmeyen herhangi bir sonucu olabilir mi?

Örneğin kodu kırabilir. Birisi yanlış hecelemeye dayanamıyorsa ve yeniden adlandırılmış bir versiyonunu uyguladıysa. Şimdi kütüphaneyi güncellediklerinde bir isim çatışması olacak.

Bu tür bir soruna standart bir yaklaşım var mı?

Bir kütüphane yazarken yazım hataları yapmayın;)

Herhangi bir amortisman uyarısı ne kadar süre yerinde bırakılmalıdır?

İtirazın bir sonraki ana sürüme kadar yerinde bırakılması gerektiğine inanıyorum (sürüm numarasındaki ilk rakam arttığında).

Bu, bazı - gerekçelendirilmiş - geriye dönük uyumluluk ihlallerinin tolere edilebildiği ve kodlarının hala iyi bir şekilde yapıldığından emin olmak için kütüphane kullanıcılarının görevidir.

Sadece değişimin içinde bulunduğundan emin olun: beyler, kullandıysanız dummy_fuction, dummy_functionher yerle değiştirin ve gitmeniz iyi olur.

Kitaplık sürümlü değilse, olduğu gibi - sürümlendirmeye başlamak için iyi bir durumdur.