Skip to main content

A library of utility functions for coputing diffs between tree-like data structures.

Project description

treediffer

version build codecov pypi docs

A library of utility functions for computing diffs between tree-like data structures.

Installation

pip install treediffer

Usage example

Given studio tree JSON-archive versions of the maintree and the stagingtree of a Studio channel generated using ./contentcuration/manage.py archivechannel ..., you can compute the tree diff between them using:

>>> from treediffer import treediff
>>> diff = treediff(maintree, stagingtree, preset="studio", format="simplified")
>>> diff
{
  "nodes_deleted": [...],   # content_ids gone in stagingtree
  "nodes_added": [...],     # new content_ids in stagingtree
  "nodes_moved": [...],     # same content_id but different node_id
  "nodes_modified": [...],  # same node_id, but changes in node attributes
}

This code examples uses the "high level" API based on the studio preset that set all the necessary lookups (node_id, content_id, parent, assetment_items, etc.) so the diffing logic will work. See examples/studiodiffferpoc.py for full script.

Ricecooker tree diffing

See examples/ricecookerdiffpoc.py for similar script that diffs ricecooker trees that get saved in chefdata/trees/ dir after each content integration script runs.

Alternative diff formats

Use format="restructured" to post-process the simplified diff and group additions and deletions into logical subtrees (e.g. if whole topic is deleted, show as subtree). This is the default when printing on command line as in the example scripts.

Use format="raw" to see the diff before simplification and move detection (for debugging).

Tests

pytest

and

pytest --cov=src/treediffer tests/

Documentation

Visit https://treediffer.readthedocs.io/ for more info about how this works In particular see https://treediffer.readthedocs.io/en/latest/diff_formats.html for the the details about the structure of the diffs produced and https://treediffer.readthedocs.io/en/latest/design.html for API advanced usage.

TODOs

  • Finish basic functionality
  • add example ricecooker differ
  • add example studio differ
  • Add kitchen sink test for combined deleted, added, moved, and modified

Project details


Download files

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

Source Distribution

treediffer-0.0.3.tar.gz (26.8 kB view details)

Uploaded Source

File details

Details for the file treediffer-0.0.3.tar.gz.

File metadata

  • Download URL: treediffer-0.0.3.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.9

File hashes

Hashes for treediffer-0.0.3.tar.gz
Algorithm Hash digest
SHA256 d91d60c1fba9be37c6a150cee96abfb332c8a6efd6478555c3b9b40c4d2a8724
MD5 22c09a545975d7c19c0290563fdcd5bf
BLAKE2b-256 50097e7a9ee52ddac6c75ae3a3a9480ef4222de520f99bca1cff433f36f78f12

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page