make -C mpy-cross fails, no "huffman"

[todbot]

CircuitPython version

n/a

Code/REPL

make -C mpy-cross

Behavior

% make -C mpy-cross
Use make V=1, make V=2 or set BUILD_VERBOSE similarly in your environment to increase build verbosity.
mkdir -p build/genhdr
GEN build/genhdr/moduledefs.h
QSTR updated
Traceback (most recent call last):
File "/Users/tod/projects/adafruit/circuitpython-adafruit/mpy-cross/../py/maketranslationdata.py", line 30, in
import huffman
ModuleNotFoundError: No module named 'huffman'
make: *** [build/genhdr/compression.generated.h] Error 1

Description

Looks like doing "pip3 install huffman" fixes this.

So add this to `requirements-dev.txt" ?

This is on MacOS with Python3.11 installed via Homebrew that otherwise hasn't done much Python development.

Additional information

No response

[tannewt]

We use an in-tree version of huffman but I don't remember why. This bit of code is meant to add it to the path: https://github.com/adafruit/circuitpython/blob/main/py/maketranslationdata.py#L26-L30

Try building from the mpy-cross directory.

[todbot]

cd mpy-cross && make does indeed work.

I guess https://github.com/adafruit/circuitpython/blob/main/BUILDING.md
and https://learn.adafruit.com/building-circuitpython/build-circuitpython#build-mpy-cross-2986721 should be updated then?

[todbot]

oh wait no cd mpy-cross && make does not work.

[todbot]

for some reason make fetch-submodules does not pull in "tools/huffman". I had to explicitly get it with cd tools/huffman; git checkout

[tannewt]

for some reason make fetch-submodules does not pull in "tools/huffman". I had to explicitly get it with cd tools/huffman; git checkout

Ah! That would do it.

[dhalbert]

for some reason make fetch-submodules does not pull in "tools/huffman". I had to explicitly get it with cd tools/huffman; git checkout

I did a fresh clone of my fork, and did make fetch-submodules. tools/huffman got cloned and populated as I would expect. I am using git 2.40.1 on Ubuntu 22.04. I use the git PPA to get a newer version than 22.04 would normally provide.

Maybe there is something wonky about your clone. You could try git remove-submodules and then git fetch-submodules again, or just try a fresh clone.

[todbot]

This is weird. I have also been building on an Ubuntu 22 x86_64 box and I swear I saw it there too.
But I just did a fresh checkout on Ubuntu (git 2.34.1) and macos (homebrew git 2.39.1) and I am not experiencing this issue now. I do know that someone else on a Mac I was helping build a board definition had the same problem and they perhaps did not have homebrew git. And at one point during this I was having PATH issues wrt homebrew.
Closing this issue because I think the problem was me.