TEST: Copyright pre-commit

[cpelley]

Added copyright pre-commit check.

Copyright check acts to check for the presence of and verify the validity of the copyright header of python files. Additionally, the role of the script is to automatically add this copyright notice (thus eliminating the need to deal with copyright headers yourself).

• Verifies that non-empty python files contains some sort-of copyright header.
  • If copyright is present, checks that this copyright exactly matches the header we expect and fail if the copyright header doesn't match.
  • If copyright not present, then add it and fail.
  • Respects files including a hash bang (i.e. correctly auto adds copyright AFTER the hash bang line when present).

Issues

• https://github.com/MetOffice/improver_suite/issues/2079
• https://github.com/MetOffice/improver_suite/issues/2253

Note

Just to raise awareness as the first dagrunner PR under review - since this branch makes changes that impact the reference documentation, an auto reference documentation build commit will be pushed accordingly thanks to the dagrunner action workflow.

[cpelley]

Ping @s-boardman - I think you might be interested in this.

[s-boardman]

Ping @s-boardman - I think you might be interested in this.

That's absurdly clever Carwyn!

[cpelley]

Thanks @mo-robert-purvis

Tidied up based on feedback.

Additionally improved by adding:

• trap to ensure that temporary files are removed at the end no matter what happens within the script.
• Commandline help.