dutils is composed of a lot of miscellaneous utility functions. These functions are documented here.
dutils.utils contains following helpers for loggins.
dutils.utils.logger is an instance configured logger. The logging is configured to store the logs in a file named after the projects, in a folder called logs in the current folder.
For example:
from dutils import utils
utils.logger.info("this goes to logs")
Assuming the name of the project is django_project, this will send the log message to a file named logs/django_project.log.
Create a logger by the given name.
| Parameters: |
|
|---|---|
| Return type: | logger object. |
Usage:
from dutils import utils
mail_logger = utils.create_logger("mail_logger")
def send_mail(*args):
mail_logger.debug("send_mail called")
...
mail_logger.debug("send_mail done")
The logs will be written in projdir/logs/mail_logger.log.
dutils.utils contains a PrintLogger class. This can be used to make all print statements go to main logger as well as on console.
To use it go to some module that is loaded by django during startup, urls.py for example, and write the following:
import sys
from dutils.utils import PrintLogger
sys.stdout = PrintLogger(sys.stdout)
print "hello log file"
After this “hello log file” will be printed on console as well as it will go in log file.
Note
You may not want to put this line in settings.py as settings.py is loaded by utils.py, which will cause cyclic dependency.
dutils.utils contains a django middleware that logs exceptions to logger.
This middleware can be used by updating the settings.py:
MIDDLEWARE_CLASSES = (
# other middlewares
'dutils.utils.SimpleExceptionHandler',
)
dutils.utils contains a uuid.
Generate a random uuid.
| Parameters: |
|
|---|---|
| Return type: | 32 byte long string, composed of hexadecimal chars. |
Usage:
>>> from dutils import utils
>>> utils.uuid()
'e5bd5a3bd2d81edaec9857cc97ec655a'
Frequently one has to log a user in. Django requires you to know the password of the user, in order to user authenticate function. This can get inconvenient when you do not have, or know the password.
dutils.utils comes with a utility method log_user_in to help in such a situation.
Log the given user in the request’s session.
| Parameters: |
|
|---|---|
| Return type: | None |
This function is typically useful for features like logging a user in after they have clicked on email confirmation link, or for imporsonate a user etc.
dutils.utils comes with a utility function ip_shell, that stops the execution and launches IPython Shell. This can be used for debugging the context at given location.
from dutils import utils
def index(request):
utils.ip_shell()
# rest
Note
This should only be used with a debugging server that runs in foreground.
A common use case in django applications is to extend django’s User by creating UserProfile. This is handy and all but you will have two pages in django’s admin interface to update user data. This can get tedious and one common solution is to inline the UserProfile data as part of User admin area. This can be done as follows:
from django.contrib import admin
from myproj.myapp.models import UserProfile
class UserProfileInline(admin.StackedInline):
model = UserProfile
class UserAdmin(admin.ModelAdmin):
inlines = [UserProfileInline]
# Unregister the built in user admin and register the custom
# User admin with UserProfile
admin.site.unregister(User)
admin.site.register(User, UserAdmin)
Place the above in myproj/myapp/admin.py and you are done. This gets tedious, and dutils.utils comes with setup_inline_userprofile_admin which does the same for you. Place the folling in you said admin.py:
from dutils import utils
utils.setup_inline_userprofile_admin()
This will do the same.
Note
setup_inline_userprofile_admin discovers the UserProfile model to user using settings.AUTH_PROFILE_MODULE. If for some reason that is not set, you can import the UserProfile model and pass it to setup_inline_userprofile_admin to facilitate discovery:
from dutils import utils
from myproj.myapp.models import UserProfile
utils.setup_inline_userprofile_admin(UserProfile)