bump_copyright Namespace Reference

Functions
def	has_hidden_dirs (dirpath)
def	get_the_paths (root_dir)
def	do_the_subs (path_collection, search, replace)

Variables
string	search_string = r'Copyright \(c\) 2003-20\d\d'
string	replace_string = r'Copyright (c) 2003-2020'
string	d = "."
	path_collection = get_the_paths(d)

Detailed Description

Walk the directory tree and replace the '20XX' copyright dates in lines with
'Copyright 2003-20XX' with '2016'. Usage:

    ./bump_copyright.py          # use "." as the start directory
    ./bump_copyright.py dirname  # use dirname as the start directory

Function Documentation

def bump_copyright.do_the_subs	(		path_collection,
			search,
			replace
	)

Look for the copyright string and sub the date

Definition at line 50 of file bump_copyright.py.

def do_the_subs(path_collection, search, replace):
    """
    Look for the copyright string and sub the date
    """
    for path in path_collection:
        with open(path, 'r+') as p:
            contents = p.read()
            pattern = re.compile(search)
            contents = pattern.sub(replace, contents)
            p.seek(0)
            p.truncate()
            p.write(contents)

def bump_copyright.get_the_paths

(

root_dir

)

Get all the files NOT in hidden directories

Definition at line 34 of file bump_copyright.py.

def get_the_paths(root_dir):
    """
    Get all the files NOT in hidden directories
    """
    path_collection = []
    for dirpath, dirnames, filenames in os.walk(root_dir):
        use_dir = not has_hidden_dirs(dirpath)
        if use_dir:
            for filename in filenames:
                # Don't try to replace the strings in this script
                if not re.search(sys.argv[0].split("/")[-1], filename):
                    fullpath = os.path.join(dirpath, filename)
                    path_collection.append(fullpath)
    return path_collection

def bump_copyright.has_hidden_dirs

(

dirpath

)

Check if the directory path has any directories leading with a '.' (accept
the current working directory as okay).

Definition at line 20 of file bump_copyright.py.

def has_hidden_dirs(dirpath):
    """
    Check if the directory path has any directories leading with a '.' (accept
    the current working directory as okay).
    """
    dirs = dirpath.split("/")
    for dir in dirs:
        # match - anchor a "." at the beginning, then 1 or more of any char
        m = re.match(r'^\.(.+)', dir)
        if m:
            return True
    return False

Variable Documentation

bump_copyright.d = "."

Definition at line 70 of file bump_copyright.py.

bump_copyright.path_collection = get_the_paths(d)

Definition at line 74 of file bump_copyright.py.

string bump_copyright.replace_string = r'Copyright (c) 2003-2020'

Definition at line 17 of file bump_copyright.py.

string bump_copyright.search_string = r'Copyright \(c\) 2003-20\d\d'

Definition at line 16 of file bump_copyright.py.