summaryrefslogtreecommitdiff
path: root/tablib/core.py
blob: 53f46163405c201817602311dad536231667ee19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# -*- coding: utf-8 -*-

# _____         ______  ______        _________
# __  /_______ ____  /_ ___  /_ _____ ______  /
# _  __/_  __ `/__  __ \__  __ \_  _ \_  __  / 
# / /_  / /_/ / _  /_/ /_  /_/ //  __// /_/ /  
# \__/  \__,_/  /_.___/ /_.___/ \___/ \__,_/   


import csv
import itertools
import os

from helpers import *
from packages import simplejson as json
from packages import xlwt

try:
    import yaml
except ImportError, why:
    from packages import yaml

	

__all__ = ['Dataset', 'source']

__version__ = '0.0.3'
__build__ = '0x000003'
__author__ = 'Kenneth Reitz'
__license__ = 'MIT'
__copyright__ = 'Copyright 2010 Kenneth Reitz'


FILE_EXTENTIONS = ('csv', 'json', 'xls', 'yaml')



class Dataset(object):
	"""Amazing Tabular Dataset object. """

	def __init__(self, *args, **kwargs):
		self._data = None
		self._saved_file = None
		self._saved_format = None


		self._data = list(args)

		try:
		    self.headers = kwargs['headers']
		except KeyError, why:
			self.headers = None

		try:
		    self.title = kwargs['title']
		except KeyError, why:
			self.title = None
			
	def __len__(self):
		return self.height

	def __getitem__(self, key):

		if is_string(key):
			if key in self.headers:
				pos = self.headers.index(key) # get 'key' index from each data
				return [row[pos] for row in self._data]
			else:
				raise KeyError
		else:
			return self._data[key]


	def __setitem__(self, key, value):
		self.validate(value)
		self._data[key] = tuple(value)


	def __delitem__(self, key):
		del self._data[key]

		
	def __repr__(self):
		if self.title:
			return '<%s dataset>' % (self.title.lower())
		else:
			return '<dataset object>'


	def validate(self, row=None, safety=False):
		"""Assures size of every row in dataset is of proper proportions."""
		if row:
			is_valid = (len(row) == self.width) if self.width else True
		else:
			is_valid = all((len(x)== self.width for x in self._data))

		if is_valid:
			return True

		else:
			if not safety:
				raise InvalidDimensions
			return False
	
	def digest(self):
		"""Retruns digest information of dataset in human-readable format."""

		digest_text = ''
		
		if self.title:
			digest_text += 'Title: %s \n' % (self.title)
		if self.headers:
			digest_text += 'Headers: %s\n' % [self.headers]

		digest_text += 'Height: %s\nWidth: %s\n' % (self.height, self.width)


		return digest_text


	@property
	def height(self):
		"""Returns the height of the Dataset."""
		return len(self._data)


	@property
	def width(self):
		"""Returns the width of the Dataset."""
		
		try:
		    return len(self._data[0])
		except KeyError, why:
		    return 0
			

	@property
	def json(self):
		"""Returns JSON representation of Dataset."""
		data = []
		
		if self.headers:
#			for (i, header) in enumerate()
			data = [dict(zip(self.headers, data_row)) for data_row in self ._data]
		else:
			data = self._data

		return json.dumps(data)

		
	@property
	def yaml(self):
		"""Returns YAML representation of Dataset."""
		# TODO: YAML Export
		pass


	@property
	def csv(self):
		"""Returns CSV representation of Dataset."""
		# TODO: CSV Export
		pass


	@property
	def xls(self):
		"""Returns XLS representation of Dataset."""
		# TODO: XLS Export
		pass


	def append(self, row, index=None):
		# todo: impliment index
		self.validate(row)
		self._data.append(tuple(row))

		
	def sort_by(self, key):
		"""SORTS datastet by given key"""
		# todo: accpept string if headers, or index nubmer
		pass


	def save(self, filename=None, format=None):

		if not format:
			# set format from filename
#			format = filename
			pass
			
		if format not in FILE_EXTENTIONS:
			raise UnsupportedFormat
			

		# note export format
		# open file, save the bitch


class InvalidDimensions(Exception):
	"Invalid size"


class UnsupportedFormat(NotImplementedError):
	"Format is not supported"


	
def source(io_string=None, filename=None):
	"""docstring for import"""
	#open by filename
	pass