__version__ is broken with 1.7.1

[saimn]

I updated to version 1.7.1 and __version__ reports '0.0.0', which then breaks astropy import because the version requirement is not met. cc @mhvk and @astrofrog @embray for the setuptools-scm knowledge.

In [3]: erfa.__version__
Out[3]: '0.0.0'

[saimn]

So I have setuptools-scm, and in your version.py code

try:
    try:
        from ._dev.scm_version import get_version as _get_version
        _version = _get_version()
        del _get_version
    except ImportError:
        from ._version import version as _version
except Exception:
    import warnings
    warnings.warn(
        f'could not determine {__name__.split(".")[0]} package version; '
        f'this indicates a broken installation')
    del warnings

    _version = '0.0.0'

_get_version() raises a LookupError: setuptools-scm was unable to detect version for '/home/simon/.pyenv/versions/3.8.1/lib/python3.8/site-packages' which is not catched as ImportError and thus does not fallback to _version.

[pllim]

Is it the leading v in the tags?

[saimn]

Not, it's expected that setuptools-scm cannot find the version from an installed package (i.e. not a git repo), it's just that the exception raised is not the one that is expected here. This could be harmless if astropy was not verifying the version. and if the code on both sides was more robust (if ._version exists, it should be used as fallback).

[avalentino]

Hi @saimn I'm not able to reproduce the issue in a clean venv environment.

$ python --version
Python 3.8.5

$ python -c "import platform; print(platform.platform())"
Linux-5.4.0-54-generic-x86_64-with-glibc2.29

$ pip list
Package       Version
------------- -------
numpy         1.19.4 
pip           20.0.2 
pkg-resources 0.0.0  
pyerfa        1.7.1  
setuptools    44.0.0 

Can you please provide more details on your setup?

[saimn]

You don't have setuptools-scm, so in that case I guess _get_version() raises the ImportError and it works.

[avalentino]

ah, sorry. Now I can reproduce. Thanks

[saimn]

I see now that you version.py is customized compared to astropy, so the good news is that other packages should not be affected by this.

[avalentino]

OK, the problem is that the erfa/_dev folder for some reason has been included in the distribution.

[avalentino]

Strange, this problem should be captured by the test suite:

$ python3 -m pytest --pyargs erfa
======================================================= test session starts ========================================================
platform linux -- Python 3.8.5, pytest-6.1.2, py-1.9.0, pluggy-0.13.1
rootdir: /home/antonio
collected 26 items                                                                                                                 

projects/pyerfa/tmp/.venv/lib/python3.8/site-packages/erfa/tests/test_erfa.py ...F....................s.                     [100%]

============================================================= FAILURES =============================================================
__________________________________________ TestVersion.test_version_with_embedded_liberfa __________________________________________

self = <erfa.tests.test_erfa.TestVersion object at 0x7ffa745c20d0>

    @pytest.mark.skipif(not embedded_liberfa(), reason='system liberfa')
    def test_version_with_embedded_liberfa(self):
        version = erfa.__version__
>       assert version.startswith(erfa.version.erfa_version)
E       AssertionError: assert False
E        +  where False = <built-in method startswith of str object at 0x7ffa74bcb530>('1.7.1')
E        +    where <built-in method startswith of str object at 0x7ffa74bcb530> = '0.0.0'.startswith
E        +    and   '1.7.1' = <module 'erfa.version' from '/home/antonio/projects/pyerfa/tmp/.venv/lib/python3.8/site-packages/erfa/version.py'>.erfa_version
E        +      where <module 'erfa.version' from '/home/antonio/projects/pyerfa/tmp/.venv/lib/python3.8/site-packages/erfa/version.py'> = erfa.version

projects/pyerfa/tmp/.venv/lib/python3.8/site-packages/erfa/tests/test_erfa.py:64: AssertionError
========================================================= warnings summary =========================================================
projects/pyerfa/tmp/.venv/lib/python3.8/site-packages/erfa/version.py:15
  /home/antonio/projects/pyerfa/tmp/.venv/lib/python3.8/site-packages/erfa/version.py:15: UserWarning: could not determine erfa package version; this indicates a broken installation
    warnings.warn(

-- Docs: https://docs.pytest.org/en/stable/warnings.html
===================================================== short test summary info ======================================================
FAILED projects/pyerfa/tmp/.venv/lib/python3.8/site-packages/erfa/tests/test_erfa.py::TestVersion::test_version_with_embedded_liberfa
======================================== 1 failed, 24 passed, 1 skipped, 1 warning in 0.80s ========================================

@saimn can you please confirm that the test fails for you as well?

[avalentino]

Should we make a patch release?

[mhvk]

Yes, I think so!

[saimn]

Yes, would be great 👍

[maxnoe]

Yes please, this breaks astropy imports.

[avalentino]

The new release should be available now.

[yucelkilic]

I was stuck in the pyerfa version control during the astropy installation. pyerfa's version was '0.0.0'. For this reason, astropy installation failed with pip's dependency control.

I checked the source code and removed the relative path "." from the line below. Then it worked.

pyerfa/erfa/version.py

Line 8 in fb1f520

from ._dev.scm_version import get_version as _get_version

I changed to:

python from _dev.scm_version import get_version as _get_version

Note: Python 3.10.8 (Mach-O 64-bit executable arm64), macOS Monterey, M2.