fix #703 : Made pattern argument of Session.filter working in the same way as pattern argument of Group.matching

Author: alixdamman

doc/source/changes/version_0_30.rst.inc

@@ -73,6 +73,27 @@ Backward incompatible changes
     >>> arr3.equals(arr4, check_axes=True)
     False
 
+* modified the behavior of the ``pattern`` argument of :py:obj:`Session.filter()` to work as the ``pattern``
+  argument of :py:obj:`Group.matching()`:
+
+    >>> axis = Axis('a=a0..a2')
+    >>> group = axis['a0,a1'] >> 'a01'
+    >>> test1, zero1 = ndtest((2, 2)), zeros((3, 2))
+    >>> s = Session([('test1', test1), ('zero1', zero1), ('axis', axis), ('group', group)])
+
+    >>> # get all items with names ending with '1'
+    >>> s.filter(pattern='*1').names
+    ['test1', 'zero1']
+
+    >>> # get all items with names starting with letter in range a-k
+    >>> s.filter(pattern='[a-k]*').names
+    ['axis', 'group']
+
+  Warning: to retrieve the previous behavior, add the character ``*`` to your pattern
+  (e.g. ``s.filter('test')`` becomes ``s.filter('test*')``).
+
+  Closes :issue:`703`.
+
 
 New features
 ------------
@@ -194,7 +215,7 @@ Miscellaneous improvements
 Fixes
 -----
 
-* fixed LArray.divnot0 being slow when the divisor has many axes and many zeros (closes :issue:`705`).
+* fixed :py:obj:`LArray.divnot0()` being slow when the divisor has many axes and many zeros (closes :issue:`705`).
 
 * fixed maximum length of sheet names (31 characters instead of 30 characters) when adding a new sheet
   to an Excel Workbook (closes :issue:`713`).

larray/core/session.py

@@ -3,6 +3,8 @@
 
 import os
 import sys
+import re
+import fnmatch
 import warnings
 from collections import OrderedDict
 
@@ -17,10 +19,6 @@
 from larray.inout.session import ext_default_engine, get_file_handler
 
 
-def check_pattern(k, pattern):
-    return k.startswith(pattern)
-
-
 # XXX: inherit from OrderedDict or LArray?
 class Session(object):
     """
@@ -646,6 +644,11 @@ def filter(self, pattern=None, kind=None):
         ----------
         pattern : str, optional
             Only keep arrays whose key match `pattern`.
+            * `?`     matches any single character
+            * `*`     matches any number of characters
+            * [seq]   matches any character in seq
+            * [!seq]  matches any character not in seq
+
         kind : (tuple of) type, optional
             Only keep objects which are instances of type(s) `kind`.
 
@@ -663,8 +666,13 @@ def filter(self, pattern=None, kind=None):
 
         Filter using a pattern argument
 
-        >>> s.filter(pattern='test').names
-        ['test1']
+        >>> # get all items with names ending with '1'
+        >>> s.filter(pattern='*1').names
+        ['test1', 'zero1']
+
+        >>> # get all items with names starting with letter in range a-k
+        >>> s.filter(pattern='[a-k]*').names
+        ['axis', 'group']
 
         Filter using kind argument
 
@@ -675,7 +683,9 @@ def filter(self, pattern=None, kind=None):
         """
         items = self._objects.items()
         if pattern is not None:
-            items = [(k, v) for k, v in items if check_pattern(k, pattern)]
+            regex = fnmatch.translate(pattern)
+            match = re.compile(regex).match
+            items = [(k, v) for k, v in items if match(k)]
         if kind is not None:
             items = [(k, v) for k, v in items if isinstance(v, kind)]
         return Session(items)

larray/tests/test_session.py

@@ -138,10 +138,10 @@ def test_iter(session):
 def test_filter(session):
     session.ax = 'ax'
     assertObjListEqual(session.filter(), [b, b12, a, a01, 'c', {}, e, g, f, 'ax'])
-    assertObjListEqual(session.filter('a'), [a, a01, 'ax'])
-    assert list(session.filter('a', dict)) == []
-    assert list(session.filter('a', str)) == ['ax']
-    assert list(session.filter('a', Axis)) == [a]
+    assertObjListEqual(session.filter('a*'), [a, a01, 'ax'])
+    assert list(session.filter('a*', dict)) == []
+    assert list(session.filter('a*', str)) == ['ax']
+    assert list(session.filter('a*', Axis)) == [a]
     assert list(session.filter(kind=Axis)) == [b, a]
     assert list(session.filter('a01', Group)) == [a01]
     assert list(session.filter(kind=Group)) == [b12, a01]