FAQ: did I break griffe?

[blaisep]

Hi @pawamoy , I'm new to Griffe (and new to dynamic analysis). Perhaps someone can see if this works on their machine.
I installed the cli pipx install griffe and when I hit enter, the cursor returns to the next line and nothing happens. Even after three hours.
So, maybe it's a problem with my environment. I also have uv installed.
However, when I run within uv ...

$ uv run griffe dump tahoe-lafs                                                                                                 
⠧ junitxml==0.7                                                                                                                                                               × Failed to download and build `gpg==1.10.0`
  ╰─▶ Build backend failed to determine requirements with `build_wheel()` (exit status: 1)

      [stderr]
      <string>:163: SyntaxWarning: invalid escape sequence '\s'
      Could not find gpgme-config.  Please install the libgpgme development package.

It's possible that the failure is unrelated to griffe because the package is a big, gnarly distributed file system built on top of Twisted.
https://github.com/tahoe-lafs/tahoe-lafs

I suppose that the suggestion for the docs would be to include an example of the expected result (and anything not expected would be a failure)

[pawamoy]

Hey @blaisep!

By using uv run, you implicitly ask uv to install all your dependencies declared in pyproject.toml. One of these dependencies has to be built (it doesn't have a wheel for your Python version or platform), and it fails to do so. The message you see comes from uv, or from the build backend used to build junitxml (probably, could be another package, would have to enable verbose output). The syntax warning is not important. The message right after is: it looks like a system library is missing, libgpgme. The package apparently needs the gpgme-config executable to build.

In short, I don't think the issue is related to Griffe at all. You could try to run uv sync before any Griffe command to make sure of that.

[pawamoy]

OK I was able to confirm that this is unrelated to Griffe, as I get the same error:

% git clone https://github.com/tahoe-lafs/tahoe-lafs --depth=1
% cd tahoe-lafs
% uv sync
  × Failed to build `gpg==1.10.0`
  ├─▶ The build backend returned an error
  ╰─▶ Call to `setuptools.build_meta:__legacy__.build_wheel` failed (exit status: 1)

      [stderr]
      Could not find gpgme-config.  Please install the libgpgme development package.

      hint: This usually indicates a problem with the package or the build environment.
  help: `gpg` (v1.10.0) was included because `tahoe-lafs[build]` (v0.1.dev1+gf451755) depends on `gpg`

[pawamoy]

I installed the cli pipx install griffe and when I hit enter, the cursor returns to the next line and nothing happens. Even after three hours.

You mean you ran griffe dump tahoe-lafs and nothing happened? I'll try it.

[pawamoy]

So, there's no tahoe-lafs Python package in this repository, only an allmydata package under src. You can dump it with griffe dump -s src allmydata.

[blaisep]

yes, it's such a legacy project that I pip install tahoe-lafs but the source tree still has allmydata (the original project name). 🙄