check_copyright Namespace Reference

Functions
def	join_license_text (header, prefix, footer, notice)
def	load (name)
def	log (cond, why, filename)
def	save (name, text)
def	write_copyright (license_text, file_text, filename)

Variables
	_EXEMPT
	action
	argp = argparse.ArgumentParser(description='copyright checker')
	args = argp.parse_args()
	base = os.path.basename(filename)
	choices
	const
	default
	ext = os.path.splitext(filename)[1]
string	FILE_LIST_COMMAND = 'git status -z | grep -Poz \'(?<=^[MARC][MARCD ] )[^\s]+\''
list	filename_list = []
	LICENSE_NOTICE = f.read().splitlines()
dictionary	LICENSE_PREFIX_RE
dictionary	LICENSE_PREFIX_TEXT
	LICENSE_TEXT
	license_text = LICENSE_TEXT[ext]
string	LICENSE_YEAR = f'Copyright {YEAR} gRPC authors.'
	m = re.search(re_license, text)
bool	ok = True
	RE_LICENSE
	re_license = RE_LICENSE[ext]
string	RE_YEAR = r'Copyright (?P<first_year>[0-9]+\-)?(?P<last_year>[0-9]+) ([Tt]he )?gRPC [Aa]uthors(\.|)'
	ROOT = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), '../..'))
def	text = load(filename)
	YEAR = datetime.datetime.now().year

Function Documentation

join_license_text()

def check_copyright.join_license_text	(		header,
			prefix,
			footer,
			notice
	)

Definition at line 150 of file check_copyright.py.

load()

def check_copyright.load

(

name

)

Definition at line 181 of file check_copyright.py.

log()

def check_copyright.log	(		cond,
			why,
			filename
	)

Definition at line 194 of file check_copyright.py.

save()

def check_copyright.save	(		name,
			text
	)

Definition at line 186 of file check_copyright.py.

write_copyright()

def check_copyright.write_copyright	(		license_text,
			file_text,
			filename
	)

Definition at line 203 of file check_copyright.py.

Variable Documentation

_EXEMPT

check_copyright._EXEMPT

private

Definition at line 104 of file check_copyright.py.

action

check_copyright.action

Definition at line 34 of file check_copyright.py.

argp

check_copyright.argp = argparse.ArgumentParser(description='copyright checker')

Definition at line 29 of file check_copyright.py.

args

check_copyright.args = argp.parse_args()

Definition at line 38 of file check_copyright.py.

base

check_copyright.base = os.path.basename(filename)

Definition at line 232 of file check_copyright.py.

choices

check_copyright.choices

Definition at line 33 of file check_copyright.py.

const

check_copyright.const

Definition at line 34 of file check_copyright.py.

default

check_copyright.default

Definition at line 32 of file check_copyright.py.

ext

check_copyright.ext = os.path.splitext(filename)[1]

Definition at line 231 of file check_copyright.py.

FILE_LIST_COMMAND

string check_copyright.FILE_LIST_COMMAND = 'git status -z | grep -Poz \'(?<=^[MARC][MARCD ] )[^\s]+\''

Definition at line 174 of file check_copyright.py.

filename_list

check_copyright.filename_list = []

Definition at line 217 of file check_copyright.py.

LICENSE_NOTICE

check_copyright.LICENSE_NOTICE = f.read().splitlines()

Definition at line 42 of file check_copyright.py.

LICENSE_PREFIX_RE

dictionary check_copyright.LICENSE_PREFIX_RE

Initial value:

=  {
    '.bat': r'@rem\s*',
    '.c': r'\s*(?://|\*)\s*',
    '.cc': r'\s*(?://|\*)\s*',
    '.h': r'\s*(?://|\*)\s*',
    '.m': r'\s*\*\s*',
    '.mm': r'\s*\*\s*',
    '.php': r'\s*\*\s*',
    '.js': r'\s*\*\s*',
    '.py': r'#\s*',
    '.pyx': r'#\s*',
    '.pxd': r'#\s*',
    '.pxi': r'#\s*',
    '.rb': r'#\s*',
    '.sh': r'#\s*',
    '.proto': r'//\s*',
    '.cs': r'//\s*',
    '.mak': r'#\s*',
    '.bazel': r'#\s*',
    '.bzl': r'#\s*',
    'Makefile': r'#\s*',
    'Dockerfile': r'#\s*',
    'BUILD': r'#\s*',
}

Definition at line 48 of file check_copyright.py.

LICENSE_PREFIX_TEXT

dictionary check_copyright.LICENSE_PREFIX_TEXT

Initial value:

=  {
    '.bat': (None, '@rem', None),
    '.c': (None, '//', None),
    '.cc': (None, '//', None),
    '.h': (None, '//', None),
    '.m': ('/**', ' *', ' */'),
    '.mm': ('/**', ' *', ' */'),
    '.php': ('/**', ' *', ' */'),
    '.js': ('/**', ' *', ' */'),
    '.py': (None, '#', None),
    '.pyx': (None, '#', None),
    '.pxd': (None, '#', None),
    '.pxi': (None, '#', None),
    '.rb': (None, '#', None),
    '.sh': (None, '#', None),
    '.proto': (None, '//', None),
    '.cs': (None, '//', None),
    '.mak': (None, '#', None),
    '.bazel': (None, '#', None),
    '.bzl': (None, '#', None),
    'Makefile': (None, '#', None),
    'Dockerfile': (None, '#', None),
    'BUILD': (None, '#', None),
}

Definition at line 79 of file check_copyright.py.

LICENSE_TEXT

check_copyright.LICENSE_TEXT

Initial value:

=  dict(
    (k,
     join_license_text(LICENSE_PREFIX_TEXT[k][0], LICENSE_PREFIX_TEXT[k][1],
                       LICENSE_PREFIX_TEXT[k][2], LICENSE_NOTICE))
    for k, v in list(LICENSE_PREFIX_TEXT.items()))

Definition at line 167 of file check_copyright.py.

license_text

check_copyright.license_text = LICENSE_TEXT[ext]

Definition at line 235 of file check_copyright.py.

LICENSE_YEAR

string check_copyright.LICENSE_YEAR = f'Copyright {YEAR} gRPC authors.'

Definition at line 147 of file check_copyright.py.

m

check_copyright.m = re.search(re_license, text)

Definition at line 246 of file check_copyright.py.

ok

bool check_copyright.ok = True

Definition at line 216 of file check_copyright.py.

RE_LICENSE

check_copyright.RE_LICENSE

Initial value:

=  dict(
    (k, r'\n'.join(LICENSE_PREFIX_RE[k] +
                   (RE_YEAR if re.search(RE_YEAR, line) else re.escape(line))
                   for line in LICENSE_NOTICE))
    for k, v in list(LICENSE_PREFIX_RE.items()))

Definition at line 139 of file check_copyright.py.

re_license

check_copyright.re_license = RE_LICENSE[ext]

Definition at line 234 of file check_copyright.py.

RE_YEAR

string check_copyright.RE_YEAR = r'Copyright (?P<first_year>[0-9]+\-)?(?P<last_year>[0-9]+) ([Tt]he )?gRPC [Aa]uthors(\.|)'

Definition at line 138 of file check_copyright.py.

ROOT

check_copyright.ROOT = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), '../..'))

Definition at line 25 of file check_copyright.py.

text

def check_copyright.text = load(filename)

Definition at line 243 of file check_copyright.py.

YEAR

check_copyright.YEAR = datetime.datetime.now().year

Definition at line 145 of file check_copyright.py.