Difference between revisions of "Attribute"

From CS 61A Wiki
Jump to: navigation, search
[checked revision][checked revision]
(copyedit; reorganize)
(copyedit; add examples)
Line 10: Line 10:
 
A ''class attribute'' is shared by all instances of a class. Class attributes are defined within the class but outside of methods.
 
A ''class attribute'' is shared by all instances of a class. Class attributes are defined within the class but outside of methods.
  
They can be accessed by the class or by instances of the class. Example:
+
They can be accessed by the class or by instances of the class: <code>A.attr</code> or <code>obj.attr</code>, where <code>A</code> is the class and <code>obj</code> is an instance of the class. Example:
 
<syntaxhighlight lang="python">
 
<syntaxhighlight lang="python">
 
>>> class A:
 
>>> class A:
Line 17: Line 17:
 
>>> A.class_attribute
 
>>> A.class_attribute
 
5
 
5
>>> A().class_attribute
+
>>> inst = A()
 +
>>> inst.class_attribute
 
5
 
5
 
</syntaxhighlight>
 
</syntaxhighlight>
 
 
<!--
 
<!--
 
<syntaxhighlight lang="python">
 
<syntaxhighlight lang="python">
Line 47: Line 47:
  
 
==Instance attribute==
 
==Instance attribute==
An ''instance attribute'' is specific to one instance of a class. Instance attributes are typically defined inside methods.
+
An ''instance attribute'' is specific to one instance of a class. Instance attributes are typically defined inside methods. Example:
 +
<syntaxhighlight lang="python">
 +
class A:
 +
    def __init__(self):
 +
        self.x = 1 # x is an instance attribute
  
Changes to an instance attribute can only be seen by its instance. If a class attribute and instance attribute have the same variable name, then the instance attribute will hide the class attribute. The instance can only access the instance attribute, although the class can still access the class attribute.
+
>>> a = A()
 +
>>> a.x
 +
1
 +
</syntaxhighlight>
  
Example:
+
If a class attribute and instance attribute have the same name, then the instance attribute will hide the class attribute. The instance can access only the instance attribute, although the class can still access the class attribute. Example:
 
<syntaxhighlight lang="python">
 
<syntaxhighlight lang="python">
 
>>> class A:
 
>>> class A:
Line 58: Line 65:
 
         def __init__(self):
 
         def __init__(self):
 
             self.num = 1
 
             self.num = 1
 
        def increase(self):
 
            self.num += 1
 
 
>>> A.num
 
>>> A.num
 
0
 
0
 
>>> inst1 = A()
 
>>> inst1 = A()
>>> inst2 = A()
 
 
>>> inst1.num
 
>>> inst1.num
 
1
 
1
>>> inst2.num
 
1
 
>>> inst1.increase()
 
>>> inst1.num
 
2
 
>>> inst2.num
 
1
 
>>> A.num
 
0
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
=== Method ===
 +
A ''method'' is an instance attribute that is a function that manipulates the object. A method can be invoked on an object in two ways:
 +
* <code>A.method(obj, arg)</code>, where <code>A</code> is a class and <code>obj</code> is the object. <code>A.method</code> is a normal function.
 +
* <code>obj.method(arg)</code>, where <code>obj</code> is the object. <code>obj.method</code> is called a ''bound method'' because it has an object attached to it. The object is automatically passed into the method as the first argument (usually <code>self</code>).
 
<syntaxhighlight lang="python">
 
<syntaxhighlight lang="python">
>>> class Test():
+
class A:
         char = 'a'
+
    def __init__(self, id):
>>> Test.char
+
         self.id = id
'a'
+
 
>>> inst = Test()
+
    def get_id(self):
>>> inst.char
+
        return self.id
'a'
+
 
>>> inst.char = 'b'
+
>>> a = A(6)
>>> inst.char
+
>>> A.get_id
'b'
+
<function A.get_id at 0x...>
>>> Test.char
+
>>> a.get_id
'a'
+
<bound method A.get_id of <__main__.A object at 0x...>>
 +
>>> A.get_id(a)
 +
6
 +
>>> a.get_id()
 +
6
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== Method ==
+
== Attribute assignment ==
A ''method'' is an attribute of an instance (not of a class) where the value is a function that manipulates the object. Unlike regular functions, methods are ''invoked'' on an object via dot notation, so the object that the method is invoked on will be automatically passed into the method as an argument. Note that accessing the attribute from the class will only return the function, so the object argument must be passed in instead of being omitted via dot notation.
+
Attributes can be assigned to by using dot notation and an equals sign.
 +
 
 +
Example of assigning a class attribute:
 
<syntaxhighlight lang="python">
 
<syntaxhighlight lang="python">
>>> class A():
+
>>> class A:
        def __init__(self, id):
+
...    class_attribute = 5
            self.id = id
+
...  
        def useless_method():
+
>>> A.class_attribute
            return 5
+
        def example_method(self):
+
            return self.id
+
>>> a = A(6)
+
>>> a.useless_method
+
<bound method A.useless_method of <__main__.A object at 0xe10250>>
+
>>> a.useless_method()
+
Traceback (most recent call last):
+
  File "<stdin>", line 1, in <module>
+
TypeError: useless_method() takes no arguments (1 given)
+
>>> A.useless_method
+
<function useless_method at 0xe0ed10>
+
>>> A.useless_method()
+
 
5
 
5
>>> a.example_method()
+
>>> A.class_attribute = 6
6
+
>>> A.class_attribute
>>> b = A(7)
+
>>> b.example_method()
+
7
+
>>> A.example_method(a)
+
 
6
 
6
 +
</syntaxhighlight>
 +
 +
Example of assigning an instance attribute:
 +
<syntaxhighlight lang="python">
 +
class A:
 +
    def __init__(self):
 +
        self.x = 1
 +
 +
>>> a = A()
 +
>>> a.x
 +
1
 +
>>> a.x = 2
 +
>>> a.x
 +
2
 +
</syntaxhighlight>
 +
 +
=== Assigning to methods ===
 +
To assign to a method for the entire class:
 +
<syntaxhighlight lang="python">
 +
A.method = lambda self: ret_value
 +
</syntaxhighlight>
 +
 +
To assign to a method for an instance:
 +
<syntaxhighlight lang="python">
 +
inst.method = lambda: ret_value
 +
</syntaxhighlight>
 +
 +
Examples:
 +
<syntaxhighlight lang="python">
 +
>>> class A:
 +
...    def __init__(self, x):
 +
...        self.x = x
 +
...
 +
>>> A.prev = lambda self: self.x - 1 # add a method for the class
 +
>>> a = A(1)
 +
>>> a.prev()
 +
0
 +
>>> a.next = lambda: a.x + 1 # add a method for object 'a'
 +
>>> a.next()
 +
2
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 144: Line 171:
 
>>> sq = Square(5.0)
 
>>> sq = Square(5.0)
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 
Because <code>area</code> is a <code>property</code> method, it can be accessed by <code>sq.area</code> instead of <code>sq.area()</code>:
 
Because <code>area</code> is a <code>property</code> method, it can be accessed by <code>sq.area</code> instead of <code>sq.area()</code>:
 
<syntaxhighlight lang="python">
 
<syntaxhighlight lang="python">
Line 197: Line 225:
 
Both of these examples essentially do the same thing in roughly the same amount of code. The advantage of having properties however, is that you may switch from the two whenver you want. Simply add or remove or add the property tags from the getters and setters.
 
Both of these examples essentially do the same thing in roughly the same amount of code. The advantage of having properties however, is that you may switch from the two whenver you want. Simply add or remove or add the property tags from the getters and setters.
 
-->
 
-->
== AttributeError ==
+
== <code>AttributeError</code> ==
When one tries to access an attribute of the object that does not exist, Python will raise an <code>AttributeError: 'type_of_obj' object has no attribute 'key'</code>.
+
When one tries to access a nonexistent attribute of an object, Python will raise an <code>AttributeError: 'type_of_obj' object has no attribute 'key'</code>.
  
 
This error commonly occurs when the object to the left of the dot is <code>None</code>. Example:
 
This error commonly occurs when the object to the left of the dot is <code>None</code>. Example:

Revision as of 14:33, 24 July 2014

An attribute of an object is a piece of data that describes the object, stored within the object as a key-value pair. Given an object, one can ask for the value of an attribute using dot notation.

>>> object.attribute
value

Class attribute

A class attribute is shared by all instances of a class. Class attributes are defined within the class but outside of methods.

They can be accessed by the class or by instances of the class: A.attr or obj.attr, where A is the class and obj is an instance of the class. Example:

>>> class A:
...     class_attribute = 5
... 
>>> A.class_attribute
5
>>> inst = A()
>>> inst.class_attribute
5

Instance attribute

An instance attribute is specific to one instance of a class. Instance attributes are typically defined inside methods. Example:

class A:
    def __init__(self):
        self.x = 1 # x is an instance attribute
 
>>> a = A()
>>> a.x
1

If a class attribute and instance attribute have the same name, then the instance attribute will hide the class attribute. The instance can access only the instance attribute, although the class can still access the class attribute. Example:

>>> class A:
        num = 0
 
        def __init__(self):
            self.num = 1
>>> A.num
0
>>> inst1 = A()
>>> inst1.num
1

Method

A method is an instance attribute that is a function that manipulates the object. A method can be invoked on an object in two ways:

  • A.method(obj, arg), where A is a class and obj is the object. A.method is a normal function.
  • obj.method(arg), where obj is the object. obj.method is called a bound method because it has an object attached to it. The object is automatically passed into the method as the first argument (usually self).
class A:
    def __init__(self, id):
        self.id = id
 
    def get_id(self):
        return self.id
 
>>> a = A(6)
>>> A.get_id
<function A.get_id at 0x...>
>>> a.get_id
<bound method A.get_id of <__main__.A object at 0x...>>
>>> A.get_id(a)
6
>>> a.get_id()
6

Attribute assignment

Attributes can be assigned to by using dot notation and an equals sign.

Example of assigning a class attribute:

>>> class A:
...     class_attribute = 5
... 
>>> A.class_attribute
5
>>> A.class_attribute = 6
>>> A.class_attribute
6

Example of assigning an instance attribute:

class A:
    def __init__(self):
        self.x = 1
 
>>> a = A()
>>> a.x
1
>>> a.x = 2
>>> a.x
2

Assigning to methods

To assign to a method for the entire class:

A.method = lambda self: ret_value

To assign to a method for an instance:

inst.method = lambda: ret_value

Examples:

>>> class A:
...     def __init__(self, x):
...         self.x = x
... 
>>> A.prev = lambda self: self.x - 1 # add a method for the class
>>> a = A(1)
>>> a.prev()
0
>>> a.next = lambda: a.x + 1 # add a method for object 'a'
>>> a.next()
2

@property

@property is a shorthand way to create getter and setter methods. Putting @property above a method allows it to be accessed as if it were an instance variable.

Sometimes we have a value that can be computed by accessing other instance variables. Instead of defining a new instance variable (which would then have to be modified each time we change an existing instance variable), we simply make a property.[1]

Example:

class Square:
    def __init__(self, side_length):
        self._length = side_length # leading underscore indicates that this attribute is only for internal use
 
    @property
    def area(self):
        return self._length ** 2
 
    @area.setter
    def area(self, value):
        self._length = value ** (1/2)
 
>>> sq = Square(5.0)

Because area is a property method, it can be accessed by sq.area instead of sq.area():

>>> sq.area
25.0

The second area method is marked as a setter method for the property area, so it is called when we use attribute assignment:

>>> sq.area = 9.0
>>> sq.area
9.0
>>> sq._length
3.0

AttributeError

When one tries to access a nonexistent attribute of an object, Python will raise an AttributeError: 'type_of_obj' object has no attribute 'key'.

This error commonly occurs when the object to the left of the dot is None. Example:

>>> obj = None
>>> obj.a()
Traceback (most recent call last):
  ...
AttributeError: 'NoneType' object has no attribute 'a'

Naming conventions[2]

  • _single_leading_underscore indicates that the attribute should be only be used internally by the object.
  • __double_leading_and_trailing__underscores__ denote magic methods, built-in attributes in Python that have a particular meaning beyond just holding a key-value pair.

Implementation

In a Python functional implementation of object-oriented programming, attributes can be modeled as a local dictionary within the object frame[3], because attributes are just key-value pairs belonging to the object.

>>> # From Section 2.6.1 of Composing Programs by John DeNero (see citation above)
>>> def make_instance(cls):
        """Return a new object instance, which is a dispatch dictionary."""
        def get_value(name):
            if name in attributes:
                return attributes[name]
            else:
                value = cls['get'](name)
                return bind_method(value, instance)
        def set_value(name, value):
            attributes[name] = value
        attributes = {}
        instance = {'get': get_value, 'set': set_value}
        return instance

References

  1. http://markmiyashita.com/cs61a/object_oriented_programming/property/
  2. http://legacy.python.org/dev/peps/pep-0008 PEP 8 Style Guide for Python Code
  3. http://composingprograms.com/pages/26-implementing-classes-and-objects.html#instances Implementation of attributes in Python