Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add diff class to generate diff HTML (and fix build) #477

Merged
merged 2 commits into from
Jul 14, 2016
Merged

Add diff class to generate diff HTML (and fix build) #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3266fb2
Add diff class to generate diff HTML
thauk-copperleaf Jun 16, 2016
5f2a3bf
Remove dependency on itertools.izip to fix Python 3.x builds and repl…
thauk-copperleaf Jun 16, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
58 changes: 31 additions & 27 deletions import_export/resources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
from __future__ import unicode_literals

import itertools
import functools
import sys
import tablib
import traceback
from copy import deepcopy
Expand Down Expand Up @@ -166,6 +164,32 @@ def __new__(cls, name, bases, attrs):
return new_class


class Diff(object):
def __init__(self, resource, instance, new):
self.left = self._export_resource_fields(resource, instance)
self.right = []
self.new = new

def compare_with(self, resource, instance, dry_run=False):
self.right = self._export_resource_fields(resource, instance)

def as_html(self):
data = []
dmp = diff_match_patch()
for v1, v2 in zip(self.left, self.right):
if v1 != v2 and self.new:
v1 = ""
diff = dmp.diff_main(force_text(v1), force_text(v2))
dmp.diff_cleanupSemantic(diff)
html = dmp.diff_prettyHtml(diff)
html = mark_safe(html)
data.append(html)
return data

def _export_resource_fields(self, resource, instance):
return [resource.export_field(f, instance) if instance else "" for f in resource.get_user_visible_fields()]


class Resource(six.with_metaclass(DeclarativeMetaclass)):
"""
Resource defines how objects are mapped to their import and export
Expand Down Expand Up @@ -342,26 +366,6 @@ def skip_row(self, instance, original):
return False
return True

def get_diff(self, original_fields, new, current_fields, dry_run=False):
"""
Get diff between original and current object when ``import_data``
is run.

``dry_run`` allows handling special cases when object is not saved
to database (ie. m2m relationships).
"""
data = []
dmp = diff_match_patch()
for v1, v2 in itertools.izip(original_fields, current_fields):
if v1 != v2 and new:
v1 = ""
diff = dmp.diff_main(force_text(v1), force_text(v2))
dmp.diff_cleanupSemantic(diff)
html = dmp.diff_prettyHtml(diff)
html = mark_safe(html)
data.append(html)
return data

def get_diff_headers(self):
"""
Diff representation headers.
Expand Down Expand Up @@ -428,15 +432,15 @@ def import_row(self, row, instance_loader, dry_run=False, **kwargs):
row_result.object_repr = force_text(instance)
row_result.object_id = instance.pk
original = deepcopy(instance)
original_fields = [self.export_field(f, original) if original else "" for f in self.get_user_visible_fields()]
diff = Diff(self, original, new)
if self.for_delete(row, instance):
if new:
row_result.import_type = RowResult.IMPORT_TYPE_SKIP
row_result.diff = self.get_diff([], False, [], dry_run)
diff.compare_with(self, None, dry_run)
else:
row_result.import_type = RowResult.IMPORT_TYPE_DELETE
self.delete_instance(instance, dry_run)
row_result.diff = self.get_diff(original_fields, False, [], dry_run)
diff.compare_with(self, None, dry_run)
else:
self.import_obj(instance, row, dry_run)
if self.skip_row(instance, original):
Expand All @@ -448,8 +452,8 @@ def import_row(self, row, instance_loader, dry_run=False, **kwargs):
# Add object info to RowResult for LogEntry
row_result.object_repr = force_text(instance)
row_result.object_id = instance.pk
instance_fields = [self.export_field(f, instance) if instance else "" for f in self.get_user_visible_fields()]
row_result.diff = self.get_diff(original_fields, new, instance_fields, dry_run)
diff.compare_with(self, instance, dry_run)
row_result.diff = diff.as_html()
self.after_import_row(row, row_result, **kwargs)
except Exception as e:
# There is no point logging a transaction error for each row
Expand Down
23 changes: 10 additions & 13 deletions tests/core/tests/resources_tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

from import_export import fields, resources, results, widgets
from import_export.instance_loaders import ModelInstanceLoader
from import_export.resources import Diff

from ..models import (
Author, Book, Category, Entry, Profile, WithDefault, WithDynamicDefault,
Expand Down Expand Up @@ -219,17 +220,15 @@ def test_export_iterable(self):
self.assertEqual(len(dataset), 1)

def test_get_diff(self):
book_fields = [self.resource.export_field(f, self.book) if self.book else ""
for f in self.resource.get_user_visible_fields()]
diff = Diff(self.resource, self.book, False)
book2 = Book(name="Some other book")
book2_fields = [self.resource.export_field(f, book2) if book2 else ""
for f in self.resource.get_user_visible_fields()]
diff = self.resource.get_diff(book_fields, False, book2_fields)
diff.compare_with(self.resource, book2)
html = diff.as_html()
headers = self.resource.get_export_headers()
self.assertEqual(diff[headers.index('name')],
self.assertEqual(html[headers.index('name')],
u'<span>Some </span><ins style="background:#e6ffe6;">'
u'other </ins><span>book</span>')
self.assertFalse(diff[headers.index('author_email')])
self.assertFalse(html[headers.index('author_email')])

@skip("See: https://github.com/django-import-export/django-import-export/issues/311")
def test_get_diff_with_callable_related_manager(self):
Expand All @@ -239,13 +238,11 @@ def test_get_diff_with_callable_related_manager(self):
author2 = Author(name="Some author")
self.book.author = author
self.book.save()
author_fields = [self.resource.export_field(f, author) if author else ""
for f in self.resource.get_user_visible_fields()]
author2_fields = [self.resource.export_field(f, author2) if author2 else ""
for f in self.resource.get_user_visible_fields()]
diff = resource.get_diff(author2_fields, False, author_fields)
diff = Diff(self.resource, author, False)
diff.compare_with(self.resource, author2)
html = diff.as_html()
headers = resource.get_export_headers()
self.assertEqual(diff[headers.index('books')],
self.assertEqual(html[headers.index('books')],
'<span>core.Book.None</span>')

def test_import_data(self):
Expand Down