PyCharm 2016.3 Help

Viewing Diagram

On this page:

Prerequisites

Before you start working with UML diagrams, make sure that the UML Support plugin is enabled. The plugin is bundled with PyCharm and is activated by default. If it is not, enable the plugin as described in Enabling and Disabling Plugins.

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 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+U or Ctrl+Alt+U.
  3. From the pop-up list, choose the diagram type:
    /help/img/idea/py_select_diagram_type.png

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

/help/img/idea/py_showClassDiagram.png

Tips and tricks

  • You can open a UML class diagram without using your pointing device. Consider such a workflow: press Alt+Home, then press Ctrl+Alt+U.
  • 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+U:
    /help/img/idea/py_package_diagram.png

See Also

Language and Framework-Specific Guidelines:

Last modified: 23 November 2016