Move register function to tagging.registry submodule, to avoid weird architecture of the package and allow more flexibility

Author: Fantomas42

docs/index.rst

@@ -129,12 +129,12 @@ access some additional tagging-related features.
 The ``register`` function
 -------------------------
 
-To register a model, import the ``tagging`` module and call its
+To register a model, import the ``tagging.registry`` module and call its
 ``register`` function, like so::
 
    from django.db import models
 
-   import tagging
+   from tagging.registry import register
 
    class Widget(models.Model):
        name = models.CharField(max_length=50)

tagging/__init__.py

@@ -13,52 +13,3 @@
 __url__ = 'https://github.com/Fantomas42/django-tagging'
 
 default_app_config = 'tagging.apps.TaggingConfig'
-
-class AlreadyRegistered(Exception):
-    """
-    An attempt was made to register a model more than once.
-    """
-    pass
-
-
-registry = []
-
-
-def register(model, tag_descriptor_attr='tags',
-             tagged_item_manager_attr='tagged'):
-    """
-    Sets the given model class up for working with tags.
-    """
-
-    from tagging.managers import ModelTaggedItemManager, TagDescriptor
-
-    if model in registry:
-        raise AlreadyRegistered(
-            "The model '%s' has already been registered." %
-            model._meta.object_name)
-    if hasattr(model, tag_descriptor_attr):
-        raise AttributeError(
-            "'%s' already has an attribute '%s'. You must "
-            "provide a custom tag_descriptor_attr to register." % (
-                model._meta.object_name,
-                tag_descriptor_attr,
-            )
-        )
-    if hasattr(model, tagged_item_manager_attr):
-        raise AttributeError(
-            "'%s' already has an attribute '%s'. You must "
-            "provide a custom tagged_item_manager_attr to register." % (
-                model._meta.object_name,
-                tagged_item_manager_attr,
-            )
-        )
-
-    # Add tag descriptor
-    setattr(model, tag_descriptor_attr, TagDescriptor())
-
-    # Add custom manager
-    ModelTaggedItemManager().contribute_to_class(
-        model, tagged_item_manager_attr)
-
-    # Finally register in registry
-    registry.append(model)

tagging/registry.py

@@ -0,0 +1,51 @@
+"""
+Registery for tagging.
+"""
+from tagging.managers import TagDescriptor
+from tagging.managers import ModelTaggedItemManager
+
+registry = []
+
+
+class AlreadyRegistered(Exception):
+    """
+    An attempt was made to register a model more than once.
+    """
+    pass
+
+
+def register(model, tag_descriptor_attr='tags',
+             tagged_item_manager_attr='tagged'):
+    """
+    Sets the given model class up for working with tags.
+    """
+    if model in registry:
+        raise AlreadyRegistered(
+            "The model '%s' has already been registered." %
+            model._meta.object_name)
+    if hasattr(model, tag_descriptor_attr):
+        raise AttributeError(
+            "'%s' already has an attribute '%s'. You must "
+            "provide a custom tag_descriptor_attr to register." % (
+                model._meta.object_name,
+                tag_descriptor_attr,
+            )
+        )
+    if hasattr(model, tagged_item_manager_attr):
+        raise AttributeError(
+            "'%s' already has an attribute '%s'. You must "
+            "provide a custom tagged_item_manager_attr to register." % (
+                model._meta.object_name,
+                tagged_item_manager_attr,
+            )
+        )
+
+    # Add tag descriptor
+    setattr(model, tag_descriptor_attr, TagDescriptor())
+
+    # Add custom manager
+    ModelTaggedItemManager().contribute_to_class(
+        model, tagged_item_manager_attr)
+
+    # Finally register in registry
+    registry.append(model)