How to retrieve the absolute revision number?

[RobertoRoos]

For a particular project I want to include the revision number in the version string, e.g. "v0.01.dev4050". The 4050 indicates this is the 4050th commit in total.

I see two numbers for the formatting field, {revision} and {distance}, but neither matches this absolute revision number.

Is there currently some way to achieve this?

EDIT: Basically the output of git rev-list --count HEAD

[cstillick]

There's no built-in variable for the total commit count, but format-jinja together with format-jinja-imports can shell out to git for exactly the number you want:

[tool.poetry-dynamic-versioning]
enable = true
format-jinja = "{{ base }}.dev{{ check_output(['git', 'rev-list', '--count', 'HEAD'], text=True) | trim }}"
format-jinja-imports = [
    { module = "subprocess", item = "check_output" },
]

Just tested this on a repo with tag v0.1.0 and 3 total commits, and the build produced 0.1.0.dev3.

Two caveats: this only works where git history is available, so building from an sdist won't have it, and shallow CI clones will undercount. If you build in GitHub Actions, set fetch-depth: 0 on actions/checkout.

[RobertoRoos]

Seems to work like a charm, thank you!

(BTW, what is the | trim in check_output(...) | trim? Is that parsed by Python or is it a Jinja thing?)

[mtkennerly]

| trim is a Jinja "filter", equivalent to .strip(). There's more info on the available filters here: https://jinja.palletsprojects.com/en/stable/templates/#list-of-builtin-filters