← Back to branch summary

~ubuntu-branches/ubuntu/saucy/python-django/saucy-updates

« back to all changes in this revision

Viewing changes to docs/ref/contrib/gis/measure.txt

  • Committer: Package Import Robot
  • Author(s): Luke Faraone, Jakub Wilk, Luke Faraone
  • Date: 2013-05-09 15:10:47 UTC
  • mfrom: (1.1.21) (4.4.27 sid)
  • Revision ID: package-import@ubuntu.com-20130509151047-aqv8d71oj9wvcv8c
Tags: 1.5.1-2
[ Jakub Wilk ]
* Use canonical URIs for Vcs-* fields.

[ Luke Faraone ]
* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/ref/contrib/gis/measure.txt
22
22
 
23
23
    >>> from django.contrib.gis.measure import Distance, D
24
24
    >>> d1 = Distance(km=5)
25
 
    >>> print d1
 
25
    >>> print(d1)
26
26
    5.0 km
27
27
    >>> d2 = D(mi=5) # `D` is an alias for `Distance`
28
 
    >>> print d2
 
28
    >>> print(d2)
29
29
    5.0 mi
30
30
 
31
31
Conversions are easy, just access the preferred unit attribute to get a
32
32
converted distance quantity::
33
33
 
34
 
    >>> print d1.mi # Converting 5 kilometers to miles
 
34
    >>> print(d1.mi) # Converting 5 kilometers to miles
35
35
    3.10685596119
36
 
    >>> print d2.km # Converting 5 miles to kilometers
 
36
    >>> print(d2.km) # Converting 5 miles to kilometers
37
37
    8.04672
38
38
 
39
39
Moreover, arithmetic operations may be performed between the distance
40
40
objects::
41
41
 
42
 
    >>> print d1 + d2 # Adding 5 miles to 5 kilometers
 
42
    >>> print(d1 + d2) # Adding 5 miles to 5 kilometers
43
43
    13.04672 km
44
 
    >>> print d2 - d1 # Subtracting 5 kilometers from 5 miles
 
44
    >>> print(d2 - d1) # Subtracting 5 kilometers from 5 miles
45
45
    1.89314403881 mi
46
46
 
47
47
Two :class:`Distance` objects multiplied together will yield an :class:`Area`
48
48
object, which uses squared units of measure::
49
49
 
50
50
    >>> a = d1 * d2 # Returns an Area object.
51
 
    >>> print a
 
51
    >>> print(a)
52
52
    40.2336 sq_km
53
53
 
54
54
To determine what the attribute abbreviation of a unit is, the ``unit_attname``
55
55
class method may be used::
56
56
 
57
 
    >>> print Distance.unit_attname('US Survey Foot')
 
57
    >>> print(Distance.unit_attname('US Survey Foot'))
58
58
    survey_ft
59
 
    >>> print Distance.unit_attname('centimeter')
 
59
    >>> print(Distance.unit_attname('centimeter'))
60
60
    cm
61
61
 
62
62
.. _supported_units:
127
127
   Returns the distance value in units corresponding to the given unit
128
128
   attribute.  For example::
129
129
 
130
 
       >>> print dist.km
 
130
       >>> print(dist.km)
131
131
       8.04672
132
132
 
133
133
   .. classmethod:: unit_attname(unit_name)
159
159
   Returns the area value in units corresponding to the given unit
160
160
   attribute.  For example::
161
161
 
162
 
       >>> print a.sq_km
 
162
       >>> print(a.sq_km)
163
163
       12.949940551680001
164
164
 
165
165
   .. classmethod:: unit_attname(unit_name)