check_headers Namespace Reference

Functions
	verbose_print (s)
	check_directory (path)
	check_file (path)

Variables
list	exclude_matches
list	filetype_matches
str	header
list	header_match
int	max_depth = 32
int	depth = 0
bool	verbose = False
	parser = argparse.ArgumentParser()
	action
	type
	default
	help
	nargs
	const
	required
	False
	int
	args = parser.parse_args()
	base_dir = args.base_dir[0]
	gitignore_path = os.path.join(base_dir, ".gitignore")
	line = line.replace('*', '.*').replace('\n', "")

Function Documentation

check_directory()

check_headers.check_directory

(

path

)

check_file()

check_headers.check_file

(

path

)

verbose_print()

check_headers.verbose_print

(

s

)

Variable Documentation

action

check_headers.action

args

check_headers.args = parser.parse_args()

base_dir

check_headers.base_dir = args.base_dir[0]

const

check_headers.const

default

check_headers.default

depth

int check_headers.depth = 0

exclude_matches

check_headers.exclude_matches

Initial value:

=  [
    "[\\/]\.", # any top level .git or .vscode etc
    "__pycache__",
    "build"
]

False

check_headers.False

filetype_matches

check_headers.filetype_matches

Initial value:

=  [
    ".*\.py$",
    ".*\.(c|h|cpp|hpp)$",
]

gitignore_path

check_headers.gitignore_path = os.path.join(base_dir, ".gitignore")

header

str check_headers.header

header_match

check_headers.header_match

Initial value:

=  [
    "Copyright \\(c\\) ([0-9]{4})(-[0-9]{4})?",
    "/\*[^\n/]*Cascoda[^\n/]*\*/"
]

help

check_headers.help

int

check_headers.int

line

check_headers.line = line.replace('*', '.*').replace('\n', "")

max_depth

int check_headers.max_depth = 32

nargs

check_headers.nargs

parser

check_headers.parser = argparse.ArgumentParser()

required

check_headers.required

type

check_headers.type

verbose

bool check_headers.verbose = False