ConfigManager¶
-
class
ConfigManager
¶ Helper class to handle vpype’s TOML configuration files.
This class is typically used via its singleton instance
CONFIG_MANAGER
:>>> from vpype import CONFIG_MANAGER >>> my_config = CONFIG_MANAGER.config.get("my_config", None)
Helper methods are provided for specific aspects of configuration, such as command-specific configs or HPGL-related configs.
By default, built-in configuration packaged with vpype are loaded at startup. If a file exists at path
~/.vpype.toml
, it will be loaded as well. Additionaly files may be loaded using theload_config_file()
method.Methods
Initialize self.
Returns the configuration for command
name
.Returns a
PlotterConfig
instance for plottername
.Returns a list of plotter names whose configuration is available.
Load a config file and add its content to the configuration database.
Attributes
Methods¶
-
ConfigManager.
__init__
()¶ Initialize self. See help(type(self)) for accurate signature.
-
ConfigManager.
get_command_config
(name)¶ Returns the configuration for command
name
.
-
ConfigManager.
get_plotter_config
(name)¶ Returns a
PlotterConfig
instance for plottername
.- Parameters
name (
Optional
[str
]) -- name of desired plotter (may beNone
, in which caseNone
is returned)- Return type
Optional
[PlotterConfig
]- Returns
PlotterConfig
instance or None if not found
-
ConfigManager.
get_plotter_list
()¶ Returns a list of plotter names whose configuration is available.