Issue 7471 - Add an API for working with blocks of filters

abp/filters/parser.py

 # This file is part of Adblock Plus <https://adblockplus.org/>,
 # Copyright (C) 2006-present eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ skipping 89 matching lines @@
     MATCH_CASE = 'match-case'
     DOMAIN = 'domain'
     THIRD_PARTY = 'third-party'
     COLLAPSE = 'collapse'
     SITEKEY = 'sitekey'
     DONOTTRACK = 'donottrack'
     CSP = 'csp'
     REWRITE = 'rewrite'
 
 
+def _option_list_to_dict(options):

[Vasily Kuznetsov, 2019/05/09 11:18:59]

These two functions were moved from `rpy.py` to provide `.to_dict()` directly on
the parsed lines. This is useful for `.to_dict()` of the filters blocks.

+    """Recursively parse filter options into dicts.
+
+    Parameters
+    ----------
+    options: A list of tuples
+        The filter options
+
+    Returns
+    -------
+    dict
+        The resulting dictionary
+
+    """
+    result = dict(options)
+    if 'domain' in result:
+        result['domain'] = _option_list_to_dict(result['domain'])
+
+    return result
+
+
+def _to_dict(line):
+    """Convert a parsed filter list line from a namedtuple to a dict.
+
+    Parameters
+    ----------
+    line: namedtuple
+        The parsed filter.
+
+    Returns
+    -------
+    dict
+        The resulting dictionary
+
+    """
+    result = dict(line._asdict())
+    if 'options' in result:
+        result['options'] = _option_list_to_dict(result['options'])
+
+    result['type'] = line.__class__.__name__
+
+    return result
+
+
 def _line_type(name, field_names, format_string):
     """Define a line type.
 
     Parameters
     ----------
     name: str
         The name of the line type to define.
     field_names: str or list
         A sequence of field names or one space-separated string that contains
         all field names.
     format_string: str
         A format specifier for converting this line type back to string
         representation.
 
     Returns
     -------
     class
         Class created with `namedtuple` that has `.type` set to lowercased
         `name` and supports conversion back to string with `.to_string()`
         method.
 
     """
     lt = namedtuple(name, field_names)
     lt.type = name.lower()
     lt.to_string = lambda self: format_string.format(self)
+    lt.to_dict = _to_dict
     return lt
 
 
 Header = _line_type('Header', 'version', '[{.version}]')
 EmptyLine = _line_type('EmptyLine', '', '')
 Comment = _line_type('Comment', 'text', '! {.text}')
 Metadata = _line_type('Metadata', 'key value', '! {0.key}: {0.value}')
 Filter = _line_type('Filter', 'text selector action options', '{.text}')
 Include = _line_type('Include', 'target', '%include {0.target}%')
 
@@ skipping 193 matching lines @@
     for line in lines:
         parsed_line = parse_line(line, position)
         yield parsed_line
 
         if position != 'body' and parsed_line.type in {'header', 'metadata'}:
             # Continue parsing metadata until it's over...
             position = 'metadata'
         else:
             # ...then switch to parsing the body.
             position = 'body'