如何在QGIS Python插件中配置性能

Question

是否可以使用kernprofer .py, line_profiler.py或类似于配置QGIS插件的东西?我不能在QGIS之外运行插件，因为插件需要QGIS的状态。将调用QGIS API。

似乎我可以修改插件的初始化器来调用kernprof，回调到插件并一路传递状态，但我无法理解它。

有没有人有从另一个工具内部运行Python分析器的经验?

Answer 1

我使用了一种更简单的方法来配置我的插件使用cProfile。在插件主类的构造函数中(在classFactory中返回)，我使用了以下代码:

 self.pr = cProfile.Profile()
 self.pr.enable()

和类的卸载方法或任何需要打印配置文件状态的地方:

    self.pr.disable()
    s = io.StringIO()
    sortby = SortKey.CUMULATIVE
    ps = pstats.Stats(self.pr, stream=s).sort_stats(sortby)
    ps.print_stats() 

记得使用下面的代码导入:

import cProfile, pstats, io
from pstats import SortKey

Answer 2

在QGIS中运行脚本时可以使用line_profiler

您需要将其导入到插件的主文件中，然后在主类之前添加profile = line_profiler.LineProfiler()，在主函数之前添加装饰器@profile，最后在函数返回之前添加profile.print_stats(stream=stream)。

我想还有其他方法可以做到，但这是我发现的方法对我来说足够好。

下面是一个Processing插件的例子:

import os
import line_profiler
profile = line_profiler.LineProfiler() 
class processingScriptExample(QgsProcessingAlgorithm):
    
    INPUT_directory = 'INPUT_directory'
    
    def initAlgorithm(self, config):
        self.addParameter(QgsProcessingParameterNumber(self.INPUT_directory,
                                                       self.tr('Output directory'),
                                                       QgsProcessingParameterFile.Folder))
    
    @profile
    def processAlgorithm(self, parameters, context, feedback):
        directory = self.parameterAsInt(parameters, self.INPUT_directory, context)
        
        ls = []
        for ii in range(1000000):
            ls.append(ii)
        
        ls = [ii for ii in range(1000000)]
        
        path_profiling = os.path.join(directory, "line_profiling.txt")
        with open(path_profiling, 'w') as stream:
            profile.print_stats(stream=stream)
        return {'Profiling file': path_profiling}

结果文件:

Timer unit: 1e-07 s
Total time: 1.31260 s
File: C:OSGeo4Wprofilesdefault/python/pluginstestalgo_test.py
Function: processAlgorithm at line 70
Line #      Hits         Time  Per Hit   % Time  Line Contents
==============================================================
    70                                               @profile
    71                                               def processAlgorithm(self, parameters, context, feedback):
    72         1        248.0    248.0      0.0          directory = self.parameterAsInt(parameters, self.INPUT_directory, context)
    73                                           
    74         1          8.0      8.0      0.0          ls = []
    75   1000001    5054594.0      5.1     38.5          for ii in range(1000000):
    76   1000000    6633146.0      6.6     50.5              ls.append(ii)
    77                                                   
    78         1    1418416.0 1418416.0     10.8          ls = [ii for ii in range(1000000)]
    79                                                   
    80         1        561.0    561.0      0.0          path_profiling = os.path.join(directory, "line_profiling.txt")
    81         1      19001.0  19001.0      0.1          with open(path_profiling, 'w') as stream:
    82                                                       profile.print_stats(stream=stream)
    83                                           
    84                                                   return {"Profiling file":path_profiling}