Ticket #5894: diff.5.diff

File diff.5.diff, 3.9 KB (added by Alex Gaynor, 16 years ago)

Adds docs, fixes a few small things

  • django/db/models/fields/__init__.py

     
    814814        self.path, self.match, self.recursive = path, match, recursive
    815815        kwargs['max_length'] = kwargs.get('max_length', 100)
    816816        Field.__init__(self, verbose_name, name, **kwargs)
    817 
     817   
     818    def formfield(self, **kwargs):
     819        defaults = {
     820            'path': self.path,
     821            'match': self.match,
     822            'recursive': self.recursive,
     823            'form_class': forms.FilePathField,
     824        }
     825        defaults.update(kwargs)
     826        return super(FilePathField, self).formfield(**defaults)
     827   
    818828    def get_manipulator_field_objs(self):
    819829        return [curry(oldforms.FilePathField, path=self.path, match=self.match, recursive=self.recursive)]
    820830
  • django/newforms/fields.py

     
    44
    55import copy
    66import datetime
     7import os
    78import re
    89import time
    910# Python 2.3 fallbacks
     
    3132    'RegexField', 'EmailField', 'FileField', 'ImageField', 'URLField',
    3233    'BooleanField', 'NullBooleanField', 'ChoiceField', 'MultipleChoiceField',
    3334    'ComboField', 'MultiValueField', 'FloatField', 'DecimalField',
    34     'SplitDateTimeField', 'IPAddressField',
     35    'SplitDateTimeField', 'IPAddressField', 'FilePathField',
    3536)
    3637
    3738# These values, if given to to_python(), will trigger the self.required check.
     
    750751
    751752    def __init__(self, *args, **kwargs):
    752753        super(IPAddressField, self).__init__(ipv4_re, *args, **kwargs)
     754       
     755class FilePathField(ChoiceField):
     756    """A ChoiceField whose choices are files from the filesystem"""
     757   
     758    def __init__(self, path, match=None, recursive=False, required=True, widget=Select, label=None, initial=None, help_text=None, *args, **kwargs):
     759        self.path, self.match, self.recursive = path, match, recursive
     760        super(FilePathField, self).__init__(choices=(), required=required, widget=widget, label=label, initial=initial, help_text=help_text, *args, **kwargs)
     761        self.choices = []
     762        if self.match is not None:
     763            self.match_re = re.compile(self.match)
     764        if recursive:
     765            for root, dirs, files in os.walk(self.path):
     766                    for f in files:
     767                        if self.match is None or self.match_re.search(f):
     768                            f = os.path.join(root, f)
     769                            self.choices.append((f, f.replace(self.path, "", 1)))
     770        else:
     771            try:
     772                for f in os.listdir(self.path):
     773                    full_file = os.path.join(self.path, f)
     774                    if os.path.isfile(full_file) and (self.match is None or self.match_re.search(f)):
     775                        self.choices.append((full_file, f))
     776            except OSError:
     777                pass
     778        self.widget.choices = self.choices
  • docs/newforms.txt

     
    13451345
    13461346.. _`bind the file data to the form`: `Binding uploaded files to a form`_
    13471347
     1348``FilePathField``
     1349~~~~~~~~~~~~~~
     1350
     1351**New in Django development version**
     1352
     1353    * Default widget: ``Select``
     1354    * Empty value: ``None``
     1355    * Normalizes to: A unicode object
     1356    * Validates that the selected choices exists in the list of choices.
     1357    * Error message keys: ``required``, ``invalid_choice``
     1358
     1359The choices are generated from the Filesystem.  They can be forced to match a specific regular expresion(this only matches the specific file, not the entire path).  It can also be recursive.
     1360
    13481361``ImageField``
    13491362~~~~~~~~~~~~~~
    13501363
Back to Top