Arama Grafiği Çizme

Python ile yazılmış eski bir kod tabanı koruyorum. Özellikle, bir modülden diğer modülleri diğer fonksiyonları çağıran diğer fonksiyonları çağıran karmaşık bir kod parçası vardır. OOP değil, sadece fonksiyonlar ve modüller.
Ana işlevi çağırdığımda akışın başladığı ve bittiği yeri takip etmeye çalıştım ama alt çizimlerde kaybolmaya çalıştığım için bunu çizmem gerektiğini hissediyorum.

Beni ilgilendiren, her işlevin, görevlerini tamamlamak ve değeri arayana geri döndürmek için vücutlarında birden çok dış işlevi çağırmasıdır.

Bunu nasıl çizebilirim? Bu tür davranışları / kodları belgelemek için ne tür bir grafik / grafik uygun olur?

Dolayısıyla, ne bir akış şeması ne de UML diyagramı çizmenin yararlı olacağını düşünmüyorum. Bir çağrı grafiği, belki?

Burada aradığınızın bir Dizi Diyagramı olduğunu düşünüyorum . Bunlar, çeşitli modüllerin okları kullanarak birbirlerini arama sırasını görselleştirmenizi sağlar.

Birini inşa etmek basittir:

1. Başlangıç ​​sınıfınızı altında noktalı bir çizgi ile çizin.
2. Arama izlemesindeki bir sonraki sınıfı / yöntemi, bunun altında noktalı bir çizgi ile çizin
3. Çizgileri, çizdiğiniz son okun altına dikey olarak konumlandırılmış bir okla bağlayın
4. İzinizdeki tüm aramalar için 2-3. Adımları tekrarlayın

Misal

Diyelim ki aşağıdaki kod için bir dizi diyagramı oluşturmak istiyoruz:

def long_division(quotient, divisor):
    solution = ""
    remainder = quotient
    working = ""
    while len(remainder) > 0:
        working += remainder[0]
        remainder = remainder[1:]
        multiplier = find_largest_fit(working, divisor)
        solution += multiplier
        working = calculate_remainder(working, multiplier, divisor)
    print solution


def calculate_remainder(working, multiplier, divisor):
    cur_len = len(working)
    int_rem = int(working) - (int(multiplier) * int (divisor))
    return "%*d" % (cur_len, int_rem)


def find_largest_fit(quotient, divisor):
    if int(divisor) == 0:
        return "0"
    i = 0
    while i <= 10:
        if (int(divisor) * i) > int(quotient):
            return str(i - 1)
        else:
            i += 1


if __name__ == "__main__":
    long_division("645", "5")

Çizeceğimiz ilk şey main, yönteme bağlanan giriş noktası ( ) long_division. Bunun, yöntem çağrısının kapsamını belirten long_division'da bir kutu oluşturduğunu unutmayın. Bu basit örnek için, kutu, çalıştırılan tek şey olması nedeniyle dizi şemamızın tüm yüksekliği olacaktır.

Şimdi find_largest_fitçalışma numaramıza uyan ve bize geri dönen en büyük katıyı bulmaya çağırıyoruz . Biz bir çizgi çizmek long_divisioniçin find_largest_fitişlev çağrısı için kapsamını belirtmek için başka bir kutu ile. Çarpan döndürüldüğünde kutunun nasıl bittiğine dikkat edin; bu fonksiyonların kapsamının sonu!

Daha büyük bir sayı için birkaç kez tekrarlayın ve grafiğiniz aşağıdaki gibi görünmelidir:

notlar

Çağrıları değişken adları geçirilmiş olarak mı yoksa yalnızca belirli bir vakayı belgelemek istiyorsanız değerleriyle mi etiketlemek istediğinizi seçebilirsiniz. Kendini çağıran bir işlevle özyineleme de gösterebilirsiniz.

Ayrıca, kullanıcıları burada gösterebilir ve onlara bilgi verebilir ve sisteme girdilerini yeterince kolayca gösterebilirsiniz. Oldukça esnek bir sistem olduğunu düşünüyorum.

Bence bir çağrı grafiği en uygun görselleştirme olurdu. Elle yapmamaya karar verirseniz pyan, bir python dosyasında statik analiz yapan ve bir grafikviziti dosyası (bir görüntüye dönüştürülebilir) aracılığıyla görselleştirilmiş bir çağrı grafiği oluşturabilen güzel bir küçük araç vardır . Birkaç çatal var, ancak en tam özellikli olanı https://github.com/davidfraser/pyan gibi görünüyor .

Komutu çalıştırdığınızda işlenmesini istediğiniz tüm dosyaları belirtmeniz yeterlidir:

python ~/bin/pyan.py --dot a.py b.py c.py -n > pyan.dot; dot -Tpng -opyan.png pyan.dot

veya

python ~/bin/pyan.py --dot $(find . -name '*.py') -n > pyan.dot; dot -Tpng -opyan.png pyan.dot

Bir fonksiyonun nerede tanımlandığını gösteren çizgileri kaldıran '-n' ile grafiği daha temiz yapabilirsiniz.