Traceback on unknown language

[spacehobo]

Entangled can't seem to work out how to annotate AWK. I was hoping the "Custom syntax" link in the web site would help me add a rule to tell it to behave like a shell script, but that section appears to be missing from the page now.

This occurs with Entangled 2.3.2 (I tried both the entangled-cli and entangled_cli packages via uv pip in a venv).

[11:47:04] WARNING  `expense.md:31`: language `awk` unknown.
           ERROR   
           ERROR    This error is due to an internal bug in Entangled.
                    Please file an issue including the above stack
                    trace and example content to reproduce the
                    exception at
                    https://github.com/entangled/entangled.py/.
Traceback (most recent call last):
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/entangled/main.py", line 34, in cli
    _ = argh.dispatch(parser)
        ^^^^^^^^^^^^^^^^^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/argh/dispatching.py", line 179, in dispatch
    return run_endpoint_function(
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/argh/dispatching.py", line 237, in run_endpoint_function
    return _process_command_output(lines, output_file, raw_output)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/argh/dispatching.py", line 254, in _process_command_output
    for line in lines:
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/argh/dispatching.py", line 362, in _execute_command
    for line in result:
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/argh/dispatching.py", line 342, in _call
    result = function(*positional, **keywords)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/entangled/commands/tangle.py", line 61, in tangle
    result, deps = tangle_ref(refs, tgt, annotation_method)
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/entangled/tangle.py", line 148, in tangle_ref
    t = tangler(refs, ref, init, v)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<string>", line 7, in __init__
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/entangled/tangle.py", line 88, in __post_init__
    assert self.cb.language
           ^^^^^^^^^^^^^^^^
AssertionError
Traceback (most recent call last):
  File "/home/nick/src/stitched-expenses/.venv/bin/entangled", line 10, in <module>
    sys.exit(cli())
             ^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/entangled/main.py", line 50, in cli
    raise e
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/entangled/main.py", line 34, in cli
    _ = argh.dispatch(parser)
        ^^^^^^^^^^^^^^^^^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/argh/dispatching.py", line 179, in dispatch
    return run_endpoint_function(
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/argh/dispatching.py", line 237, in run_endpoint_function
    return _process_command_output(lines, output_file, raw_output)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/argh/dispatching.py", line 254, in _process_command_output
    for line in lines:
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/argh/dispatching.py", line 362, in _execute_command
    for line in result:
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/argh/dispatching.py", line 342, in _call
    result = function(*positional, **keywords)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/entangled/commands/tangle.py", line 61, in tangle
    result, deps = tangle_ref(refs, tgt, annotation_method)
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/entangled/tangle.py", line 148, in tangle_ref
    t = tangler(refs, ref, init, v)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<string>", line 7, in __init__
  File "/home/nick/src/stitched-expenses/.venv/lib/python3.12/site-packages/entangled/tangle.py", line 88, in __post_init__
    assert self.cb.language
           ^^^^^^^^^^^^^^^^
AssertionError

[jhidding]

An unknown language shouldn't throw an error like this, just print a warning.

[spacehobo]

I just led a workshop in Rotterdam on the practice of Literate Programming, using entangled.py, so thank you for this tool!

I think that we all agreed that we wished we could specify custom language identifiers (and their related comment string and shebang-detection rules) in the YAML headers at the top of our markdown documents. Pandoc (which we're using to render the publishable output) supports YAML metadata either in a separate file or in a rule-delimited block at the top of the markdown stream. It could be worthwhile to claim a namespace in this block and allow the definition of new language configurations.

[jhidding]

Oh, that's so cool! Could you tell me more about the event? I wish you told me before, I could have dropped by ;)

This feature already works (since this week)!

---
entangled:
  version: "2.4"
  style: basic
  languages:
    - name: Nim
      identifiers: ["nim"]
      comment: { "open": "#" }
---

Hello World from Nim!
=====================

```nim
#| file: hello.nim
echo "Hello, World!"
```

[jhidding]

Also, I'm not able to reproduce your error. Could you see if its fixed by accident in Entangled 2.4? Else, can you give a minimal input that triggers the error?

[jhidding]

Ping @spacehobo ?

[spacehobo]

Ah sorry, I don't use github often so I didn't see your ping. I'll whip something up shortly.

[spacehobo]

I also can't reproduce this with v2.4.0, so it does seem that at some point these tracebacks were fixed!