[Patches] [ python-Patches-914575 ] difflib side by side diff
support, diff.py s/b/s HTML option
SourceForge.net
noreply at sourceforge.net
Fri Jul 23 15:24:58 CEST 2004
Patches item #914575, was opened at 2004-03-11 18:50
Message generated for change (Comment added) made by jimjjewett
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=914575&group_id=5470
Category: Modules
Group: Python 2.4
Status: Open
Resolution: None
Priority: 6
Submitted By: Dan Gass (dmgass)
Assigned to: Nobody/Anonymous (nobody)
Summary: difflib side by side diff support, diff.py s/b/s HTML option
Initial Comment:
lib/difflib.py:
Added support for generating side by side differences.
Intended to be used for generating HTML pages but is
generic where it can be used for other types of markup.
tools/scripts/diff.py:
Added -m option to use above patch to generate an
HTML page of side by side differences between two
files. The existing -c option when used with the new -m
option controls whether contextual differences are
shown or whether the entire file is displayed (number of
context lines is controlled by existing -l option).
NOTES:
(1) Textual context diffs were included as requested. In
addition, full and contextual HTML side by side
differences (that this patch generated) are also included
to assist in analyzing the differences and showing an
example.
(2) If this functionality is worthy of inclusion in the
standard python distribution, I am willing to provide more
documentation or make modifications to change the
interface or make improvements.
(3) When using Internet Explorer some font sizes seem
to skew things a bit. Generally I've found the "smallest"
to work best. If someone knows why, I'd be interested
in making any necessary adjustments in the generated
HTML.
----------------------------------------------------------------------
Comment By: Jim Jewett (jimjjewett)
Date: 2004-07-23 09:24
Message:
Logged In: YES
user_id=764593
I agree that users should be able to override the template.
I think Raymond was concerned about
(1) backwards compatibility if you want to change the
interface. For instance, you might later decide that there
should be separate templates for header/footer/match section/
changed line/added line/deleted line.
(2) matching the other diff options, so this doesn't look far
more complicated.
Unfortunately, at the moment I don't see a good way to solve
those; using a private member and access functions wouldn't
really simplify things much.
----------------------------------------------------------------------
Comment By: Dan Gass (dmgass)
Date: 2004-07-23 07:53
Message:
Logged In: YES
user_id=995755
I intend on implementing all the suggestions from the last
two comment submissions when I hear back from Raymond
Hettinger. I'm questioning making the templates private
global variables. I intentionally made them members of a
class so that they could be overridden when the class is
subclassed.
----------------------------------------------------------------------
Comment By: Raymond Hettinger (rhettinger)
Date: 2004-07-19 09:12
Message:
Logged In: YES
user_id=80475
Unfortunately, I do not have time to give this more review.
Several thoughts:
- consider making mdiff as private. that will leave its API
flexible to accomodate future changes
- move the templates to private global variables and work to
improve their indentation so that the html is readable
- inline the code for _escape from sax. the three replaces
are not worth the interdependency
- the methods work fine with properly formatted input but
crash badly when the newlines have been stripped. So,
either make the code more flexible or add error handling.
- overall, nice job.
----------------------------------------------------------------------
Comment By: Adam Souzis (asouzis)
Date: 2004-07-17 15:12
Message:
Logged In: YES
user_id=57486
The diffs look cool but if the to and from lines are
identical an exception is thrown:
File "<string>", line 23, in makeDiff
File "c:\_dev\rx4rdf\rx\htmldiff.py", line 1687, in make_file
summary=summary))
File "c:\_dev\rx4rdf\rx\htmldiff.py", line 1741, in make_table
if not diff_flags[0]:
IndexError: list index out of range
(This is on python 2.3.3 -- I renamed your difflib.py to
htmldiff.py and put it in site-packages)
Perhaps you should add the case of two identical files to
test_difflib.py.
thanks
----------------------------------------------------------------------
Comment By: Dan Gass (dmgass)
Date: 2004-07-16 05:16
Message:
Logged In: YES
user_id=995755
Since I have not gotten any feedback on the user interface I
took the liberty to tweek it the best I thought how. Since I
consider this new functionality very solid I went ahead and
created changes to the documentation and test suite.
Per Martin v. Löwis (loewis) instructions I generated a patch
which hopefully meets his needs. My CVS access is limited to
the web interface and thus the patch is based on the latest
checked in as of today:
python/python/dist/src/Lib/difflib.py -- rev 1.21
python/python/dist/src/Tools/scripts/diff.py -- rev 1.2
python/python/dist/src/Lib/test/test_difflib.py -- rev 1.10
python/python/dist/src/Doc/lib/libdifflib.tex -- rev 1.17
Note, I am not very familiar with .tex but it seemed straight
forward. I editted the file by hand and it should be very close
to what I intended. Unfortunately I am not set up to convert
the .tex to HTML. I may try that next week.
----------------------------------------------------------------------
Comment By: Dan Gass (dmgass)
Date: 2004-07-16 05:13
Message:
Logged In: YES
user_id=995755
Since I have not gotten any feedback on the user interface I
took the liberty to tweek it the best I thought how. Since I
consider this new functionality very solid I went ahead and
created changes to the documentation and test suite.
Per Martin v. Löwis (loewis) instructions I generated a patch
which hopefully meets his needs. My CVS access is limited to
the web interface and thus the patch is based on the latest
checked in as of today:
python/python/dist/src/Lib/difflib.py -- rev 1.21
python/python/dist/src/Tools/scripts/diff.py -- rev 1.2
python/python/dist/src/Lib/test/test_difflib.py -- rev 1.10
python/python/dist/src/Doc/lib/libdifflib.tex -- rev 1.17
Note, I am not very familiar with .tex but it seemed straight
forward. I editted the file by hand and it should be very close
to what I intended. Unfortunately I am not set up to convert
the .tex to HTML. I may try that next week.
----------------------------------------------------------------------
Comment By: Martin v. Löwis (loewis)
Date: 2004-07-15 02:30
Message:
Logged In: YES
user_id=21627
The pack lacks changes to the documentation (libdifflib.tex)
and changes to the test suite. Please always submit patches
as single unified or context diffs, rather than zip files of
the revised files.
----------------------------------------------------------------------
Comment By: Dan Gass (dmgass)
Date: 2004-07-02 14:17
Message:
Logged In: YES
user_id=995755
With the updated patch code I just posted, both full and
contextual differences pass the validator.w3.org check
(XHTML 1.0 Transitional). Also the extra carriage returns
put in by DOS were removed from the difflib.py patch.
----------------------------------------------------------------------
Comment By: Walter Dörwald (doerwalter)
Date: 2004-06-25 14:01
Message:
Logged In: YES
user_id=89016
Submitting difflib_context.html to validator.w3.org gives 2333
errors. The character encoding is missing and there's no
DOCTYPE declaration. The rest of the errors seem to be
mostly related to the nowrap attribute (which must be written
as nowrap="nowrap", as this is the only allowed value).
Furthermore the patch contains a mix of CR and CRLF
terminated lines.
----------------------------------------------------------------------
Comment By: Dan Gass (dmgass)
Date: 2004-06-24 02:23
Message:
Logged In: YES
user_id=995755
I just attached an updated patch. I based the patch on
diff.py(CVS1.1) and difflib.py(CVS1.20) which was the latest I
saw today on viewCVS.
The following enhancements were made:
1) user interface greatly simplified for generating HTML (see
diff.py for example)
2) generated HTML now 4.01 Transitional compliant (so says
HTML Tidy)
3) HTML color scheme for differences now matches that used
by viewCVS.
4) differences table now has a row for each line making the
HTML less susceptible to browser quirks.
5) took care of all issues to date enumerated here in this
patch.
It would be great if I could get some help on:
A) getting some JavaScript? written to be able to select and
cut text from a single column (right now text is selected from
the whole row including both "from" and "to" text and line
numbers.
B) solving the line width issue. Currently the "from" / "to"
column is as wide as the widest line. Any ideas on wrapping
or scrolling?
As of now the only feature I may want to add in the near
future is optional tab expansion.
Thanks to those that have commented here and emailed me
with suggestions and advice!
----------------------------------------------------------------------
Comment By: Jim Jewett (jimjjewett)
Date: 2004-06-11 10:35
Message:
Logged In: YES
user_id=764593
Thank you; I have often wished for side-by-side, but not quite
badly enough to write it.
That said, I would recommend some tweaks to the formatting.
"font" is deprecated; "span" would be better.
On my display, the "next" lines don't always seem to be
counted (except the first one), so that the anchors column is
not lined up with the others. (This would also be fixed by the
separate rows suggestion.)
Ideally, the line numbers would be in a separate column from
the code, to make cut'n'paste easier. (Then you could replace
font.num (or span.num) with td.linenum.)
Ideally, each change group should be a separate row in the
table. (I realize that this probably means a two-layer iterator,
so that the line breaks and blank lines can be inserted
correctly in the code columns.)
----------------------------------------------------------------------
Comment By: Dan Gass (dmgass)
Date: 2004-04-29 00:30
Message:
Logged In: YES
user_id=995755
Also, I will need to submit the fix for making it behave nice
when there are no differences!!
----------------------------------------------------------------------
Comment By: Dan Gass (dmgass)
Date: 2004-04-09 09:30
Message:
Logged In: YES
user_id=995755
In the time since submission I've found that the interface to
the chgFmt and lineFmt functions (arguments of mdiff) should
include both the line number and an indication of side
(from/to). The use for it I've found is for dropping anchors
into the generated markup that it can be hyperlinked from
elsewhere.
----------------------------------------------------------------------
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=914575&group_id=5470
More information about the Patches
mailing list