also of interest to @deliciouslytyped, sorry for delay!

@veprbl @jonringer thx for great comments! I took suggestions as possible, except where it would break the build

ping?

@veprbl I'm trying to enable tests but working on it is really frustrating when a failure in the test phase fails the whole derivation and I have to wait an hour for the next cycle. Is there any way to separate tests and the build into separate derivations?

Edit: meanwhile I worked around this by using nix-shell.

@lopsided I can't reply to your post for some reason but the original buildPhase has similar code to that

@veprbl I'm trying to enable tests but working on it is really frustrating when a failure in the test phase fails the whole derivation and I have to wait an hour for the next cycle.

nix-shell ./path/to/nixpkgs/default.nix -A pythonPackage.wxPython will probably your best bet, you will be loaded into a similar environment as when the package builds, I don't remember if checkInputs all get inserted. If you have the source checked out locally, then you can iterate within that shell.

Edit: meanwhile I worked around this by using nix-shell.

Was just making sure :)

Another option would be to make 2 derivations, one for the building the initial package, then another that imports that package and runs the tests

@lopsided I can't reply to your post for some reason but the original buildPhase has similar code to that

Yes, I adapted mine from that.

It annoys me that you had to duplicate the code like that but I don't know what to do about it. :(
Meanwhile I had some trouble figuring out how the heck to run the unit tests. Maybe we should try to document somewhere that if anyone is trying to find something related to the build system they should look in build.py... (I completely forgot about that since the last time I poked at this)

It appears to me that build.py does some stuff for calling python itself, for running tests - this may be dropping/mangling PYTHONPATH or whatever the nix infrastructure does. This may need to be worked around to get tests to function.

It might be good to get some wxPython people to review our stuff at some point?

Edit:
Temporary workaround: patch to the following:
os.environ['PYTHONPATH'] = os.environ['PYTHONPATH']+ ":" + phoenixDir()
Will ask upstream to patch.

@jonringer Thanks, I totally missed your comment. I was thinking about making two derivations like you said but I thought of how to do it with nix-shell faster than otherwise. Now that I actually know how to run the tests I might try the latter though.

Currently stuck on /nix/store/dwi186iqm6p3kfncfsl62fbfwfry1yci-python3-3.7.3/bin/python3.7: can't open file 'nix_run_setup': [Errno 2] No such file or directory in nix-build, but maybe more on that later.
...Which might be exactly what @lopsided98 worked around as discussed above...

However, I don't understand why that would be the case given that both buildPhase and installCheckPhase (in my WIP) are overridden, so nothing should be trying to call nix_run_setup...

@deliciouslytyped your installCheckPhases are being overriden most likely because you're using a buildPythonPackage which will override those attrs here or a related build helper.

/nix/store/dwi186iqm6p3kfncfsl62fbfwfry1yci-python3-3.7.3/bin/python3.7: can't open file 'nix_run_setup'

This will happen if you override the buildPhase, but use the default checkPhase. If you're using installCheckPhase, i would move it to checkPhase. Or even better yet, try to use the preCheck, and postCheck hooks if it fits your problem domain.

Doh, the order on the // there caught me with my pants down! (I assumed...) Looks like I need some more belts...

Seems a bit unorthodox that they go and override that...
Hmm, interesting, maybe that's a way to do it without using removeAttrs.
I'm too tired at this point to figure out if what I'm saying is coherent, so that's that for today.

@deliciouslytyped for the average python package, this behavior makes sense. The typical "build and install"for python is just dumping .py's into a directory. If you do need all the phases and "more" control, you could do stdenv.mkderivation + toPythonModule however, this is generally more aimed at projects that have a significant amount of native build outputs and the project stands on it's own outside of python; the toPythonModule will just package the bindings, IIRC.

Edit: see also: https://github.com/wxWidgets/Phoenix/pull/1135/files for test thingy usage example

WIP, has tests at least running:

{ openglSupport ? true

, lib
, stdenv

, buildPythonPackage
, fetchPypi
, python
, pyopengl

, wxGTK
, cairo
, pango

#nativeBuildInputs
, which
, doxygen
, pkgconfig

#buildInputs
, libjpeg
, libtiff
, SDL
, gst-plugins-base
, libnotify
, freeglut
, xorg
, ncurses
, requests
, libpng
, gstreamer
, libX11
, pathlib2

#checkInputs #TODO clean
, numpy
, pytest, pytest_xdist, pytest-timeout
, sphinx
, xvfb_run
}@args:

let
  pname = "wxPython";
  version = "4.0.6";
in

buildPythonPackage rec {
  inherit pname version;

  src = fetchPypi {
    inherit pname version;
    sha256 = "35cc8ae9dd5246e2c9861bb796026bbcb9fb083e4d49650f776622171ecdab37";
    };

  checkInputs = [ xvfb_run sphinx numpy pytest pytest_xdist pytest-timeout ];
  disabledTests = [
    "access_Tests"  #TODO because not implemented yet and automatically fails
    "test_lib_agw_piectrlMethods"  #TODO because hangs the build and timeout skips the rest of tests
    ];
  checkPhase = ''
    runHook preCheck
    xvfb-run -s '-screen 0 800x600x24' \
      ${python.pythonForBuild.interpreter} build.py test --verbose --pytest_timeout=60 \
         --extra_pytest="-k 'not ( ${lib.concatStringsSep " or " disabledTests} )'"
    runHook postCheck
    '';

  nativeBuildInputs = [ pkgconfig which doxygen wxGTK ];

  buildInputs = [
    libjpeg libtiff SDL
    gst-plugins-base libnotify freeglut xorg.libSM ncurses
    requests libpng gstreamer libX11
    pathlib2
    (wxGTK.gtk)
    ] ++ (lib.optional openglSupport pyopengl);

  hardeningDisable = [ "format" ];
  
  DOXYGEN = "${doxygen}/bin/doxygen";

  preConfigure = lib.optionalString (!stdenv.isDarwin) ''
    substituteInPlace wx/lib/wxcairo/wx_pycairo.py \
      --replace 'cairoLib = None' 'cairoLib = ctypes.CDLL("${cairo}/lib/libcairo.so")'
    substituteInPlace wx/lib/wxcairo/wx_pycairo.py \
      --replace '_dlls = dict()' '_dlls = {k: ctypes.CDLL(v) for k, v in [
        ("gdk",        "${wxGTK.gtk}/lib/libgtk-x11-2.0.so"),
        ("pangocairo", "${pango.out}/lib/libpangocairo-1.0.so"), #TODO does this need to refer to .out
        ("appsvc",     None)
        ]}'
    '';

  prePatch = ''
    substituteInPlace build.py \
      --replace "os.environ['PYTHONPATH'] = phoenixDir()" "os.environ['PYTHONPATH'] = os.environ['PYTHONPATH'] + ':' + phoenixDir()"
    '';

  buildPhase = ''
    python build.py -v --use_syswx dox etg --nodoc sip build_py
    '';

  installPhase = ''
    ${python.interpreter} setup.py install --skip-build --prefix=$out #TODO this uses python.interpreter but the above does not?
    wrapPythonPrograms
    '';

  passthru = { inherit args; };

  meta = {
    description = "Cross platform GUI toolkit for Python, Phoenix version";
    homepage = http://wxpython.org/;
    license = lib.licenses.wxWindows;
    };

  }

Something looks sketchy here:

unittests/test_lib_agw_piectrl.py::lib_agw_piectrl_Tests::test_lib_agw_piectrlCtor PASSED [ 44%]
INTERNALERROR> Traceback (most recent call last):
INTERNALERROR>   File "/nix/store/9pl2hgg3p2ijhzaycj2h77p3ny0vwfgy-python3.7-pytest-4.2.1/lib/python3.7/site-packages/_pytest/main.py", line 203, in wrap_session
INTERNALERROR>     session.exitstatus = doit(config, session) or 0
INTERNALERROR>   File "/nix/store/9pl2hgg3p2ijhzaycj2h77p3ny0vwfgy-python3.7-pytest-4.2.1/lib/python3.7/site-packages/_pytest/main.py", line 243, in _main
INTERNALERROR>     config.hook.pytest_runtestloop(session=session)

[SNIP]

INTERNALERROR>     pytest.fail('Timeout >%ss' % timeout)
INTERNALERROR>   File "/nix/store/9pl2hgg3p2ijhzaycj2h77p3ny0vwfgy-python3.7-pytest-4.2.1/lib/python3.7/site-packages/_pytest/outcomes.py", line 113, in fail
INTERNALERROR>     raise Failed(msg=msg, pytrace=pytrace)
INTERNALERROR> Failed: Timeout >60.0s

== 19 failed, 754 passed, 6 skipped, 1 xfailed, 68 warnings in 524.68 seconds ==

Does it just abort the rest of the test process on a timeout? Note the last PASSED is at 44%.

Edit: The help string does say "Timeout, in seconds, for stopping stuck test cases. (Currently not working as expected, so disabled by default.)"

@deliciouslytyped thanks for picking up, been offline in the wilderness. Will try to look at tests in a couple days, they are a real PITA which is why I disabled doCheck. I did try some applications though, like Helloworld, that worked fine.

This pull request has been mentioned on Nix community. There might be relevant details there:

https://discourse.nixos.org/t/wxpython-on-python3/3588/2

Test termination behavior of timeout is explained at https://pypi.org/project/pytest-timeout/

@FRidh stuff seems to generally work, how should failing tests be handled? It would be nice to get this merged finally...

I'm also not sure how to process test ouput.

@deliciouslytyped you can use the pytest testrunner, it has more options to disabling certain tests or files.

pytest --ignore=path/to/file.py or -k 'not some_test_substring'

example can be seen here 93ebc61

@FRidh can you please set some minumum criteria for getting this merged so I have something to work towards?
We can set some additional goals for after that, I would really like this to just be in the tree already.

Can/should we do anything about using wrapgappshook here? or does that need to be used in the libraries/binaries that consume this package?

I made a change and pushed to master. Thanks for the effort. In the future, though, we should improve this to build a wheel instead.

Yay, since this PR is closed, I should probably create a TODO list in a new issue "soon".

What did you change?

Using ${python.interpreter} instead of python

I'm not volunteering right now but does anyone want to work on getting tests enabled and following up with upstream about the tests?