Ticket #5893: allow_folders.3.diff

django/db/models/fields/__init__.py

@@ -838 +838 @@
         return super(FileField, self).formfield(**defaults)
 
 class FilePathField(Field):
-    def __init__(self, verbose_name=None, name=None, path='', match=None, recursive=False, **kwargs):
-        self.path, self.match, self.recursive = path, match, recursive
+    def __init__(self, verbose_name=None, name=None, path='', match=None, recursive=False, allow_files=True, allow_folders=False, **kwargs):
+        self.path, self.match, self.recursive, self.allow_files, self.allow_folders = path, match, recursive, allow_files, allow_folders
+        assert self.allow_files or self.allow_folders
         kwargs['max_length'] = kwargs.get('max_length', 100)
         Field.__init__(self, verbose_name, name, **kwargs)
     
@@ -848 +849 @@
             'path': self.path,
             'match': self.match,
             'recursive': self.recursive,
+            'allow_files': self.allow_files,
+            'allow_folders': self.allow_folders,
             'form_class': forms.FilePathField,
         }
         defaults.update(kwargs)

django/forms/fields.py

@@ -720 +720 @@
         raise NotImplementedError('Subclasses must implement this method.')
 
 class FilePathField(ChoiceField):
-    def __init__(self, path, match=None, recursive=False, required=True,
-                 widget=Select, label=None, initial=None, help_text=None,
-                 *args, **kwargs):
-        self.path, self.match, self.recursive = path, match, recursive
+    def __init__(self, path, match=None, recursive=False, allow_files=True,
+                 allow_folders=False,required=True, widget=Select, label=None,
+                 initial=None, help_text=None, *args, **kwargs):
+        self.path, self.match, self.recursive, self.allow_files, self.allow_folders = path, match, recursive, allow_files, allow_folders
+        assert self.allow_files or self.allow_folders
         super(FilePathField, self).__init__(choices=(), required=required,
             widget=widget, label=label, initial=initial, help_text=help_text,
             *args, **kwargs)
@@ -732 +733 @@
             self.match_re = re.compile(self.match)
         if recursive:
             for root, dirs, files in os.walk(self.path):
-                for f in files:
-                    if self.match is None or self.match_re.search(f):
-                        f = os.path.join(root, f)
-                        self.choices.append((f, f.replace(path, "", 1)))
+                if self.allow_files:
+                    for f in files:
+                        if self.match is None or self.match_re.search(f):
+                            f = os.path.join(root, f)
+                            self.choices.append((f, f.replace(path, "", 1)))
+                if self.allow_folders:
+                    for f in dirs:
+                        if self.match is None or self.match_re.search(f):
+                            f = os.path.join(root, f)
+                            self.choices.append((f, f.replace(path, "", 1)))
         else:
             try:
                 for f in os.listdir(self.path):
                     full_file = os.path.join(self.path, f)
-                    if os.path.isfile(full_file) and (self.match is None or self.match_re.search(f)):
+                    if ((self.allow_files and os.path.isfile(full_file)) or (self.allow_folders and os.path.isdir(full_file))) and (self.match is None or self.match_re.search(f)):
                         self.choices.append((full_file, f))
             except OSError:
                 pass

docs/model-api.txt

@@ -321 +321 @@
     ``recursive``           Optional. Either ``True`` or ``False``. Default is
                             ``False``. Specifies whether all subdirectories of
                             ``path`` should be included.
+                            
+    ``allow_files``         Optional.  Specifies whether or not the list of
+                            choices should contain files, it defaults to 
+                            ``True``. Either this or ``allow_folders`` must be 
+                            ``True``.
+                            
+    ``allow_folders``       Optional.  Specifies whether or not the list of 
+                            choices should contain folders, it defaults to 
+                            ``False``.  Either this or ``allow_files`` must be 
+                            ``True``.
     ======================  ===================================================
 
 Of course, these arguments can be used together.

docs/forms.txt

@@ -1380 +1380 @@
     ``match``       No          A regular expression pattern; only files with
                                 names matching this expression will be allowed
                                 as choices.
+                                
+    ``allow_files`` No          Specifies whether or not the list of choices 
+                                should contain files, it defaults to ``True``. 
+                                Either this or ``allow_folders`` must be ``True``.
+    
+    ``allow_folders`` No        Specifies whether or not the list of choices 
+                                should contain folders, it defaults to ``False``. 
+                                Either this or ``allow_files`` must be ``True``.
     ==============  ==========  ===============================================
 
 ``ImageField``

tests/regressiontests/forms/fields.py

@@ -1169 +1169 @@
 >>> f.choices.sort()
 >>> fix_os_paths(f.choices)
 [('.../django/forms/__init__.py', '__init__.py'), ('.../django/forms/extras/__init__.py', 'extras/__init__.py'), ('.../django/forms/extras/widgets.py', 'extras/widgets.py'), ('.../django/forms/fields.py', 'fields.py'), ('.../django/forms/forms.py', 'forms.py'), ('.../django/forms/models.py', 'models.py'), ('.../django/forms/util.py', 'util.py'), ('.../django/forms/widgets.py', 'widgets.py')]
+>>> f = forms.FilePathField(path=path, allow_folders=True, allow_files=False)
+>>> fix_os_paths(f.choices)
+[('.../django/forms/extras', 'extras')]
+>>> f = forms.FilePathField(path=path, allow_folders=True, allow_files=True)
+>>> f.choices.sort()
+>>> fix_os_paths(f.choices)
+[('.../django/forms/__init__.py', '__init__.py'), ('.../django/forms/__init__.pyc', '__init__.pyc'), ('.../django/forms/extras', 'extras'), ('.../django/forms/fields.py', 'fields.py'), ('.../django/forms/fields.pyc', 'fields.pyc'), ('.../django/forms/forms.py', 'forms.py'), ('.../django/forms/forms.pyc', 'forms.pyc'), ('.../django/forms/formsets.pyc', 'formsets.pyc'), ('.../django/forms/models.py', 'models.py'), ('.../django/forms/models.pyc', 'models.pyc'), ('.../django/forms/util.py', 'util.py'), ('.../django/forms/util.pyc', 'util.pyc'), ('.../django/forms/widgets.py', 'widgets.py'), ('.../django/forms/widgets.pyc', 'widgets.pyc')]
 
 # SplitDateTimeField ##########################################################