Skip to content

Type Hint Improvements #2635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Atlamillias wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Type Hint Improvements #2635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4047bfe
refactor: Python context managers to return `Iterator[T]`
Apr 13, 2026
0c35f16
refactor: changed `label` Python data type to `mvPyDataType::Optional…
Apr 13, 2026
be712a9
refactor: corrected `mvPlot` `zoom_rate` Python data type to `mvPyDat…
Apr 13, 2026
66cc7bf
refactor: use `mvEventType_On` as `event_type` parameter default over…
Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
348 changes: 174 additions & 174 deletions dearpygui/_dearpygui.pyi
View file
Open in desktop

Large diffs are not rendered by default.

874 changes: 437 additions & 437 deletions dearpygui/_dearpygui_RTD.py
View file
Open in desktop

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions dearpygui/_deprecated.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ def staging_container(**kwargs):

@deprecated("Use: add_spacer(...)")
def add_spacing(**kwargs):
""" (deprecated function) Adds vertical spacing.
""" (deprecated function) Adds vertical spacing.

Args:
label (str, optional): Overrides 'name' as label.
Expand Down Expand Up @@ -258,10 +258,10 @@ def add_same_line(**kwargs):

@deprecated("Use: `get_plot_query_rects()`")
def is_plot_queried(plot: Union[int, str], **kwargs):
""" (deprecated function) Returns true if the plot is currently being queried.
""" (deprecated function) Returns true if the plot is currently being queried.

Args:
plot (Union[int, str]):
plot (Union[int, str]):
Returns:
bool
"""
Expand All @@ -273,7 +273,7 @@ def get_plot_query_area(plot: Union[int, str], **kwargs):
""" (deprecated function) Returns the last/current query area of the plot. If no area is available [0, 0, 0, 0] will be returned.

Args:
plot (Union[int, str]):
plot (Union[int, str]):
Returns:
Union[List[float], Tuple[float, ...]]
"""
Expand All @@ -288,7 +288,7 @@ def add_hline_series(x, **kwargs):
""" (deprecated function) Adds an infinite horizontal line series to a plot.

Args:
x (Any):
x (Any):
label (str, optional): Overrides 'name' as label.
user_data (Any, optional): User data for callbacks
use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid).
Expand All @@ -303,14 +303,14 @@ def add_hline_series(x, **kwargs):
"""

return internal_dpg.add_inf_line_series(x, **kwargs, horizontal=True)


@deprecated("Use: `add_inf_line_series()`")
def add_vline_series(x, **kwargs):
""" (deprecated function) Adds an infinite vertical line series to a plot.

Args:
x (Any):
x (Any):
label (str, optional): Overrides 'name' as label.
user_data (Any, optional): User data for callbacks
use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid).
Expand Down Expand Up @@ -425,52 +425,52 @@ def set_start_callback(callback):
return internal_dpg.set_frame_callback(3, callback)

@deprecated("This call is a no-op because character ranges are now automatic")
def add_font_chars(chars : Union[List[int], Tuple[int, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]:
def add_font_chars(chars : Union[List[int], Tuple[int, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]:
""" (deprecated function) Adds specific font characters to a font.

Args:
chars (Union[List[int], Tuple[int, ...]]):
chars (Union[List[int], Tuple[int, ...]]):
label (str, optional): Overrides 'name' as label.
user_data (Any, optional): User data for callbacks
use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid).
tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label.
parent (Union[int, str], optional): Parent to add this item to. (runtime adding)
id (Union[int, str], optional): (deprecated)
id (Union[int, str], optional): (deprecated)
Returns:
Union[int, str]
"""
pass

@deprecated("This call is a no-op because character ranges are now automatic")
def add_font_range(first_char : int, last_char : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]:
def add_font_range(first_char : int, last_char : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]:
""" (deprecated function) Adds a range of font characters to a font.

Args:
first_char (int):
last_char (int):
first_char (int):
last_char (int):
label (str, optional): Overrides 'name' as label.
user_data (Any, optional): User data for callbacks
use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid).
tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label.
parent (Union[int, str], optional): Parent to add this item to. (runtime adding)
id (Union[int, str], optional): (deprecated)
id (Union[int, str], optional): (deprecated)
Returns:
Union[int, str]
"""
pass

@deprecated("This call is a no-op because character ranges are now automatic")
def add_font_range_hint(hint : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]:
def add_font_range_hint(hint : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]:
""" (deprecated function) Adds a range of font characters (mvFontRangeHint_ constants).

Args:
hint (int):
hint (int):
label (str, optional): Overrides 'name' as label.
user_data (Any, optional): User data for callbacks
use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid).
tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label.
parent (Union[int, str], optional): Parent to add this item to. (runtime adding)
id (Union[int, str], optional): (deprecated)
id (Union[int, str], optional): (deprecated)
Returns:
Union[int, str]
"""
Expand Down
10 changes: 5 additions & 5 deletions dearpygui/_header.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import List, Any, Callable, Union, Tuple
from typing import List, Any, Callable, Union, Tuple, Iterator, Optional
from contextlib import contextmanager
import warnings
import functools
Expand Down Expand Up @@ -82,7 +82,7 @@ def start_dearpygui():
raise RuntimeError("Viewport was not created and shown.")

while(internal_dpg.is_dearpygui_running()):
internal_dpg.render_dearpygui_frame()
internal_dpg.render_dearpygui_frame()


@contextmanager
Expand All @@ -95,12 +95,12 @@ def mutex():


@contextmanager
def popup(parent: Union[int, str], mousebutton: int = internal_dpg.mvMouseButton_Right, modal: bool=False, tag:Union[int, str]=0, min_size:Union[List[int], Tuple[int, ...]]=[100,100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], no_move: bool=False, no_background: bool=False) -> int:
def popup(parent: Union[int, str], mousebutton: int = internal_dpg.mvMouseButton_Right, modal: bool=False, tag:Union[int, str]=0, min_size:Union[List[int], Tuple[int, ...]]=[100,100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], no_move: bool=False, no_background: bool=False) -> Iterator[Union[int, str]]:
"""A window that will be displayed when a parent item is hovered and the corresponding mouse button has been clicked. By default a popup will shrink fit the items it contains.
This is useful for context windows, and simple modal window popups.
When popups are used a modal they have more avaliable settings (i.e. title, resize, width, height) These
can be set by using configure item.
This is a light wrapper over window. For more control over a modal|popup window use a normal window with the modal|popup keyword
can be set by using configure item.
This is a light wrapper over window. For more control over a modal|popup window use a normal window with the modal|popup keyword
and set the item handler and mouse events manually.

Args:
Expand Down
Loading