]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blobdiff - src/allmydata/_auto_deps.py
Suppress DeprecationWarning about twisted.internet.interfaces.IFinishableConsumer...
[tahoe-lafs/tahoe-lafs.git] / src / allmydata / _auto_deps.py
index f77db1c04687ab742a63c7a6ac872c62acc0b29d..ddc670e6fef155f18eafd40d4a1b33bfbec55628 100644 (file)
-# Note: do not import any module from Tahoe-LAFS itself in this
-# file. Also please avoid importing modules from other packages than
-# the Python Standard Library if at all possible (exception: we rely
-# on importing pkg_resources, which is provided by setuptools,
-# zetuptoolz, distribute, and perhaps in the future distutils2, for
-# the require_auto_deps() function.)
-
-install_requires=[
-                  # we require newer versions of setuptools (actually
-                  # zetuptoolz) to build, but can handle older versions to run
-                  "setuptools >= 0.6c6",
-
-                  "zfec >= 1.1.0",
-
-                  # Feisty has simplejson 1.4
-                  "simplejson >= 1.4",
-
-                  "zope.interface",
-                  "Twisted >= 2.4.0",
-
-                  # 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[secure_connections] >= 0.6.1",
-                  "Nevow >= 0.6.0",
-
-                  # Needed for SFTP. pyasn1 is needed by twisted.conch in Twisted >= 9.0.
-                  # pycrypto 2.2 doesn't work due to https://bugs.launchpad.net/pycrypto/+bug/620253
-                  "pycrypto == 2.0.1, == 2.1, >= 2.3",
-                  "pyasn1 >= 0.0.8a",
-
-                  # http://www.voidspace.org.uk/python/mock/
-                  "mock",
-
-                  # Will be needed to test web apps, but not yet. See #1001.
-                  #"windmill >= 1.3",
-                  ]
-
-import platform
-if platform.machine().lower() in ['i386', 'x86_64', 'amd64', 'x86', '']:
-    # pycryptopp v0.5.20 fixes bugs in SHA-256 and AES on x86 or amd64
-    # (from Crypto++ revisions 470, 471, 480, 492).  The '' is there
-    # in case platform.machine is broken and this is actually an x86
-    # or amd64 machine.
-    install_requires.append("pycryptopp >= 0.5.20")
-else:
-    # pycryptopp v0.5.13 had a new bundled version of Crypto++
-    # (v5.6.0) and a new bundled version of setuptools (although that
-    # shouldn't make any different to users of pycryptopp).
-    install_requires.append("pycryptopp >= 0.5.14")
-
-
-# Sqlite comes built into Python >= 2.5, and is provided by the "pysqlite"
-# distribution for Python 2.4.
-import sys
-if sys.version_info < (2, 5):
-    # pysqlite v2.0.5 was shipped in Ubuntu 6.06 LTS "dapper" and Nexenta NCP 1.
-    install_requires.append("pysqlite >= 2.0.5")
-
-## The following block is commented-out because there is not currently a pywin32 package which
-## can be easy_install'ed and also which actually makes "import win32api" succeed.
-## See http://sourceforge.net/tracker/index.php?func=detail&aid=1799934&group_id=78018&atid=551954
-## Users have to manually install pywin32 on Windows before installing Tahoe.
-##import platform
-##if platform.system() == "Windows":
-##    # Twisted requires pywin32 if it is going to offer process management functionality, or if
-##    # it is going to offer iocp reactor.  We currently require process management.  It would be
-##    # better if Twisted would declare that it requires pywin32 if it is going to offer process
-##    # management.  That is twisted ticket #3238 -- http://twistedmatrix.com/trac/ticket/3238 .
-##    install_requires.append('pywin32')
-
-if hasattr(sys, 'frozen'): # for py2exe
-    install_requires=[]
-del sys # clean up namespace
-
-def require_python_version():
-    import sys, platform
-
-    # we require 2.4.4 on non-UCS-2, non-Redhat builds to avoid <http://www.python.org/news/security/PSF-2006-001/>
-    # we require 2.4.3 on non-UCS-2 Redhat, because 2.4.3 is common on Redhat-based distros and will have patched the above bug
-    # we require at least 2.4.2 in any case to avoid a bug in the base64 module: <http://bugs.python.org/issue1171487>
-    if sys.maxunicode == 65535:
-        if sys.version_info < (2, 4, 2) or sys.version_info[0] > 2:
-            raise NotImplementedError("Tahoe-LAFS current requires Python v2.4.2 or greater "
-                                      "for a UCS-2 build (but less than v3), not %r" %
-                                      (sys.version_info,))
-    elif platform.platform().lower().find('redhat') >= 0:
-        if sys.version_info < (2, 4, 3) or sys.version_info[0] > 2:
-            raise NotImplementedError("Tahoe-LAFS current requires Python v2.4.3 or greater "
-                                      "on Redhat-based distributions (but less than v3), not %r" %
-                                      (sys.version_info,))
-    else:
-        if sys.version_info < (2, 4, 4) or sys.version_info[0] > 2:
-            raise NotImplementedError("Tahoe-LAFS current requires Python v2.4.4 or greater "
-                                      "for a non-UCS-2 build (but less than v3), not %r" %
-                                      (sys.version_info,))
-
-def require_auto_deps():
-    """
-    The purpose of this function is to raise a pkg_resources exception if any of the
-    requirements can't be imported.  This is just to give earlier and more explicit error
-    messages, as opposed to waiting until the source code tries to import some module from one
-    of these packages and gets an ImportError.  This function gets called from
-    src/allmydata/__init__.py .
-    """
-    require_python_version()
-
-    import pkg_resources
-    for requirement in install_requires:
-        try:
-            pkg_resources.require(requirement)
-        except pkg_resources.DistributionNotFound:
-            # there is no .egg-info present for this requirement, which
-            # either means that it isn't installed, or it is installed in a
-            # way that pkg_resources can't find it (but regular python
-            # might).  There are several older Linux distributions which
-            # provide our dependencies just fine, but they don't ship
-            # .egg-info files. Note that if there *is* an .egg-info file,
-            # but it shows a too-old version, then we'll get a
-            # VersionConflict error instead of DistributionNotFound.
-            pass
+# Note: please minimize imports in this file. In particular, do not import
+# any module from Tahoe-LAFS or its dependencies, and do not import any
+# modules at all at global level. That includes setuptools and pkg_resources.
+# 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.
+
+install_requires = [
+    # we require newer versions of setuptools (actually
+    # zetuptoolz) to build, but can handle older versions to run
+    "setuptools >= 0.6c6",
+
+    "zfec >= 1.1.0",
+
+    # Feisty has simplejson 1.4
+    "simplejson >= 1.4",
+
+    # zope.interface 3.6.3 and 3.6.4 are incompatible with Nevow (#1435).
+    "zope.interface <= 3.6.2, >= 3.6.5",
+
+    # On Windows we need at least Twisted 9.0 to avoid an indirect dependency on pywin32.
+    # 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 for the FTP frontend in order for Twisted's FTP server to
+    # support asynchronous close.
+    "Twisted >= 10.1.0",
+
+    # 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.
+    # 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.1",
+    "pyOpenSSL",
+
+    "Nevow >= 0.6.0",
+
+    # Needed for SFTP. pyasn1 is needed by twisted.conch in Twisted >= 9.0.
+    # 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",
+    "pyasn1 >= 0.0.8a",
+
+    # http://www.voidspace.org.uk/python/mock/
+    "mock",
+
+    # pycryptopp-0.6.0 includes ed25519
+    "pycryptopp >= 0.6.0",
+
+    # Will be needed to test web apps, but not yet. See #1001.
+    #"windmill >= 1.3",
+]
+
+# Includes some indirect dependencies, but does not include allmydata.
+# These are in the order they should be listed by --version, etc.
+package_imports = [
+    # package name      module name
+    ('foolscap',        'foolscap'),
+    ('pycryptopp',      'pycryptopp'),
+    ('zfec',            'zfec'),
+    ('Twisted',         'twisted'),
+    ('Nevow',           'nevow'),
+    ('zope.interface',  'zope.interface'),
+    ('python',          None),
+    ('platform',        None),
+    ('pyOpenSSL',       'OpenSSL'),
+    ('simplejson',      'simplejson'),
+    ('pycrypto',        'Crypto'),
+    ('pyasn1',          'pyasn1'),
+    ('mock',            'mock'),
+]
+
+def require_more():
+    import sys
+
+    # Don't try to get the version number of setuptools in frozen builds, because
+    # that triggers 'site' processing that causes failures. Note that frozen
+    # builds still (unfortunately) import pkg_resources in .tac files, so the
+    # entry for setuptools in install_requires above isn't conditional.
+    if not hasattr(sys, 'frozen'):
+        package_imports.append(('setuptools', 'setuptools'))
+
+require_more()
+
+
+# These are suppressed globally:
+
+global_deprecation_messages = [
+    "BaseException.message has been deprecated as of Python 2.6",
+    "twisted.internet.interfaces.IFinishableConsumer was deprecated in Twisted 11.1.0: Please use IConsumer (and IConsumer.unregisterProducer) instead.",
+]
+
+# These are suppressed while importing dependencies:
+
+deprecation_messages = [
+    "the sha module is deprecated; use the hashlib module instead",
+    "object.__new__\(\) takes no parameters",
+    "The popen2 module is deprecated.  Use the subprocess module.",
+    "the md5 module is deprecated; use hashlib instead",
+    "twisted.web.error.NoResource is deprecated since Twisted 9.0.  See twisted.web.resource.NoResource.",
+    "twisted.internet.interfaces.IFinishableConsumer was deprecated in Twisted 11.1.0: Please use IConsumer (and IConsumer.unregisterProducer) instead.",
+    "the sets module is deprecated",
+]
+
+user_warning_messages = [
+    "Hashing uninitialized InterfaceClass instance",
+    "Reliable disconnection notification requires pywin32 215 or later",
+]
+
+runtime_warning_messages = [
+    "Not using mpz_powm_sec.  You should rebuild using libgmp >= 5 to avoid timing attack vulnerability.",
+]
+
+warning_imports = [
+    'nevow',
+    'twisted.persisted.sob',
+    'twisted.python.filepath',
+    'Crypto.Hash.SHA',
+]