Cython API: various improvements and checks

This commit is contained in:
Celine Mercier
2017-07-28 13:15:13 +02:00
parent b9c65a871f
commit 35b0c55a8c
10 changed files with 178 additions and 94 deletions

View File

@ -23,7 +23,7 @@ from obitools3.utils cimport tobytes, \
bytes2str, \
tostr
from ..object cimport OBIObjectClosedInstance
from ..object cimport OBIDeactivatedInstanceError
from obitools3.dms.view import typed_view
@ -92,14 +92,13 @@ cdef class View(OBIWrapper) :
object view_name,
object comments=None):
cdef bytes view_name_b = tobytes(view_name)
cdef bytes comments_b
cdef void* pointer
cdef View view
if not self.active() :
raise OBIObjectClosedInstance()
raise OBIDeactivatedInstanceError()
if comments is not None:
comments_b = tobytes(comments)
@ -149,7 +148,7 @@ cdef class View(OBIWrapper) :
return view
cpdef close(self):
def close(self):
cdef Obiview_p pointer = self.pointer()
if self.active() :
@ -160,34 +159,29 @@ cdef class View(OBIWrapper) :
bytes2str(self.name))
def __repr__(self) :
# TODO check everywhere
if not self.active() :
raise OBIObjectClosedInstance()
@OBIWrapper.checkIsActive
def __repr__(self) :
cdef str s = "{name:s}\n{comments:s}\n{line_count:d} lines\n".format(name = str(self.name),
comments = str(self.comments),
line_count = self.line_count)
for column_name in self.keys() :
s = s + repr(self[column_name]) + '\n'
return s
def keys(self):
cdef str col_alias
cdef bytes col_alias
cdef int i
cdef Obiview_p pointer = self.pointer()
cdef int nb_column = pointer.infos.column_count
cdef Alias_column_pair_p column_p = pointer.infos.column_references
if not self.active() :
raise OBIObjectClosedInstance()
raise OBIDeactivatedInstanceError()
for i in range(nb_column) :
col_alias = bytes2str(column_p[i].alias)
col_alias = column_p[i].alias
yield col_alias
@ -195,9 +189,9 @@ cdef class View(OBIWrapper) :
object column_name):
if not self.active() :
raise OBIObjectClosedInstance()
raise OBIDeactivatedInstanceError()
return Column.open(self, column_name)
return Column.open(self, tobytes(column_name))
def get_column_with_idx(self,
@ -207,24 +201,24 @@ cdef class View(OBIWrapper) :
cdef int nb_column = pointer.infos.column_count
if not self.active() :
raise OBIObjectClosedInstance()
raise OBIDeactivatedInstanceError()
if column_idx > nb_column :
raise IndexError(column_idx, "No column with this index")
return Column.open(self, pointer.infos.column_references[column_idx].alias)
cpdef delete_column(self,
object column_name) :
cdef bytes column_name_b = tobytes(column_name)
if not self.active() :
raise OBIObjectClosedInstance()
raise OBIDeactivatedInstanceError()
# Close the cython instance first
col = self[column_name]
col = self[column_name_b]
col.close()
# Remove the column from the view which closes the C structure
@ -242,7 +236,7 @@ cdef class View(OBIWrapper) :
cdef bytes new_name_b = tobytes(new_name)
if not self.active() :
raise OBIObjectClosedInstance()
raise OBIDeactivatedInstanceError()
if (obi_view_create_column_alias(self.pointer(),
tobytes(current_name_b),
@ -262,8 +256,12 @@ cdef class View(OBIWrapper) :
cdef Column old_column
cdef Column new_column
cdef index_t length = len(self)
old_column = self.get_column(column_name)
cdef column_name_b = tobytes(column_name)
if not self.active() :
raise OBIDeactivatedInstanceError()
old_column = self.get_column(column_name_b)
if new_data_type == 0 :
new_data_type = old_column.data_type
@ -276,24 +274,27 @@ cdef class View(OBIWrapper) :
new_column = Column.new_column(self, old_column.pointer().header.name, new_data_type,
nb_elements_per_line=new_nb_elements_per_line, elements_names=new_elements_names,
comments=old_column.comments, alias=tobytes(column_name)+tobytes('___new___'))
comments=old_column.comments, alias=column_name_b+tobytes('___new___'))
for i in range(length) :
new_column[i] = old_column[i]
# Remove old column from view
self.delete_column(column_name)
self.delete_column(column_name_b)
# Rename new
new_column.name = column_name
new_column.name = column_name_b
return new_column
cpdef Line_selection new_selection(self,list lines=None):
cpdef Line_selection new_selection(self, list lines=None):
if not self.active() :
raise OBIDeactivatedInstanceError()
return Line_selection(self, lines)
@OBIWrapper.checkIsActive
def __iter__(self):
# Iteration on each line of all columns
@ -304,14 +305,17 @@ cdef class View(OBIWrapper) :
for line_nb in range(self.line_count) :
yield Line(self, line_nb)
# TODO test time gain without
@OBIWrapper.checkIsActive
def __getitem__(self, object ref) :
if type(ref) == int :
return Line(self, ref)
else : # TODO assume str or bytes for optimization (discuss)
return self.get_column(ref) # TODO hyper lent dans la pratique
@OBIWrapper.checkIsActive
def __setitem__(self, index_t idx, object item) :
cdef Column col
line = self[idx]
@ -329,15 +333,18 @@ cdef class View(OBIWrapper) :
)
line[k] = item[k]
def __contains__(self, str column_name):
return (column_name in self.keys())
@OBIWrapper.checkIsActive
def __contains__(self, object column_name):
return (tobytes(column_name) in self.keys())
@OBIWrapper.checkIsActive
def __len__(self):
return(self.line_count)
@OBIWrapper.checkIsActive
def __str__(self) :
cdef Line line
cdef str to_print
@ -350,36 +357,48 @@ cdef class View(OBIWrapper) :
# Width (column count) property getter
@property
def width(self):
if not self.active() :
raise OBIDeactivatedInstanceError()
return self.pointer().infos.column_count
# DMS property getter
@property
def dms(self):
if not self.active() :
raise OBIDeactivatedInstanceError()
return self._dms
# line_count property getter
@property
def line_count(self):
if not self.active() :
raise OBIDeactivatedInstanceError()
return self.pointer().infos.line_count
# name property getter
@property
def name(self):
if not self.active() :
raise OBIDeactivatedInstanceError()
return <bytes> self.pointer().infos.name
# view type property getter
@property
def type(self): # @ReservedAssignment
if not self.active() :
raise OBIDeactivatedInstanceError()
return <bytes> self.pointer().infos.view_type
# comments property getter
@property
def comments(self):
if not self.active() :
raise OBIDeactivatedInstanceError()
return <bytes> self.pointer().infos.comments
# TODO setter that concatenates new comments?
@ -391,20 +410,21 @@ cdef class Line :
self._view = view
def __getitem__(self, str column_name) :
return (self._view).get_column(column_name)[self._index]
def __getitem__(self, object column_name) :
return (self._view).get_column(tobytes(column_name))[self._index]
def __setitem__(self, object column_name_, object value): # TODO discuss
def __setitem__(self, object column_name, object value): # TODO discuss
# TODO detect multiple elements (dict type)? put somewhere else? but more risky (in get)
# TODO OBI_QUAL ?
cdef type value_type
cdef obitype_t value_obitype
cdef bytes value_b
cdef bytes column_name_b
column_name = tostr(column_name_) # TODO
column_name_b = tobytes(column_name)
if column_name not in self._view :
if column_name_b not in self._view :
if value == None :
raise Exception("Trying to create a column from a None value (can't guess type)")
value_type = type(value)
@ -428,27 +448,33 @@ cdef class Line :
else :
raise Exception("Could not guess the type of a value to create a new column")
Column.new_column(self._view, column_name, value_obitype)
Column.new_column(self._view, column_name_b, value_obitype)
(self._view).get_column(column_name).set_line(self._index, value)
(self._view).get_column(column_name_b).set_line(self._index, value)
def __iter__(self):
cdef bytes column_name
for column_name in (self._view).keys() :
yield column_name
def keys(self):
return self._view.keys()
def __contains__(self, str column_name):
return (column_name in self.keys())
def __contains__(self, object column_name):
return (tobytes(column_name) in self.keys())
def __repr__(self):
cdef dict line
cdef str column_name
cdef dict line
cdef bytes column_name_b
cdef str column_name_str
line = {}
for column_name in self._view.keys() :
line[column_name] = self[column_name]
for column_name_b in self._view.keys() :
column_name_str = bytes2str(column_name_b)
line[column_name_str] = self[column_name_str]
return str(line)
# View property getter
@ -559,7 +585,7 @@ cdef class Line_selection(list):
cdef View view
if not self._view.active() :
raise OBIObjectClosedInstance()
raise OBIDeactivatedInstanceError()
if comments is not None:
comments_b = tobytes(comments)
@ -568,7 +594,7 @@ cdef class Line_selection(list):
pointer = obi_clone_view(self._view._dms.pointer(),
self._view.pointer(),
view_name_b,
view_name_b,
self.__build_binary_list__(),
comments_b)
@ -589,7 +615,7 @@ cdef class Line_selection(list):
cdef register_view_class(bytes view_type_name,
type view_class):
type view_class):
'''
Each subclass of `dms.view` needs to be registered after its declaration
'''