diff options
author | Andrew Butcher <abutcher@afrolegs.com> | 2017-01-25 11:37:48 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-01-25 11:37:48 -0500 |
commit | d8fee0cc8441812cdd5e7aaae815adad7a9bbee7 (patch) | |
tree | 81aafd9b795aeab7d64e1ae94fc72b3e5c7c576d /roles/lib_utils/src/generate.py | |
parent | 22706eb1bef19329ac0e72303d02f1c47e48e825 (diff) | |
parent | cf5f85ff884107cfba3ac929d2f731d98f467ce0 (diff) | |
download | openshift-d8fee0cc8441812cdd5e7aaae815adad7a9bbee7.tar.gz openshift-d8fee0cc8441812cdd5e7aaae815adad7a9bbee7.tar.bz2 openshift-d8fee0cc8441812cdd5e7aaae815adad7a9bbee7.tar.xz openshift-d8fee0cc8441812cdd5e7aaae815adad7a9bbee7.zip |
Merge pull request #3141 from tbielawa/fragment_banners
Fragment banners
Diffstat (limited to 'roles/lib_utils/src/generate.py')
-rwxr-xr-x | roles/lib_utils/src/generate.py | 37 |
1 files changed, 36 insertions, 1 deletions
diff --git a/roles/lib_utils/src/generate.py b/roles/lib_utils/src/generate.py index 6daade108..3f23455b5 100755 --- a/roles/lib_utils/src/generate.py +++ b/roles/lib_utils/src/generate.py @@ -27,19 +27,54 @@ def parse_args(): return parser.parse_args() +def fragment_banner(fragment_path, side, data): + """Generate a banner to wrap around file fragments + +:param string fragment_path: A path to a module fragment +:param string side: ONE OF: "header", "footer" +:param StringIO data: A StringIO object to write the banner to +""" + side_msg = { + "header": "Begin included fragment: {}", + "footer": "End included fragment: {}" + } + annotation = side_msg[side].format(fragment_path) + + banner = """ +# -*- -*- -*- {} -*- -*- -*- +""".format(annotation) + + # Why skip? + # + # * 'generated' - This is the head of the script, we don't want to + # put comments before the #!shebang + # + # * 'license' - Wrapping this just seemed like gratuitous extra + if ("generated" not in fragment_path) and ("license" not in fragment_path): + data.write(banner) + + # Make it self-contained testable + return banner + + def generate(parts): - '''generate the source code for the ansible modules''' + '''generate the source code for the ansible modules + +:param Array parts: An array of paths (strings) to module fragments + ''' data = six.StringIO() for fpart in parts: # first line is pylint disable so skip it with open(os.path.join(OPENSHIFT_ANSIBLE_PATH, fpart)) as pfd: + fragment_banner(fpart, "header", data) for idx, line in enumerate(pfd): if idx in [0, 1] and 'flake8: noqa' in line or 'pylint: skip-file' in line: # noqa: E501 continue data.write(line) + fragment_banner(fpart, "footer", data) return data |