FilePathField doesn't support folders

[Alex Gaynor]

FilePathField(both the model field and the form field) only allows for selecting files, not folders. I have attached a fix to the problem which adds allow_files and allow_folders options, both of which default to true. This applies to both trunk and newforms-admin(which hasn't updated the FilePathField to use newforms, for whatever reason).

[Chris Beaven]

Interesting proposal. My suggestions (apart from the need for docs & tests):

• change allow_folders to default to False (to keep the current default behaviour)
• append folders before files to choices

Patch should also be applied against newforms-admin, which is a bit of a problem since this field hasn't been updated to newforms yet - #5894.

[Alex Gaynor]

Updated to have files by default, but no folders

[Alex Gaynor]

Cleaned up the if/elif brackets, also appended folders first

[Alex Gaynor]

Added an assert to make sure either allow_files or allow_folders is true

[Alex Gaynor]

Cleaned up the if brackets again

[Brian Rosner]

This does not apply to only newforms-admin. This is a newforms and trunk problem that newforms-admin will inherit if it is approved for inclusion.

[Alex Gaynor]

Fixed a few typos

[Alex Gaynor]

Now fix_os_paths is applied to the output of the new tests

[Alex Gaynor]

Updated patch: newforms -> forms

[Alex Gaynor]

stupid literals

[Karen Tracey]

Put this on my list to look at.

[Karen Tracey]

Hey Alex -- First, the file containing the new test was just converted to unit tests. Can you convert the new test?

Also I'm not sure about the asserts. For the model field I'd expect that contradiction to be be caught during validation. I see there are a couple of asserts in that file for auto field stuff, but it seems most errors of this sort are caught instead in get_validation_errors in django/core/management/validate.py. Is there some reason you went with an assert here instead?

For the form field, there are other such nonsensical argument combos that we just don't check for. The user is left with a form that can't ever validate (e.g. IntegerField with max_value lower than min_value), but that's what they asked for. Perhaps not as helpful as we could be, but using assert to catch invalid arg combos passed into Django just doesn't seem to fit in with the rest of the code...is there some reason this case is special and should be handled differently than other similar cases?

[Karen Tracey]

Oh, and the doc changes need versionadded flags, don't they?

[Alex Gaynor]

Resolves issues.

[Alex Gaynor]

Merge conflicts!

[Aymeric Augustin]

Change UI/UX from NULL to False.

[Aymeric Augustin]

Change Easy pickings from NULL to False.

[Alex Gaynor]

Final patch (note to others, please don't review/commit; this is an example patch for a "contributing to django" event).

[Alex Gaynor]

In [17925]:

Fixed #5893 -- Added a flag to FilePathField to allow listing folders, in addition to regular files. Thank you to Brian Rosner, for encouraging me to first contribute to Django 4 years ago.