如何在QGIS Python插件中进行性能分析？

Question

能否使用kernprof.py、line_profiler.py或类似的工具来对QGIS插件进行性能分析？由于插件需要从QGIS获取状态并调用QGIS API，因此无法在QGIS之外运行该插件。

看起来我可以修改插件的初始化程序来调用kernprof，通过回调向插件传递状态，但我无法理解它的实现方式。

有没有人有在另一个工具内部运行Python性能分析器的经验？

- jakop

Answer 1

我使用了较为简单的方法，使用cProfile来对我的插件进行性能分析。在插件的主类构造函数（在classFactory中返回）中，我使用了以下代码：

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

当需要在类的unload方法或任何位置上打印配置文件统计信息时：

    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

- Mohammad Zatkhahi

Answer 2

在 QGIS 内运行脚本时，可以使用 line_profiler。

您需要在插件的主文件中与其他导入一起导入它，然后在主类之前添加 profile = line_profiler.LineProfiler()，在主函数之前添加装饰器 @profile 进行分析，最后在函数返回之前添加 profile.print_stats(stream=stream)。

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

以下是处理插件的示例：

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:\OSGeo4W\profiles\default/python/plugins\test\algo_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}

- Jean-François Bourdon