Code

Opened 7 years ago

Closed 7 years ago

#3448 closed (fixed)

python help() parsing problem for django.core.mail

Reported by: Michael VanLandingham <m.vanland@…> Owned by: jacob
Component: Documentation Version: master
Severity: Keywords: django.core.mail, help, docs
Cc: poj+django@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Error when accessing django.core.mail through python help()

EnvironmentError: Environment variable DJANGO_SETTINGS_MODULE is undefined 

In python help(), if I do:

help> django.core.mail

I get:

problem in django.core.mail - EnvironmentError: Environment variable DJANGO_SETTINGS_MODULE is undefined.

Other things in the django.core package display their docstrings and such.. It seems like something basic, but I didn't see anything obvious.

I'm on OS X 10.4.8, python 2.4.4, installed the source from the svn repository, e.g. 'python setup.py install'

Attachments (2)

core_mail_help.diff (2.1 KB) - added by Per Jonsson <poj@…> 7 years ago.
core_mail_help-v2.diff (2.9 KB) - added by Per Jonsson <poj@…> 7 years ago.

Download all attachments as: .zip

Change History (9)

comment:1 Changed 7 years ago by SmileyChris

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Design decision needed

I'd guess it's due to the following lines:

def send_mail(subject, message, from_email, recipient_list, fail_silently=False, auth_user=settings.EMAIL_HOST_USER, auth_password=settings.EMAIL_HOST_PASSWORD):
def send_mass_mail(datatuple, fail_silently=False, auth_user=settings.EMAIL_HOST_USER, auth_password=settings.EMAIL_HOST_PASSWORD):

It could be fixed rather easily by setting those default arguments inside of the functions if they're None. Alternately, you could just set the environment variable or use manage.py shell.

Marked as decision needed since it's pretty trivial. If someone who cared was to write up a patch, it may convince a committer to patch rather than close ;)

comment:2 Changed 7 years ago by anonymous

  • Triage Stage changed from Design decision needed to Accepted

The change suggested by SmileyChris is indeed the correct fix. We should never refer to settings.* in default arguments because it removes the ability to manually configure the settings (via settings.configure()), as well as causing problems as in this bug. Use None for the default argument (which is read at import time) and inside the function do test for None and replace it with the settings.XYZ value; we require settings to have already be configured in some fashion before actually executing any functions, so this is safe.

comment:3 Changed 7 years ago by mtredinnick

(Last comment was from me.)

Changed 7 years ago by Per Jonsson <poj@…>

comment:4 Changed 7 years ago by Per Jonsson <poj@…>

  • Cc poj+django@… added
  • Has patch set

I've written a patch that implements the suggestions in this ticket.

comment:5 Changed 7 years ago by Per Jonsson <poj@…>

  • Triage Stage changed from Accepted to Ready for checkin

Changed 7 years ago by Per Jonsson <poj@…>

comment:6 Changed 7 years ago by Per Jonsson <poj@…>

Realised when reading another ticket that the original patch didn't update the documentation in docs/email.txt

The new version fixes that problem.

comment:7 Changed 7 years ago by jacob

  • Resolution set to fixed
  • Status changed from new to closed

Fixed in [4574].

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.