add_headers Namespace Reference

Functions
def	add_headers (directories, file_types, cchar="!", author="Rohit Goswami <rgoswami[at]ieee.org>", repository_url="https://github.com/HaoZeke/GaussJacobiQuad", library_name="GaussJacobiQuad", date=current_date, commit=commit_hash)

Variables
	GITROOT = os.popen("git rev-parse --show-toplevel").read().strip()
	current_date = datetime.now().strftime("%Y-%m-%d")
	commit_hash = os.popen("git rev-parse HEAD").read().strip()[:7]
	header_template
	parser = argparse.ArgumentParser(description="Add headers to source files.")
	type
	str
	required
	True
	nargs
	help
	args = parser.parse_args()
	file_types = args.ftypes.split(",")

Function Documentation

add_headers()

def add_headers.add_headers	(		directories,
			file_types,
			cchar = "!",
			author = "Rohit Goswami <rgoswami[at]ieee.org>",
			repository_url = "https://github.com/HaoZeke/GaussJacobiQuad",
			library_name = "GaussJacobiQuad",
			date = current_date,
			commit = commit_hash
	)

Definition at line 44 of file add_headers.py.

):
    # Fill in the template variables
    header_text = header_template.render(
        author=author,
        repository_url=repository_url,
        library_name=library_name,
        date=current_date,
        commit=commit_hash,
        cchar=cchar,
    )
    for directory in directories:
        # Iterate over all files in the specified directory
        for root, dirs, files in os.walk(directory):
            for filename in files:
                if any(filename.endswith(suffix) for suffix in file_types):
                    filepath = os.path.join(root, filename)
 
                    with open(filepath, "r") as file:
                        content = file.read()
 
                    # Check for the existing header and replace or append
                    if "BEGIN_HEADER" in content and "END_HEADER" in content:
                        content = re.sub(
                            rf"{cchar} BEGIN_HEADER.*?{cchar} END_HEADER\n",
                            header_text,
                            content,
                            flags=re.DOTALL,
                        )
                    else:
                        content = header_text + content
 
                    with open(filepath, "w") as file:
                        file.write(content)
 
        print("Headers added or updated in all files in" f" {directory} using {cchar}.")
 
 

Variable Documentation

args

add_headers.args = parser.parse_args()

Definition at line 103 of file add_headers.py.

commit_hash

add_headers.commit_hash = os.popen("git rev-parse HEAD").read().strip()[:7]

Definition at line 17 of file add_headers.py.

current_date

add_headers.current_date = datetime.now().strftime("%Y-%m-%d")

Definition at line 14 of file add_headers.py.

file_types

add_headers.file_types = args.ftypes.split(",")

Definition at line 104 of file add_headers.py.

GITROOT

add_headers.GITROOT = os.popen("git rev-parse --show-toplevel").read().strip()

Definition at line 11 of file add_headers.py.

header_template

add_headers.header_template

Initial value:

=  Template(
    
)

Definition at line 20 of file add_headers.py.

help

add_headers.help

Definition at line 93 of file add_headers.py.

nargs

add_headers.nargs

Definition at line 93 of file add_headers.py.

parser

add_headers.parser = argparse.ArgumentParser(description="Add headers to source files.")

Definition at line 91 of file add_headers.py.

required

add_headers.required

Definition at line 93 of file add_headers.py.

str

add_headers.str

Definition at line 93 of file add_headers.py.

True

add_headers.True

Definition at line 93 of file add_headers.py.

type

add_headers.type

Definition at line 93 of file add_headers.py.