Pycharm
 
2023.3
快捷方式：Windows
获取 PyCharm
  1. 使用源代码
  2. UML 类图

专业的
UML 类图

最后修改时间：2023 年 12 月 4 日

右键单击类文件或包并选择图表| 显示图表| 显示图表弹出窗口。

启用图表插件

此功能依赖于图表插件，该插件默认在 PyCharm 中捆绑并启用。如果相关功能不可用，请确保您没有禁用该插件。

  1. 按打开 IDE 设置，然后选择插件。CtrlAlt0S

  2. 打开“已安装”选项卡，找到“图表”插件，然后选中插件名称旁边的复选框。

PyCharm 允许您在项目中的包上生成图表。此类图始终反映应用程序中实际类和方法的结构。

查看 UML 类图

  1. 在“项目”工具窗口中，右键单击要为其创建图表的项目，然后选择“图表”|“图表”。显示图表 ）。CtrlAltShift0U

  2. 在打开的列表中，选择Python 类图。PyCharm 生成类及其依赖项的 UML 图。

您可以使用 UML 类图来评估本地代码更改如何影响应用程序。

  • 从代码编辑器、 Project工具窗口或 Changes视图的上下文菜单中，选择Show Local Changes as UML，或按。CtrlAltShift0D

    该图在弹出窗口中打开。您可以双击节点以在差异查看器中查看更改。

要以 UML 类图的形式查看修订版中的更改，请在版本控制工具窗口的历史记录选项卡中，选择所需修订版并从上下文菜单中选择将差异显示为 UML或按。CtrlShift0D

分析类图

提示

您可以按元素来查看图表元素列表并在它们之间导航。CtrlF12

要查看方法、字段和其他代码元素的列表，请选择图表编辑器顶部的图表工具栏上的相应图标。

Py 类依赖

当您单击图中的类时，PyCharm 会将不在同一包中的类显示为灰色。当您在包含内部包的包上生成图表时，这可能会有所帮助。

要将图表另存为文件，请右键单击图表编辑器，然后从上下文菜单中选择“导出图表”|“导出图表”。导出到文件，然后是要保存图表的文件扩展名。

管理类图

使用图表时，使用图表编辑器中的上下文菜单来执行不同的任务。您可以查看类的成员、添加新成员、删除现有成员、查看实现、检查父类、执行基本重构、添加注释等。

您可以通过选择图表元素并按) 导航到底层源代码。F4

  • 要选择一个元素，请在图表中单击它。

  • 要选择多个相邻元素，请按住并单击所需的元素，或者仅在要选择的元素周围拖动套索。Shift

  • 要选择多个不相邻的元素，请按住并单击所需的元素。CtrlShift

  • 要选择类成员，请双击类元素，然后使用箭头键或鼠标指针。

将现有类添加到图表中

  1. 按。Space

  2. 在打开的搜索字段中，开始输入要添加的类的名称。然后，从建议列表中选择所需的课程。

    /help/img/idea/2023.3/py_umlPopup.png
    动图

    如果要添加超出项目范围的类，请选中“包括非项目项”复选框。

从图中删除节点元素

  1. 在图表编辑器中，选择要删除的节点元素。

  2. 右键单击该元素，然后从上下文菜单中选择“删除” 。Delete

    或者，选择重构 | 安全删除 。在这种情况下，PyCharm在应用更改之前会检查用法。AltDelete

提示

您可以通过按代码元素快速搜索用法。AltF7

添加新成员到班级

您可以在图表编辑器中执行一些正向工程。

  1. 在图表编辑器中，选择要添加新成员的类，然后从上下文菜单中选择“新建”或按。然后选择要创建的代码元素（字段或方法）。AltInsert

  2. 根据您的选择，PyCharm 将打开相应的对话框，您可以在其中指定创建新元素所需的信息。

PyCharm 将该项目添加到您的图表中并相应地更新源代码。

查看实现和父类

您可以在图表中查看实现和父类。如果 PyCharm 找到多个父类或实现，它会显示相应项目的列表。选择您需要查看父项与其子项之间的联系的一项。

  1. 在图表编辑器中，选择您想要查看其实现或父类的项目。

  2. 右键单击这些项目，然后从上下文菜单中分别选择“显示实现” 或“显示父级”。CtrlAlt0B CtrlAlt0P

  3. 在打开的弹出窗口中，选择您需要的项目并按。要在弹出窗口中向上或向下扩展您的选择，请分别按或。EnterShift+UpShift+Down

配置图表设置

您可以配置图表设置，以便在创建图表时默认情况下可以使用某些选项。

  1. 按打开 IDE 设置，然后选择“工具”|“IDE”。图表。CtrlAlt0S

  2. 在右侧窗格中，选择默认情况下要查看的选项，然后单击“确定”应用更改。

分析图表

分析图操作组允许您以各种方式分析图，例如执行自动聚类、测量节点中心性、搜索周期、过滤两个节点之间的路径等。

过滤两个节点之间的路径

大多数时候，生成的图表又大又复杂。通常，您只想专注于图表的特定部分。PyCharm 允许您过滤两个图表元素之间的路径。

  1. 在图表编辑器中，选择要关注的两个节点，然后右键单击其中之一以打开上下文菜单。

  2. 从上下文菜单中，选择分析图表 | 关注两个节点之间的路径。

    笔记

    如果您不仅要关注两个节点，还要关注所选节点与其邻居的连接方式，请从上下文菜单中选择“关注节点邻居”选项。

  3. 在打开的对话框中，根据需要选择其他选项，然后单击“查找”。

    PyCharm 显示仅与选定节点关联的连接。

测量图的中心性

您可以使用此操作来识别图中的重要节点。

  1. 在图表编辑器中，右键单击编辑器中的任意位置以打开上下文菜单。

  2. 从上下文菜单中，选择分析图表 | 衡量中心性。

  3. 在打开的对话框中，根据需要选择其他选项，然后单击“测量”。

    节点“重要性”通过从 0.0 到 1.0 测量的分数值来表示，并且应首先探索最亮的节点选择。

提示

按取消操作。Ctrl0Z

生产力技巧

启用图表预览

打开结构工具窗口并拖动阴影区域以获得所需的视图。选择图中的一个或多个节点以在预览区域中突出显示相应的节点。Alt07

管理图表布局

右键单击图表背景，然后从上下文菜单中选择“布局” 。然后从子菜单中选择所需的布局。要应用选定的布局，请单击应用当前布局按钮图表工具栏上的 。

或者，手动拖动图中的实体以实现所需的布局。

放大和缩小

使用以下任一技术：

  • 单击图表编辑器工具栏上的放大按钮和。缩小按钮

  • 按住并旋转鼠标滚轮。Ctrl

  • 按或。NumPad +NumPad -

使用放大镜工具

按住鼠标，将鼠标悬停在图表区域上。Alt

以图表形式查看数据库或表的结构

在数据库工具窗口中，右键单击架构或表，然后选择图表|图表。显示可视化 或图表 | 从上下文菜单中显示可视化弹出窗口。CtrlAltShift0U CtrlAlt0U

以图表形式查看 SQL 查询计划

在编辑器中，右键单击 SQL 语句并选择解释计划。然后，在“输出”窗格中，切换到“计划”选项卡。默认情况下，查询显示为树。要将其以图表形式查看，请单击“显示可视化” ( 显示可视化按钮) 或按。CtrlAltShift0U

物品

描述

领域

单击此按钮可显示类节点中的字段。

方法

单击此按钮可显示类节点中的方法。

内部类

单击此按钮可在类节点中显示内部类。

放大

单击此按钮可增加图表的比例，或按。NumPad +

缩小

单击此按钮可缩小图表比例，或按。NumPad -

实际尺寸

单击此按钮可恢复图表的实际大小。

适合内容

单击此按钮可使内容适合当前图表大小。

应用当前布局

单击此按钮应用从图表的上下文菜单中选择的当前布局，或按。F5

路线边缘

单击此图标可将图表缩放到窗口的边缘。

将图表复制到剪贴板

单击此图标可将图表复制到剪贴板中。

将所选内容复制到剪贴板

单击该图标，然后用鼠标选择任意图表区域：所选区域将被复制到剪贴板中。

保存图表

单击此按钮可将当前图表另存为UML文件。

导出图

单击此图标可使用与第三方工具兼容的各种格式将图表导出到文件、图像或在浏览器中打开图表。

导出图

您可以选择并配置以下选项：

  • 在网页编辑器中打开：单击此按钮可选择可以将图表导出到的第三方编辑器。

  • 将图表复制到剪贴板：单击此按钮可使用一种可用格式将图表保存到剪贴板。

  • 保存图表：单击该按钮将当前图表保存为文件。您可以使用列表中的一种可用格式。

  • 保存图片：单击该按钮可将当前图表保存为PNG 格式。

  • 打印：单击此按钮打印图表。

打印

单击此按钮可打印图表。

下表包含工具栏上不可用的命令。

物品

描述

新的

使用此节点向图表添加新元素。

显示类别

显示或隐藏方法、内部类和字段等类别。

将类添加到图表中

允许将现有类添加到图中。开始输入类名称并从完成列表中选择目标项目。

删除

删除选定的图表。

重构

该节点包含在当前上下文中启用的重构命令。

跳转至源代码

选择此命令可在编辑器中打开选定的图节点元素。

查找用法

选择此命令可搜索所选节点元素的用法。

实际尺寸

恢复图表的实际大小

适合内容

使内容适合当前图表大小。

布局

从子菜单中选择所需的图表布局。

方向

为您提供以下方向选项：从下到上、从上到下、

应用当前布局

应用从图表上下文菜单的“布局”节点中选择的当前布局

路线边缘

将图表内容缩放到图表窗口的边缘。

外貌

通过显示网格、边缘标签、桥来管理图表的呈现方式。允许您合并边缘并选择边缘形状。

对齐网格。

将元素与网格对齐。

布局后适合内容

选择布局后适合图表内容。默认启用。

将图表复制到剪贴板

单击此图标可将图表复制到剪贴板中。

将所选内容复制到剪贴板

单击该图标，然后用鼠标选择任意图表区域：所选区域将被复制到剪贴板中。

导出到图像文件

使用指定的名称和路径将图表保存在图像文件中。可能的格式有：jpeg、png、svg、svgz或gif。

打印

打印图表。

保存 UML 图

将当前图表保存在指定位置作为xml文件。

PyCharm在显示类之间的关系时遵循UML 约定。

除此之外，PyCharm 支持以下颜色和箭头：

物品

描述

实施

绿色箭头对应于implements类声明中的子句。

延伸

蓝色箭头对应于类扩展。

内部类

这个标志出现在内部类中。