PyCharm 4.0.0 Web Help

Some features described here are available in the Professional edition only.

In this section:

Basics

You can invoke UML class diagram from different places:

  • From the various tool windows.
  • From the Navigation bar.
  • From the Structure tool window.
  • From the editor.

PyCharm displays UML diagrams in two modes:

  • In a pop-up window.
  • In a separate editor tab.

PyCharm makes is possible to choose diagram type:

  • Python class diagram
  • Django model dependency diagram (for the Django projects).
  • Google App Engine model dependency diagram (for the Google App Engine projects).

Opening diagram

To open a UML class diagram
  1. Select the desired item, or open it in the editor.
  2. Do one of the following:
    • On the context menu of the selection, click Diagram, and on the submenu, select the way you want to view the model: Show Diagram or Show Diagram Pop-up.
    • Press Ctrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UCtrl+Shift+Alt+UShift Alt ⌘ UShift Alt ⌘ UShift Alt ⌘ U or Ctrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UAlt ⌘ UAlt ⌘ UAlt ⌘ U.
  3. From the pop-up list, choose the diagram type:

    py_select_diagram_type

The diagram is displayed in the editor tab or in the pop-up window:

py_showClassDiagram

Tip

You can open UML class diagram without using your pointing device. Consider such workflow: press Alt+HomeAlt+HomeAlt+HomeAlt+HomeAlt+HomeAlt+HomeAlt+HomeAlt+Home⌘ Up or Alt HomeAlt HomeAlt ⌘ B, then press Ctrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UAlt ⌘ UAlt ⌘ UAlt ⌘ U.

3.0+

Tip

It is possible to view a UML class diagram of a Python package. Just select a Python package in the Project tool window, and press Ctrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UCtrl+Alt+UAlt ⌘ UAlt ⌘ UAlt ⌘ U:

py_package_diagram

See Also

Language and Framework-Specific Guidelines:

Reference:

Web Resources: