python3.pkgs.sphinxcontrib-openapi: unbreak, switch to cilium fork

[flokli]

Description of changes

This fork uses m2r instead of mdinclude.

m2r is unmaintained and incompatible with recent versions of mistune (and old ones are insecure).

See

• cilium/cilium@b986246
• cilium/openapi@cd829a0

for details.

This PR also packages picobox and sphinx_mdinclude, which are new dependencies of sphinxcontrib-openapi.

Due to picobox being incompatible with Python 3.10 currently, this only unbreaks python39.pkgs.sphinxcontrib-openapi, but it's better than not being able to render openapi stuff at all.

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 22.11 Release Notes (or backporting 22.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
  • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
• Fits CONTRIBUTING.md.

[flokli]

Hmmh, this still seems to fail to execute, showing a

AttributeError: module 'collections.abc' has no attribute 'defaultdict'

…that's also visible in the (currently disabled) tests. I need to take a look.

[flokli]

I got it to work! sphinx now is able to render openapi specs again.

Unfortunately, I wasn't able to get the test suite to parse, but considering it's also disabled for all other sphinx-related python packages too, it's probably not too much of an issue.

[flokli]

This apparently got introduced in cilium/openapi@a1d4fca (so I commented there).

We could probably just pin the commit before that instead of undoing the change in a patch but I'd rather see it fixed in cilium/openapi too.

[flokli]

I sent a PR at cilium/openapi#1.

[SuperSandro2000]

The prefix for python is python310.pkgs or python310Packages right now. 3.9 is still being build but not the default anymore and python2 is completely unsupported.

[flokli]

The prefix for python is python310.pkgs or python310Packages right now. 3.9 is still being build but not the default anymore and python2 is completely unsupported.

Yes, I used the python39 prefix in the PR to convey this unbreaks at least the python 3.9 version of the package - meaning if you assemble a python 3.9 environment with sphinx and this PR, you can render docs. Of course, once ikalnytskyi/picobox#55 is fixed, we should relax the version bounds in picobox.

Until the tests pass, I don't want to mark picocom as not broken on 3.10.

[flokli]

Apparently, the python 3.10 fix for picobox is already in master, there just hasn't been a release yet. I fetchpatch'ed the patch and removed the python 3.9 restriction.

Likewise, sphinx-mdinclude docutils support was fixed too, so no need to ship a downstream patch in nixpkgs, we can fetchpatch this commit too.

In both cases, I linked to the issue/comment asking for a release containing the fixes.

I'd like to wait until cilium/openapi#1 is merged before merging this PR in, so we can point to the final commit there, too.

[flokli]

cilium/openapi#1 has been merged, this PR was updated. This is ready from my side.

[flokli]

sphinx-mdinclude did just release 0.5.2, containing the patch, so I updated the version to this and dropped the patch.

[SuperSandro2000]

This should be pythonOlder "3.7"

[qmonnet]

[Follow-up] @flokli Hi, the PR to upstream the changes from the cilium fork has been merged a few weeks ago (sphinx-contrib/openapi#127), and a new tag has been created for sphinx/openapi (https://github.com/sphinx-contrib/openapi/releases/tag/0.8.0), so you probably want to revert to that source. We probably won't keep the cilium/ fork forever.

[flokli]

@qmonnet thanks for the highlight. I opened #211156, which switches it back to the fork.