Home > Articles

This chapter is from the book

This chapter is from the book

5.4 Building Tag Detail Webpage

To reinforce what we already know and expand our knowledge of URL patterns, we now create a second webpage. Our webpage will display the information for a single Tag object. We call our function view tag_detail(). Let’s begin by adding a URL pattern.

In Chapter 3, we specifically added SlugField to our Tag model to allow for the simple creation of unique URLs. We intend to use it now for our URL pattern. We want the request for /tag/django/ to show the webpage for the django Tag and the request for /tag/web/ to show the webpage for the web Tag.

This is the first gap in our knowledge. How can we get a single URL pattern to recognize both /tag/django/ and /tag/web/? The second gap in our knowledge is that we have no easy way to use the information in the URL pattern. Once we’ve isolated django and web, how can we pass this information to the view so that it may request the data from the database?

To make the problem more concrete, let’s start with the tag_detail() view.

5.4.1 Coding the tag_detail() Function View

Open /organizer/views.py and program the bare minimum functionality of a view (accept an HttpRequest object, return an HttpResponse object), as shown in Example 5.5.

Example 5.5: Project Code

organizer/views.py in f0d1985791

16   def tag_detail(request):
17       return HttpResponse()

Our first task is to select the data for the Tag object that the user has selected. For the moment, we will assume that we have somehow been passed the unique slug value of the Tag as the variable slug, and we use it in our code (but Python will yell at you if you try to run this). We use the get() method of our Tag model manager, which returns a single object. We want our search for the slug field to be case insensitive, so we use the iexact field lookup scheme. Our lookup is thus Tag.objects.get(slug--iexact=slug), as shown in Example 5.6.

Example 5.6: Project Code

organizer/views.py in ba4f692e00

16  def tag_detail(request):
17      # slug = ?
18      tag = Tag.objects.get(slug--iexact=slug)
19      return HttpResponse()

We may now load the template we wish to render, organizer/tag_detail.html. When we wrote the template, we wrote it to use a variable named tag. We thus create a Context object to pass the value of our Python variable named tag to our template variable tag. Recall that the syntax is Context({'template_variable_name': Python_variable_name}). We thus extend our view code as shown in Example 5.7.

Example 5.7: Project Code

organizer/views.py in 2fdb78366f

16   def tag_detail(request):
17       # slug = ?
18       tag = Tag.objects.get(slug--iexact=slug)
19       template = loader.get_template(
20           'organizer/tag_detail.html')
21       context = Context({'tag': tag})
22       return HttpResponse(template.render(context))

We have what would be a fully working function view if not for the problem we are now forced to confront: the slug variable is never set. The value of the slug will be in the URL path. If Django receives the request for /tag/django/, we want the value of our slug variable to be set to 'django'. Django provides two ways to get it.

The first way is terrible and inadvisable: we can parse the URL path ourselves. The request variable, an HttpRequest object, contains all the information provided by the user and Django, and we could access request.path_info to get the full path. In our example above, request.path_info would return 'tag/django/'. However, to get the slug from our URL path, we would need to parse the value of request.path_info, and doing so in each and every view would be tedious and repetitive, in direct violation of the Don’t Repeat Yourself (DRY) principle.

The second method, the recommended and easy solution, is to get Django to send it to us via the URL configuration, as we shall discover in the next section. To accommodate this solution, we simply add slug as a parameter to the function view.

Our final view is shown in Example 5.8.

Example 5.8: Project Code

organizer/views.py in 84eb438c96

16   def tag_detail(request, slug):
17       tag = Tag.objects.get(slug--iexact=slug)
18       template = loader.get_template(
19           'organizer/tag_detail.html')
20       context = Context({'tag': tag})
21       return HttpResponse(template.render(context))

5.4.2 Adding a URL Pattern for tag_detail

With our tag_detail() function view fully programmed, we now need to point Django to it by adding a URL pattern to the URL configuration. The pattern will be in the form of url(<regular_expression>, tag_detail), where the value of <regular_expression> is currently unknown. In this section, we need to solve two problems:

  1. We need to build a regular expression that allows for multiple inputs. For example, /tag/django/ and /tag/web/ must both be valid URL paths.
  2. We must pass the value of the slug in the URL path to the detail view.

The answer to both of these problems is to use regular expressions groups.

To solve the first case, we first begin by building a static regular expression. Remember that our regular expressions patterns should not start with a /. To match /tag/django/ we can use the regular expression r'^tag/django/$'. Similarly, r'^tag/web/$' will match /tag/web/. The goal is to build a regular expression that will match all slugs. As mentioned in Chapter 3, a SlugField accepts a string with a limited character set: alphanumeric characters, the underscore, and the dash. We first define a regular expression character set by replacing django and web with two brackets: r'^tag/[]/$'. Any character or character set inside the brackets is a valid character for the string. We want multiple characters, so we add the + character to match at least one character: r'^tag/[]+/$'. In Python, \w will match alphanumeric characters and the underscore. We can thus add \w and - (the dash character) to the character set to match a valid slug: r'^tag/[\w\-]+/$'. This regular expression will successfully match /tag/django/, /tag/web/, and even /tag/video-games/ and /tag/video_games/.

This regular expression matches all of the URLs we actually want, but it will not pass the value of the slug to the tag_detail() function view. To do so, we can use a named group. Python regular expressions identify named groups with the text (?P<name>pattern), where name is the name of the group and pattern is the actual regular expression pattern. In a URL pattern, Django takes any named group and passes its value to the view the URL pattern points to. In our case, we want our named group to use the pattern we just built—[\w\-]+—and to be called slug. We thus have (?P<slug>[\w\-]+).

Our full regular expression has become r'^tag/(?P<slug>[\w\-]+)/$'. This regular expression will match a slug and pass its value to the view the URL pattern points to. We can now build our URL pattern.

We are building a URL pattern for our tag_detail() view, which exists in the views.py file in our organizer app. We first import the view via a Python import and then create a URL pattern by calling url() and passing the regular expression and the view. Example 5.9 shows the resulting URL configuration in suorganizer/urls.py.

Example 5.9: Project Code

suorganizer/urls.py in 5b18131069

16   from django.conf.urls import include, url
 .       ...
19   from organizer.views import homepage, tag_detail
 .       ...
24       url(r'^tag/(?P<slug>[\w\-]+)/$',
25           tag_detail,
26           ),

If we request http://127.0.0.1:8000/tag/django or the Django runserver, Django will select our new URL pattern and call tag_detail(request, slug='django').

The regular expression pattern and view pointer are not the only parameters we can pass to url(). It is possible, and highly recommended, to specify the keyword argument name for URL patterns. The utility of specifying name is the ability to refer to a URL pattern in Django, a practice we discuss in Chapter 6: Integrating Models, Templates, Views, and URL Configurations to Create Links between webpages. This practice not only is useful in Django but also allows me to refer to URL patterns in the book without ambiguity.

It is possible to name a URL pattern whatever you wish. However, I strongly recommend you namespace your names, allowing for easy reference without conflict across your site. In this book, I use the name of the app, the name of the model being used, and the display type for the object type. We thus name the URL pattern organizer_tag_detail. Our final URL pattern is shown in Example 5.10.

Example 5.10: Project Code

suorganizer/urls.py in 79c8d40d8a

24     url(r'^tag/(?P<slug>[\w\-]+)/$',
25         tag_detail,
26         name='organizer_tag_detail'),

Consider all the code we have avoided writing by writing our URL pattern intelligently. At the end of Section 5.4.1, we were considering parsing the raw URL path string (passed to the view via request.path_info) to find the slug value of our tag. Thanks to Django’s smart URL configuration, simply by providing a named group to our regular expression pattern, we can pass values in the URL directly to the view.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020