| # Licensed to the Apache Software Foundation (ASF) under one or more |
| # contributor license agreements. See the NOTICE file distributed with |
| # this work for additional information regarding copyright ownership. |
| # The ASF licenses this file to You under the Apache License, Version 2.0 |
| # (the "License"); you may not use this file except in compliance with |
| # the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| |
| import sys |
| import os |
| import re |
| |
| reHREF = re.compile('<a.*?>(.*?)</a>', re.IGNORECASE) |
| |
| reMarkup = re.compile('<.*?>') |
| |
| def checkSummary(fullPath): |
| printed = False |
| f = open(fullPath) |
| lastLine = None |
| anyMissing = False |
| sawPackage = False |
| desc = [] |
| for line in f.readlines(): |
| lineLower = line.strip().lower() |
| if desc is not None: |
| # TODO: also detect missing description in overview-summary |
| if lineLower.startswith('package ') or lineLower.startswith('<h1 title="package" '): |
| sawPackage = True |
| elif sawPackage: |
| if lineLower.startswith('<table ') or lineLower.startswith('<b>see: '): |
| desc = ' '.join(desc) |
| desc = reMarkup.sub(' ', desc) |
| desc = desc.strip() |
| if desc == '': |
| if not printed: |
| print |
| print fullPath |
| printed = True |
| print ' no package description (missing package.html in src?)' |
| anyMissing = True |
| desc = None |
| else: |
| desc.append(lineLower) |
| |
| if lineLower in ('<td> </td>', '<td></td>', '<td class="collast"> </td>'): |
| m = reHREF.search(lastLine) |
| if not printed: |
| print |
| print fullPath |
| printed = True |
| print ' missing: %s' % unescapeHTML(m.group(1)) |
| anyMissing = True |
| lastLine = line |
| if desc is not None and fullPath.find('/overview-summary.html') == -1: |
| raise RuntimeError('BUG: failed to locate description in %s' % fullPath) |
| f.close() |
| return anyMissing |
| |
| def unescapeHTML(s): |
| s = s.replace('<', '<') |
| s = s.replace('>', '>') |
| s = s.replace('&', '&') |
| return s |
| |
| def checkPackageSummaries(root): |
| """ |
| Just checks for blank summary lines in package-summary.html; returns |
| True if there are problems. |
| """ |
| |
| #for dirPath, dirNames, fileNames in os.walk('%s/lucene/build/docs/api' % root): |
| |
| if False: |
| os.chdir(root) |
| print |
| print 'Run "ant javadocs" > javadocs.log...' |
| if os.system('ant javadocs > javadocs.log 2>&1'): |
| print ' FAILED' |
| sys.exit(1) |
| |
| anyMissing = False |
| for dirPath, dirNames, fileNames in os.walk(root): |
| |
| if dirPath.find('/all/') != -1: |
| # These are dups (this is a bit risk, eg, root IS this /all/ directory..) |
| continue |
| |
| if 'package-summary.html' in fileNames: |
| if checkSummary('%s/package-summary.html' % dirPath): |
| anyMissing = True |
| if 'overview-summary.html' in fileNames: |
| if checkSummary('%s/overview-summary.html' % dirPath): |
| anyMissing = True |
| |
| return anyMissing |
| |
| if __name__ == '__main__': |
| checkPackageSummaries(sys.argv[1]) |
