Failure to initialize Config object

[norlandrhagen]

Issue description

Hi there, I'm trying to use Donfig for a project and ran into a potential bug when trying to setup a Config.

When setting up a Config and adding default values via a dict:

from donfig import Config

config = Config('cmip6_downscaling', defaults={'test_key':'key'})

I get the AttributeError:

AttributeError                            Traceback (most recent call last)
<ipython-input-1-6c2352fed93f> in <module>
      1 from donfig import Config
      2
----> 3 config = Config('project', defaults={'test_key':'key'})
      4
~/opt/anaconda3/envs/install/envs/cmip6/lib/python3.9/site-packages/donfig/config_obj.py in __init__(self, name, defaults, paths, env, env_var, root_env_var, env_prefix)
    366         self.config = {}
    367         self.config_lock = threading.Lock()
--> 368         self.refresh()
    369
    370     def __contains__(self, item):
~/opt/anaconda3/envs/install/envs/cmip6/lib/python3.9/site-packages/donfig/config_obj.py in refresh(self, **kwargs)
    440
    441         for d in self.defaults:
--> 442             update(self.config, d, priority='old')
    443
    444         update(self.config, self.collect(**kwargs))
~/opt/anaconda3/envs/install/envs/cmip6/lib/python3.9/site-packages/donfig/config_obj.py in update(old, new, priority)
    109
    110     """
--> 111     for k, v in new.items():
    112         k = canonical_name(k, old)
    113
AttributeError: 'str' object has no attribute 'items'

If I pass defaults as a list, the config object seems to be created without issues.

config = Config('project', defaults=[{'test_key':'key'}])

config.defaults
[{'test_key': 'key'}]

[djhoese]

Thanks for filing this! This is definitely a bug in the documentation. As you've discovered defaults should be passed as a list of dictionaries.

Do you have any interest/time in correcting the documentation and submitting a pull request?

[norlandrhagen]

Yeah totally! I'm a bit busy now, but I'll open up a PR soon to the docs.

Loving the package so far!

[djhoese]

I'm preparing a new release so I thought I'd fix this docs issue myself. Sorry.

[jhamman]

fyi, I noticed this bug is still in the documentation: https://donfig.readthedocs.io/en/latest/configuration.html#configuration-object

config = Config('mypkg', defaults={'key1': 'default_val'}, paths=['/usr/local/etc/'])

Did the docs get rebuilt as part of the 0.7.0 release?

[djhoese]

Looks like there is a syntax error in the sphinx config. Fixing...

[djhoese]

🤦‍♂️ Looks like readthedocs was defaulting to Python 2.7 and the "master" branch so it was double-failing (py3 only and "main").

[djhoese]

@jhamman If you do a forced refresh of the latest page it should show the brackets around the defaults argument.

Edit: And pull request builds on RTD should be enabled from now on.

[jhamman]

Thanks @djhoese - looks like its all working now.

Thanks!