Dearpygui入门指南

Getting Started

What is Dear PyGui

Dear PyGui is a simple to use (but powerful) Python GUI framework. Dear PyGui provides a wrapping of Dear ImGui that simulates a traditional retained mode GUI, as opposed to Dear ImGui’s immediate mode paradigm.

Under the hood, Dear PyGui uses the immediate mode paradigm allowing for extremely dynamic interfaces. Similar to PyQt, Dear PyGui does not use native widgets but instead draws the widgets using your computer’s graphics card (using Directx11, Metal, and Vulkan rendering APIs).

In the same manner Dear ImGui provides a simple way to create tools for game developers, Dear PyGui provides a simple way for python developers to create quick and powerful GUIs for scripts.

Why use Dear PyGui

When compared with other Python GUI libraries Dear PyGui is unique with:

• GPU Rendering
• Simple built-in Asynchronous function support
• Complete theme and style control
• Simple built-in logging window
• 70+ widgets with hundreds of widget combinations
• Detailed documentation, examples and unparalleled support

Installing

Ensure you have at least Python 3.6 (64 bit) installed.

pip install dearpygui

First Run

A variety of examples demonstrating usage can be found in the Examples folder on github. Documentation can be found here and also from within the library by using the show_documentation() command.

Using Dear PyGui is a simple as creating a python script like the one below

The main script must always conclude with start_dearpygui().

Code:

import dearpygui.dearpygui as dpg

def save_callback():
    print("Save Clicked")

with dpg.window(label="Example Window"):
    dpg.add_text("Hello, world")
    dpg.add_button(label="Save", callback=save_callback)
    dpg.add_input_text(label="string", default_value="Quick brown fox")
    dpg.add_slider_float(label="float", default_value=0.273, max_value=1)
dpg.start_dearpygui()

Result:

Basic

Creating Widgets

DPG items can be broken down into :

• regular items (i.e. inputs, buttons)
• container items (i.e. window, popup, tooltip, child)
• layout items (i.e. group, next_column)
• Items are added with their respective add_*** commands or context
  managers.

New widget are created by calling the various add_xxxx commands or using context managers for container widgets. These commands all return a unique identifier than can be used to refer to the widget at a later time. Below is a simple example for creating a window with a few simple widgets:

import dearpygui.dearpygui as dpg

with dpg.window(label="Tutorial"):

    dpg.add_button(label="Apply")
    dpg.add_same_line(spacing=10)
    dpg.add_button(label="Apply")
    dpg.add_same_line(spacing=10)
    dpg.add_button(label="Apply")
    dpg.add_spacing(count=5)

    # printing the widgets unique id
    id=dpg.add_button(label="Press me")
    print(id)

dpg.start_dearpygui() 

Result:

Using Widgets

Every input widget has a value which can be set using the default_value keyword when being created or at runtime by the command set_value.
To access the value of a widget we can use the command get_value.

import dearpygui.dearpygui as dpg

with dpg.window(label="Tutorial"):

    cb = dpg.add_checkbox(label="Radio Button", default_value=False)
    print("First value of the Radio Button is: ", dpg.get_value(cb))

    dpg.set_value(cb, True)
    print("Value after setting the Radio Button is: ", dpg.get_value(cb))

dpg.start_dearpygui()

如何插入一段漂亮的代码片

去博客设置页面，选择一款你喜欢的代码片高亮样式，下面展示同样高亮的 代码片.

// An highlighted block
var foo = 'bar';

生成一个适合你的列表

• 项目
  • 项目
    • 项目

1. 项目1
2. 项目2
3. 项目3

• 计划任务
• 完成任务

创建一个表格

一个简单的表格是这么创建的：

项目	Value
电脑	$1600
手机	$12
导管	$1

设定内容居中、居左、居右

使用:---------:居中
使用:----------居左
使用----------:居右

第一列	第二列	第三列
第一列文本居中	第二列文本居右	第三列文本居左

SmartyPants

SmartyPants将ASCII标点字符转换为“智能”印刷标点HTML实体。例如：

TYPE	ASCII	HTML
Single backticks	'Isn't this fun?'	‘Isn’t this fun?’
Quotes	"Isn't this fun?"	“Isn’t this fun?”
Dashes	-- is en-dash, --- is em-dash	– is en-dash, — is em-dash

创建一个自定义列表

Markdown

Text-to- HTML conversion tool

Authors

John

Luke

如何创建一个注脚

一个具有注脚的文本。¹

注释也是必不可少的

Markdown将文本转换为 HTML。

KaTeX数学公式

您可以使用渲染LaTeX数学表达式 KaTeX:

Gamma公式展示 $\Gamma (n)=(n-1)!\forall n\in \mathbb{N}$ 是通过欧拉积分

$$\Gamma (z)={\int }_0^{\infty }{t}^{z-1}{e}^{-t}dt.$$

你可以找到更多关于的信息 LaTeX 数学表达式here.

新的甘特图功能，丰富你的文章

• 关于 甘特图 语法，参考 这儿,

UML 图表

可以使用UML图表进行渲染。 Mermaid. 例如下面产生的一个序列图：

这将产生一个流程图。:

• 关于 Mermaid 语法，参考 这儿,

FLowchart流程图

我们依旧会支持flowchart的流程图：

• 关于 Flowchart流程图 语法，参考 这儿.

导出与导入

导出

如果你想尝试使用此编辑器, 你可以在此篇文章任意编辑。当你完成了一篇文章的写作, 在上方工具栏找到 文章导出 ，生成一个.md文件或者.html文件进行本地保存。

导入

如果你想加载一篇你写过的.md文件，在上方工具栏可以选择导入功能进行对应扩展名的文件导入，
继续你的创作。

---

1. 注脚的解释 ↩︎