Python クラス図について

Question

ソースコードの内容というか各ソースファイルにあるクラスや関数を視覚的に分かるようにまとめたいです。

そこでクラス図というのがあるそうですが、このクラスというのはソースコードの class に該当するものですか？
この場合、クラスのないソースコードは表現できないということでしょうか？
（クラスを使わないプログラムがそもそも望ましくない？）

クラスを使っていないソースファイルの関係性をまとめるにはオリジナルな描き方になってしまうのでしょうか？
それとも他に表現可能なUMLなど図法があるのでしょうか？

Answer 1

クラスを使うべきか？という疑問が出るのなら、まずはクラスの概念やメリットを勉強したほうがいいでしょう。必ず使うべきというものでもありません。
また、クラス図に何を求めるかはあなたにしか判断できないと思うので、試してみるのが一番でしょう。
一例(pyreverse)
ソースコードからドキュメントを起こすのが目的であれば、そのソースコードの作りに依存するため、何がベストとは言えないでしょう。

Answer 2

doxygen 等のツールによりソースコードから自動生成出来ます。
ソースコードを解析して得られるものは通常 classで定義したものに限ります。
以下のように、動的(実行時)に生成されるクラスは含まれません。

• type や namedtuple により生成したクラス。(コメントで補足可能)
• eval や compile で生成されるもの。(出来れば避けるべき)

クラスに所属しない関数に関しては、クラス図はありませんが、
実行時の呼び出し情報等を元にしたコールグラフといったものもあります。

---

実体はクラスだが、動的に生成される為ドキュメントではクラスと扱われないものの例。
通常は動的に生成した Point, C クラスはVariable に分類される。

コメントにより情報を補足すればクラスとしての扱いは可能。
但し、静的解析では必要な情報を得られない為、
継承元のクラス等をドキュメント内でも再度指定する必要があります。

---

解析対象としたコードのサンプル

# sample.py


from collections import namedtuple

class A:
    """
    @class A
    @brief sample A class
    """
    def foo(self):
        pass

class B(A):
    """
    @class B
    @brief sample B class
    """
    def bar(self):
        pass

##
# @class Point
# @brief Point class
Point = namedtuple("Point", "x,y")

##
# @class C
# @inherit B
C = type("C", (B,), {})