Programming with python Descriptors (_get_, _set_, _delete_) - MicroPyramid

Python descriptors are object attributes that are only invoked for new style of classes. Python descriptors comes under the category of meta programming(code that manipulates code). The descriptors are accessed with special classes that allows to: -- manage properties of another class and -- implement an interface for get, set and delete We can also say that the descriptors are object attributes and the attribute access is overridden by one of the methods in descriptor protocol. Those methods are __get__(), __set__() and __delete__(). Now the question will be like why to use descriptors?? Descriptors are considered as a most powerful and interesting because: -- They provide you to handle the inputs in ordered way -- They are reusable properties which makes to avoid repetitive code. -- They provide you with a powerful validation tool that allows only particular type of data as requested. Creating descriptors:- There are three ways of creating a descriptor:

Type 1:- If you want a descriptor to be used for many different classes and attributes. eg: for type checking The structure of a descriptor class is as follows:

class descriptor(object):
  def __get__(self, instance owner):
    pass
  def __set__(self, instance, self):
    pass
  def __del__(self, instance)
    pass

-- The descriptor allows to send some special properties. self is the instance if the descriptor, instance is the instance of class or the instance of whole descriptors, owner is the type or the class that instance is a part of. Eg:

class Descriptor(object):
  def __init__(self):
    self._name = ";"
  def __get__(self, instance, owner):
    print "Getting: %s" % self._name return self._name
  def __set__(self, instance, name):
    print "Setting: %s" % name self._name = name.title()
  def __delete__(self, instance):
    print "Deleting: %s" %self._name del self._name

class Person(object):
  name = Descriptor()

Lets see the output:

>>> user = Person()
>>> user.name = 'john smith'
Setting: john smith
>>> user.name
Getting: John Smith 'John Smith'
>>> del user.name
Deleting: John Smith
Calling descriptor class is overriding the methods get,set and delete.

Type 2 :- The most simplest way of creating descriptors is to use a property type. By using a property type we are able to create descriptors for attributes only. Syntax for creating property() is: property(fget=None, fset=None, fdel=None, doc=None) Where fget – attribute get method fset – attribute set method fdel – attribute delete method doc – docstring Eg:-

class Person(object):
  def __init__(self):
    self._name = ';'
  def fget(self):
    print "Getting: %s" % self._name
    return self._name
  def fset(self, value):
    print "Setting: %s" % value
    self._name = value.title()
  def fdel(self):
    print "Deleting: %s" %self._name
  del self._name
    name = property(fget, fset, fdel, "I'm the property.")

Note:- -- The output will be same as the output for Type 1. -- The difference is that the property() attribute is used to define read-only attributes in the system. -- fset, fget and fdel methods are optional -- If we try to assign a value to the attribute it shows error like

name = property(fget, None, fdel, "I'm the property")
user.name = 'john smith'
Traceback (most recent call last):
File stdin, line 21, in mоdule
user.name = 'john smith'
AttributeError: can't set attribute

Type 3 :- Creating descriptors using property decorators which are a combination of property type method and Python decorators. what are python decorators? A decorator is a callable object in python that takes a function/method/class definition as an argument and returns a replacement of its type ie.. it is used to modify a function/method/class definition. eg:-

>>> def outer(some_func):
... def inner():
... print "before some_func"
... ret = some_func() # 1
... return ret + 1
... return inner >>> def foo():
... return 1
>>> decorated = outer(foo) # 2
>>> decorated() before some_func
2

We can replace the decorated class with foo itself so that no new class to be created. This will re-assign the old class with decorated class:

Now foo is the decorated version of the original foo The symbol @: This symbol is used to assign a decorater to a function. For the above example we can write @outer >>> foo This will assign the decorator outer to the function foo Now creating descriptor using decorator: eg:

The below is an example for decorator.
class Person(object):
  def __init__(self):
    self._name = ';'
  @property
  def name(self):
    print "Getting: %s" % self._name
    return self._name
  @name.setter
  def name(self, value):
    print "Setting: %s" % value
    self._name = value.title()
  @name.deleter
  def name(self):
    print "Deleting: %s" % self._name
    del self._name

The code is so complex and it has lot of code. To resolve this issue the concept of descriptors came. Type 1 will resolve this issue.

Posted On 12 December 2010 By MicroPyramid


Need any Help in your Project?Let's Talk

Latest Comments
Unit testing with selenium-python

Unit testing with selenium-python. Unit test case example to test the front-end

Continue Reading...
Tips to choose the best custom software development company

Choosing the best company for your software development needs is the most important step. This blog explains you tips to outsource custom software development services.

Continue Reading...
WSGI explanation with simple APP

The main goal of WSGI is to facilitate easy interconnection of servers and web frameworks/applications. WSGI defines a standerd API for web servers(uWSGI, Twisted, Gunicorn) …

Continue Reading...
Understanding self and __init__ method in python Class.

Understand self and __init__ method in python Class?
Before understanding the "self" and "__init__" methods in python class, it's very helpful if we have the idea …

Continue Reading...
List of python class special methods or magic methods

python class special methods or magic methods. magic methods allow us to override or add the default functionality of python objects. One of the biggest …

Continue Reading...
Building and Parsing XML Document using Python

Creating XML document with required elements, Then Parsing it using Python to generate a serialized form of its contents.

Continue Reading...
Working with python collections Counter

Python collections - Counter is to count the frequency of character, OrderedDict is to track the order of the contents in which they are added …

Continue Reading...
Python to Debian package: Simple, Easy and Fast

Packaging python script to debian follows strict instructions, using the following instructions, most of the steps can be skipped hence making it easy and fast.
If …

Continue Reading...
Sending SMS, MMS using Twilio.

A simple Tutorial on sending SMS and MMS in python using Twilio. In this tutorial you will learn how to send SMS, MMS and checking …

Continue Reading...
Customize and Embed Vimeo Videos using Python Requests.

Using python requests and vimeo endpoints it becomes very easy and simple to upload our videos and customize them.

Vimeo Access token:
1. Create an …

Continue Reading...
Getting Started with the IPython Notebook

IPython is a set of tools developed to make it easier for the programmers to work with Python and data. IPython provides extensions to the …

Continue Reading...
Python Arrow To Show Human Friendly Time

Arrow is a python library and command-line tool to genrerate, manipulate dates, times, timestamps.
use of arrow:
With the use of arrow, we can also create, manipulate, …

Continue Reading...
Working with python collections part 1

Python Collections - named tuple is to access by the names specified and deque is to append and pop the elements from both sides of …

Continue Reading...
Building Documentation with readthedocs

In this blog, I'm going to explain you how to write the Sphinx docs using reStructuredText to host in the Read the Docs.

Installing Sphinx

Continue Reading...
Create excel file, Insert image, Draw Bar Graphs in excel files in python using xlsxwriter

Xlsxwriter is a python module through which we can write data to Excel 2007+ XLSX file format. In this blog post we learn to write …

Continue Reading...
Integrate Twitter Social API into Django App

Integrating Twitter sign in (OAuth) in Django App, which includes
1. Capturing username via Twitter Login
2. Updating authenticated user current status on twitter(tweets).

Continue Reading...
How to implement Case Insensitive CSV DictReader in python

In general use cases we upload the CSV files to the system to store huge amount of data by uploading single file. For example in …

Continue Reading...
Python using yield and generators.

Generators are memory efficient. They allow us to code with minimum intermediate arguments, less data structures. Generators are of two types, generator expressions and generator …

Continue Reading...
Introduction to Object Oriented Programming with Python 3

Introduction to Object Oriented Programming with Python

Continue Reading...
Python Coding Techniques and Programming Practices

Coding techniques and programming practices are one of the features of a professional programmer. While writing code to solve a problem programmer should make simple …

Continue Reading...
FABRIC – LEARNING PART 2

Using Fabric, we can develop interactive script for ec2 region, ec2 flavour amazon web services. For this, you need aws account, security group, key pair, …

Continue Reading...
Generating PDF Files in Python using xhtml2pdf

There are many ways for generating PDF in python. In this post I will be presenting PDF files generation with xhtml2pdf.

xhtml2pdf: xhtml2pdf is a …

Continue Reading...
Using Python xlwt generating CSV writer and Excel files

In most of the cases, you need to export the data from your database to different formats. In this post I will show you how …

Continue Reading...
How to access development server publicly using Localtunnel

We do need to expose our local server to hit call-back URLs while programming with other APIs. There is a tool called local tunnel from …

Continue Reading...
How to generate PDF Files from HTML In Python using PDFKIT

There are many approches for generating PDF in python. pdfkit is one of the better approache as, it renders HTML into PDF with various image …

Continue Reading...
Converting Audio and Video files using FFMPEG Tool

FFMPEG is a command-line tool that converts audio or video to required formats, which handle multimedia data. It can also capture and encode in real-time.

Continue Reading...
Python Web Scraping with Beautiful soup

Download all One Piece animation series episodes by scraping site using BeautifulSoup python library.

Continue Reading...
Publishing Python Modules with PIP via PyPi

We'll install so many packages in our day to day python development. Now in this blog post, we'll try to know how to create our …

Continue Reading...
Programming with python: Decorators

Python decorators supports aspect-oriented programming. It is used to add or modify code in functions or classes. Using decorators will provide security, tracing, looking ..etc …

Continue Reading...
Vim for Python Web Development

Having a good environment setup is important for effective, fast and easy coding. We have different IDE's like eclipse, pycharm, sublime etc.. which are powerful …

Continue Reading...
Understanding Python Properties

Python Properties is a class for managing class attributes in Python. Property( ) is a built-in function that creates and returns a property object

Syntax:
attribute_name …

Continue Reading...
QRCode generation in python

A Quick Response code(QRCode) is a two-dimensional pictographic code used for its fast readability and comparatively large storage capacity. The code consists of black modules …

Continue Reading...
Understanding Audio Quality: Bit Rate, Sample Rate

Audio Quality is the accuracy and enjoyability of the audio which the user can listen from an electronic device. Audio quality depends upon the bit …

Continue Reading...
Programming with python Descriptors (_get_, _set_, _delete_) - MicroPyramid

Python descriptors are object attributes that are only invoked for new style of classes. Python descriptors comes under the category of meta programming(code that manipulates …

Continue Reading...
Debugging in Python

When something goes wrong with your code instead of using standard debugging techniques such as print statements use debugging tools. I found two great tools …

Continue Reading...
Python development environment on windows

Python is an interpreted, object-oriented, high-level programming language with dynamic semantics. Python's simple, easy to learn syntax emphasizes readability and therefore reduces the cost of …

Continue Reading...

Subscribe To our news letter

Subscribe and Stay Updated about our Webinars, news and articles on Django, Python, Machine Learning, Amazon Web Services, DevOps, Salesforce, ReactJS, AngularJS, React Native.
* We don't provide your email contact details to any third parties