added TODO/XXX/FIXME/misc comments

Author: gdementen

larray/core/abstractbases.py

@@ -5,6 +5,7 @@
 
 # define abstract base classes to enable isinstance type checking on our objects
 # idea taken from https://github.com/pandas-dev/pandas/blob/master/pandas/core/dtypes/generic.py
+# FIXME: __metaclass__ is ignored in Python 3
 class ABCAxis(object):
     __metaclass__ = ABCMeta
 

larray/core/array.py

@@ -17,7 +17,7 @@
 
 # * Axis.sequence? geo.seq('A31', 'A38') (equivalent to geo['A31..A38'])
 
-# * re-implement row_totals/col_totals? or what do we do with them?
+# ? re-implement row_totals/col_totals? or what do we do with them?
 
 # * time specific API so that we know if we go for a subclass or not
 
@@ -397,7 +397,7 @@ def __getitem__(self, key):
 
     def __setitem__(self, key, value):
         # we still need to prepare the key instead of letting numpy handle everything so that
-        # existing (integer)LArray keys are handled correctly (broadcasted using axes names).
+        # existing (integer)LArray keys are broadcasted correctly (using axes names).
         self.array.__setitem__(self._prepare_key(key, wildcard=True), value, translate_key=False)
 
 
@@ -710,7 +710,7 @@ def meta(self, meta):
                             "instead of {}".format(type(meta).__name__))
         self._meta = meta if isinstance(meta, Metadata) else Metadata(meta)
 
-    # TODO: rename to posnonzero and implement a label version of nonzero
+    # TODO: rename to inonzero and implement a label version of nonzero
     # TODO: implement wildcard argument to avoid producing the combined labels
     def nonzero(self):
         r"""
@@ -1273,6 +1273,9 @@ def __bool__(self):
     # Python 2
     __nonzero__ = __bool__
 
+    # TODO: this should be a thin wrapper around a method in AxisCollection
+    # TODO: either support a list (of axes names) as first argument here (and set_labels)
+    #       or don't support that in set_axes
     def rename(self, renames=None, to=None, inplace=False, **kwargs):
         """Renames axes of the array.
 
@@ -8379,6 +8382,7 @@ def stack(elements=None, axis=None, title=None, meta=None, **kwargs):
         axis = Axis(axis)
     if elements is None:
         if not isinstance(axis, Axis) and sys.version_info[:2] < (3, 6):
+            # XXX: this should probably be a warning, not an error
             raise TypeError("axis argument should provide label order when using keyword arguments on Python < 3.6")
         elements = kwargs.items()
     elif kwargs:
@@ -8394,6 +8398,8 @@ def stack(elements=None, axis=None, title=None, meta=None, **kwargs):
         axis = elements.axes[axis]
         values = [elements[k] for k in axis]
     elif isinstance(elements, dict):
+        # TODO: support having no Axis object for Python3.7 (without error or warning)
+        # XXX: we probably want to support this with a warning on Python < 3.7
         assert isinstance(axis, Axis)
         values = [elements[v] for v in axis.labels]
     elif isinstance(elements, Iterable):

larray/core/axis.py

@@ -104,6 +104,7 @@ def __init__(self, labels, name=None):
         self.__sorted_values = None
         self._length = None
         self._iswildcard = False
+        # set _labels, _length and _iswildcard via the property
         self.labels = labels
 
     @property
@@ -2059,6 +2060,9 @@ def copy(self):
         """
         return self[:]
 
+    # XXX: what's the point in supporting a list of Axis or AxisCollection in axes_to_replace?
+    #      it is used in LArray.set_axes but if it is only there, shouldn't the support for that be
+    #      moved there?
     def replace(self, axes_to_replace=None, new_axis=None, inplace=False, **kwargs):
         """Replace one, several or all axes of the collection.
 

larray/inout/xw_excel.py

@@ -270,6 +270,7 @@ def close(self):
             if self.filepath is not None and os.path.isfile(self.xw_wkb.fullname):
                 tmp_file = self.xw_wkb.fullname
                 self.xw_wkb.close()
+                # XXX: do we check for this case earlier and act differently depending on overwrite?
                 os.remove(self.filepath)
                 os.rename(tmp_file, self.filepath)
             else:
@@ -292,6 +293,10 @@ def __enter__(self):
             return self
 
         def __exit__(self, type_, value, traceback):
+            # XXX: we should probably also avoid closing the workbook for visible=True???
+            # XXX: we might want to disallow using open_excel as a context manager (in __enter__)
+            #      when we have nothing to do in close because it is kinda misleading (this might piss off
+            #      users though, so maybe a warning would be better).
             if not self.active_workbook:
                 self.close()