#15269: document dircmp.left and right.

Based on patch by Chris Jerdonek.
This commit is contained in:
R David Murray 2012-08-14 21:50:38 -04:00
parent 6ce21a3b84
commit becfcc0a6b
1 changed files with 25 additions and 0 deletions

View File

@ -106,6 +106,16 @@ The :class:`dircmp` class
to compute are used. to compute are used.
.. attribute:: left
The directory *a*.
.. attribute:: right
The directory *b*.
.. attribute:: left_list .. attribute:: left_list
Files and subdirectories in *a*, filtered by *hide* and *ignore*. Files and subdirectories in *a*, filtered by *hide* and *ignore*.
@ -168,3 +178,18 @@ The :class:`dircmp` class
A dictionary mapping names in :attr:`common_dirs` to :class:`dircmp` objects. A dictionary mapping names in :attr:`common_dirs` to :class:`dircmp` objects.
Here is a simplified example of using the ``subdirs`` attribute to search
recursively through two directories to show common different files::
>>> from filecmp import dircmp
>>> def print_diff_files(dcmp):
... for name in dcmp.diff_files:
... print "diff_file %s found in %s and %s" % (name, dcmp.left,
... dcmp.right)
... for sub_dcmp in dcmp.subdirs.values():
... print_diff_files(sub_dcmp)
...
>>> dcmp = dircmp('dir1', 'dir2')
>>> print_diff_files(dcmp)