Reading/writing userconfig from multiple hooks

DennisGoff · September 19, 2024, 10:10pm

I am experimenting with some userconfig values for saving certain preferences. I one hook that writes a value to a custom userconfig value, and then another hook that reads that value and acts accordingly. However, what i have noticed is that when hook 1 makes the change, hook 2 doesn’t seem to register it. For example, I have a userconfig boolean set to True and hook 1 sets that value to False:

userconfig.customField.value = False
userconfig.save_changes()

When I then try to read that value from hook 2 as below, it still reads as True

customField = userconfig.customField.get_option("value")

Only way I can get it to register the change is by reloading pyRevit, but that’s not an option. Do changes to the config file only get registered on reload?

sanzoghenzo · September 20, 2024, 6:40am

Hi @DennisGoff,
I see that you wrote usercongfig, but do you mean that you’re using the pyrevit.userconfig.user_config global variable?
If so, I believe this is the problem, that global variabel doesn’t get updated. And that’s why I usually avoid global variables and code outside functions

We should move all the following code to an init_user_config function so that you can call it to create your own user config variable or rewrite the global one.
Are you up to the task and willing to make this change? (Note that these my assumptions just by looking at the code, so it might not work, but it’s worth a try)

github.com

pyrevitlabs/pyRevit/blob/f9fa0d296386d548e198324dd752fb7fb5cd7b58/pyrevitlib/pyrevit/userconfig.py#L807-L875


      
          # location for default pyRevit config files
          if not EXEC_PARAMS.doc_mode:
              LOCAL_CONFIG_FILE = find_config_file(HOME_DIR)
              ADMIN_CONFIG_FILE = find_config_file(PYREVIT_ALLUSER_APP_DIR)
              USER_CONFIG_FILE = find_config_file(PYREVIT_APP_DIR)
          
              # decide which config file to use
              # check if a config file is inside the repo. for developers config override
              if LOCAL_CONFIG_FILE:
                  CONFIG_TYPE = 'Local'
                  CONFIG_FILE = LOCAL_CONFIG_FILE
          
              # check to see if there is any config file provided by admin
              elif ADMIN_CONFIG_FILE \
                      and os.access(ADMIN_CONFIG_FILE, os.W_OK) \
                      and not USER_CONFIG_FILE:
                  # if yes, copy that and use as default
                  # if admin config file is writable it means it is provided
                  # to bootstrap the first pyRevit run
                  try:

This file has been truncated. show original

DennisGoff · September 20, 2024, 4:47pm

I don’t think I would know where to begin making changes to the actual pyRevit code. But for a little more context, I’m trying to implement the autosave feature from this PR on github:

Autosave by alexdaversa · Pull Request #1692 · pyrevitlabs/pyRevit · GitHub

It works fine, but what I noticed is that if you turn it off/on, the change doesn’t register without a reload of pyRevit. I suppose you could just write to some local file rather than editing the pyRevit_config.ini file