]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blobdiff - src/allmydata/_auto_deps.py
Fix a pyflakes warning.
[tahoe-lafs/tahoe-lafs.git] / src / allmydata / _auto_deps.py
index b05309c16c65c2841c45a7e147b558dcf7aec0dc..69a6081586960e71207de1e96297bfbe4d6e8a1f 100644 (file)
@@ -4,6 +4,17 @@
 # It is ok to import modules from the Python Standard Library if they are
 # always available, or the import is protected by try...except ImportError.
 
+# The semantics for requirement specs changed incompatibly in setuptools 8,
+# which now follows PEP 440. The requirements used in this file must be valid
+# under both the old and new semantics. That can be achieved by limiting
+# requirement specs to one of the following forms:
+#
+#   * >= X, <= Y where X < Y
+#   * >= X, != Y, != Z, ... where X < Y < Z...
+#
+# (In addition, check_requirement in allmydata/__init__.py only supports
+# >=, <= and != operators.)
+
 install_requires = [
     # We require newer versions of setuptools (actually
     # zetuptoolz) to build, but can handle older versions to run.
@@ -16,36 +27,33 @@ install_requires = [
 
     # zope.interface >= 3.6.0 is required for Twisted >= 12.1.0.
     # zope.interface 3.6.3 and 3.6.4 are incompatible with Nevow (#1435).
-    "zope.interface == 3.6.0, == 3.6.1, == 3.6.2, >= 3.6.5",
+    "zope.interface >= 3.6.0, != 3.6.3, != 3.6.4",
 
     # * foolscap < 0.5.1 had a performance bug which spent O(N**2) CPU for
     #   transferring large mutable files of size N.
     # * foolscap < 0.6 is incompatible with Twisted 10.2.0.
     # * foolscap 0.6.1 quiets a DeprecationWarning.
-    # * foolscap < 0.6.3 is incompatible with Twisted-11.1.0 and newer. Since
-    #   current Twisted is 12.0, any build which needs twisted will grab a
-    #   version that requires foolscap>=0.6.3
-    # * pyOpenSSL is required by foolscap for it (foolscap) to provide secure
-    #   connections. Foolscap doesn't reliably declare this dependency in a
-    #   machine-readable way, so we need to declare a dependency on pyOpenSSL
-    #   ourselves. Tahoe-LAFS doesn't *really* depend directly on pyOpenSSL,
-    #   so if something changes in the relationship between foolscap and
-    #   pyOpenSSL, such as foolscap requiring a specific version of
-    #   pyOpenSSL, or foolscap switching from pyOpenSSL to a different crypto
-    #   library, we need to update this declaration here.
-    #
-    "foolscap >= 0.6.3",
+    # * foolscap < 0.6.3 is incompatible with Twisted 11.1.0 and newer.
+    # * foolscap 0.8.0 generates 2048-bit RSA-with-SHA-256 signatures,
+    #   rather than 1024-bit RSA-with-MD5. This also allows us to work
+    #   with a FIPS build of OpenSSL.
+    "foolscap >= 0.8.0",
 
     # Needed for SFTP.
     # pycrypto 2.2 doesn't work due to <https://bugs.launchpad.net/pycrypto/+bug/620253>
     # pycrypto 2.4 doesn't work due to <https://bugs.launchpad.net/pycrypto/+bug/881130>
-    "pycrypto == 2.1.0, == 2.3, >= 2.4.1",
+    "pycrypto >= 2.1.0, != 2.2, != 2.4",
 
     # <http://www.voidspace.org.uk/python/mock/>, 0.8.0 provides "call"
     "mock >= 0.8.0",
 
     # pycryptopp-0.6.0 includes ed25519
     "pycryptopp >= 0.6.0",
+
+    "service-identity",         # this is needed to suppress complaints about being unable to verify certs
+    "characteristic >= 14.0.0", # latest service-identity depends on this version
+    "pyasn1 >= 0.1.4",          # latest pyasn1-modules depends on this version
+    "pyasn1-modules >= 0.0.5",  # service-identity depends on this
 ]
 
 # Includes some indirect dependencies, but does not include allmydata.
@@ -65,6 +73,9 @@ package_imports = [
     ('pycrypto',         'Crypto'),
     ('pyasn1',           'pyasn1'),
     ('mock',             'mock'),
+    ('service-identity', 'service_identity'),
+    ('characteristic',   'characteristic'),
+    ('pyasn1-modules',   'pyasn1_modules'),
 ]
 
 # Dependencies for which we don't know how to get a version number at run-time.
@@ -72,7 +83,6 @@ not_import_versionable = [
     'zope.interface',
     'mock',
     'pyasn1',
-    'pyasn1-modules',
 ]
 
 # Dependencies reported by pkg_resources that we can safely ignore.
@@ -95,64 +105,89 @@ import sys
 if not hasattr(sys, 'frozen'):
     package_imports.append(('setuptools', 'setuptools'))
 
-if sys.platform == "win32":
-    install_requires += [
-        # * On Windows we need at least Twisted 9.0 to avoid an indirect
-        #   dependency on pywin32.
-        # * We also need Twisted 10.1 for the FTP frontend in order for
-        #   Twisted's FTP server to support asynchronous close.
-        # * When the cloud backend lands, it will depend on Twisted 10.2.0
-        #   which includes the fix to <https://twistedmatrix.com/trac/ticket/411>.
-        # * The SFTP frontend depends on Twisted 11.0.0 to fix the SSH server
-        #   rekeying bug <https://twistedmatrix.com/trac/ticket/4395>
-        # * We don't want Twisted >= 13.0 to avoid a dependency of its endpoints
-        #   code on pywin32. <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2028>
-        #
-        "Twisted == 11.0.0, == 11.1.0, == 12.0.0, == 12.1.0, == 12.2.0",
 
-        # * We need Nevow >= 0.9.33 to avoid a bug in Nevow's setup.py
-        #   which imported twisted at setup time.
-        # * We don't want Nevow 0.11 because that requires Twisted >= 13.0
-        #   which conflicts with the Twisted requirement above.
-        #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2291>
-        #
-        "Nevow == 0.9.33, == 0.10",
+# * On Linux we need at least Twisted 10.1.0 for inotify support
+#   used by the drop-upload frontend.
+# * We also need Twisted 10.1.0 for the FTP frontend in order for
+#   Twisted's FTP server to support asynchronous close.
+# * The SFTP frontend depends on Twisted 11.0.0 to fix the SSH server
+#   rekeying bug <https://twistedmatrix.com/trac/ticket/4395>
+# * The FTP frontend depends on Twisted >= 11.1.0 for
+#   filepath.Permissions
+#
+# On Windows, Twisted >= 12.2.0 has a dependency on pywin32.
+# Since pywin32 can only be installed manually, we fall back to
+# requiring earlier versions of Twisted and Nevow if it is not
+# already installed.
+# <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2028>
+#
+# When the fallback is used we also need to work around the fact
+# that Nevow imports itself when building, which causes Twisted
+# and zope.interface to be imported; therefore, we need to set
+# setup_requires to make sure that the versions of Twisted and
+# zope.interface used at build time satisfy Nevow's requirements.
+#
+# In cases where this fallback isn't needed, we prefer Nevow >= 0.11.1
+# which can be installed using pip, and Twisted >= 13.0.0 which
+# Nevow 0.11.1 depends on. In this case we should *not* use the
+# setup_requires hack, because if we do then the build will break
+# when Twisted < 13.0.0 is already installed (even though it could
+# have succeeded by building a later version under support/ ).
+#
+# <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2032>
+# <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2249>
+# <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2291>
+# <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>
 
-        # pyasn1 is needed by twisted.conch in Twisted >= 9.0.
-        "pyasn1 >= 0.0.8a",
+setup_requires = []
+
+_use_old_Twisted_and_Nevow = False
+if sys.platform == "win32":
+    try:
+        import win32api
+        [win32api]
+    except ImportError:
+        _use_old_Twisted_and_Nevow = True
+
+if _use_old_Twisted_and_Nevow:
+    install_requires += [
+        "Twisted >= 11.1.0, <= 12.1.0",
+        "Nevow >= 0.9.33, <= 0.10",
     ]
+    setup_requires += [req for req in install_requires if req.startswith('Twisted')
+                                                       or req.startswith('zope.interface')]
 else:
     install_requires += [
-        # * On Linux we need at least Twisted 10.1.0 for inotify support
-        #   used by the drop-upload frontend.
-        # * Nevow 0.11.1 requires Twisted >= 13.0.0 so we might as well
-        #   require it directly; this helps to work around
-        #   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2286>.
-        #   This also satisfies the requirements for the FTP and SFTP
-        #   frontends and cloud backend mentioned in the Windows section
-        #   above.
-        #
         "Twisted >= 13.0.0",
-
-        # Nevow >= 0.11.1 can be installed using pip.
         "Nevow >= 0.11.1",
-
-        "service-identity",         # this is needed to suppress complaints about being unable to verify certs
-        "characteristic >= 14.0.0", # latest service-identity depends on this version
-        "pyasn1 >= 0.1.4",          # latest pyasn1-modules depends on this version
-        "pyasn1-modules",           # service-identity depends on this
     ]
 
-    package_imports += [
-        ('service-identity', 'service_identity'),
-        ('characteristic',   'characteristic'),
-        ('pyasn1-modules',   'pyasn1_modules'),
-    ]
 
-# If pyOpenSSL >= 0.14 is *already* installed, then accept it, otherwise
-# require pyOpenSSL 0.13 or 0.13.1.
-# See <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1246#comment:6> for why
-# we don't rely on pkg_resources to tell us the installed pyOpenSSL version number.
+# * pyOpenSSL is required in order for foolscap to provide secure connections.
+#   Since foolscap doesn't reliably declare this dependency in a machine-readable
+#   way, we need to declare a dependency on pyOpenSSL ourselves. Tahoe-LAFS does
+#   not *directly* depend on pyOpenSSL.
+#
+# * pyOpenSSL >= 0.13 is needed in order to avoid
+#   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2005>.
+#
+# * pyOpenSSL >= 0.14 is built on the 'cryptography' package which depends
+#   on 'cffi' (and indirectly several other packages). Unfortunately cffi
+#   attempts to compile code dynamically, which causes problems on many systems.
+#   It also depends on the libffi OS package which may not be installed.
+#   <https://bitbucket.org/cffi/cffi/issue/109/enable-sane-packaging-for-cffi>
+#   <https://bitbucket.org/cffi/cffi/issue/70/cant-install-cffi-using-pip-on-windows>
+#
+#   So, if pyOpenSSL 0.14 has *already* been installed and is importable, we
+#   want to accept it; otherwise we ask for pyOpenSSL 0.13 or 0.13.1.
+#   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2193>
+#
+#   We don't rely on pkg_resources to tell us the installed pyOpenSSL version
+#   number, because pkg_resources telling us that we have 0.14 is not sufficient
+#   evidence that 0.14 will be the imported version (or will work correctly).
+#   One possible reason why it might not be is explained in
+#   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1246#comment:6> and
+#   <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1258>.
 
 _can_use_pyOpenSSL_0_14 = False
 try:
@@ -165,8 +200,8 @@ except Exception:
 
 if _can_use_pyOpenSSL_0_14:
     install_requires += [
-        # pyOpenSSL >= 0.13 is needed in order to fix
-        # <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2005>.
+        # Although we checked for pyOpenSSL >= 0.14 above, we only actually
+        # need pyOpenSSL >= 0.13; requiring 0.14 here cannot help.
         "pyOpenSSL >= 0.13",
 
         # ... and now all the new stuff that pyOpenSSL 0.14 transitively
@@ -177,6 +212,7 @@ if _can_use_pyOpenSSL_0_14:
         "cryptography",
         "cffi >= 0.8",          # latest cryptography depends on this version
         "six >= 1.4.1",         # latest cryptography depends on this version
+        "enum34",               # latest cryptography depends on this
         "pycparser",            # cffi depends on this
     ]
 
@@ -184,11 +220,12 @@ if _can_use_pyOpenSSL_0_14:
         ('cryptography',     'cryptography'),
         ('cffi',             'cffi'),
         ('six',              'six'),
+        ('enum34',           'enum'),
         ('pycparser',        'pycparser'),
     ]
 else:
     install_requires += [
-        "pyOpenSSL == 0.13, == 0.13.1",
+        "pyOpenSSL >= 0.13, <= 0.13.1",
     ]