Skip to main content

convtools is a python library to declaratively define fast conversions from python objects to python objects, including processing collections and doing complex aggregations and joins.

Project description

convtools is a python library to declaratively define quite fast conversions from python objects to python objects, including processing collections and doing complex aggregations and joins.

Once defined, the conversion can be compiled into an ad hoc code OR be reused for building more complex conversions.

https://img.shields.io/pypi/pyversions/convtools.svg https://img.shields.io/github/license/itechart-almakov/convtools.svg https://codecov.io/gh/itechart-almakov/convtools/branch/master/graph/badge.svg Tests Status Documentation Status https://img.shields.io/github/tag/itechart-almakov/convtools.svg https://badge.fury.io/py/convtools.svg Downloads

What’s the workflow?

  1. from convtools import conversion as c
  2. define conversions
  3. (optional) store them somewhere for further reuse
  4. call gen_converter method to compile the conversion into a function, written with an ad hoc code
  5. (optional) it’s totally fine to generate converters at runtime, for simple conversions it takes less than 0.1-0.2 milliseconds to get compiled.

Below are real-world like examples (for more tutorial-like examples, please scroll down to the Installation step):

# ======== #
# GROUP BY #
# ======== #
input_data = [
    {'a': 5,  'b': 'foo'},
    {'a': 10, 'b': 'foo'},
    {'a': 10, 'b': 'bar'},
    {'a': 10, 'b': 'bar'},
    {'a': 20, 'b': 'bar'}
]

conv = c.group_by(
    c.item("b")
).aggregate({
    "b": c.item("b"),
    "a_first": c.reduce(c.ReduceFuncs.First, c.item("a")),
    "a_max": c.reduce(c.ReduceFuncs.Max, c.item("a")),
}).gen_converter(debug=True)

conv(input_data) == [
    {'b': 'foo', 'a_first': 5, 'a_max': 10},
    {'b': 'bar', 'a_first': 10, 'a_max': 20}]


# ========= #
# AGGREGATE #
# ========= #
conv = c.aggregate({
    # list of "a" values where "b" equals to "bar"
    "a": c.reduce(
        c.ReduceFuncs.Array,
        c.item("a")
    ).filter(c.item("b") == "bar"),

    # "b" value of a row where "a" has Max value
    "b": c.reduce(
        c.ReduceFuncs.MaxRow,
        c.item("a"),
    ).item("b", default=None),
}).gen_converter(debug=True)

conv(input_data) == {'a': [10, 10, 20], 'b': 'bar'}
# ==== #
# JOIN #
# ==== #
collection_1 = [
    {"id": 1, "name": "Nick"},
    {"id": 2, "name": "Joash"},
    {"id": 3, "name": "Bob"},
]
collection_2 = [
    {"ID": "3", "age": 17, "country": "GB"},
    {"ID": "2", "age": 21, "country": "US"},
    {"ID": "1", "age": 18, "country": "CA"},
]
input_data = (collection_1, collection_2)

conv = c.join(
    c.item(0),
    c.item(1),
    c.and_(
        c.LEFT.item("id") == c.RIGHT.item("ID").as_type(int),
        c.RIGHT.item("age") >= 18
    ),
    how="left",
).pipe(
    c.list_comp({
        "id": c.item(0, "id"),
        "name": c.item(0, "name"),
        "age": c.item(1, "age", default=None),
        "country": c.item(1, "country", default=None),
    })
).gen_converter(debug=True)

assert conv(input_data) == [
    {'id': 1, 'name': 'Nick', 'age': 18},
    {'id': 2, 'name': 'Joash', 'age': 21}]

Why would you need this?

  • you need to serialize some objects
  • you need to define data transformations based on some input, which becomes available at runtime
  • you want to reuse field-wise transformations across the project without worrying about huge overhead of calling tens of functions per row/object, especially when there are thousands of them to be processed
  • you believe that Python is awesome enough to have powerful aggregations and joins
  • you like the idea of having something else write an unpleasant ad hoc code for you

Is it any different from tools like Pandas?

  • convtools doesn’t need to wrap data in any container to provide useful API, it just writes normal python code under the hood
  • convtools is a lightweight library with no dependencies (however optional black is highly recommended for pretty-printing generated code when debugging)
  • convtools is about defining and reusing conversions – declarative approach, while wrapping data in high-performance containers is more of being imperative

Description

The speed of convtools comes from the approach of generating code & compiling conversion functions, which don’t have any generic code like superfluous loops, ifs, etc.

So you can keep following the DRY principle by storing and reusing the code on the python expression level, but at the same time be able to run the gen_converter and get the compiled code which doesn’t care about being DRY and is generated to be highly specialized for the specific need.

Thanks to pipes & labels it’s possible to define multiple pipelines of data processing, including branching and merging of them.

Conversions are not limited to simple data transformations, there are GroupBy & Aggregate conversions with many useful reducers:

  • from common Sum, Max
  • and less widely supported First/Last, Array/ArrayDistinct
  • to DictSum-like ones (for nested aggregation) and MaxRow/MinRow (for finding an object with max/min value and further processing)

Also there are higher-level conversions - JOINS (inner, left, right, outer, cross), which processes 2 iterables and returns a generator of joined pairs.

Every conversion:
  • contains the information of how to transform an input
  • can be piped into another conversion (same as wrapping)
  • can be labeled to be reused further in the conversions chain
  • has a method gen_converter returning a function compiled at runtime
  • despite being compiled at runtime, is debuggable with pdb due to linecache populating.

Installation:

pip install convtools

Example #1: deserialization & data preps

# get by "department" key and then call method "strip"
department = c.item("department").call_method("strip")
first_name = c.item("first_name").call_method("capitalize")
last_name = c.item("last_name").call_method("capitalize")

# call "format" method of a string and pass first & last names as parameters
full_name = c("{} {}").call_method("format", first_name, last_name)
date_of_birth = c.item("dob")

# partially initialized "strptime"
parse_date = c.call_func(
    datetime.strptime,
    c.this(),
    "%Y-%m-%d"
).call_method("date")

c.item("objects").pipe(
    c.generator_comp({
        "id": c.item("id"),
        "first_name": first_name,
        "last_name": last_name,
        "full_name": full_name,
        "date_of_birth": c.if_(
            date_of_birth,
            date_of_birth.pipe(parse_date),
            None,
        ),
        "salary": c.call_func(
            Decimal,
            c.item("salary").call_method("replace", ",", "")
        ),
        # pass a hardcoded dict and to get value by "department" key
        "department_id": c.naive({
            "D1": 10,
            "D2": 11,
            "D3": 12,
        }).item(department),
        "date": c.item("date").pipe(parse_date),
    })
).pipe(
    c.dict_comp(
        c.item("id"), # key
        # write a python code expression, format with passed parameters
        c.inline_expr("{employee_cls}(**{kwargs})").pass_args(
            employee_cls=Employee,
            kwargs=c.this(),
        ),            # value
    )
).gen_converter(debug=True)

Gets compiled into:

def converter705_580(data_):
    global add_label_, get_by_label_
    pipe705_68 = data_["objects"]
    pipe705_973 = (
        {
            "id": i703_861["id"],
            "first_name": i703_861["first_name"].capitalize(),
            "last_name": i703_861["last_name"].capitalize(),
            "full_name": "{} {}".format(
                i703_861["first_name"].capitalize(),
                i703_861["last_name"].capitalize(),
            ),
            "date_of_birth": (
                strptime494_480(i703_861["dob"], "%Y-%m-%d").date()
                if i703_861["dob"]
                else None
            ),
            "salary": Decimal731_432(i703_861["salary"].replace(",", "")),
            "department_id": v677_416[i703_861["department"].strip()],
            "date": strptime494_480(i703_861["date"], "%Y-%m-%d").date(),
        }
        for i703_861 in pipe705_68
    )
    return {
        i705_330["id"]: (Employee700_725(**i705_330))
        for i705_330 in pipe705_973
    }

Example #2: word count

import re
from itertools import chain

# the suggested way of importing convtolls
from convtools import conversion as c

# Let's say we need to count words across all files
input_data = [
    "war-and-peace-1.txt",
    "war-and-peace-2.txt",
    "war-and-peace-3.txt",
    "war-and-peace-4.txt",
]
def read_file(filename):
    with open(filename) as f:
        for line in f:
            yield line

# iterate an input and read file lines
extract_strings = c.generator_comp(
    c.call_func(read_file, c.this())
)

# 1. make ``re`` pattern available to the code to be generated
# 2. call ``finditer`` method of the pattern and pass the string
#    as an argument
# 3. pass the result to the next conversion
# 4. iterate results, call ``.group()`` method of each re.Match
#    and call ``.lower()`` on each result
split_words = (
    c.naive(re.compile(r'\w+')).call_method("finditer", c.this())
    .pipe(
        c.generator_comp(
            c.this().call_method("group", 0).call_method("lower")
        )
    )
)

# ``extract_strings`` is the generator of strings
# so we iterate it and pass each item to ``split_words`` conversion
vectorized_split_words = c.generator_comp(
    c.this().pipe(
        split_words
    )
)

# flattening the result of ``vectorized_split_words``, which is
# a generator of generators of strings
flatten = c.call_func(
    chain.from_iterable,
    c.this(),
)

# aggregate the input, the result is a single dict
# words are keys, values are count of words
dict_word_to_count = c.aggregate(
    c.reduce(
        c.ReduceFuncs.DictCount,
        (c.this(), c.this()),
        default=dict
    )
)

# take top N words by:
#  - call ``.items()`` method of the dict (the result of the aggregate)
#  - pass the result to ``sorted``
#  - take the slice, using input argument named ``top_n``
#  - cast to a dict
take_top_n = (
    c.this().call_method("items")
    .pipe(sorted, key=lambda t: t[1], reverse=True)
    .pipe(c.this()[:c.input_arg("top_n")])
    .as_type(dict)
)

# the resulting pipeline is pretty self-descriptive, except the ``c.if_``
# part, which checks the condition (first argument),
# and returns the 2nd if True OR the 3rd (input data by default) otherwise
pipeline = (
    extract_strings
    .pipe(flatten)
    .pipe(vectorized_split_words)
    .pipe(flatten)
    .pipe(dict_word_to_count)
    .pipe(
        c.if_(
            c.input_arg("top_n").is_not(None),
            c.this().pipe(take_top_n),
        )
    )
# Define the resulting converter function signature.
# In fact this isn't necessary if you don't need to specify default values
).gen_converter(debug=True, signature="data_, top_n=None")

# check the speed yourself :)
# e.g. take a look in txt format and tune the ``extract_strings``
# conversion as needed
pipeline(input_data, top_n=3)

Generated code:

def aggregate(data_):
    global add_label_, get_by_label_
    _none = v123_497
    agg_data_v0_ = _none
    expected_checksum_ = 1
    checksum_ = 0
    it_ = iter(data_)
    for row_ in it_:

        if agg_data_v0_ is _none:
            agg_data_v0_ = {row_: 1}

            if agg_data_v0_ is not _none:
                checksum_ |= 1
                if checksum_ == expected_checksum_:
                    break

        else:
            if row_ not in agg_data_v0_:
                agg_data_v0_[row_] = 1
            else:
                agg_data_v0_[row_] += 1

    for row_ in it_:

        if row_ not in agg_data_v0_:
            agg_data_v0_[row_] = 1
        else:
            agg_data_v0_[row_] += 1

    result_ = dict() if agg_data_v0_ is _none else agg_data_v0_

    return result_

def converter459_881(data_, top_n=None):
    pipe459_557 = (read_file376_398(i458_940) for i458_940 in data_)
    pipe459_694 = from_iterable401_690(pipe459_557)
    pipe459_916 = (
        (i397_760.group(0).lower() for i397_760 in v379_129.finditer(i456_473))
        for i456_473 in pipe459_694
    )
    pipe459_431 = from_iterable401_690(pipe459_916)
    pipe459_970 = aggregate469_287(pipe459_431)
    return (
        dict(
            (
                sorted(pipe459_970.items(), key=lambda418_804, reverse=True)[
                    (slice(None, top_n, None))
                ]
            )
        )
        if (top_n is not None)
        else pipe459_970
    )

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for convtools, version 0.5.3
Filename, size File type Python version Upload date Hashes
Filename, size convtools-0.5.3.tar.gz (80.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page