Timings and saving raw outputs added. batchrunner merged.

Author: alireza sharifi

lighthouse/__init__.py

@@ -1,2 +1 @@
-from .runner import LighthouseRunner, LighthouseRepeatRunner
-from .batch import BatchRunner
+from .runner import LighthouseRunner, LighthouseRepeatRunner, BatchRunner

lighthouse/batch.py

@@ -1,46 +1,36 @@
-# this python file uses the following encoding utf-8
-
-# Python Standard Library
+# Standard library modules
 from collections import namedtuple
 from datetime import timedelta
+from typing import Dict, List
 
 
-AuditResult = namedtuple('AuditResult', ['title', 'score', 'display'])
+AuditResult = namedtuple('AuditResult', ['id','title', 'score', 'display','numval','numunit'])
 AuditCategoryResult = namedtuple('AuditCategoryResult', ['passed', 'failed'])
 
-BASE_TIMINGS = [
-    'first-contentful-paint',
-    'speed-index',
-    'interactive',
-    'first-meaningful-paint',
-    'first-cpu-idle',
-    'estimated-input-latency',
-    'time-to-first-byte',
-]
-"""list(str) default list of timings"""
-
-
-class LighthouseReport(object):
+class LighthouseReport:
     """
-    Lighthouse report abstract
+    Represents a Lighthouse report.
 
-    Should provide more pleasant report then the lighthouse JSON.
+    Provides a more user-friendly interface to the Lighthouse JSON report.
     """
 
-    def __init__(self, data, timings=BASE_TIMINGS):
+    def __init__(self, data: Dict, timings: List[str] = []):
         """
         Args:
-            data (dict): JSON loaded lighthouse report
-            timings (list(str), optional): list of timings
-                to gather
+            data (dict): JSON loaded Lighthouse report
+            
+            timings (list(str), optional): List of timings to gather
+                from Lighthouse report. Defaults to an empty list.
         """
 
         self.__data = data
         self.__timings = timings
 
     @property
-    def score(self):
-        """ Dictionary of lighthouse's category name: score (0 to 1) """
+    def score(self) -> Dict[str, float]:
+        """
+        Dictionary of Lighthouse category names and their corresponding scores (0 to 1).
+        """
 
         return {
             k: v.get('score', 0)
@@ -49,8 +39,10 @@ def score(self):
         }
 
     @property
-    def timings(self):
-        """ Dictionary of lighthouse's timings names: timedelta times """
+    def timings(self) -> Dict[str, timedelta]:
+        """
+        Dictionary of Lighthouse timing names and their corresponding times as timedeltas.
+        """
 
         return {
             k: timedelta(milliseconds=v.get('numericValue')) 
@@ -59,14 +51,17 @@ def timings(self):
             if k in self.__timings
         }
 
-    @property
-    def audits(self):
+    def audits(self, score_thresh: float = 1) -> Dict[str, AuditCategoryResult]:
         """
-        Dictionary of audits as category name: object with passed/failed keys
-            with lists attached.
+        Returns a dictionary of Lighthouse audits, grouped by category, with passed/failed
+        keys and lists of passed/failed audits attached.
+
+        Args:
+            score_thresh (float, optional): The minimum score required for an audit to be considered
+                passed. Defaults to 1 (all audits must pass).
         """
-        res = {}
 
+        res = {}
         for category, data in self.__data['categories'].items():
             all_audit_refs = [
                 x.get('id')
@@ -76,23 +71,30 @@ def audits(self):
             sdm_to_reject = ['manual', 'notApplicable', 'informative']
             passed_audits = [
                 AuditResult(**{
+                    'id': v['id'],
                     'title': v['title'],
                     'score': v['score'],
                     'display': v.get('displayValue'),
+                    'numval': v.get('numericValue'),
+                    'numunit': v.get('numericUnit'),
                 })
                 for k, v in all_audits.items()
-                if v.get('score', 0) == 1 and
+                if v.get('score',0) is not None and 
+                v.get('score', 0) >= score_thresh and
                 v.get('scoreDisplayMode') not in sdm_to_reject
             ]
 
             failed_audits = [
                 AuditResult(**{
+                    'id': v['id'],
                     'title': v['title'],
                     'score': v['score'],
                     'display': v.get('displayValue'),
+                    'numval': v.get('numericValue'),
+                    'numunit': v.get('numericUnit'),
                 })
                 for k, v in all_audits.items()
-                if (v.get('score',0) is None or v.get('score', 0) < 1) and
+                if (v.get('score',0) is None or v.get('score', 0) < score_thresh) and
                 v.get('scoreDisplayMode') not in sdm_to_reject
             ]