""" Helps automatically modifying the dates of copyright for some S/W.

#-------------------------------------------------------------------------

def __init__(self, base_directory : str ,

excluded_directories: list = [],

excluded_suffixes : list = [] ) -> None:

'''Constructor.

self.base_directory = base_directory

self.excluded_directories = excluded_directories + ['__pycache__']

self.excluded_suffixes = excluded_suffixes

self.reset()

#-------------------------------------------------------------------------

def reset(self):

'''Resets internal status.

self.already_evaluated = False

self.current_year = str( date.today().year )

self.reg_exp = re.compile( '(1|2)[0-9]{3}' )

#-------------------------------------------------------------------------

def modify(self, stop_count: int = -1 ,

verbose : bool = False,

max_size : int = 50 ) -> None:

'''Runs the script that modifies the files content.

if not self.already_evaluated:

self.__run_directory( self.base_directory, stop_count, verbose, max_size )

#-------------------------------------------------------------------------

def __run_directory(self, dir_path: str ,

count : int ,

verbose : bool,

max_size: int ):

'''Recursively runs through directories to modify dates of copyright.

#-----------------------------------------------------------------

def _get_substring(match):

return match.string[ match.start():match.end() ]

#-----------------------------------------------------------------

def _print_verbose(src_filename):

if len(src_filename) <= max_size:

file_name = src_filename

else:

file_name = '...' + src_filename[3-max_size:]

the_format = '{' + ':{:d}s'.format( max_size ) + '} '

print( the_format.format( file_name ), end='' )

#-----------------------------------------------------------------

my_dir_content = [ os_path.join(dir_path, filename) for filename in os_listdir(dir_path) ]

my_subdirs = [ dirpath for dirpath in my_dir_content \

if os_path.isdir(dirpath) and os_path.basename(dirpath) not in self.excluded_directories ]

my_python_srcs = [ filepath for filepath in my_dir_content \

if os_path.isfile(filepath) and not ('.git' in filepath or '.settings' in filepath) ]

for subdir_path in my_subdirs:

self.__run_directory( subdir_path, count, verbose, max_size )

for python_src_path in my_python_srcs:

if verbose:

_print_verbose( python_src_path )

sys_stdout.flush()

if any(python_src_path.endswith(suffix) for suffix in self.excluded_suffixes):

if verbose: print( 'excluded' )

continue

b_modified = False

with open( python_src_path, 'r' ) as fp:

file_content = fp.readlines()

for num_line, line in enumerate(file_content):

if 'Copyright ' in line:

dates_match = [ d for d in self.reg_exp.finditer( line ) ]

if len(dates_match) == 1:

try:

# only one date. Is it current year?

the_year = _get_substring( dates_match[0] )

if the_year != self.current_year:

# well, no. So let's append current year in between

my_start_index, my_end_index = dates_match[0].start(), dates_match[0].end()

file_content[ num_line ] = '{}-{}{}'.format( line[:my_end_index],

self.current_year ,

line[my_end_index:] )

b_modified = True

except:

count += 1

else:

try:

# two dates (and no more according to our copyright conventions)

end_year = _get_substring( dates_match[1] )

# does last year equals current one?

if end_year != self.current_year:

# well, no. So, let's change ending year with current one

my_start_index, my_end_index = dates_match[1].start(), dates_match[1].end()

file_content[ num_line ] = '{}{}{}'.format( line[:my_start_index],

self.current_year ,

line[my_end_index:] )

b_modified = True

except:

count += 1

count -= 1

if count == 0:

# ok, let's stop modifying copyright dates in this file

break

if b_modified:

# some copyright dates have been modified,

# so we have to modify file

try:

if verbose:

print( 'modified' )

# save modified file

new_name = python_src_path+'~'

with open( new_name, 'w' ) as fp:

fp.writelines( file_content )

# remove former one

os_remove( python_src_path )

# rename new one

os_replace( new_name, python_src_path )

except Exception as e:

print( "!!! Exception raised while modifying file'{:s}\n -- {:s}".format( python_src_path, str(e) ) )

else:

if verbose:

print( 'ok' )