Fetching contributors…
Cannot retrieve contributors at this time
134 lines (99 sloc) 3.68 KB
# coding: utf-8
media path selection
TODO: Made this generic and don't use settings.MEDIA_ROOT direct, let it
be set as a argument to widget/fields etc.
* model field
* form field
* widget
INFO: This exist only for backward-compatibility and will be removed
in the future. Please use static_path!
:copyleft: 2010-2016 by the django-tools team, see AUTHORS for more details.
:license: GNU GPL v3 or above, see LICENSE for more details.
from __future__ import absolute_import, division, print_function
import os
import warnings
if __name__ == "__main__":
# For doctest only
os.environ["DJANGO_SETTINGS_MODULE"] = "django.conf.global_settings"
from django import forms
from django.db import models
from django.conf import settings
from django.utils.six import with_metaclass
from django_tools.utils.messages import failsafe_message
def directory_walk(path):
Directory tree generator
similar to os.walk, except:
- yield only directories
- sorted list case-insensitive
- follow links (os.walk can do this since python 2.6)
dirs = []
for name in os.listdir(path):
if os.path.isdir(os.path.join(path, name)):
yield path
# Sort case-insensitive
for dir in dirs:
sub_path = os.path.join(path, dir)
for x in directory_walk(sub_path):
yield x
class MediaPathWidget(forms.Select):
Select a sub directory in settings.MEDIA_ROOT
>>> import os, django_tools
>>> settings.MEDIA_ROOT = os.path.dirname(os.path.abspath(django_tools.__file__))
>>> MediaPathWidget().choices # doctest: +ELLIPSIS
[('auto_update_cache', 'auto_update_cache'), ..., ('views', 'views')]
def __init__(self, attrs=None):
super(MediaPathWidget, self).__init__(attrs)
self._base_path = os.path.abspath(os.path.normpath(settings.MEDIA_ROOT))
self.choices = self._get_path_choices()
except OSError as err:
self.choices = []
if settings.DEBUG:
failsafe_message("Can't read MEDIA_ROOT: %s" % err)
"MediaPathWidget is deprecated and will removed in the future!"
" Please use StaticPathWidget.",
def _get_path_choices(self):
media_dirs_choices = []
cut_pos = len(self._base_path)
for root in directory_walk(self._base_path):
rel_dir = root[cut_pos:].strip(os.sep)
if rel_dir:
media_dirs_choices.append((rel_dir, rel_dir))
return media_dirs_choices
class MediaPathModelField(models.TextField, with_metaclass(models.SubfieldBase)):
# def __init__(self, separator=",", strip_items=True, skip_empty=True, *args, **kwargs):
# self.separator = separator
# self.strip_items = strip_items
# self.skip_empty = skip_empty
# super(MediaPathModelField, self).__init__(*args, **kwargs)
def formfield(self, **kwargs):
""" Use always own widget and form field. """
"MediaPathModelField is deprecated and will removed in the future!"
" Please use StaticPathModelField.",
kwargs["widget"] = MediaPathWidget
# kwargs["form_class"] = SignSeparatedFormField
return super(MediaPathModelField, self).formfield(**kwargs)
if __name__ == "__main__":
import doctest
# verbose=True
print("DocTest end.")