pkgs/development/python-modules/cocotb/default.nix

   1 {
   2   lib,
   3   buildPythonPackage,
   4   fetchFromGitHub,
   5   setuptools,
   6   setuptools-scm,
   7   cocotb-bus,
   8   find-libpython,
   9   pytestCheckHook,
  10   swig,
  11   iverilog,
  12   ghdl,
  13   stdenv,
  14   fetchpatch,
  15 }:
  16
  17 buildPythonPackage rec {
  18   pname = "cocotb";
  19   version = "1.9.2";
  20   format = "setuptools";
  21
  22   # pypi source doesn't include tests
  23   src = fetchFromGitHub {
  24     owner = "cocotb";
  25     repo = "cocotb";
  26     tag = "v${version}";
  27     hash = "sha256-7KCo7g2I1rfm8QDHRm3ZKloHwjDIICnJCF8KhaFdvqY=";
  28   };
  29
  30   nativeBuildInputs = [ setuptools-scm ];
  31
  32   buildInputs = [ setuptools ];
  33   propagatedBuildInputs = [ find-libpython ];
  34
  35   postPatch = ''
  36     patchShebangs bin/*.py
  37
  38     # POSIX portability (TODO: upstream this)
  39     for f in \
  40       cocotb/share/makefiles/Makefile.* \
  41       cocotb/share/makefiles/simulators/Makefile.*
  42     do
  43       substituteInPlace $f --replace 'shell which' 'shell command -v'
  44     done
  45
  46     # remove circular dependency cocotb-bus from setup.py
  47     substituteInPlace setup.py --replace "'cocotb-bus<1.0'" ""
  48   '';
  49
  50   disabledTests = [
  51     # https://github.com/cocotb/cocotb/commit/425e1edb8e7133f4a891f2f87552aa2748cd8d2c#diff-4df986cbc2b1a3f22172caea94f959d8fcb4a128105979e6e99c68139469960cL33
  52     "test_cocotb"
  53     "test_cocotb_parallel"
  54   ];
  55
  56   nativeCheckInputs = [
  57     cocotb-bus
  58     pytestCheckHook
  59     swig
  60     iverilog
  61     ghdl
  62   ];
  63
  64   preCheck = ''
  65     export PATH=$out/bin:$PATH
  66     mv cocotb cocotb.hidden
  67   '';
  68
  69   pythonImportsCheck = [ "cocotb" ];
  70
  71   meta = {
  72     changelog = "https://github.com/cocotb/cocotb/releases/tag/v${version}";
  73     description = "Coroutine based cosimulation library for writing VHDL and Verilog testbenches in Python";
  74     mainProgram = "cocotb-config";
  75     homepage = "https://github.com/cocotb/cocotb";
  76     license = lib.licenses.bsd3;
  77     broken = stdenv.hostPlatform.isDarwin;
  78     maintainers = with lib.maintainers; [
  79       matthuszagh
  80       jleightcap
  81     ];
  82   };
  83 }