IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

utils: Use better variable names in check_fileheader

Browse Source 
We're going to be doing some surgery on this function, so first clean it
up before we do anything else.

Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
Stephen Finucane 2017-10-02 19:24:13 +01:00
parent ae08b2d794
commit 64b4d7c686
1 changed files with 23 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
utils/check_sources.py
View File

@ -98,47 +98,46 @@ def check_style(fn, lines):
@checker('.py', only_pkg=True) @checker('.py', only_pkg=True)
def check_fileheader(fn, lines): def check_fileheader(fn, lines):
# line number correction # line number correction
c = 1 offset = 1
if lines[0:1] == ['#!/usr/bin/env python\n']: if lines[0:1] == ['#!/usr/bin/env python\n']:
lines = lines[1:] lines = lines[1:]
c = 2 offset = 2
llist = [] llist = []
docopen = False doc_open = False
for lno, l in enumerate(lines): for lno, line in enumerate(lines):
llist.append(l) llist.append(line)
if lno == 0: if lno == 0:
if l != '# -*- coding: utf-8 -*-\n': if line != '# -*- coding: utf-8 -*-\n':
yield 1, "missing coding declaration" yield 1, "missing coding declaration"
elif lno == 1: elif lno == 1:
if l != '"""\n' and l != 'r"""\n': if line != '"""\n' and line != 'r"""\n':
yield 2, 'missing docstring begin (""")' yield 2, 'missing docstring begin (""")'
else: else:
docopen = True doc_open = True
elif docopen: elif doc_open:
if l == '"""\n': if line == '"""\n':
# end of docstring # end of docstring
if lno <= 4: if lno <= 4:
yield lno + c, "missing module name in docstring" yield lno + offset, "missing module name in docstring"
break break
if l != '\n' and l[:4] != ' ' and docopen: if line != '\n' and line[:4] != ' ' and doc_open:
yield lno + c, "missing correct docstring indentation" yield lno + offset, "missing correct docstring indentation"
if lno == 2: if lno == 2:
# if not in package, don't check the module name # if not in package, don't check the module name
modname = fn[:-3].replace('/', '.').replace('.__init__', '') mod_name = fn[:-3].replace('/', '.').replace('.__init__', '')
while modname: while mod_name:
if l.lower()[4:-1] == modname: if line.lower()[4:-1] == mod_name:
break break
modname = '.'.join(modname.split('.')[1:]) mod_name = '.'.join(mod_name.split('.')[1:])
else: else:
yield 3, "wrong module name in docstring heading" yield 3, "wrong module name in docstring heading"
modnamelen = len(l.strip()) mod_name_len = len(line.strip())
elif lno == 3: elif lno == 3:
if l.strip() != modnamelen * '~': if line.strip() != mod_name_len * '~':
yield 4, "wrong module name underline, should be ~~~...~" yield 4, "wrong module name underline, should be ~~~...~"
else: else:
yield 0, "missing end and/or start of docstring..." yield 0, "missing end and/or start of docstring..."
@ -147,11 +146,11 @@ def check_fileheader(fn, lines):
if not license or not license_re.match(license[0]): if not license or not license_re.match(license[0]):
yield 0, "no correct license info" yield 0, "no correct license info"
ci = -3 offset = -3
copyright = llist[ci:ci + 1] copyright = llist[offset:offset + 1]
while copyright and copyright_2_re.match(copyright[0]): while copyright and copyright_2_re.match(copyright[0]):
ci -= 1 offset -= 1
copyright = llist[ci:ci + 1] copyright = llist[offset:offset + 1]
if not copyright or not copyright_re.match(copyright[0]): if not copyright or not copyright_re.match(copyright[0]):
yield 0, "no correct copyright info" yield 0, "no correct copyright info"