borgmatic-collective/borgmatic
borgmatic-collective/borgmatic
9
74
Fork 54
Code Issues 55 Pull requests 4 Releases 159 Packages 1 Activity Actions 1

WARNING Variable "{name}" is not supported in the before create everything hook #1213

New issue
Closed
opened 2025-12-24 21:52:17 +00:00 by adatum Β· 7 comments
adatum commented 2025-12-24 21:52:17 +00:00
Copy link

What I'm trying to do and why

When borgmatic runs i see this warning the logs:

WARNING Variable "{name}" is not supported in the before create everything hook

The relevant section of borgmatic's YAML config file contains the following line:

- runuser -l user -c 'dnf --cacheonly repoquery --qf "%{name}\n" --userinstalled > /home/user/Dropbox/userinstalled_$(hostname).txt'

{name} in this case is not a borgmatic variable, but a dnf variable in the command being run. However, it's not clear to me how to escape it.

This is not an urgent issue, as it is just a warning and the actual behavior is as desired.

Steps to reproduce

No response

Actual behavior

No response

Expected behavior

No response

Other notes / implementation ideas

No response

borgmatic version

2.0.12

borgmatic installation method

Fedora package

Borg version

borg 1.4.3

Python version

Python 3.14.2

Database version (if applicable)

No response

Operating system and version

Fedora 43

### What I'm trying to do and why When borgmatic runs i see this warning the logs: `WARNING Variable "{name}" is not supported in the before create everything hook` The relevant section of borgmatic's YAML config file contains the following line: `- runuser -l user -c 'dnf --cacheonly repoquery --qf "%{name}\n" --userinstalled > /home/user/Dropbox/userinstalled_$(hostname).txt'` `{name}` in this case is not a borgmatic variable, but a dnf variable in the command being run. However, it's not clear to me how to escape it. This is not an urgent issue, as it is just a warning and the actual behavior is as desired. ### Steps to reproduce _No response_ ### Actual behavior _No response_ ### Expected behavior _No response_ ### Other notes / implementation ideas _No response_ ### borgmatic version 2.0.12 ### borgmatic installation method Fedora package ### Borg version borg 1.4.3 ### Python version Python 3.14.2 ### Database version (if applicable) _No response_ ### Operating system and version Fedora 43
witten commented 2025-12-24 22:09:10 +00:00
Owner
Copy link

Thanks for taking the time to file this. I'll have to think about what if anything can be done about it. Maybe a YAML tag that flags the line as not to be warned about? A borgmatic option to disable the warnings altogether? Something else?

Thanks for taking the time to file this. I'll have to think about what if anything can be done about it. Maybe a YAML tag that flags the line as not to be warned about? A borgmatic option to disable the warnings altogether? Something else?
adatum commented 2025-12-25 00:25:10 +00:00
Author
Copy link

What are your thoughts on these AI suggestions?

  • {{ and }}: In Python string formatting, doubling the braces escapes them.

  • %%: Depending on your shell environment, you may also need to double the percent sign if it's being interpreted by a shell wrapper, though usually, the {{name}} change is the primary fix for the borgmatic warning specifically.

I tried {{ }} but that broke the command and still had the warning from borgmatic. Not sure how to test without running borgmatic each time.

I would think finding and documenting how to escape the notation, if possible, makes more sense than changing borgmatic.

What are your thoughts on these AI suggestions? > - {{ and }}: In Python string formatting, doubling the braces escapes them. > > - %%: Depending on your shell environment, you may also need to double the percent sign if it's being interpreted by a shell wrapper, though usually, the {{name}} change is the primary fix for the borgmatic warning specifically. I tried {{ }} but that broke the command and still had the warning from borgmatic. Not sure how to test without running borgmatic each time. I would think finding and documenting how to escape the notation, if possible, makes more sense than changing borgmatic.
witten commented 2026-01-05 05:38:31 +00:00
Owner
Copy link

I would think finding and documenting how to escape the notation, if possible, makes more sense than changing borgmatic.

The interpolation and warning logic are both performed by borgmatic, so any escape notation would have to be implemented by changing borgmatic.

What are your thoughts on these AI suggestions?

{{ and }}: In Python string formatting, doubling the braces escapes them.

%%: Depending on your shell environment, you may also need to double the percent sign if it's being interpreted by a shell wrapper, though usually, the {{name}} change is the primary fix for the borgmatic warning specifically.

{{ and }} could maybe work, although then it might be a breaking change for anyone who has those literals in their existing commands. That could be okay if documented as such.

I don't think %% would be necessary.

I tried {{ }} but that broke the command and still had the warning from borgmatic.

Yeah, that's definitely not implemented currently.

Not sure how to test without running borgmatic each time.

You could move/copy the command hook to a borgmatic action other than create, just temporarily to make testing easier.

> I would think finding and documenting how to escape the notation, if possible, makes more sense than changing borgmatic. The interpolation and warning logic are both performed by borgmatic, so any escape notation would have to be implemented by changing borgmatic. > What are your thoughts on these AI suggestions? > > > * > > {{ and }}: In Python string formatting, doubling the braces escapes them. > > > > * > > %%: Depending on your shell environment, you may also need to double the percent sign if it's being interpreted by a shell wrapper, though usually, the {{name}} change is the primary fix for the borgmatic warning specifically. `{{` and `}}` could maybe work, although then it might be a breaking change for anyone who has those literals in their existing commands. That could be okay if documented as such. I don't think `%%` would be necessary. > I tried {{ }} but that broke the command and still had the warning from borgmatic. Yeah, that's definitely not implemented currently. > Not sure how to test without running borgmatic each time. You could move/copy the command hook to a borgmatic action other than `create`, just temporarily to make testing easier.
witten commented 2026-01-05 19:43:58 +00:00
Owner
Copy link

I have this working now using backslashes for escaping, e.g. \{name\}. This is consistent with how escaping is already done for environment variable interpolation. And as part of this work, I'm also implementing the same sort of escaping for constant interpolation.

I'm working on tests now to finish this up.

I have this working now using backslashes for escaping, e.g. `\{name\}`. This is consistent with how escaping is already done for environment variable interpolation. And as part of this work, I'm also implementing the same sort of escaping for constant interpolation. I'm working on tests now to finish this up.
πŸ‘ 1
witten commented 2026-01-05 23:42:12 +00:00
Owner
Copy link

Okay, this is implemented in main and will be part of the next release! Docs will be live shortly. Note that this is technically a breaking change, in that anyone who happens to already have \{name\} in their configuration will see that replaced with {name}. (And no, there's not currently a way to escape the escapes. πŸ˜…)

Thanks again for filing this.

Okay, this is implemented in main and will be part of the next release! Docs will be live shortly. Note that this _is_ technically a breaking change, in that anyone who happens to already have `\{name\}` in their configuration will see that replaced with `{name}`. (And no, there's not currently a way to escape the escapes. πŸ˜…) Thanks again for filing this.
πŸŽ‰ 1
witten commented 2026-01-16 21:15:04 +00:00
Owner
Copy link

Released in borgmatic 2.1.0!

Released in borgmatic 2.1.0!
πŸŽ‰ 1
adatum commented 2026-01-26 16:35:59 +00:00
Author
Copy link

Can confirm: this variable warning is gone with borgmatic 2.1.0 !

Can confirm: this variable warning is gone with borgmatic 2.1.0 !
πŸ‘ 1
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
command-hook-steps
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.13
2.0.12
2.0.11
2.0.10
2.0.9
2.0.8
2.0.7
2.0.6
2.0.5
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
1.9.14
1.9.13
1.9.12
1.9.11
1.9.10
1.9.9
1.9.8
1.9.7
1.9.6
1.9.5
1.9.4
1.9.3
1.9.2
1.9.1
1.9.0
1.8.14
1.8.13
1.8.12
1.8.11
1.8.10
1.8.9
1.8.8
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.24
1.5.23
1.5.22
1.5.21
1.5.20
1.5.19
1.5.18
1.5.17
1.5.16
1.5.15
1.5.14
1.5.13
1.5.12
1.5.11
1.5.10
1.5.9
1.5.8
1.5.7
1.5.7.dev0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.22
1.4.21
1.4.20
1.4.19
1.4.18
1.4.17
1.4.16
1.4.15
1.4.14
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.26
1.3.25
1.3.24
1.3.23
1.3.22
1.3.21
1.3.20
1.3.19
1.3.18
1.3.17
1.3.16
1.3.15
1.3.14
1.3.13
1.3.12
1.3.11
1.3.10
1.3.9
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.18
1.2.17
1.2.16
1.2.15
1.2.14
1.2.13
1.2.12
1.2.11
1.2.10
1.2.9
1.2.8
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.15
1.1.14
1.1.13
1.1.12
1.1.11
1.1.10
1.1.9
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.3
1.0.2
1.0.1
1.0.0
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
Labels
Clear labels   
blocked

   
breaking

   
bug

   
data loss

   
design finalized

   
good first issue

   
new feature area

   
question / support

   
security

   
waiting for response
No labels
blocked
breaking
bug
data loss
design finalized
good first issue
new feature area
question / support
security
waiting for response
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
borgmatic-collective/borgmatic#1213
No description provided.