genomepy.config.Config
- class genomepy.config.Config
Bases:
MutableMapping
Configuration class.
State will be shared across config objects.
- __init__()
Create a Config object and read a config file.
Methods
__init__
()Create a Config object and read a config file.
clear
()get
(k[,d])items
()keys
()load
([path])Load yaml-formatted config file.
pop
(k[,d])If key is not found, d is returned if given, otherwise KeyError is raised.
popitem
()as a 2-tuple; but raise KeyError if D is empty.
save
([path])Save current state of config dictionary.
setdefault
(k[,d])update
([E, ]**F)If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values
()Attributes
config_dir
config_file
default_config_file
- clear() None. Remove all items from D.
- get(k[, d]) D[k] if k in D, else d. d defaults to None.
- items() a set-like object providing a view on D's items
- keys() a set-like object providing a view on D's keys
- load(path=None)
Load yaml-formatted config file.
- Parameters
path (str | None) – path to config file
- pop(k[, d]) v, remove specified key and return the corresponding value.
If key is not found, d is returned if given, otherwise KeyError is raised.
- popitem() (k, v), remove and return some (key, value) pair
as a 2-tuple; but raise KeyError if D is empty.
- save(path=None)
Save current state of config dictionary.
- Parameters
path (str | None) – path to config file
- setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
- update([E, ]**F) None. Update D from mapping/iterable E and F.
If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
- values() an object providing a view on D's values