Python Dictionary Display Filter

A Wireshark-like display filter for Python dictionaries and various other data sources, including objects, lists, and SQL databases.

Table of Contents

1. Quick Start
2. Features
3. Examples
4. Acknowledgements

Quick Start

To quickly get started with the python-dictionary-display-filter, follow the steps below:

Installation

First, install the package using pip:

pip3 install python-dict-display-filter

Initialization

Next, import the necessary module and initialize the DictDisplayFilter with a list of dictionaries:

from pydictdisplayfilter import DictDisplayFilter

actors = [
    {"name": ["Laurence", "Fishburne"], "age": {"born": "1961"}, "gender": "male"},
    {"name": ["Keanu", "Reeves"], "age": {"born": "1964"}, "gender": "male", "power": ["flight", "bullet-time"]},
    {"name": ["Joe", "Pantoliano"], "age": {"born": "1951"}, "gender": "male"},
    {"name": ["Carrie-Anne", "Moss"], "age": {"born": "1967"}, "gender": "female"}
]

ddf = DictDisplayFilter(actors)

Filtering Data

Once the DictDisplayFilter is initialized, you can start filtering the data using the display filter query language. For example, let's filter the actors whose birth year is after 1960:

filter_query = "age.born > 1960"
filtered_data = ddf.filter(filter_query)
print(list(filtered_data))
[
    {"name": ["Laurence", "Fishburne"], "age": {"born": "1961"}, "gender": "male"},
    {"name": ["Keanu", "Reeves"], "age": {"born": "1964"}, "gender": "male", "power": ["flight", "bullet-time"]},
    {"name": ["Carrie-Anne", "Moss"], "age": {"born": "1967"}, "gender": "female"}
]

You can also use more complex queries to filter the data. For example, let's filter male actors born between 1960 and 1964 whose names end with "e":

filter_query = "gender == male and (age.born > 1960 and age.born < 1965) and name matches .*e$"
filtered_data = ddf.filter(filter_query)
print(list(filtered_data))

This will output the filtered data:

[{'name': ['Laurence', 'Fishburne'], 'age': {'born': '1961'}, 'gender': 'male'}]

For more details and advanced usage, please refer to the User Guide.

Features

Python Dictionary Display Filter supports a wide range of features, including:

• Comparison Operators: ==, !=, <=, <, >=, >, ~=, ~, &
• Combining Operators: and, or, xor, not
• Membership Operators: in
• Types: Text, Number, Date & Time, Ethernet-, IPv4-, IPv6-Address
• Slicing: Text, Ethernet-, IPv4-, IPv6-Address
• Functions: upper, lower, len
• Data Sources: CSV, Dictionaries, JSON, Objects, SQLite

For a detailed description of the individual features check out the User Guide.

Examples

For detailed examples of how the display filter can be utilized, please refer to the following sections of the User Guide:

• CSV Display Filter
• JSON Display Filter
• SQLite Display Filter
• Nmap Display Filter

Acknowledgements

This project wouldn't be possible without these awesome projects:

• wireshark display filter: Display filter for filtering network packages
• parameterized: Parameterized testing with any Python test framework
• pyparsing: Creating PEG-parsers made easy
• ipranger: Parsing and matching IPv4-addresses
• python-dateutil: Parsing and comparing dates