src/eric7/Plugins/WizardPlugins/EricPluginWizard/Templates.py

branch
eric7
changeset 10797
81f885140d2b
parent 10439
21c28b0f9e41
child 10800
c6ce5522be30
equal deleted inserted replaced
10796:125a9caa538f 10797:81f885140d2b
77 def deactivate(self): 77 def deactivate(self):
78 """ 78 """
79 Public method to deactivate this plug-in. 79 Public method to deactivate this plug-in.
80 """ 80 """
81 pass 81 pass
82 {config3}''' 82 {config3}\
83 {installDependencies}'''
83 84
84 configTemplate0 = """from eric7 import Preferences 85 configTemplate0 = """from eric7 import Preferences
85 86
86 """ 87 """
87 88
88 configTemplate1 = '''def getConfigData(): 89 configTemplate1 = '''def getConfigData():
89 """ 90 """
90 Module function returning data as required by the configuration dialog. 91 Function returning data as required by the configuration dialog.
91 92
92 @return dictionary containing the relevant data 93 @return dictionary containing the relevant data
93 @rtype dict 94 @rtype dict
94 """ 95 """
95 return {{ 96 return {{
103 }} 104 }}
104 105
105 106
106 def prepareUninstall(): 107 def prepareUninstall():
107 """ 108 """
108 Module function to prepare for an un-installation. 109 Function to prepare for an un-installation.
109 """ 110 """
110 Preferences.getSettings().remove({className}.PreferencesKey) 111 Preferences.getSettings().remove({className}.PreferencesKey)
111 112
112 113
113 ''' 114 '''
144 "pluginTypename": "{pluginTypename}", 145 "pluginTypename": "{pluginTypename}",
145 """ 146 """
146 147
147 previewPixmapTemplate = '''def previewPix(): 148 previewPixmapTemplate = '''def previewPix():
148 """ 149 """
149 Module function to return a preview pixmap. 150 Function to return a preview pixmap.
150 151
151 @return preview pixmap 152 @return preview pixmap
152 @rtype QPixmap 153 @rtype QPixmap
153 """ 154 """
154 from PyQt6.QtGui import QPixmap 155 from PyQt6.QtGui import QPixmap
159 160
160 ''' 161 '''
161 162
162 exeDisplayDataListTemplate = '''def exeDisplayDataList(): 163 exeDisplayDataListTemplate = '''def exeDisplayDataList():
163 """ 164 """
164 Module function to support the display of some executable info. 165 Function to support the display of some executable info.
165 166
166 @return list of dictionaries containing the data to query the presence of 167 @return list of dictionaries containing the data to query the presence of
167 the executable 168 the executable
168 @rtype list of dict 169 @rtype list of dict
169 """ 170 """
189 190
190 ''' 191 '''
191 192
192 exeDisplayDataTemplate = '''def exeDisplayData(): 193 exeDisplayDataTemplate = '''def exeDisplayData():
193 """ 194 """
194 Module function to support the display of some executable info. 195 Function to support the display of some executable info.
195 196
196 @return dictionary containing the data to query the presence of 197 @return dictionary containing the data to query the presence of
197 the executable 198 the executable
198 @rtype dict 199 @rtype dict
199 """ 200 """
215 216
216 ''' 217 '''
217 218
218 exeDisplayDataInfoTemplate = '''def exeDisplayData(): 219 exeDisplayDataInfoTemplate = '''def exeDisplayData():
219 """ 220 """
220 Module function to support the display of some executable info. 221 Function to support the display of some executable info.
221 222
222 @return dictionary containing the data to be shown 223 @return dictionary containing the data to be shown
223 @rtype dict 224 @rtype dict
224 """ 225 """
225 data = { 226 data = {
234 235
235 ''' 236 '''
236 237
237 moduleSetupTemplate = '''def moduleSetup(): 238 moduleSetupTemplate = '''def moduleSetup():
238 """ 239 """
239 Module function to perform module level setup. 240 Function to perform module level setup.
240 """ 241 """
241 pass 242 pass
242 243
243 244
244 ''' 245 '''
245 246
246 apiFilesTemplate = '''def apiFiles(language): 247 apiFilesTemplate = '''def apiFiles(language):
247 """ 248 """
248 Module function to return the API files made available by this plug-in. 249 Function to return the API files made available by this plug-in.
249 250
250 @param language language to get APIs for 251 @param language language to get APIs for
251 @type str 252 @type str
252 @return list of API filenames 253 @return list of API filenames
253 @rtype list of str 254 @rtype list of str
262 return apis 263 return apis
263 264
264 265
265 ''' 266 '''
266 267
268 installDependenciesTemplate = '''
269
270 def installDependencies(pipInstall):
271 """
272 Function to install dependencies of this plug-in.
273
274 @param pipInstall function to be called with a list of package names.
275 @type function
276 """
277 pass
278 '''
279
267 # 280 #
268 # eflag: noqa = M841 281 # eflag: noqa = M841

eric ide

mercurial