fanglab / mbin

mBin: a methylation-based binning framework for metagenomic SMRT sequencing reads
Other
25 stars 3 forks source link

Potential dependency conflicts between mbin and numpy #14

Open NeolithEra opened 4 years ago

NeolithEra commented 4 years ago

Hi, as shown in the following full dependency graph of mbin, mbin requires numpy >=1.7.1,<1.14, mbin requires matplotlib >=1.5.0 (matplotlib 3.2.1 will be installed, i.e., the newest version satisfying the version constraint), and directed dependency matplotlib 3.2.1 transitively introduces numpy >=1.11.

Obviously, there are multiple version constraints set for numpy in this project. However, according to pip's “first found wins” installation strategy, numpy 1.13.3 (i.e., the newest version satisfying constraint >=1.7.1,<1.14) is the actually installed version.

Although the first found package version numpy 1.13.3 just satisfies the later dependency constraint (numpy >=1.7.1,<1.14), such installed version is very close to the upper bound of the version constraint of numpy specified by matplotlib 3.2.1.

Once matplotlib upgrades,its newest version will be installed. Therefore, it will easily cause a dependency conflict (build failure), if the upgraded matplotlib version introduces a higher version of numpy, violating its another version constraint >=1.7.1,<1.14.

According to the release history of matplotlib, it habitually upgrates Numpy in its recent releases. For instance, matplotlib #15645 upgrated Numpy’s constraint from >=1.11 to >=1.12, and matplotlib #15698 upgrated Numpy’s constraint from >=1.12 to >=1.15.

As such, it is a warm warning of a potential dependency conflict issue for mbin.

Dependency tree

mbin - 1.1.1
| +- biopython(install version:1.76 version range:>=1.6.1)
| | +- numpy(install version:1.13.3 version range:*)
| +- h5py(install version:2.10.0 version range:>=2.0.1)
| +- matplotlib(install version:3.2.1 version range:>=1.5.0)
| | +- cycler(install version:0.10.0 version range:>=0.10)
| | | +- six(install version:1.14.0 version range:*)
| | +- kiwisolver(install version:1.2.0 version range:>=1.0.1)
| | +- numpy(install version:1.13.3 version range:>=1.11)
| | +- pyparsing(install version:3.0.0a1 version range:>=2.0.1)
| | +- python-dateutil(install version:2.8.1 version range:>=2.1)
| +- numpy(install version:1.13.3 version range:>=1.7.1,<1.14)
| +- pbcore(install version:1.2.10 version range:>=0.9.4)
| | +- cython(install version:3.0a1 version range:*)
| | +- h5py(install version:2.10.0 version range:>=2.0.1)
| | +- numpy(install version:1.13.3 version range:>=1.7.1)
| | +- pysam(install version:0.15.4 version range:>=0.9.0)
| | | +- cython(install version:3.0a1 version range:>=0.29.12)
| +- pysam(install version:0.15.4 version range:>=0.10.0)
| | +- cython(install version:3.0a1 version range:>=0.29.12)
| +- scipy(install version:1.2.3 version range:>=0.12.0)

Thanks for your help. Best, Neolith

NeolithEra commented 4 years ago

Suggested Solution

  1. Loosen the version range of numpy to be >=1.7.1.
  2. Remove your direct dependency numpy, and use the numpy transitively introduced by matplotlib.
  3. Change your direct dependency matplotlib to be >=1.5.0<=3.2.1. @jbeaulaurier Which solution do you prefer, 1 ,2or 3? Please let me know your choice. May I pull a request to solve this issue?
NeolithEra commented 4 years ago

@jbeaulaurier ,Could you help me review this issue? Thx :p

jbeaulaurier commented 4 years ago

Hi Neolith, thanks for pointing this out. From your suggested options, I think #3 is the safest solution for this project. Please go ahead and submit a pull request and thanks for you help!