0.12

readme.md

@@ -36,6 +36,9 @@ This code will be executed
 ```
 
 # Changelog
+#### 0.12 (2024-01-09)
+- Error when providing invalid options
+
 #### 0.11 (2024-01-09)
 - Updated CI and ruff fixes
 

src/sphinx_exec_code/__version__.py

@@ -1 +1 @@
-__version__ = '0.11'
+__version__ = '0.12'

src/sphinx_exec_code/sphinx_spec.py

@@ -28,6 +28,14 @@ def from_options(cls, options: Dict[str, Any]) -> 'SphinxSpecBase':
  if not val:
  val = cls.defaults[name]
  opts[name] = val
+
+ if left := set(options) - set(cls.aliases):
+ msg = (
+ f'Invalid option{"s" if len(left) != 1 else ""}: '
+ f'{", ".join(sorted(map(str, left)))}! Supported: {", ".join(sorted(map(str, cls.aliases)))}'
+ )
+ raise ValueError(msg)
+
  return cls(**opts)
 
  @classmethod

tests/test_sphinx_spec.py

@@ -42,12 +42,12 @@ def test_build_spec_code():
 
 
 def test_spec_code():
- obj = SpecCode.from_options({'linenos': None, 'caption': 'my_header'})
+ obj = SpecCode.from_options({'linenos': None, 'caption': 'my_header', 'filename': 'filename'})
  assert obj.caption == 'my_header'
  assert obj.language == 'python'
  assert obj.linenos is True
  assert obj.hide is False
- assert obj.filename == ''
+ assert obj.filename == 'filename'
 
 
 def test_spec_output():
@@ -56,3 +56,11 @@ def test_spec_output():
  assert obj.language == 'none'
  assert obj.linenos is False
  assert obj.hide is True
+
+
+def test_invalid_options():
+ with pytest.raises(ValueError) as e:
+ SpecOutput.from_options({'hide-output': None})
+
+ assert str(e.value) == ('Invalid option: hide-output! '
+ 'Supported: caption_output, hide_output, language_output, linenos_output')