Fri, 22 Jan 2021 16:48:43 +0100
Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)
5619
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | # -*- coding: utf-8 -*- |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | |
7923
91e843545d9a
Updated copyright for 2021.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7780
diff
changeset
|
3 | # Copyright (c) 2017 - 2021 Detlev Offenbach <detlev@die-offenbachs.de> |
5619
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | # |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | Module implementing a dialog to enter the data for a built-in assignment to |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | be ignored. |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | from PyQt5.QtCore import pyqtSlot |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | from PyQt5.QtWidgets import QDialog, QDialogButtonBox |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | |
7256
4ef3b78ebb4e
Continued to resolve code style issue M841.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7229
diff
changeset
|
14 | from .Ui_CodeStyleAddBuiltinIgnoreDialog import ( |
5619
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | Ui_CodeStyleAddBuiltinIgnoreDialog |
7256
4ef3b78ebb4e
Continued to resolve code style issue M841.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7229
diff
changeset
|
16 | ) |
5619
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | |
5621
80cce672d505
Added a checker for using mutable types as default functiona rgument (M821).
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
5619
diff
changeset
|
19 | class CodeStyleAddBuiltinIgnoreDialog(QDialog, |
5619
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | Ui_CodeStyleAddBuiltinIgnoreDialog): |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | Class implementing a dialog to enter the data for a built-in assignment to |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | be ignored. |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | def __init__(self, parent=None): |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | Constructor |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | @param parent reference to the parent widget |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | @type QWidget |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | super(CodeStyleAddBuiltinIgnoreDialog, self).__init__(parent) |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | self.setupUi(self) |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | self.__updateOkButton |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | msh = self.minimumSizeHint() |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | self.resize(max(self.width(), msh.width()), msh.height()) |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | def __updateOkButton(self): |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | Private slot to set the state of the OK button. |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | self.buttonBox.button(QDialogButtonBox.Ok).setEnabled( |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | bool(self.leftEdit.text()) and |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | bool(self.rightEdit.text())) |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
47 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | @pyqtSlot(str) |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | def on_leftEdit_textChanged(self, txt): |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | Private slot to handle a change of the text of the left side edit. |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
52 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | @param txt text of the line edit |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | @type str |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | self.__updateOkButton() |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | @pyqtSlot(str) |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | def on_rightEdit_textChanged(self, txt): |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | Private slot to handle a change of the text of the right side edit. |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | @param txt text of the line edit |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | @type str |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | self.__updateOkButton() |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | def getData(self): |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | Public method to get the entered data. |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | @return tuple containing the left and right hand side of the assignment |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | @rtype tuple of two str |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | """ |
ab999dc48132
Made the built-ins checker configurable.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | return self.leftEdit.text(), self.rightEdit.text() |