3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

klippy: Validate that options in the config file exist 

Check that all options specified in the config file are valid.  This
catches possible typos and spelling errors in variable names that have
a default.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2016-11-30 16:07:17 -05:00
parent 2f97b2d7c2
commit 17dcb42752
2 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/Todo.md
View File

@ -4,18 +4,10 @@ features still to be implemented. In no particular order:
Host user interaction Host user interaction
===================== =====================
* Improve error reporting: * See if there is a better way to report errors. Octoprint sometimes
doesn't highlight an error (one has to look in the terminal tab to
* Improve error checks on config file values. If a parameter is find the error) and errors written to the log can be non-obvious to
incorrect or missing a more friendly error message should be a user.
presented to the user.
* Warn on any unused config settings (to catch spelling errors or
fields defined in an incorrect section).
* Find a better way to report errors. Octoprint sometimes doesn't
highlight an error (one has to look in the terminal tab to find the
error) and errors written to the log can be non-obvious to a user.
* Improve startup: * Improve startup:

17
klippy/klippy.py
View File

@ -44,6 +44,8 @@ class ConfigWrapper:
if (default is not self.sentinel if (default is not self.sentinel
and not self.printer.fileconfig.has_option(self.section, option)): and not self.printer.fileconfig.has_option(self.section, option)):
return default return default
self.printer.all_config_options[
(self.section.lower(), option.lower())] = 1
try: try:
return parser(self.section, option) return parser(self.section, option)
except self.error, e: except self.error, e:
@ -79,6 +81,7 @@ class Printer:
self.stats_timer = self.reactor.register_timer(self.stats) self.stats_timer = self.reactor.register_timer(self.stats)
self.connect_timer = self.reactor.register_timer( self.connect_timer = self.reactor.register_timer(
self.connect, self.reactor.NOW) self.connect, self.reactor.NOW)
self.all_config_options = {}
self.state_message = message_startup self.state_message = message_startup
self.debugoutput = self.dictionary = None self.debugoutput = self.dictionary = None
self.fileconfig = None self.fileconfig = None
@ -118,6 +121,19 @@ class Printer:
self.objects[oname].build_config() self.objects[oname].build_config()
self.gcode.build_config() self.gcode.build_config()
self.mcu.build_config() self.mcu.build_config()
def validate_config(self):
valid_sections = dict([(s, 1) for s, o in self.all_config_options])
for section in self.fileconfig.sections():
section = section.lower()
if section not in valid_sections:
raise ConfigParser.Error("Unknown config file section '%s'" % (
section,))
for option in self.fileconfig.options(section):
option = option.lower()
if (section, option) not in self.all_config_options:
raise ConfigParser.Error(
"Unknown option '%s' in section '%s'" % (
option, section))
def connect(self, eventtime): def connect(self, eventtime):
try: try:
self.load_config() self.load_config()
@ -127,6 +143,7 @@ class Printer:
self.mcu.connect_file(self.debugoutput, self.dictionary) self.mcu.connect_file(self.debugoutput, self.dictionary)
self.mcu.connect() self.mcu.connect()
self.build_config() self.build_config()
self.validate_config()
self.gcode.set_printer_ready(True) self.gcode.set_printer_ready(True)
self.state_message = "Running" self.state_message = "Running"
except ConfigParser.Error, e: except ConfigParser.Error, e: