Merge branch 'master' of deluge-torrent.org:deluge

ChangeLog

@@ -5,6 +5,8 @@
 	now, it even supports multiple users perfectly.
 	* Authentication/Permission exceptions are now sent to clients and recreated
 	there to allow acting upon them.
+	* Enforced the use of the "deluge.plugins" namespace to reduce package
+	names clashing beetween regular packages and deluge plugins.
 
 ==== Core ====
 	* Implement #1063 option to delete torrent file copy on torrent removal - patch from Ghent

deluge/__init__.py

@@ -1 +1,4 @@
 """Deluge"""
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/pluginmanagerbase.py

@@ -59,6 +59,16 @@ METADATA_KEYS = [
     "Description",
 ]
 
+DEPRECATION_WARNING = """
+The plugin %s is not using the "deluge.plugins" namespace.
+In order to avoid package name clashes between regular python packages and
+deluge plugins, the way deluge plugins should be created has changed.
+If you're seeing this message and you're not the developer of the plugin which
+triggered this warning, please report to it's author.
+If you're the developer, please take a look at the plugins hosted on deluge's
+git repository to have an idea of what needs to be changed.
+"""
+
 class PluginManagerBase:
     """PluginManagerBase is a base class for PluginManagers to inherit"""
 
@@ -140,6 +150,13 @@ class PluginManagerBase:
                 log.exception(e)
                 continue
             instance.enable()
+            if not instance.__module__.startswith("deluge.plugins"):
+                import warnings
+                warnings.warn_explicit(
+                    DEPRECATION_WARNING % name,
+                    DeprecationWarning,
+                    instance.__module__, 0
+                )
             if self._component_state == "Started":
                 component.start([instance.plugin._component_name])
             plugin_name = plugin_name.replace("-", " ")

deluge/plugins/AutoAdd/deluge/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/AutoAdd/deluge/plugins/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/AutoAdd/deluge/plugins/autoadd/common.py

@@ -39,4 +39,5 @@
 
 def get_resource(filename):
     import pkg_resources, os
-    return pkg_resources.resource_filename("autoadd", os.path.join("data", filename))
+    return pkg_resources.resource_filename("deluge.plugins.autoadd",
+                                           os.path.join("data", filename))

deluge/plugins/AutoAdd/setup.py

@@ -38,7 +38,7 @@
 #    statement from all source files in the program, then also delete it here.
 #
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 __plugin_name__ = "AutoAdd"
 __author__ = "Chase Sterling, Pedro Algarvio"
@@ -48,7 +48,7 @@ __url__ = "http://dev.deluge-torrent.org/wiki/Plugins/AutoAdd"
 __license__ = "GPLv3"
 __description__ = "Monitors folders for .torrent files."
 __long_description__ = """"""
-__pkg_data__ = {__plugin_name__.lower(): ["template/*", "data/*"]}
+__pkg_data__ = {'deluge.plugins.'+__plugin_name__.lower(): ["template/*", "data/*"]}
 
 setup(
     name=__plugin_name__,
@@ -59,16 +59,16 @@ setup(
     url=__url__,
     license=__license__,
     long_description=__long_description__ if __long_description__ else __description__,
-
-    packages=[__plugin_name__.lower()],
+    packages=find_packages(),
+    namespace_packages = ["deluge", "deluge.plugins"],
     package_data = __pkg_data__,
 
     entry_points="""
     [deluge.plugin.core]
-    %s = %s:CorePlugin
+    %s = deluge.plugins.%s:CorePlugin
     [deluge.plugin.gtkui]
-    %s = %s:GtkUIPlugin
+    %s = deluge.plugins.%s:GtkUIPlugin
     [deluge.plugin.webui]
-    %s = %s:WebUIPlugin
+    %s = deluge.plugins.%s:WebUIPlugin
     """ % ((__plugin_name__, __plugin_name__.lower())*3)
 )

deluge/plugins/Blocklist/deluge/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Blocklist/deluge/plugins/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Blocklist/deluge/plugins/blocklist/common.py

@@ -40,7 +40,8 @@ from functools import wraps
 from sys import exc_info
 
 def get_resource(filename):
-    return pkg_resources.resource_filename("blocklist", os.path.join("data", filename))
+    return pkg_resources.resource_filename("deluge.plugins.blocklist",
+                                           os.path.join("data", filename))
 
 def raisesErrorsAs(error):
     """
@@ -73,14 +74,14 @@ def raisesErrorsAs(error):
 def remove_zeros(ip):
     """
     Removes unneeded zeros from ip addresses.
-    
+
     Example: 000.000.000.003 -> 0.0.0.3
-    
+
     :param ip: the ip address
     :type ip: string
-    
+
     :returns: the ip address without the unneeded zeros
     :rtype: string
-    
+
     """
     return ".".join([part.lstrip("0").zfill(1) for part in ip.split(".")])

deluge/plugins/Blocklist/setup.py

@@ -31,7 +31,7 @@
 #
 
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 __plugin_name__ = "Blocklist"
 __author__ = "John Garland"
@@ -41,7 +41,7 @@ __url__ = "http://deluge-torrent.org"
 __license__ = "GPLv3"
 __description__ = "Download and import IP blocklists"
 __long_description__ = __description__
-__pkg_data__ = {__plugin_name__.lower(): ["data/*"]}
+__pkg_data__ = {'deluge.plugins.'+__plugin_name__.lower(): ["data/*"]}
 
 setup(
     name=__plugin_name__,
@@ -53,15 +53,16 @@ setup(
     license=__license__,
     long_description=__long_description__,
 
-    packages=[__plugin_name__.lower()],
+    packages=find_packages(),
+    namespace_packages = ["deluge", "deluge.plugins"],
     package_data = __pkg_data__,
 
     entry_points="""
     [deluge.plugin.core]
-    %s = %s:CorePlugin
+    %s = deluge.plugins.%s:CorePlugin
     [deluge.plugin.gtkui]
-    %s = %s:GtkUIPlugin
+    %s = deluge.plugins.%s:GtkUIPlugin
     [deluge.plugin.webui]
-    %s = %s:WebUIPlugin
+    %s = deluge.plugins.%s:WebUIPlugin
     """ % ((__plugin_name__, __plugin_name__.lower())*3)
 )

deluge/plugins/Example/deluge/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Example/deluge/plugins/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Example/deluge/plugins/example/common.py

@@ -37,4 +37,5 @@ import pkg_resources
 import os.path
 
 def get_resource(filename):
-    return pkg_resources.resource_filename("execute", os.path.join("data", filename))
+    return pkg_resources.resource_filename("deluge.plugins.example",
+                                           os.path.join("data", filename))

deluge/plugins/Example/setup.py

@@ -31,7 +31,7 @@
 #
 #
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 __plugin_name__ = "Example"
 __author__ = "Andrew Resch"
@@ -41,7 +41,7 @@ __url__ = "http://deluge-torrent.org"
 __license__ = "GPLv3"
 __description__ = "Example plugin"
 __long_description__ = __description__
-__pkg_data__ = {__plugin_name__.lower(): []}
+__pkg_data__ = {"deluge.plugins."+__plugin_name__.lower(): []}
 
 setup(
     name=__plugin_name__,
@@ -53,15 +53,16 @@ setup(
     license=__license__,
     long_description=__long_description__,
 
-    packages=[__plugin_name__.lower()],
+    packages=find_packages(),
+    namespace_packages = ["deluge", "deluge.plugins"],
     package_data = __pkg_data__,
 
     entry_points="""
     [deluge.plugin.core]
-    %s = %s:CorePlugin
+    %s = %s:deluge.plugins.CorePlugin
     [deluge.plugin.gtkui]
-    %s = %s:GtkUIPlugin
+    %s = %s:deluge.plugins.GtkUIPlugin
     [deluge.plugin.webui]
-    %s = %s:WebUIPlugin
+    %s = %s:deluge.plugins.WebUIPlugin
     """ % ((__plugin_name__, __plugin_name__.lower())*3)
 )

deluge/plugins/Execute/deluge/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Execute/deluge/plugins/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Execute/deluge/plugins/execute/common.py

@@ -37,4 +37,5 @@ import pkg_resources
 import os.path
 
 def get_resource(filename):
-    return pkg_resources.resource_filename("example", os.path.join("data", filename))
+    return pkg_resources.resource_filename("deluge.plugins.execute",
+                                           os.path.join("data", filename))

deluge/plugins/Execute/deluge/plugins/execute/webui.py

@@ -33,7 +33,6 @@
 #
 #
 
-import pkg_resources
 
 from deluge.log import getPluginLogger
 from deluge.ui.client import client

deluge/plugins/Execute/setup.py

@@ -31,7 +31,7 @@
 #
 #
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 __plugin_name__ = "Execute"
 __author__ = "Damien Churchill"
@@ -41,7 +41,7 @@ __url__ = "http://deluge-torrent.org"
 __license__ = "GPLv3"
 __description__ = "Plugin to execute a command upon an event"
 __long_description__ = __description__
-__pkg_data__ = {__plugin_name__.lower(): ["data/*"]}
+__pkg_data__ = {"deluge.plugins."+__plugin_name__.lower(): ["data/*"]}
 
 setup(
     name=__plugin_name__,
@@ -53,15 +53,16 @@ setup(
     license=__license__,
     long_description=__long_description__,
 
-    packages=[__plugin_name__.lower()],
+    packages=find_packages(),
+    namespace_packages = ["deluge", "deluge.plugins"],
     package_data = __pkg_data__,
 
     entry_points="""
     [deluge.plugin.core]
-    %s = %s:CorePlugin
+    %s = %s:deluge.plugins.CorePlugin
     [deluge.plugin.gtkui]
-    %s = %s:GtkUIPlugin
+    %s = %s:deluge.plugins.GtkUIPlugin
     [deluge.plugin.web]
-    %s = %s:WebUIPlugin
+    %s = %s:deluge.plugins.WebUIPlugin
     """ % ((__plugin_name__, __plugin_name__.lower())*3)
 )

deluge/plugins/Extractor/deluge/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Extractor/deluge/plugins/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Extractor/deluge/plugins/extractor/common.py

@@ -35,4 +35,5 @@
 
 def get_resource(filename):
     import pkg_resources, os
-    return pkg_resources.resource_filename("extractor", os.path.join("data", filename))
+    return pkg_resources.resource_filename("deluge.plugins.extractor",
+                                           os.path.join("data", filename))

deluge/plugins/Extractor/setup.py

@@ -37,7 +37,7 @@
 #
 #
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 __plugin_name__ = "Extractor"
 __author__ = "Andrew Resch"
@@ -47,7 +47,7 @@ __url__ = "http://deluge-torrent.org"
 __license__ = "GPLv3"
 __description__ = "Extract files upon completion"
 __long_description__ = """"""
-__pkg_data__ = {__plugin_name__.lower(): ["template/*", "data/*"]}
+__pkg_data__ = {"deluge.plugins."+__plugin_name__.lower(): ["template/*", "data/*"]}
 
 setup(
     name=__plugin_name__,
@@ -59,15 +59,16 @@ setup(
     license=__license__,
     long_description=__long_description__ if __long_description__ else __description__,
 
-    packages=[__plugin_name__.lower()],
+    packages=find_packages(),
+    namespace_packages = ["deluge", "deluge.plugins"],
     package_data = __pkg_data__,
 
     entry_points="""
     [deluge.plugin.core]
-    %s = %s:CorePlugin
+    %s = %s:deluge.plugins.CorePlugin
     [deluge.plugin.gtkui]
-    %s = %s:GtkUIPlugin
+    %s = %s:deluge.plugins.GtkUIPlugin
     [deluge.plugin.webui]
-    %s = %s:WebUIPlugin
+    %s = %s:deluge.plugins.WebUIPlugin
     """ % ((__plugin_name__, __plugin_name__.lower())*3)
 )

deluge/plugins/Feeder/deluge/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Feeder/deluge/plugins/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Feeder/setup.py

@@ -34,7 +34,7 @@
 #    but you are not obligated to do so. If you do not wish to do so, delete
 #    this exception statement from your version. If you delete this exception
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 __plugin_name__ = "feeder"
 __author__ = "Fredrik Eriksson"
@@ -44,7 +44,7 @@ __url__ = ""
 __license__ = "GPLv3"
 __description__ = "A plugin for automatically downloadning torrents from a RSS-feed"
 __long_description__ = """"""
-__pkg_data__ = {__plugin_name__.lower(): ["template/*", "data/*"]}
+__pkg_data__ = {"deluge.plugins."+__plugin_name__.lower(): ["template/*", "data/*"]}
 
 setup(
     name=__plugin_name__,
@@ -56,15 +56,16 @@ setup(
     license=__license__,
     long_description=__long_description__,
 
-    packages=[__plugin_name__.lower()],
+    packages=find_packages(),
+    namespace_packages = ["deluge", "deluge.plugins"],
     package_data = __pkg_data__,
 
     entry_points="""
     [deluge.plugin.core]
-    %s = %s:CorePlugin
+    %s = deluge.plugins.%s:CorePlugin
     [deluge.plugin.gtkui]
-    %s = %s:GtkUIPlugin
+    %s = deluge.plugins.%s:GtkUIPlugin
     [deluge.plugin.webui]
-    %s = %s:WebUIPlugin
+    %s = deluge.plugins.%s:WebUIPlugin
     """ % ((__plugin_name__, __plugin_name__.lower())*3)
 )

deluge/plugins/FreeSpace/create_dev_link.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+BASEDIR=$(cd `dirname $0` && pwd)
+CONFIG_DIR=$( test -z $1 && echo "" || echo "$1")
+[ -d "$CONFIG_DIR/plugins" ] || echo "Config dir "$CONFIG_DIR" is either not a directory or is not a proper deluge config directory. Exiting"
+[ -d "$CONFIG_DIR/plugins" ] || exit 1
+cd $BASEDIR
+test -d $BASEDIR/temp || mkdir $BASEDIR/temp
+export PYTHONPATH=$BASEDIR/temp
+python setup.py build develop --install-dir $BASEDIR/temp
+cp $BASEDIR/temp/*.egg-link $CONFIG_DIR/plugins
+rm -fr $BASEDIR/temp

deluge/plugins/FreeSpace/deluge/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/FreeSpace/deluge/plugins/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/FreeSpace/deluge/plugins/freespace/common.py

@@ -39,4 +39,5 @@
 
 def get_resource(filename):
     import pkg_resources, os
-    return pkg_resources.resource_filename("freespace", os.path.join("data", filename))
+    return pkg_resources.resource_filename("deluge.plugins.freespace",
+                                           os.path.join("data", filename))

deluge/plugins/FreeSpace/setup.py

@@ -37,7 +37,7 @@
 #    statement from all source files in the program, then also delete it here.
 #
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 __plugin_name__ = "FreeSpace"
 __author__ = "Pedro Algarvio"
@@ -47,7 +47,7 @@ __url__ = "http://deluge.ufsoft.org/hg/Notification/"
 __license__ = "GPLv3"
 __description__ = "Plugin which continuously checks for available free space."
 __long_description__ = __description__
-__pkg_data__ = {__plugin_name__.lower(): ["template/*", "data/*"]}
+__pkg_data__ = {"deluge.plugins."+__plugin_name__.lower(): ["template/*", "data/*"]}
 
 setup(
     name=__plugin_name__,
@@ -59,13 +59,14 @@ setup(
     license=__license__,
     long_description=__long_description__ if __long_description__ else __description__,
 
-    packages=[__plugin_name__.lower()],
+    packages=find_packages(),
+    namespace_packages = ["deluge", "deluge.plugins"],
     package_data = __pkg_data__,
 
     entry_points="""
     [deluge.plugin.core]
-    %s = %s:CorePlugin
+    %s = deluge.plugins.%s:CorePlugin
     [deluge.plugin.gtkui]
-    %s = %s:GtkUIPlugin
+    %s = deluge.plugins.%s:GtkUIPlugin
     """ % ((__plugin_name__, __plugin_name__.lower())*2)
 )

deluge/plugins/Label/deluge/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Label/deluge/plugins/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Label/deluge/plugins/label/webui.py

@@ -48,7 +48,8 @@ from deluge import component
 log = getPluginLogger(__name__)
 
 def get_resource(filename):
-    return pkg_resources.resource_filename("label", os.path.join("data", filename))
+    return pkg_resources.resource_filename("deluge.plugins.label",
+                                           os.path.join("data", filename))
 
 class WebUI(WebPluginBase):
 

deluge/plugins/Label/setup.py

@@ -31,7 +31,7 @@
 #
 
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 __plugin_name__ = "Label"
 __author__ = "Martijn Voncken"
@@ -45,7 +45,7 @@ Allows labels to be assigned to torrents
 
 Also offers filters on state, tracker and keywords
 """
-__pkg_data__ = {__plugin_name__.lower(): ["template/*", "data/*"]}
+__pkg_data__ = {"deluge.plugins."+__plugin_name__.lower(): ["template/*", "data/*"]}
 
 setup(
     name=__plugin_name__,
@@ -57,15 +57,16 @@ setup(
     license=__license__,
     long_description=__long_description__,
 
-    packages=[__plugin_name__.lower(), "label.gtkui"],
+    packages=find_packages(),
+    namespace_packages = ["deluge", "deluge.plugins"],
     package_data = __pkg_data__,
 
     entry_points="""
     [deluge.plugin.core]
-    %s = %s:CorePlugin
+    %s = deluge.plugins.%s:CorePlugin
     [deluge.plugin.gtkui]
-    %s = %s:GtkUIPlugin
+    %s = deluge.plugins.%s:GtkUIPlugin
     [deluge.plugin.web]
-    %s = %s:WebUIPlugin
+    %s = deluge.plugins.%s:WebUIPlugin
     """ % ((__plugin_name__, __plugin_name__.lower())*3)
 )

deluge/plugins/Notifications/create_dev_link.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+BASEDIR=$(cd `dirname $0` && pwd)
+CONFIG_DIR=$( test -z $1 && echo "" || echo "$1")
+[ -d "$CONFIG_DIR/plugins" ] || echo "Config dir "$CONFIG_DIR" is either not a directory or is not a proper deluge config directory. Exiting"
+[ -d "$CONFIG_DIR/plugins" ] || exit 1
+cd $BASEDIR
+test -d $BASEDIR/temp || mkdir $BASEDIR/temp
+export PYTHONPATH=$BASEDIR/temp
+python setup.py build develop --install-dir $BASEDIR/temp
+cp $BASEDIR/temp/*.egg-link $CONFIG_DIR/plugins
+rm -fr $BASEDIR/temp

deluge/plugins/Notifications/deluge/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Notifications/deluge/plugins/__init__.py

@@ -0,0 +1,3 @@
+# this is a namespace package
+import pkg_resources
+pkg_resources.declare_namespace(__name__)

deluge/plugins/Notifications/deluge/plugins/notifications/common.py

@@ -52,7 +52,7 @@ except ImportError:
 
 def get_resource(filename):
     import pkg_resources, os
-    return pkg_resources.resource_filename("notifications",
+    return pkg_resources.resource_filename("deluge.plugins.notifications",
                                            os.path.join("data", filename))