#!/usr/bin/env python

from twitter import simplejson, TwitterError, User

class List(object):

'''A class representing the List structure used by the twitter API.

The List structure exposes the following properties:

list.id

list.name

list.slug

list.description

list.full_name

list.mode

list.uri

list.member_count

list.subscriber_count

list.following

'''

def __init__(self, **kwargs):

param_defaults = {

'id': None,

'name': None,

'slug': None,

'description': None,

'full_name': None,

'mode': None,

'uri': None,

'member_count': None,

'subscriber_count': None,

'following': None,

'user': None}

for (param, default) in param_defaults.iteritems():

setattr(self, param, kwargs.get(param, default))

def GetId(self):

'''Get the unique id of this list.

Returns:

The unique id of this list

'''

return self._id

def SetId(self, id):

'''Set the unique id of this list.

Args:

id:

The unique id of this list.

'''

self._id = id

id = property(GetId, SetId,

doc='The unique id of this list.')

def GetName(self):

'''Get the real name of this list.

Returns:

The real name of this list

'''

return self._name

def SetName(self, name):

'''Set the real name of this list.

Args:

name:

The real name of this list

'''

self._name = name

name = property(GetName, SetName,

doc='The real name of this list.')

def GetSlug(self):

'''Get the slug of this list.

Returns:

The slug of this list

'''

return self._slug

def SetSlug(self, slug):

'''Set the slug of this list.

Args:

slug:

The slug of this list.

'''

self._slug = slug

slug = property(GetSlug, SetSlug,

doc='The slug of this list.')

def GetDescription(self):

'''Get the description of this list.

Returns:

The description of this list

'''

return self._description

def SetDescription(self, description):

'''Set the description of this list.

Args:

description:

The description of this list.

'''

self._description = description

description = property(GetDescription, SetDescription,

doc='The description of this list.')

def GetFull_name(self):

'''Get the full_name of this list.

Returns:

The full_name of this list

'''

return self._full_name

def SetFull_name(self, full_name):

'''Set the full_name of this list.

Args:

full_name:

The full_name of this list.

'''

self._full_name = full_name

full_name = property(GetFull_name, SetFull_name,

doc='The full_name of this list.')

def GetMode(self):

'''Get the mode of this list.

Returns:

The mode of this list

'''

return self._mode

def SetMode(self, mode):

'''Set the mode of this list.

Args:

mode:

The mode of this list.

'''

self._mode = mode

mode = property(GetMode, SetMode,

doc='The mode of this list.')

def GetUri(self):

'''Get the uri of this list.

Returns:

The uri of this list

'''

return self._uri

def SetUri(self, uri):

'''Set the uri of this list.

Args:

uri:

The uri of this list.

'''

self._uri = uri

uri = property(GetUri, SetUri,

doc='The uri of this list.')

def GetMember_count(self):

'''Get the member_count of this list.

Returns:

The member_count of this list

'''

return self._member_count

def SetMember_count(self, member_count):

'''Set the member_count of this list.

Args:

member_count:

The member_count of this list.

'''

self._member_count = member_count

member_count = property(GetMember_count, SetMember_count,

doc='The member_count of this list.')

def GetSubscriber_count(self):

'''Get the subscriber_count of this list.

Returns:

The subscriber_count of this list

'''

return self._subscriber_count

def SetSubscriber_count(self, subscriber_count):

'''Set the subscriber_count of this list.

Args:

subscriber_count:

The subscriber_count of this list.

'''

self._subscriber_count = subscriber_count

subscriber_count = property(GetSubscriber_count, SetSubscriber_count,

doc='The subscriber_count of this list.')

def GetFollowing(self):

'''Get the following status of this list.

Returns:

The following status of this list

'''

return self._following

def SetFollowing(self, following):

'''Set the following status of this list.

Args:

following:

The following of this list.

'''

self._following = following

following = property(GetFollowing, SetFollowing,

doc='The following status of this list.')

def GetUser(self):

'''Get the user of this list.

Returns:

The owner of this list

'''

return self._user

def SetUser(self, user):

'''Set the user of this list.

Args:

user:

The owner of this list.

'''

self._user = user

user = property(GetUser, SetUser,

doc='The owner of this list.')

def __ne__(self, other):

return not self.__eq__(other)

def __eq__(self, other):

try:

return other and \

self.id == other.id and \

self.name == other.name and \

self.slug == other.slug and \

self.description == other.description and \

self.full_name == other.full_name and \

self.mode == other.mode and \

self.uri == other.uri and \

self.member_count == other.member_count and \

self.subscriber_count == other.subscriber_count and \

self.following == other.following and \

self.user == other.user

except AttributeError:

return False

def __str__(self):

'''A string representation of this twitter.List instance.

The return value is the same as the JSON string representation.

Returns:

A string representation of this twitter.List instance.

'''

return self.AsJsonString()

def AsJsonString(self):

'''A JSON string representation of this twitter.List instance.

Returns:

A JSON string representation of this twitter.List instance

'''

return simplejson.dumps(self.AsDict(), sort_keys=True)

def AsDict(self):

'''A dict representation of this twitter.List instance.

The return value uses the same key names as the JSON representation.

Return:

A dict representing this twitter.List instance

'''

data = {}

if self.id:

data['id'] = self.id

if self.name:

data['name'] = self.name

if self.slug:

data['slug'] = self.slug

if self.description:

data['description'] = self.description

if self.full_name:

data['full_name'] = self.full_name

if self.mode:

data['mode'] = self.mode

if self.uri:

data['uri'] = self.uri

if self.member_count is not None:

data['member_count'] = self.member_count

if self.subscriber_count is not None:

data['subscriber_count'] = self.subscriber_count

if self.following is not None:

data['following'] = self.following

if self.user is not None:

data['user'] = self.user.AsDict()

return data

@staticmethod

def NewFromJsonDict(data):

'''Create a new instance based on a JSON dict.

Args:

data:

A JSON dict, as converted from the JSON in the twitter API

Returns:

A twitter.List instance

'''

if 'user' in data:

user = User.NewFromJsonDict(data['user'])

else:

user = None

return List(id=data.get('id', None),

name=data.get('name', None),

slug=data.get('slug', None),

description=data.get('description', None),

full_name=data.get('full_name', None),

mode=data.get('mode', None),

uri=data.get('uri', None),

member_count=data.get('member_count', None),

subscriber_count=data.get('subscriber_count', None),

following=data.get('following', None),

user=user)