Python: module filecmp

filecmp

Utilities for comparing files and directories. Classes: dircmp Functions: cmp(f1, f2, shallow=1, use_statcache=0) -> int cmpfiles(a, b, common) -> ([], [], [])

Modules

stat

statcache

Classes

dircmp

class dircmp

A class that manages the comparison of 2 directories. dircmp(a,b,ignore=None,hide=None) A and B are directories. IGNORE is a list of names to ignore, defaults to ['RCS', 'CVS', 'tags']. HIDE is a list of names to hide, defaults to [os.curdir, os.pardir]. High level usage: x = dircmp(dir1, dir2) x.report() -> prints a report on the differences between dir1 and dir2 or x.report_partial_closure() -> prints report on differences between dir1 and dir2, and reports on common immediate subdirectories. x.report_full_closure() -> like report_partial_closure, but fully recursive. Attributes: left_list, right_list: The files in dir1 and dir2, filtered by hide and ignore. common: a list of names in both dir1 and dir2. left_only, right_only: names only in dir1, dir2. common_dirs: subdirectories in both dir1 and dir2. common_files: files in both dir1 and dir2. common_funny: names in both dir1 and dir2 where the type differs between dir1 and dir2, or the name is not stat-able. same_files: list of identical files. diff_files: list of filenames which differ. funny_files: list of files which could not be compared. subdirs: a dictionary of dircmp objects, keyed by names in common_dirs.

Methods defined here:

__getattr__(self, attr)

__init__(self, a, b, ignore=None, hide=None)

phase0(self)

phase1(self)

phase2(self)

phase3(self)

phase4(self)

phase4_closure(self)

report(self)

report_full_closure(self)

report_partial_closure(self)

Data and non-method functions defined here:

__doc__ = 'A class that manages the comparison of 2 direct...p objects, keyed by names in common_dirs.\n '

__module__ = 'filecmp'

_dircmp__p0_attrs = ('left_list', 'right_list')

_dircmp__p1_attrs = ('common', 'left_only', 'right_only')

_dircmp__p2_attrs = ('common_dirs', 'common_files', 'common_funny')

_dircmp__p3_attrs = ('same_files', 'diff_files', 'funny_files')

_dircmp__p4_attrs = ('subdirs',)

Functions

_cmp(a, b, sh, st): # Compare two files. # Return: # 0 for equal # 1 for different # 2 for funny cases (can't stat, etc.)

_do_cmp(f1, f2)

_filter(list, skip): # Return a copy with items that occur in skip removed.

_sig(st)

cmp(f1, f2, shallow=1, use_statcache=0): Compare two files. Arguments: f1 -- First file name f2 -- Second file name shallow -- Just check stat signature (do not read the files). defaults to 1. use_statcache -- Do not stat() each file directly: go through the statcache module for more efficiency. Return value: integer -- 1 if the files are the same, 0 otherwise. This function uses a cache for past comparisons and the results, with a cache invalidation mechanism relying on stale signatures. Of course, if 'use_statcache' is true, this mechanism is defeated, and the cache will never grow stale.

cmpfiles(a, b, common, shallow=1, use_statcache=0): Compare common files in two directories. a, b -- directory names common -- list of file names found in both directories shallow -- if true, do comparison based solely on stat() information use_statcache -- if true, use statcache.stat() instead of os.stat() Returns a tuple of three lists: files that compare equal files that are different filenames that aren't regular files.

demo(): # Demonstration and testing.

Data
		BUFSIZE = 8192 __all__ = ['cmp', 'dircmp', 'cmpfiles'] __file__ = '/usr/lib/python2.2/filecmp.pyc' __name__ = 'filecmp' _cache = {}