[Python] 자동으로 UML Class Diagram 만들기

Eugene CHOI·2021년 7월 2일
2

Python

목록 보기
1/2
post-thumbnail

파이썬 프로젝트를 하다보면 프로그램의 규모가 커지고 구조화 되어 갈수록 각 클래스의 attribute를 정리할 필요가 있습니다.
지금까지는 ppt나 draw.io같은 다이어그램을 그릴 수 있는 툴을 이용하여 직접 일일이 그렸는데, 조금의 수정사항만 생겨도 많이 고쳐야 하는 불편함이 있었습니다.

하지만 pyreverse 패키지를 사용하면 그림을 그릴 필요 없이 간단하게 특정 파이썬 파일의 UML Class Diagram을 생성할 수 있습니다.
pyreverse 패키지는 pylint 패키지 안에 포함되어 있기 때문에 pylint 패키지를 설치합니다.

그리고 graphviz를 이용하여 시각화 하기 때문에 따로 설치하여 주어야 합니다. 윈도우, 우분투 모두 설치 후 반드시 환경변수 설정을 해 주세요.


Install Pylint

아래 세 가지 방법 중 하나를 사용하세요.

  1. pip를 이용한 설치

    $ pip install  pylint
  2. conda를 이용한 설치

    $ conda install  pylint
  3. conda와 anaconda 채널을 통하여 설치

    $ conda install -c anaconda pylint

How to Use

다음과 같은 argument를 이용하여 간단하게 만들 수 있습니다.

$ pyreverse -o "확장자명" "폴더 혹은 경로명"

example

$ pyreverse -o png ./A2C_SERIAL.py   
parsing .\A2C_SERIAL.py...

Result

profile
Hi, my name is Eugene CHOI the Automotive MCU FW developer.

2개의 댓글

comment-user-thumbnail
2021년 10월 27일

좋은 글 감사합니다. 올려주신 글을 따라하다가 하나의 문제가 발생했는데요. 생성되는 png파일을 열면 하얗게만 나옵니다. 혹시 해결하는 방법 있을까요? (graphviz, pylint, graphviz의 환경변수 설정 모두 완료했습니다.) (graphviz의 버전은2.49.2입니다.)

1개의 답글