def read_config_file(self):
"""Read config file and parse the contents into the settings attr."""
if not os.path.isfile(self.filename):
return
self.config_parser.read(self.filename)
if 'default' in self.config_parser.sections():
circuit_drawer = self.config_parser.get('default',
'circuit_drawer')
if circuit_drawer:
if circuit_drawer not in [
'text', 'mpl', 'latex', 'latex_source'
]:
raise exceptions.QiskitUserConfigError(
"%s is not a valid circuit drawer backend. Must be "
"either 'text', 'mpl', 'latex', or 'latex_source'" %
circuit_drawer)
self.settings['circuit_drawer'] = circuit_drawer
circuit_mpl_style = self.config_parser.get('default',
'circuit_mpl_style')
if circuit_mpl_style:
if circuit_mpl_style not in ['default', 'bw']:
raise exceptions.QiskitUserConfigError(
"%s is not a valid mpl circuit style. Must be "
"either 'default' or 'bw'" % circuit_mpl_style)
self.settings['circuit_mpl_style'] = circuit_mpl_style
def read_config_file(self):
"""Read config file and parse the contents into the settings attr."""
if not os.path.isfile(self.filename):
return
self.config_parser.read(self.filename)
if 'default' in self.config_parser.sections():
# Parse circuit_drawer
circuit_drawer = self.config_parser.get('default',
'circuit_drawer',
fallback=None)
if circuit_drawer:
if circuit_drawer not in [
'text', 'mpl', 'latex', 'latex_source', 'auto'
]:
raise exceptions.QiskitUserConfigError(
"%s is not a valid circuit drawer backend. Must be "
"either 'text', 'mpl', 'latex', 'auto', or "
"'latex_source'" % circuit_drawer)
self.settings['circuit_drawer'] = circuit_drawer
# Parse circuit_mpl_style
circuit_mpl_style = self.config_parser.get('default',
'circuit_mpl_style',
fallback=None)
if circuit_mpl_style:
if circuit_mpl_style not in ['default', 'bw']:
raise exceptions.QiskitUserConfigError(
"%s is not a valid mpl circuit style. Must be "
"either 'default' or 'bw'" % circuit_mpl_style)
self.settings['circuit_mpl_style'] = circuit_mpl_style
# Parse transpile_optimization_level
transpile_optimization_level = self.config_parser.getint(
'default', 'transpile_optimization_level', fallback=-1)
if not transpile_optimization_level == -1:
if (transpile_optimization_level < 0
or transpile_optimization_level > 3):
raise exceptions.QiskitUserConfigError(
"%s is not a valid optimization level. Must be "
"0, 1, 2, or 3.")
self.settings['transpile_optimization_level'] = (
transpile_optimization_level)
# Parse package warnings
package_warnings = self.config_parser.getboolean(
'default', 'suppress_packaging_warnings', fallback=False)
if package_warnings:
self.settings['suppress_packaging_warnings'] = package_warnings
def read_config_file(self):
"""Read config file and parse the contents into the settings attr."""
if not os.path.isfile(self.filename):
return
self.config_parser.read(self.filename)
if 'default' in self.config_parser.sections():
# Parse circuit_drawer
circuit_drawer = self.config_parser.get('default',
'circuit_drawer',
fallback=None)
if circuit_drawer:
if circuit_drawer not in [
'text', 'mpl', 'latex', 'latex_source', 'auto'
]:
raise exceptions.QiskitUserConfigError(
"%s is not a valid circuit drawer backend. Must be "
"either 'text', 'mpl', 'latex', 'latex_source', or "
"'auto'." % circuit_drawer)
self.settings['circuit_drawer'] = circuit_drawer
# Parse state_drawer
state_drawer = self.config_parser.get('default',
'state_drawer',
fallback=None)
if state_drawer:
valid_state_drawers = [
'auto', 'text', 'latex', 'latex_source', 'qsphere',
'hinton', 'bloch'
]
if state_drawer not in valid_state_drawers:
valid_choices_string = "', '".join(
c for c in valid_state_drawers)
raise exceptions.QiskitUserConfigError(
f"'{state_drawer}' is not a valid state drawer backend. "
f"Choose from: '{valid_choices_string}'")
self.settings['state_drawer'] = state_drawer
# Parse circuit_mpl_style
circuit_mpl_style = self.config_parser.get('default',
'circuit_mpl_style',
fallback=None)
if circuit_mpl_style:
if not isinstance(circuit_mpl_style, str):
warn(
"%s is not a valid mpl circuit style. Must be "
"a text string. Will not load style." %
circuit_mpl_style, UserWarning, 2)
self.settings['circuit_mpl_style'] = circuit_mpl_style
# Parse circuit_mpl_style_path
circuit_mpl_style_path = self.config_parser.get(
'default', 'circuit_mpl_style_path', fallback=None)
if circuit_mpl_style_path:
cpath_list = circuit_mpl_style_path.split(':')
for path in cpath_list:
if not os.path.exists(os.path.expanduser(path)):
warn(
"%s is not a valid circuit mpl style path."
" Correct the path in ~/.qiskit/settings.conf." %
path, UserWarning, 2)
self.settings['circuit_mpl_style_path'] = cpath_list
# Parse transpile_optimization_level
transpile_optimization_level = self.config_parser.getint(
'default', 'transpile_optimization_level', fallback=-1)
if transpile_optimization_level != -1:
if (transpile_optimization_level < 0
or transpile_optimization_level > 3):
raise exceptions.QiskitUserConfigError(
"%s is not a valid optimization level. Must be "
"0, 1, 2, or 3.")
self.settings['transpile_optimization_level'] = (
transpile_optimization_level)
# Parse parallel
parallel_enabled = self.config_parser.getboolean('default',
'parallel',
fallback=None)
if parallel_enabled is not None:
self.settings['parallel_enabled'] = parallel_enabled
# Parse num_processes
num_processes = self.config_parser.getint('default',
'num_processes',
fallback=-1)
if num_processes != -1:
if num_processes <= 0:
raise exceptions.QiskitUserConfigError(
"%s is not a valid number of processes. Must be "
"greater than 0")
self.settings['num_processes'] = num_processes
def set_config(key, value, section=None, file_path=None):
"""Adds or modifies a user configuration
It will add configuration to the currently configured location
or the value of file argument.
Only valid user config can be set in 'default' section. Custom
user config can be added in any other sections.
Changes to the existing config file will not be reflected in
the current session since the config file is parsed at import time.
Args:
key (str): name of the config
value (obj): value of the config
section (str, optional): if not specified, adds it to the
`default` section of the config file.
file_path (str, optional): the file to which config is added.
If not specified, adds it to the default config file or
if set, the value of `QISKIT_SETTINGS` env variable.
Raises:
QiskitUserConfigError: if the config is invalid
"""
filename = file_path or os.getenv("QISKIT_SETTINGS", DEFAULT_FILENAME)
section = "default" if section is None else section
if not isinstance(key, str):
raise exceptions.QiskitUserConfigError("Key must be string type")
valid_config = {
"circuit_drawer",
"circuit_mpl_style",
"circuit_mpl_style_path",
"transpile_optimization_level",
"parallel",
"num_processes",
}
if section in [None, "default"]:
if key not in valid_config:
raise exceptions.QiskitUserConfigError(
"{} is not a valid user config.".format(key))
config = configparser.ConfigParser()
config.read(filename)
if section not in config.sections():
config.add_section(section)
config.set(section, key, str(value))
try:
with open(filename, "w") as cfgfile:
config.write(cfgfile)
except OSError as ex:
raise exceptions.QiskitUserConfigError(
"Unable to load the config file {}. Error: '{}'".format(
filename, str(ex)))
# validates config
user_config = UserConfig(filename)
user_config.read_config_file()
def read_config_file(self):
"""Read config file and parse the contents into the settings attr."""
if not os.path.isfile(self.filename):
return
self.config_parser.read(self.filename)
if 'default' in self.config_parser.sections():
# Parse circuit_drawer
circuit_drawer = self.config_parser.get('default',
'circuit_drawer',
fallback=None)
if circuit_drawer:
if circuit_drawer not in [
'text', 'mpl', 'latex', 'latex_source', 'auto'
]:
raise exceptions.QiskitUserConfigError(
"%s is not a valid circuit drawer backend. Must be "
"either 'text', 'mpl', 'latex', 'latex_source', or "
"'auto'." % circuit_drawer)
self.settings['circuit_drawer'] = circuit_drawer
# Parse circuit_mpl_style
circuit_mpl_style = self.config_parser.get('default',
'circuit_mpl_style',
fallback=None)
if circuit_mpl_style:
if not isinstance(circuit_mpl_style, str):
warn(
"%s is not a valid mpl circuit style. Must be "
"a text string. Will not load style." %
circuit_mpl_style, UserWarning, 2)
self.settings['circuit_mpl_style'] = circuit_mpl_style
# Parse circuit_mpl_style_path
circuit_mpl_style_path = self.config_parser.get(
'default', 'circuit_mpl_style_path', fallback=None)
if circuit_mpl_style_path:
cpath_list = circuit_mpl_style_path.split(':')
for path in cpath_list:
if not os.path.exists(os.path.expanduser(path)):
warn(
"%s is not a valid circuit mpl style path."
" Correct the path in ~/.qiskit/settings.conf." %
path, UserWarning, 2)
self.settings['circuit_mpl_style_path'] = cpath_list
# Parse transpile_optimization_level
transpile_optimization_level = self.config_parser.getint(
'default', 'transpile_optimization_level', fallback=-1)
if not transpile_optimization_level == -1:
if (transpile_optimization_level < 0
or transpile_optimization_level > 3):
raise exceptions.QiskitUserConfigError(
"%s is not a valid optimization level. Must be "
"0, 1, 2, or 3.")
self.settings['transpile_optimization_level'] = (
transpile_optimization_level)
# Parse package warnings
package_warnings = self.config_parser.getboolean(
'default', 'suppress_packaging_warnings', fallback=False)
if package_warnings:
self.settings['suppress_packaging_warnings'] = package_warnings