Move clean_name to utils

Jody McIntyre · Jody McIntyre · commit 7cb67d57bfa9 · 2017-04-10T17:35:32.000Z
We want to use this in the Google Cloud Storage backend as well.

This is a separate commit so we can verify the clean_name tests in s3boto
still pass (before I move those as well).
diff --git a/storages/backends/s3boto.py b/storages/backends/s3boto.py
@@ -1,5 +1,4 @@
 import os
-import posixpath
 import mimetypes
 from datetime import datetime
 from gzip import GzipFile
@@ -24,7 +23,7 @@
     raise ImproperlyConfigured("Could not load Boto's S3 bindings.\n"
                                "See https://github.com/boto/boto")
 
-from storages.utils import setting
+from storages.utils import clean_name, setting
 
 boto_version_info = tuple([int(i) for i in boto_version.split('-')[0].split('.')])
 
@@ -348,15 +347,7 @@ def _clean_name(self, name):
         """
         Cleans the name so that Windows style paths work
         """
-        # Normalize Windows style paths
-        clean_name = posixpath.normpath(name).replace('\\', '/')
-
-        # os.path.normpath() can strip trailing slashes so we implement
-        # a workaround here.
-        if name.endswith('/') and not clean_name.endswith('/'):
-            # Add a trailing slash as it was stripped.
-            clean_name += '/'
-        return clean_name
+        return clean_name(name)
 
     def _normalize_name(self, name):
         """
diff --git a/storages/utils.py b/storages/utils.py
@@ -1,3 +1,5 @@
+import posixpath
+
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 
@@ -20,3 +22,19 @@ def setting(name, default=None, strict=False):
         msg = "You must provide settings.%s" % name
         raise ImproperlyConfigured(msg)
     return getattr(settings, name, default)
+
+
+def clean_name(name):
+    """
+    Cleans the name so that Windows style paths work
+    """
+    # Normalize Windows style paths
+    clean_name = posixpath.normpath(name).replace('\\', '/')
+
+    # os.path.normpath() can strip trailing slashes so we implement
+    # a workaround here.
+    if name.endswith('/') and not clean_name.endswith('/'):
+        # Add a trailing slash as it was stripped.
+        return clean_name + '/'
+    else:
+        return clean_name
