|
From: Doug H. <dou...@us...> - 2003-01-18 14:15:32
|
Update of /cvsroot/happydoc/HappyDoc3/happydoclib
In directory sc8-pr-cvs1:/tmp/cvs-serv7942/happydoclib
Modified Files:
scanner.py
Added Files:
cvsignore.py test_cvsignore.py
Log Message:
Update the scanner to read .cvsignore files and ignore anything listed
in them. Reads both the local .cvsignore (in the current directory)
and the one in $HOME (if it exists) to mimic the behavior of cvs.
--- NEW FILE: cvsignore.py ---
#!/usr/bin/env python
#
# $Id: cvsignore.py,v 1.1 2003/01/18 14:15:29 doughellmann Exp $
#
# Copyright 2003 Doug Hellmann.
#
#
# All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Class to encapsulate the .cvsignore logic.
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name' : '$RCSfile: cvsignore.py,v $',
'rcs_id' : '$Id: cvsignore.py,v 1.1 2003/01/18 14:15:29 doughellmann Exp $',
'creator' : 'Doug Hellmann <do...@he...>',
'project' : 'HappyDoc',
'created' : 'Sat, 18-Jan-2003 08:29:30 EST',
#
# Current Information
#
'author' : '$Author: doughellmann $',
'version' : '$Revision: 1.1 $',
'date' : '$Date: 2003/01/18 14:15:29 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
from fnmatch import fnmatch
import os
#
# Import Local modules
#
#
# Module
#
class CVSIgnoreList:
def __init__(self, ignoreFileNames):
self.patterns = []
self.ignore_filenames = ignoreFileNames
for filename in self.ignore_filenames:
self.readIgnoreFile(filename)
return
def readIgnoreFile(self, filename):
"""Reads a .cvsignore file to include its patterns with the patterns
read from other files.
"""
try:
file = open(filename, 'rt')
except IOError:
return
else:
lines = file.readlines()
file.close()
patterns = [ s.strip() for s in lines ]
for pattern in patterns:
if pattern not in self.patterns:
self.patterns.append(pattern)
return
def shouldIgnoreFile(self, filename):
"""Returns true if the filename should be ignored.
"""
basename = os.path.basename(filename)
for pattern in self.patterns:
if basename == pattern:
return 1
elif fnmatch(basename, pattern):
return 1
return 0
--- NEW FILE: test_cvsignore.py ---
#!/usr/bin/env python
#
# $Id: test_cvsignore.py,v 1.1 2003/01/18 14:15:29 doughellmann Exp $
#
# Copyright 2003 Doug Hellmann.
#
#
# All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Test the cvsignore module.
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name' : '$RCSfile: test_cvsignore.py,v $',
'rcs_id' : '$Id: test_cvsignore.py,v 1.1 2003/01/18 14:15:29 doughellmann Exp $',
'creator' : 'Doug Hellmann <do...@he...>',
'project' : 'HappyDoc',
'created' : 'Sat, 18-Jan-2003 08:42:33 EST',
#
# Current Information
#
'author' : '$Author: doughellmann $',
'version' : '$Revision: 1.1 $',
'date' : '$Date: 2003/01/18 14:15:29 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
import unittest
#
# Import Local modules
#
from happydoclib.cvsignore import CVSIgnoreList
#
# Module
#
class CVSIgnoreTest(unittest.TestCase):
def testIgnoreExplicitName(self):
ignore_list = CVSIgnoreList([])
ignore_list.patterns.append('foo.txt')
if not ignore_list.shouldIgnoreFile('/tmp/foo.txt'):
self.fail('Should have ignored foo.txt.')
return
def testIgnorePatternWithExt(self):
ignore_list = CVSIgnoreList([])
ignore_list.patterns.append('*.pyc')
if not ignore_list.shouldIgnoreFile('/tmp/foo.pyc'):
self.fail('Should have ignored foo.pyc.')
return
def testNotIgnoreExplicitName(self):
ignore_list = CVSIgnoreList([])
if ignore_list.shouldIgnoreFile('/tmp/foo.txt'):
self.fail('Should not have ignored foo.txt.')
return
def testNotIgnorePatternWithExt(self):
ignore_list = CVSIgnoreList([])
if ignore_list.shouldIgnoreFile('/tmp/foo.pyc'):
self.fail('Should not have ignored foo.pyc.')
return
Index: scanner.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/scanner.py,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** scanner.py 1 Jan 2003 13:48:08 -0000 1.15
--- scanner.py 18 Jan 2003 14:15:29 -0000 1.16
***************
*** 70,73 ****
--- 70,74 ----
from happydoclib.trace import trace
from happydoclib.utils import *
+ from happydoclib.cvsignore import CVSIgnoreList
#
***************
*** 185,192 ****
--- 186,205 ----
contents = glob.glob(pattern)
+ local_cvsignore_filename = os.path.join(directoryName, '.cvsignore')
+ home_cvsignore_filename = os.path.join(os.environ['HOME'], '.cvsignore')
+ cvsignore_list = CVSIgnoreList(
+ (local_cvsignore_filename,
+ home_cvsignore_filename,
+ )
+ )
+
#
# Recurse
#
for subnode_name in contents:
+ if cvsignore_list.shouldIgnoreFile(subnode_name):
+ trace.write('Skipping %s, found in .cvsignore' % subnode_name,
+ outputLevel=TRACE_LEVEL)
+ continue
self.buildPackageTree(subnode_name, tree)
|
