PyInstaller Support for SunPy

.gitignore

@@ -232,6 +232,11 @@ docs/guide/data_types/figure.png
 *.orig
 .tmp
 
+# PyInstaller Files
+.pyinstaller/run_sunpy_tests
+.pyinstaller/sunpy_tests
+.pyinstaller/run_sunpy_tests.spec
+
 ### Vagrant: https://www.toptal.com/developers/gitignore/api/vagrant
 # General
 .vagrant/

.pyinstaller/hooks/hook-sunpy.py

@@ -0,0 +1,14 @@
+from PyInstaller.utils.hooks import collect_data_files, collect_entry_point, collect_submodules, copy_metadata
+
+datas, hiddenimports = collect_entry_point("pytest11")
+
+datas += collect_data_files("sunpy")
+datas += collect_data_files("dask")
+datas += collect_data_files("drms")
+datas += copy_metadata("sunpy")
+
+hiddenimports += collect_submodules('sunpy')
+hiddenimports += collect_submodules('numpy.distutils')
+hiddenimports += collect_submodules('distutils')
+hiddenimports += ['skimage.filters.rank.core_cy_3d']
+hiddenimports += ['sunpy.data.data_manager.tests.mocks']

.pyinstaller/run_sunpy_tests.py

@@ -0,0 +1,81 @@
+import os
+import sys
+import shutil
+
+import pytest
+
+# Skipping these tests that take check the name of the current module (which ends up starting with
+# sunpy_tests rather than sunpy).
+# asdf path issue with PyInstaller as well.
+
+if getattr(sys, 'frozen', False):
+    # Running in a bundle
+    bundle_dir = sys._MEIPASS
+
+    SKIP_TESTS = [
+        'test_saveframe',
+        'test_saveframe_arr',
+        'test_genericmap_basic',
+        'test_genericmap_mask',
+        'test_attr_metamagic',
+        'test_main_nonexisting_module',
+        'test_main_stdlib_module',
+        'test_origin',
+        'test_find_dependencies',
+        'test_missing_dependencies_by_extra',
+        'test_hgc_100',
+        'test_missing_dependencies_by_extra',
+        'test_basic',
+        'test_data_manager',
+        'test_file_tampered',
+        'test_download_cache',
+        'test_skip_all',
+        'test_override_file',
+        'test_same_file_id_different_module']
+
+    sys.exit(pytest.main(['sunpy_tests',
+                          '-k ' + ' and '.join('not ' + test for test in SKIP_TESTS)]))
+else:
+    ROOT = os.path.join(os.path.dirname(__file__), '../')
+
+    for root, dirnames, files in os.walk(os.path.join(ROOT, 'sunpy')):
+        for dirname in dirnames:
+            final_dir = os.path.relpath(
+                os.path.join(
+                    root.replace(
+                        'sunpy',
+                        'sunpy_tests'),
+                    dirname),
+                ROOT)
+            # We only copy over 'tests' directories, but not sunpy/tests (only
+            # sunpy/tests/tests) since that is not just a directory with tests.
+            if dirname == 'tests' and not root.endswith('sunpy'):
+                shutil.copytree(os.path.join(root, dirname), final_dir, dirs_exist_ok=True)
+            else:
+                # Create empty __init__.py files so that 'sunpy_tests' still
+                # behaves like a single package, otherwise pytest gets confused
+                # by the different conftest.py files.
+                init_filename = os.path.join(final_dir, '__init__.py')
+                if not os.path.exists(os.path.join(final_dir, '__init__.py')):
+                    os.makedirs(final_dir, exist_ok=True)
+                    with open(os.path.join(final_dir, '__init__.py'), 'w') as f:
+                        f.write("#")
+        # Copy over all conftest.py files
+        for file in files:
+            if file == 'conftest.py':
+                final_file = os.path.relpath(
+                    os.path.join(
+                        root.replace(
+                            'sunpy',
+                            'sunpy_tests'),
+                        file),
+                    ROOT)
+                shutil.copy2(os.path.join(root, file), final_file)
+
+        # Add the top-level __init__.py file
+        with open(os.path.join('sunpy_tests', '__init__.py'), 'w') as f:
+            f.write("#")
+
+        # Copy the top-level conftest.py
+        shutil.copy2(os.path.join(ROOT, 'sunpy', 'conftest.py'),
+                     os.path.join('sunpy_tests', 'conftest.py'))

azure-pipelines.yml

@@ -97,6 +97,8 @@ stages:
           - linux: py38-conda
             libraries: {}
 
+          - linux: pyinstaller
+
 
   - ${{ if or(eq(variables['Build.Reason'], 'Schedule'), eq(variables['Build.Reason'], 'Manual')) }}:
     - stage: CronTests

changelog/5224.feature.rst

@@ -0,0 +1 @@
+Added hook file and tests for using PyInstaller with SunPy.

sunpy/coordinates/tests/test_frameattributes.py

@@ -7,9 +7,14 @@
 from astropy.time import Time
 
 from sunpy.coordinates import frames, get_earth
+from sunpy.coordinates.frameattributes import ObserverCoordinateAttribute, TimeFrameAttributeSunPy
+from sunpy.coordinates.frames import (
+    HeliocentricInertial,
+    HeliographicCarrington,
+    HeliographicStonyhurst,
+    Helioprojective,
+)
 from sunpy.time import parse_time
-from ..frameattributes import ObserverCoordinateAttribute, TimeFrameAttributeSunPy
-from ..frames import HeliocentricInertial, HeliographicCarrington, HeliographicStonyhurst, Helioprojective
 
 
 @pytest.fixture

sunpy/coordinates/tests/test_frames.py

@@ -13,10 +13,15 @@
 )
 from astropy.tests.helper import assert_quantity_allclose
 
+from sunpy import sun
+from sunpy.coordinates.frames import (
+    Heliocentric,
+    HeliographicCarrington,
+    HeliographicStonyhurst,
+    Helioprojective,
+)
 from sunpy.time import parse_time
 from sunpy.util.exceptions import SunpyUserWarning
-from ... import sun
-from ..frames import Heliocentric, HeliographicCarrington, HeliographicStonyhurst, Helioprojective
 
 RSUN_METERS = sun.constants.get('radius').si.to(u.m)
 DSUN_METERS = sun.constants.get('mean distance').si.to(u.m)

sunpy/coordinates/tests/test_wcs_utils.py

@@ -14,8 +14,12 @@
     HeliographicStonyhurst,
     Helioprojective,
 )
+from sunpy.coordinates.wcs_utils import (
+    _set_wcs_aux_obs_coord,
+    solar_frame_to_wcs_mapping,
+    solar_wcs_frame_mapping,
+)
 from sunpy.util import SunpyUserWarning
-from ..wcs_utils import _set_wcs_aux_obs_coord, solar_frame_to_wcs_mapping, solar_wcs_frame_mapping
 
 
 @pytest.mark.parametrize('ctype, frame', [[['HPLN', 'HPLT'], Helioprojective],

sunpy/data/data_manager/tests/test_manager.py

@@ -15,7 +15,7 @@ def test_basic(storage, downloader, data_function):
     assert Path(storage._store[0]['file_path']).name == ('sunpy.test_file')
 
 
-def test_cache(manager, storage, downloader, data_function):
+def test_download_cache(manager, storage, downloader, data_function):
     """
     Test calling function multiple times does not redownload.
     """

sunpy/data/tests/test_sample.py

@@ -1,6 +1,6 @@
 import pytest
 
-from .._sample import _download_sample_data, _retry_sample_data
+from sunpy.data._sample import _download_sample_data, _retry_sample_data
 
 
 @pytest.mark.remote_data

sunpy/io/special/asdf/tags/tests/test_coordinate_frames.py

@@ -1,17 +1,15 @@
 import os
-import platform
-from distutils.version import LooseVersion
 
 import numpy as np
 import pytest
 
+import asdf
 import astropy.units as u
 from astropy.coordinates import CartesianRepresentation
 
 import sunpy.coordinates.frames as frames
 from sunpy.tests.helpers import asdf_entry_points
 
-asdf = pytest.importorskip('asdf', '2.0.2')
 from asdf.tests.helpers import assert_roundtrip_tree  # NOQA isort:skip
 
 sunpy_frames = list(map(lambda name: getattr(frames, name), frames.__all__))
@@ -61,22 +59,12 @@ def test_hgc_100():
             assert hgc.observer.object_name == 'earth'
 
 
-# Skip these two tests on windows due to a weird interaction with atomicfile
-# and tmpdir
-skip_windows_asdf = pytest.mark.skipif(
-    (LooseVersion(asdf.__version__) < LooseVersion("2.3.1")
-     and platform.system() == 'Windows'),
-    reason="See https://github.com/spacetelescope/asdf/pull/632")
-
-
-@skip_windows_asdf
 @asdf_entry_points
 def test_saveframe(coordframe_scalar, tmpdir):
     tree = {'frame': coordframe_scalar}
     assert_roundtrip_tree(tree, tmpdir)
 
 
-@skip_windows_asdf
 @asdf_entry_points
 def test_saveframe_arr(coordframe_array, tmpdir):
     tree = {'frame': coordframe_array}

sunpy/io/special/asdf/tags/tests/test_genericmap.py

@@ -2,14 +2,11 @@
 isort:skip_file.
 """
 # flake8: noqa: E402
-import platform
-from distutils.version import LooseVersion
 
 import numpy as np
 import pytest
 
 import astropy.units as u
-asdf = pytest.importorskip('asdf', '2.0')
 from asdf.tests.helpers import assert_roundtrip_tree
 
 import sunpy.map
@@ -24,15 +21,6 @@ def aia171_test_map():
     return sunpy.map.Map(aia_path)
 
 
-# Skip these two tests on windows due to a weird interaction with atomicfile
-# and tmpdir
-skip_windows_asdf = pytest.mark.skipif(
-    (LooseVersion(asdf.__version__) < LooseVersion("2.3.1")
-     and platform.system() == 'Windows'),
-    reason="See https://github.com/spacetelescope/asdf/pull/632")
-
-
-@skip_windows_asdf
 @asdf_entry_points
 def test_genericmap_basic(aia171_test_map, tmpdir):
 
@@ -41,7 +29,6 @@ def test_genericmap_basic(aia171_test_map, tmpdir):
     assert_roundtrip_tree(tree, tmpdir, extensions=SunpyExtension())
 
 
-@skip_windows_asdf
 @asdf_entry_points
 def test_genericmap_mask(aia171_test_map, tmpdir):
 

sunpy/util/sysinfo.py

@@ -59,10 +59,10 @@ def system_info():
     """
     base_reqs = get_distribution("sunpy").requires()
     base_reqs = {base_req.name.lower() for base_req in base_reqs}
-    extra_reqs = get_distribution("sunpy").requires(extras=["all"])
+    extra_reqs = get_distribution("sunpy").requires()
     extra_reqs = sorted({extra_req.name.lower() for extra_req in extra_reqs}.difference(base_reqs))
 
-    missing_packages, installed_packages = find_dependencies(package="sunpy", extras=["all"])
+    missing_packages, installed_packages = find_dependencies(package="sunpy")
     extra_prop = {"System": platform.system(),
                   "Arch": f"{platform.architecture()[0]}, ({platform.processor()})",
                   "Python": platform.python_version(),

tox.ini

@@ -179,3 +179,24 @@ install_command = pip install --no-deps {opts} {packages}
 commands =
     conda list
     {env:PYTEST_COMMAND} {posargs}
+
+[testenv:pyinstaller]
+description = check that sunpy can be included in a pyinstaller bundle
+changedir = .pyinstaller
+deps =
+    pyinstaller
+extras =
+    tests
+    net
+    all
+commands =
+    ./python3 run_sunpy_tests.py
+    pyinstaller --onefile run_sunpy_tests.py \
+                --distpath . \
+                --additional-hooks-dir hooks \
+                --exclude-module tkinter \
+                --hidden-import pytest \
+                --hidden-import sunpy \
+                --hidden-import pytest_mpl.plugin
+
+    ./run_sunpy_tests