license_updater.main package

Subpackages

• license_updater.main.updaters package
  • Subpackages
    • license_updater.main.updaters.python_copyright_metadata package
      • Submodules
      • license_updater.main.updaters.python_copyright_metadata.update module
      • Module contents
  • Module contents

Submodules

license_updater.main.client module

class license_updater.main.client.LicenseUpdater(quiet=False, code_theme='vim', **kwargs)

Bases: object

Create a License Updater

collect_summary(script)

Collect a summary of the changes

detect(paths, details=True, updaters=None, ignore_patterns=None)

Look for changes in files according to updaters

iter_paths(paths)

Helper function to flexibly handle parsing paths.

show_summary()

Show summary of changes

update(paths, details=True, updaters=None, ignore_patterns=None)

Update files.

property updaters

Get a list of updaters available

license_updater.main.script module

class license_updater.main.script.ScriptFile(filename)

Bases: object

Parse a script and/or file into the updater.

We always present the changes (copy of original) and then can easily compare the two. The overall structure should not change.

diff(code_theme='vim', return_result=False)

Show diff between original (cfg) and changed!

property has_changes

Determine if before != after (the action has changed)

write(path)

Save the action to file.

license_updater.main.updater module

class license_updater.main.updater.UpdaterBase

Bases: object

property classpath

date_time_format = '%Y-%m-%dT%H:%M:%S%z'

description = 'An abstract base updater.'

abstract detect(*args, **kwargs)

file_regex = None

matches(path)

Determine if an updater matches a file.

name = 'updater'

property settings

Get settings specific to updater

property slug

property title

class license_updater.main.updater.UpdaterFinder

Bases: Mapping

Create a cache of available updaters.

load()

Load new updaters

Module contents