Backend geliştirme kurulumu¶
Bu sayfa, Gramps Web'in backend'ini (sunucu bileşeni) geliştirmeye başlamak için gereken adımları listeler: Gramps Web API.
Ön koşullar¶
Önerilen geliştirme kurulumu, devcontainers ile Visual Studio Code kullanmaktadır. Bu yaklaşım, ihtiyaç duyduğunuz tüm araçlarla önceden yapılandırılmış bir geliştirme ortamı oluşturacaktır. Başlamak için aşağıdaki bileşenlere ihtiyacınız olacak:
İşletim sistemi olarak Linux, macOS veya Windows kullanabilirsiniz.
Başlarken¶
- Gramps Web API deposunu açın ve "fork" butonuna tıklayın.
- Forkladığınız depoyu yerel makinenize Git kullanarak klonlayın.
- Klonlanan depoyu Visual Studio Code'da açın. İstendiğinde "Container'da Yeniden Aç" seçeneğini seçin veya komut paletini manuel olarak açın (Ctrl+Shift+P veya Cmd+Shift+P) ve "Dev Containers: Yeniden Oluştur ve Container'da Yeniden Aç" seçeneğini seçin.
- Geliştirici konteynerinin oluşturulmasını ve başlamasını bekleyin. Bu, özellikle ilk kez birkaç dakika sürebilir.
Görevler¶
Eğer yalnızca backend kodunu değiştiriyorsanız, bir web sunucusu başlatmanıza gerek yoktur - birim testleri, çalışır durumda bir sunucuya ihtiyaç duymadan API'ye istek simüle etmeye olanak tanıyan bir Flask test istemcisi kullanır.
Ancak, bir sunucu çalıştırmak faydalıdır eğer
- Değişikliklerinizi gerçek HTTP istekleri ile denemek istiyorsanız (bkz. manuel sorgular),
- Değişikliklerin etkisini tam Gramps Web uygulamasında önizlemek istiyorsanız veya
- Aynı zamanda frontend'de de değişiklikler yapmak istiyorsanız (bkz. frontend geliştirme kurulumu).
Sunucunun çalıştırılması, önceden tanımlanmış görevlerle geliştirici konteynerinde basitleştirilmiştir. Bu görevleri komut paletinden (Ctrl+Shift+P veya Cmd+Shift+P) "Görevler: Görev Çalıştır" seçeneğini seçerek ve ardından aşağıdakilerden birini seçerek çalıştırabilirsiniz: - "Web API'yi Sun" - Flask geliştirme sunucusunu 5555 numaralı portta hata ayıklama günlüğü etkin olarak başlatır. - "Celery işçisini Başlat" - arka plan görevlerini işlemek için bir Celery işçisi başlatır.
Hata Ayıklama¶
Hata ayıklama bazen zorlu olabilir, özellikle karmaşık davranışları izlemeye veya ince sorunları tanımlamaya çalışırken. Bunu kolaylaştırmak için, hem çalışan bir API örneğini hem de bireysel test durumlarını doğrudan Visual Studio Code içinde hata ayıklayabilirsiniz.
Gramps Web API'yi Hata Ayıklama¶
Çalışan API'yi hata ayıklamak için:
- Visual Studio Code'u açın ve Çalıştır ve Hata Ayıkla görünümüne gidin.
- Açılır menüden "Web API" yapılandırmasını seçin.
- Hata ayıklamayı başlatın.
- Backend'e istek gönderdiğinizde (ister manuel olarak ister Gramps Web GUI aracılığıyla), kodda ayarladığınız herhangi bir kesme noktasında yürütme duracaktır.
Bu, değişkenleri, kontrol akışını ve diğer çalışma zamanı ayrıntılarını incelemenizi sağlar.
Test Durumlarını Hata Ayıklama¶
Belirli bir test durumunu hata ayıklamak için:
- Hata ayıklamak istediğiniz test dosyasını açın (örneğin,
test_people.py). - Visual Studio Code'da Çalıştır ve Hata Ayıkla görünümünü açın.
- "Mevcut Test Dosyası" yapılandırmasını seçin.
- Hata ayıklamayı başlatın — yürütme, o test dosyasında ayarlanan herhangi bir kesme noktasında duracaktır.
Bu kurulum, test mantığını adım adım incelemenizi, değişken değerlerini gözlemlemenizi ve test hatalarını veya beklenmedik sonuçları daha iyi anlamanızı sağlar.