6438592394

Committed 07 Oct 2023 02:52AM UTC coverage: 73.923% (-0.01%) from 73.937%

Build # 6438592394

Build Type

push

github

Committed by

web-flow

Commit Message

[bugfix] Fix `AFXMainWindow` methods return types (backport #5286) (#5287)

[bugfix] Fix `AFXMainWindow` methods return types (#5286)

* [bugfix] Fix AFXMainWindow return types

* Remove toolboxName argument for registerGuiMenuButton

(cherry picked from commit 51df0fc24)

Co-authored-by: Hailin Wang <hailin.wang@connect.polyu.hk>

Run Details

36 of 36 new or added lines in 5 files covered. (100.0%)

24754 of 33486 relevant lines covered (73.92%)

0.74 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/abaqus/PlugInRegistration/AFXApp.py

from __future__ import annotations

from .AFXMainWindow import AFXMainWindow
from .FXApp import FXApp


class AFXApp(FXApp):
    """This class is responsible for providing some high-level GUI control methods."""

    #: Used to query whether the GUI is locked.
    ID_QUERY_GUILOCK: int = hash("ID_QUERY_GUILOCK")

    #: Used to change the cursor.
    ID_SHOW_HOURGLASS: int = hash("ID_SHOW_HOURGLASS")

    def __init__(
        self,
        appName: str = "Abaqus/CAE",
        vendorName: str = "SIMULIA",
        productName: str = "''",
        majorNumber: int = -1,
        minorNumber: int = -1,
        updateNumber: int = -1,
        prerelease: bool = False,
    ):
        """Constructor.

        Parameters
        ----------
        appName : str
            Application registry key.
        vendorName : str
            Vendor registry key.
        productName : str
            Product name.
        majorNumber : int
            Version number.
        minorNumber : int
            Release number.
        updateNumber : int
            Update number.
        prerelease : bool
            Official/Prerelease flag.
        """

    def create(self):
        """Creates windows for the application.

        Reimplemented from FXApp.
        """

    def getAFXMainWindow(self) -> AFXMainWindow:  # type: ignore
        """Returns a pointer to the AFXMainWindow."""

    def getBasePrerelease(self) -> bool:  # type: ignore
        """Returns True if the base product is a prerelease."""

    def getBaseProductName(self) -> str:  # type: ignore
        """Returns the base product name."""

    def getBaseVersionNumbers(self, majorNumber: int, minorNumber: int, updateNumber: int):
        """Returns the base product's major, minor, and update numbers.

        Parameters
        ----------
        majorNumber : int
            Version number.
        minorNumber : int
            Release number.
        updateNumber : int
            Update number.
        """

    def getKernelInitializationCommand(self) -> str:  # type: ignore
        """Returns the command string that will be issued upon application startup."""

    def getPrerelease(self) -> bool:  # type: ignore
        """Returns True if this is a prerelease."""

    def getProductName(self) -> str:  # type: ignore
        """Returns the product name."""

    def getVersionNumbers(self) -> tuple[int, int, int]:  # type: ignore
        """Returns the major, minor, and update numbers."""

    def init(self, argc: int, argv: str, *args, **kwargs):
        """Initializes the application and connects to the kernel.

        Parameters
        ----------
        argc : int

        argv : str
        """

    def isLocked(self) -> bool:  # type: ignore
        """Returns True if the GUI is locked or False if otherwise.

        Reimplemented from FXApp.
        """

    def isProductCAE(self) -> bool:  # type: ignore
        """Returns True if the base product is Abaqus/CAE."""

    def isProductViewer(self) -> bool:  # type: ignore
        """Returns True if the base product is Abaqus/Viewer."""

    def isLearningEdition(self) -> bool:  # type: ignore
        """Returns True if the base product is a learning edition."""

    def lock(self):
        """Locks the GUI (normally used during command and mode processing)."""

    def run(self):
        """Runs the main application event loop until stop() is called,.

        Reimplemented from FXApp.
        """

    def runUntil(self, condition: int):
        """Run an event loop till some flag becomes non-zero. Reimplemented from FXApp.

        Parameters
        ----------
        condition : int
        """

    def unlock(self):
        """Unlocks the GUI."""

1	from __future__ import annotations	×
2
3	from .AFXMainWindow import AFXMainWindow	×
4	from .FXApp import FXApp	×
5
6
7	class AFXApp(FXApp):	×
8	"""This class is responsible for providing some high-level GUI control methods."""
9
10	#: Used to query whether the GUI is locked.
11	ID_QUERY_GUILOCK: int = hash("ID_QUERY_GUILOCK")	×
12
13	#: Used to change the cursor.
14	ID_SHOW_HOURGLASS: int = hash("ID_SHOW_HOURGLASS")	×
15
16	def __init__(	×
17	self,
18	appName: str = "Abaqus/CAE",
19	vendorName: str = "SIMULIA",
20	productName: str = "''",
21	majorNumber: int = -1,
22	minorNumber: int = -1,
23	updateNumber: int = -1,
24	prerelease: bool = False,
25	):
26	"""Constructor.
27
28	Parameters
29	----------
30	appName : str
31	Application registry key.
32	vendorName : str
33	Vendor registry key.
34	productName : str
35	Product name.
36	majorNumber : int
37	Version number.
38	minorNumber : int
39	Release number.
40	updateNumber : int
41	Update number.
42	prerelease : bool
43	Official/Prerelease flag.
44	"""
45
46	def create(self):	×
47	"""Creates windows for the application.
48
49	Reimplemented from FXApp.
50	"""
51
52	def getAFXMainWindow(self) -> AFXMainWindow: # type: ignore	×
53	"""Returns a pointer to the AFXMainWindow."""
54
55	def getBasePrerelease(self) -> bool: # type: ignore	×
56	"""Returns True if the base product is a prerelease."""
57
58	def getBaseProductName(self) -> str: # type: ignore	×
59	"""Returns the base product name."""
60
61	def getBaseVersionNumbers(self, majorNumber: int, minorNumber: int, updateNumber: int):	×
62	"""Returns the base product's major, minor, and update numbers.
63
64	Parameters
65	----------
66	majorNumber : int
67	Version number.
68	minorNumber : int
69	Release number.
70	updateNumber : int
71	Update number.
72	"""
73
74	def getKernelInitializationCommand(self) -> str: # type: ignore	×
75	"""Returns the command string that will be issued upon application startup."""
76
77	def getPrerelease(self) -> bool: # type: ignore	×
78	"""Returns True if this is a prerelease."""
79
80	def getProductName(self) -> str: # type: ignore	×
81	"""Returns the product name."""
82
83	def getVersionNumbers(self) -> tuple[int, int, int]: # type: ignore	×
84	"""Returns the major, minor, and update numbers."""
85
86	def init(self, argc: int, argv: str, args, *kwargs):	×
87	"""Initializes the application and connects to the kernel.
88
89	Parameters
90	----------
91	argc : int
92
93	argv : str
94	"""
95
96	def isLocked(self) -> bool: # type: ignore	×
97	"""Returns True if the GUI is locked or False if otherwise.
98
99	Reimplemented from FXApp.
100	"""
101
102	def isProductCAE(self) -> bool: # type: ignore	×
103	"""Returns True if the base product is Abaqus/CAE."""
104
105	def isProductViewer(self) -> bool: # type: ignore	×
106	"""Returns True if the base product is Abaqus/Viewer."""
107
108	def isLearningEdition(self) -> bool: # type: ignore	×
109	"""Returns True if the base product is a learning edition."""
110
111	def lock(self):	×
112	"""Locks the GUI (normally used during command and mode processing)."""
113
114	def run(self):	×
115	"""Runs the main application event loop until stop() is called,.
116
117	Reimplemented from FXApp.
118	"""
119
120	def runUntil(self, condition: int):	×
121	"""Run an event loop till some flag becomes non-zero. Reimplemented from FXApp.
122
123	Parameters
124	----------
125	condition : int
126	"""
127
128	def unlock(self):	×
129	"""Unlocks the GUI."""

haiiliin / abqpy / 6438592394

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous