Opened 21 months ago

Last modified 21 months ago

#22712 new Cleanup/optimization

Consider not using built-in functions as parameters

Reported by: Naddiseo Owned by: nobody
Component: contrib.staticfiles Version: 1.6
Severity: Normal Keywords:
Cc: Naddiseo Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


Currently the staticfiles finders' find function has a paramter all which is also a built-in function. Personally, I consider using built-ins as parameters/variables to be bad form, and would usually just rename the parameter in my subclasses. Unfortunately, find is explicitly called with all=all in django.contrib.staticfiles.finders.find(). So, to use the built in all() one needs to use from __builtin__ import all as all_.

There are probably more examples throughout the codebase, but this is the one I've run into.

Change History (3)

comment:1 Changed 21 months ago by timo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Unfortunately, I think changing this is not going to be worth it, backwards compatibility wise. Will leave it open for a second opinion though.

comment:2 Changed 21 months ago by Naddiseo

  • Cc Naddiseo added

Couldn't the arguments undergo the normal django deprecation cycle? For two version accept both, but issue a warning if the builtin version is used.

comment:3 Changed 21 months ago by aaugustin

  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Uncategorized to Cleanup/optimization

The all kwarg is a private API, so we can change it. However, we should check whether this is going to break popular third-party addons. (I don't know the staticfiles landscape very well.)

Note: See TracTickets for help on using tickets.
Back to Top