Opened 3 years ago

Closed 3 years ago

#28623 closed Cleanup/optimization (worksforme)

Docs: handle_uploaded_file(f) .. what is "f"?

Reported by: Thomas Güttler Owned by: nobody
Component: Documentation Version: 1.11
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Thomas Güttler)

def handle_uploaded_file(f):
    with open('some/file/name.txt', 'wb+') as destination:
        for chunk in f.chunks():

I talked with an other developer about this above code.

I can create a pull request.

It would be nice if you give me a matching name for this variable.

I started to stutter.


Because: What is "f"?

A more verbose name would be great.

Change History (3)

comment:1 Changed 3 years ago by Thomas Güttler

Description: modified (diff)

comment:2 Changed 3 years ago by Tim Graham

Component: UncategorizedDocumentation
Type: UncategorizedCleanup/optimization

Look at the usage code above: handle_uploaded_file(request.FILES['file']). If you click on the docs for request.FILES, you'll see, "Each value in FILES is an UploadedFile." I'm not sure a more verbose name provides much benefit. If you read the Python docs for files, you'll see that f is a common variable name, probably to avoid clashing with the Python built-in file. Also, the name handle_uploaded_file implies that the argument (the thing being handled) is an uploaded file.

Last edited 3 years ago by Tim Graham (previous) (diff)

comment:3 Changed 3 years ago by Tim Graham

Resolution: worksforme
Status: newclosed
Note: See TracTickets for help on using tickets.
Back to Top