Merge pull request #58 from philipstarkey/philipstarkey/issue43

Fixes .pth file has no effect in editable install

Author: chrisjbillington

labscript-suite.pth

@@ -1,2 +1 @@
-import labscript_profile; labscript_profile.add_userlib_and_pythonlib()
-import labscript_profile; labscript_profile.add_development_directories()
+import sys; exec("try: import labscript_profile; labscript_profile.add_userlib_and_pythonlib()\nexcept ModuleNotFoundError: pass")

labscript_profile/__init__.py

@@ -1,3 +1,4 @@
+import site
 import sys
 import os
 from configparser import ConfigParser, NoSectionError, NoOptionError
@@ -56,22 +57,4 @@ def add_userlib_and_pythonlib():
             except (NoSectionError, NoOptionError):
                 paths = []
             for path in paths:
-                if os.path.exists(path):
-                    sys.path.append(path)
-
-
-def add_development_directories():
-    """Prepend directories in <LABSCRIPT_SUITE_PROFILE>/dev to the search path, if they
-    are listed in the file <LABSCRIPT_SUITE_PROFILE>/dev/enabled (if that file
-    exists)."""
-    if LABSCRIPT_SUITE_PROFILE is None:
-        return
-    dev_dir = LABSCRIPT_SUITE_PROFILE / 'dev'
-    enabled_file = dev_dir / 'enabled'
-    if not os.path.exists(enabled_file):
-        return
-    with open(enabled_file) as f:
-        for line in f:
-            repository = dev_dir / line.strip()
-            if os.path.isdir(repository):
-                sys.path.insert(0, repository)
+                site.addsitedir(path)

setup.py

@@ -1,9 +1,24 @@
 import os
 from setuptools import setup
+from setuptools.command.develop import develop
+from distutils import log
+
+
+class develop_command(develop):
+    """Custom develop command which installs the .pth file to site-packages for editable
+    installs."""
+    def run(self):
+        path = os.path.join(self.install_dir, 'labscript-suite.pth')
+        super().run()
+        if not self.uninstall:
+            log.info(f'Copying labscript-suite.pth to {path}')
+            if not self.dry_run:
+                self.copy_file('labscript-suite.pth', path)
+
 
 VERSION_SCHEME = {
     "version_scheme": os.getenv("SCM_VERSION_SCHEME", "guess-next-dev"),
     "local_scheme": os.getenv("SCM_LOCAL_SCHEME", "node-and-date"),
 }
 
-setup(use_scm_version=VERSION_SCHEME)
+setup(use_scm_version=VERSION_SCHEME, cmdclass={'develop': develop_command})