How to tell from setup.py if the module is being installed in editable mode

Question

My current setup.py writes the git commit hash in a file which the module can access after it has been installed. However, I would like to disable that when I am developing the module since the setup.py file will not be triggered twice and the hash would be inaccurate. This brings us to the question:

Is there a way to tell from setup.py whether the module is being installed in editable mode? i.e.,
pip install -e .

I found a similar question here, but even the "hack" will not work in my case since the module will be installed directly with git, and the .git directory will exist even for normal installs during installation.

hoefling · Accepted Answer · 2018-07-11 21:19:17Z

8

Just override the correct command. install is being run on pip install ., develop on pip install --editable ..

# setup.py
from distutils import log
from setuptools import setup
from setuptools.command.install import install as install_orig
from setuptools.command.develop import develop as develop_orig


class develop(develop_orig):

    def run(self):
        self.announce('this code will run on editable install only', level=log.INFO)
        super().run()


class install(install_orig):

    def run(self):
        self.announce('this code will run on normal install only', level=log.INFO)
        super().run()


setup(
    name='spam',
    cmdclass={'install': install, 'develop': develop}
)

Test it:

$ pip install . -vvv | grep "this code"                                
  this code will run on normal install only
$ pip install -e . -vvv | grep "this code"
  this code will run on editable install only

answered Jul 11, 2018 at 21:19

hoefling

67.8k15 gold badges182 silver badges228 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

mara004 Over a year ago

Could you please update the post to remove the one remaining use of distutils, since it's deprecated?

mara004 Over a year ago

And in fact, this also doesn't work. You actually have to override the build_py cmdclass and check the editable_mode attribute as described here.

Collectives™ on Stack Overflow

How to tell from setup.py if the module is being installed in editable mode

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related