Or B Or B - 1 year ago 33
Python Question

Requiring only one of two dependencies in a requirements file

Some Python packages require one of two packages as a dependency. For example,

requires either

Is it possible to include such a dependency in a
file? Is there any 'or' operator that works with these files?

If not, what can I do to add these requirements to the file so only one of them will be installed?

Answer Source

Currently neither pip's requirement.txt nor setuptools directly allow such a construction. Both require you to specify a list of requirements. You can restrict the version of a requirement, but that's all.

Inside Python, you can handle this situation as follows:

    import dependency1

    def do_it(x):
        return dependency1.some_function(x)
except ImportError:
        import dependency2

        def do_it(x)
            return dependency2.another_function(x)
    except ImportError:
        raise ImportError('You must install either dependency1 or '
                          + 'dependecy2!')

Now do_it uses either dependency1.some_function or dependency2.another_function, depending on which is available.

That will still leave you with the problem of how to specify your requirements. I see two options:

  1. Don't formally specify the requirement in requirements.txt or setup.py but document that the user needs to install one of the dependencies. This approach might be OK if the setup of your software requires additional manual steps anyway (i.e. more than just pip install my_tool).
  2. Hard-code your preferred requirement in requirements.txt or setup.py.

In the end, you have to ask yourself why people might want to use one dependency over the other: I usually couldn't care less about the dependencies of the libraries that I use, because (disk) space is cheap and (due to virtualenv) there is little risk of incompatibilities. I'd therefore even suggest you think about not supporting two different dependencies for the same functionality.