copyrights: update copyright headers in all files of the project by svalat · Pull Request #410 · idefix-code/idefix

svalat · 2026-09-10T12:43:45Z

Goal

This PR adds a script ./pytools/update_file_headers.py to update the copyright headers for all the files in the project.

It is configured via ./pytools/update_file_headers.json.

How

It scans the git blame of all files listed in the git repo.
The files are filtered about their type (shell / C / HTML) to inject the proper comment style, some are excluded.
The authors are assigned to their institution & years of contribution on the file.
The last modification MONTH / YEAR and the FILENAME is now present in the header.

Usage

# update all git files
./pytools/update_file_headers.py --git-all .

# update a single file
./pytools/update_file_headers.py ./test.py

Commit name

Ideally when making a commit to update the copyrights before a release, you need to name this commit :

copyrights: ...............

Any other regexp can be configured in the config file in key exclude_summary_regexps.

So it will be ignored by the next scan to ignore the copyright lines in the git blame and not adding the authors updater to all files of the project.

In case you forgot, you can add the git commit to skip in the key exclude_hashes of the config file.

Imported extern source

The core script to apply the patching comes originally from MALT :
https://github.com/memtt/malt/blob/v1.6.3/dev/update_file_headers.py and is just slightly patched here to adapt the style to Idefix.

The original license is same than Idefix : CeCILL-C so no problem to redistribute it with its original copyright still in.

Note

This PR affect most of the files of the project.

…ence & authors (imported from MALT : MALloc Tracker)

glesur · 2026-09-10T18:51:50Z

+    "",
+    "Copyright(C) by :",
+    "@COPYRIGHTS@",
+    "- and other code contributors",


Suggested change

"- and other code contributors",

"and other code contributors",

glesur · 2026-09-10T18:52:58Z

+    "63753204+nscepi@users.noreply.github.com": "nicolas.scepi@univ-grenoble-alpes.fr",
+    "nicolas.scepi@gmail.com": "nicolas.scepi@univ-grenoble-alpes.fr",
+    "geoffroy.lesur@obs.ujf-grenoble.fr": "geoffroy.lesur@univ-grenoble-alpes.fr",
+    "93188557+vdbma@users.noreply.github.com": "vreville@irap.omp.eu",


Suggested change

"93188557+vdbma@users.noreply.github.com": "vreville@irap.omp.eu",

"93188557+vdbma@users.noreply.github.com": "mbossche@aip.de",

glesur · 2026-09-10T18:56:22Z

+    "geoffroy.lesur@obs.ujf-grenoble.fr": "geoffroy.lesur@univ-grenoble-alpes.fr",
+    "93188557+vdbma@users.noreply.github.com": "vreville@irap.omp.eu",
+    "victorreville@gmail.com": "vreville@irap.omp.eu",
+    "cr52@protonmail.com": [


not sure we want to have this option for Clément, as we don't do that for others (Baghdadi, Van den Bossche,Mauxion) and it implies that we track everybody's email, while I'm pretty sure we won't. Let's just keep one unique email for everyone, hopefully the last one.

Here I track the mail, because this is how the code relates to the institution.
But that's looks ok to me to keep it simpler, I will remove it.

glesur · 2026-09-10T18:56:42Z

+    ]
+  },
+  "affiliation_domains": {
+    "@irap.omp.eu": "IPAP",


Suggested change

"@irap.omp.eu": "IPAP",

"@irap.omp.eu": "IRAP",

glesur · 2026-09-10T18:58:43Z

+  },
+  "affiliation_domains": {
+    "@irap.omp.eu": "IPAP",
+    "geoffroy.lesur@univ-grenoble-alpes.fr": "IPAG / CNRS",


can't we say that @univ-grenoble-alpes.fr is IPAG/UGA/CNRS in all generality?

Currently we can perfectly do that, I will apply.
It might change in the future if you get other contributions from other labs of UGA, but we can adapt at that time.

For this latter case, I will just make such the code takes the full mail with precedence over the domain one, this is a 1 line fix or already done.

glesur · 2026-09-10T18:59:39Z

+    "marc.coiffier@univ-grenoble-alpes.fr": "IPAG / CNRS",
+    "clement.robert@univ-grenoble-alpes.fr": "IPAG / CNRS",
+    "nicolas.scepi@univ-grenoble-alpes.fr": "IPAG / CNRS",
+    "jonah.mauxion@univ-grenoble-alpes.fr": "IPAG / CNRS"


probably missing van den bossche here (IAP Postdam)

Just wanted to notify that my affiliation is "Max-Planck-Institut für Astrophysik, Garching b. München" or "MPA Garching"

glesur · 2026-09-10T19:02:48Z

 // Licensed under CeCILL 2.1 License, see COPYING for more information
 // ***********************************************************************************
+// Other contributors :
+// - Gaylor Wafflard <gaylor.wafflard@univ-grenoble-alpes.fr> (IPAG / CNRS - 2024)


I'm a bit confused as to why Gaylor doesn't appear as a regular contributor here. He's not at the origin of the axis module, but he certainly contributed at some point.

Hum, this is because he is mentioned as co-author of one of your merge 19ed7be. As I have no way to distinguish I added him in all related files.

svalat · 2026-09-11T08:41:49Z

Wait for merge that I made a last patch to handle the co-authors in commits summary so authors like Gaylor will appear in the right place in the header instead of after it.

neutrinoceros

A couple suggestions about the script itself

neutrinoceros · 2026-09-11T09:26:53Z

+                commiter_name = "INIT"
+                commiter_time = "INIT"
+                commiter_zone = "INIT"
+                summary = "INIT"


there should probably be a else: raise ... here

I just added a else: pass because I just ignore the other fields here.

neutrinoceros · 2026-09-11T09:28:32Z

+            # direct definition or per year mode
+            if isinstance(db[mail], str):
+                return db[mail]
+            elif isinstance(db[mail], list):


assuming my type hint is correct, this could be simplified by simply removing the elif condition and de-indent its content ?

Added an else: raise, the type checking is not an error handling. I prefer to stay safe here by re-checking.

neutrinoceros · 2026-09-11T09:40:10Z

+
+
+############################################################
+def main():


Make this testable and return an exit status

Suggested change

def main():

def main(argv: list[str] | None = None) -> int:

I don't test it yet, as it is not an infrastructure issue, I keep it simple.

neutrinoceros · 2026-09-11T09:40:49Z

+
+    # run
+    run_from_args(options)
+


Suggested change

return 0

neutrinoceros · 2026-09-11T09:42:25Z

+            if (
+                fnmatch.fnmatch(filename, ipattern)
+                or filename.startswith(ipattern)
+                or filename == ipattern


This condition will never be evaluated to True because the previous one would already short-circuit it

Suggested change

or filename == ipattern

Good eyes ;).

neutrinoceros · 2026-09-11T09:43:45Z

A couple suggestions for the script itself:

add PEP 723 script metadata (first and foremost, declare the third party dependency on gitPython)

move the script to somewhere not importable (e.g., to a new scripts subdir)

ensure portability on all platforms using pathlib instead of the occasional Unix-only /

ensure the script can be run from anywhere using relative paths

This is a helper script just for us when we make release, I would not pass too much time on it for now.
We can improve it latter.
For the script directory I will have another one which will come later, I will move it at that moment.

…s first

… in the file headers

svalat

Thanks for the remarks, I fixed most, even if it is an internal script for us mainly.

svalat · 2026-09-14T15:20:13Z

+                commiter_name = "INIT"
+                commiter_time = "INIT"
+                commiter_zone = "INIT"
+                summary = "INIT"


I just added a else: pass because I just ignore the other fields here.

svalat · 2026-09-14T15:22:32Z

+            # direct definition or per year mode
+            if isinstance(db[mail], str):
+                return db[mail]
+            elif isinstance(db[mail], list):


Added an else: raise, the type checking is not an error handling. I prefer to stay safe here by re-checking.

svalat · 2026-09-14T15:46:46Z

+
+
+############################################################
+def main():


I don't test it yet, as it is not an infrastructure issue, I keep it simple.

svalat · 2026-09-22T11:20:28Z

This is a helper script just for us when we make release, I would not pass too much time on it for now.
We can improve it latter.
For the script directory I will have another one which will come later, I will move it at that moment.

glesur

one last author got his email wrong :-(

glesur · 2026-09-22T18:50:31Z

+    "93188557+vdbma@users.noreply.github.com": "mbossche@aip.de",
+    "victorreville@gmail.com": "vreville@irap.omp.eu",
+    "cr52@protonmail.com": "clement.robert@univ-grenoble-alpes.fr"
+  },


Suggested change

},

"89980449+Anto6453@users.noreply.github.com": "antonin.borderies@ens-lyon.fr"

},

glesur · 2026-09-22T18:51:09Z

+    "@irap.omp.eu": "IRAP",
+    "@univ-grenoble-alpes.fr": "IPAG/UGA/CNRS",
+    "dutta.alankar@gmail.com": "MPA Garching",
+    "@aip.de": "IAP Postdam"


Suggested change

"@aip.de": "IAP Postdam"

"@aip.de": "IAP Postdam"

"@ens-lyon.fr": "ENS Lyon"

Fixed + some others and added an error message when the affiliation is not yet known to me sure to not miss others.
I will give another look & check pass tomorrow morning.

svalat added 5 commits September 8, 2026 18:35

header: introduce a script to update the source file headers with lic…

6d64074

…ence & authors (imported from MALT : MALloc Tracker)

copyrights: update copyrights headers in all files of the project

c84770c

headers: handle the case where the author line is too long

7c6d783

copyrights: add missing contributors

33fdd45

copyrights: add misssing headers to CMakeLists.txt files

89c551e

glesur requested changes Sep 10, 2026

View reviewed changes

copyrights: fix PR remarks

b2a0c7e

neutrinoceros reviewed Sep 11, 2026

View reviewed changes

svalat added 5 commits September 14, 2026 18:03

copyrights: fix PR remarks

4cdad51

copyrights: scan the co-authors in the commit message

9778824

copyrights: fix author order by full date then name so first author i…

4f05cba

…s first

copyrights: add manual co-authors so they appear in the standard list…

7dd544f

… in the file headers

copyrights: minor fix

f432e15

svalat commented Sep 22, 2026

View reviewed changes

glesur reviewed Sep 22, 2026

View reviewed changes

svalat added 2 commits September 22, 2026 21:07

copyrights: fix a mail issue

5f66008

copyrights: fix some other wrong mails

6e95687

glesur merged commit f0403bb into idefix-code:develop Sep 23, 2026
41 checks passed

glesur mentioned this pull request Sep 23, 2026

V2.4.0 #414

Open

	"- and other code contributors",
	"and other code contributors",

	"93188557+vdbma@users.noreply.github.com": "vreville@irap.omp.eu",
	"93188557+vdbma@users.noreply.github.com": "mbossche@aip.de",



		############################################################
		def main():

	},
	"89980449+Anto6453@users.noreply.github.com": "antonin.borderies@ens-lyon.fr"
	},

	"@aip.de": "IAP Postdam"
	"@aip.de": "IAP Postdam"
	"@ens-lyon.fr": "ENS Lyon"

Conversation

svalat commented Sep 10, 2026

Goal

How

Usage

Commit name

Imported extern source

Note

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

svalat Sep 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dutta-alankar Sep 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

svalat commented Sep 11, 2026

Uh oh!

neutrinoceros left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

neutrinoceros Sep 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

svalat left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

svalat Sep 10, 2026 •

edited

Loading

dutta-alankar Sep 11, 2026 •

edited

Loading

neutrinoceros Sep 11, 2026 •

edited

Loading