[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

[tor-commits] [stem/master] Making decriptor reader accept path or list of paths



commit 81f272b9e227b36fe93037cbd1d8ef2265403269
Author: Damian Johnson <atagar@xxxxxxxxxxxxxx>
Date:   Sat May 5 17:06:12 2012 -0700

    Making decriptor reader accept path or list of paths
    
    More often than not people will want to read descriptors from a single path
    rather than a list of paths. There's no need to make them wrap that path in a
    list before calling us.
---
 stem/descriptor/reader.py       |    9 ++++++---
 test/integ/descriptor/reader.py |   30 +++++++++++++++---------------
 2 files changed, 21 insertions(+), 18 deletions(-)

diff --git a/stem/descriptor/reader.py b/stem/descriptor/reader.py
index 8f00f5f..1110854 100644
--- a/stem/descriptor/reader.py
+++ b/stem/descriptor/reader.py
@@ -197,7 +197,8 @@ class DescriptorReader:
   instead.
   
   Arguments:
-    targets (list)      - paths for files or directories to be read from
+    target (str, list)  - path or list of paths for files or directories to be
+                          read from
     follow_links (bool) - determines if we'll follow symlinks when traversing
                           directories
     buffer_size (int)   - descriptors we'll buffer before waiting for some to
@@ -206,8 +207,10 @@ class DescriptorReader:
                           listings from this path, errors are ignored
   """
   
-  def __init__(self, targets, follow_links = False, buffer_size = 100, persistence_path = None):
-    self._targets = targets
+  def __init__(self, target, follow_links = False, buffer_size = 100, persistence_path = None):
+    if isinstance(target, str): self._targets = [target]
+    else: self._targets = target
+    
     self._follow_links = follow_links
     self._persistence_path = persistence_path
     self._skip_listeners = []
diff --git a/test/integ/descriptor/reader.py b/test/integ/descriptor/reader.py
index 0e3467c..0d4a638 100644
--- a/test/integ/descriptor/reader.py
+++ b/test/integ/descriptor/reader.py
@@ -155,7 +155,7 @@ class TestDescriptorReader(unittest.TestCase):
     for i in xrange(15):
       remaining_entries = list(descriptor_entries)
       
-      with stem.descriptor.reader.DescriptorReader([descriptor_path]) as reader:
+      with stem.descriptor.reader.DescriptorReader(descriptor_path) as reader:
         for descriptor in reader:
           descriptor_str = str(descriptor)
           
@@ -175,7 +175,7 @@ class TestDescriptorReader(unittest.TestCase):
     """
     
     descriptor_path = os.path.join(DESCRIPTOR_TEST_DATA, "example_descriptor")
-    reader = stem.descriptor.reader.DescriptorReader([descriptor_path])
+    reader = stem.descriptor.reader.DescriptorReader(descriptor_path)
     
     with reader:
       self.assertEquals(1, len(list(reader)))
@@ -200,7 +200,7 @@ class TestDescriptorReader(unittest.TestCase):
     them.
     """
     
-    reader = stem.descriptor.reader.DescriptorReader([DESCRIPTOR_TEST_DATA], buffer_size = 2)
+    reader = stem.descriptor.reader.DescriptorReader(DESCRIPTOR_TEST_DATA, buffer_size = 2)
     
     with reader:
       self.assertTrue(reader.get_buffered_descriptor_count() <= 2)
@@ -219,7 +219,7 @@ class TestDescriptorReader(unittest.TestCase):
     # First run where the persistence_path doesn't yet exist. This just tests
     # the saving functionality.
     
-    reader = stem.descriptor.reader.DescriptorReader([descriptor_path], persistence_path = persistence_path)
+    reader = stem.descriptor.reader.DescriptorReader(descriptor_path, persistence_path = persistence_path)
     with reader: self.assertEqual(1, len(list(reader)))
     
     # check that we've saved reading example_descriptor
@@ -233,7 +233,7 @@ class TestDescriptorReader(unittest.TestCase):
     # reads and takes the persistence_path into account then it won't read the
     # descriptor file. This in essence just tests its loading functionality.
     
-    reader = stem.descriptor.reader.DescriptorReader([descriptor_path], persistence_path = persistence_path)
+    reader = stem.descriptor.reader.DescriptorReader(descriptor_path, persistence_path = persistence_path)
     with reader: self.assertEqual(0, len(list(reader)))
   
   def test_archived_uncompressed(self):
@@ -244,7 +244,7 @@ class TestDescriptorReader(unittest.TestCase):
     expected_results = _get_raw_tar_descriptors()
     test_path = os.path.join(DESCRIPTOR_TEST_DATA, "descriptor_archive.tar")
     
-    with stem.descriptor.reader.DescriptorReader([test_path]) as reader:
+    with stem.descriptor.reader.DescriptorReader(test_path) as reader:
       read_descriptors = [str(desc) for desc in list(reader)]
       self.assertEquals(expected_results, read_descriptors)
   
@@ -256,7 +256,7 @@ class TestDescriptorReader(unittest.TestCase):
     expected_results = _get_raw_tar_descriptors()
     test_path = os.path.join(DESCRIPTOR_TEST_DATA, "descriptor_archive.tar.gz")
     
-    with stem.descriptor.reader.DescriptorReader([test_path]) as reader:
+    with stem.descriptor.reader.DescriptorReader(test_path) as reader:
       read_descriptors = [str(desc) for desc in list(reader)]
       self.assertEquals(expected_results, read_descriptors)
   
@@ -268,7 +268,7 @@ class TestDescriptorReader(unittest.TestCase):
     expected_results = _get_raw_tar_descriptors()
     test_path = os.path.join(DESCRIPTOR_TEST_DATA, "descriptor_archive.tar.bz2")
     
-    with stem.descriptor.reader.DescriptorReader([test_path]) as reader:
+    with stem.descriptor.reader.DescriptorReader(test_path) as reader:
       read_descriptors = [str(desc) for desc in list(reader)]
       self.assertEquals(expected_results, read_descriptors)
   
@@ -279,7 +279,7 @@ class TestDescriptorReader(unittest.TestCase):
     """
     
     is_test_running = True
-    reader = stem.descriptor.reader.DescriptorReader(["/"])
+    reader = stem.descriptor.reader.DescriptorReader("/")
     
     # Fails the test after a couple seconds if we don't finish successfully.
     # Depending on what we're blocked on this might not work when the test
@@ -311,7 +311,7 @@ class TestDescriptorReader(unittest.TestCase):
         last_modified = int(os.stat(path).st_mtime)
         expected_results[path] = last_modified
     
-    reader = stem.descriptor.reader.DescriptorReader([DESCRIPTOR_TEST_DATA])
+    reader = stem.descriptor.reader.DescriptorReader(DESCRIPTOR_TEST_DATA)
     with reader: list(reader) # iterates over all of the descriptors
     
     self.assertEquals(expected_results, reader.get_processed_files())
@@ -323,7 +323,7 @@ class TestDescriptorReader(unittest.TestCase):
     """
     
     skip_listener = SkipListener()
-    reader = stem.descriptor.reader.DescriptorReader([DESCRIPTOR_TEST_DATA])
+    reader = stem.descriptor.reader.DescriptorReader(DESCRIPTOR_TEST_DATA)
     reader.register_skip_listener(skip_listener.listener)
     
     with reader: list(reader) # iterates over all of the descriptors
@@ -350,7 +350,7 @@ class TestDescriptorReader(unittest.TestCase):
     initial_processed_files = {test_path: sys.maxint}
     
     skip_listener = SkipListener()
-    reader = stem.descriptor.reader.DescriptorReader([test_path])
+    reader = stem.descriptor.reader.DescriptorReader(test_path)
     reader.register_skip_listener(skip_listener.listener)
     reader.set_processed_files(initial_processed_files)
     
@@ -380,7 +380,7 @@ class TestDescriptorReader(unittest.TestCase):
       test_file.close()
       
       skip_listener = SkipListener()
-      reader = stem.descriptor.reader.DescriptorReader([test_path])
+      reader = stem.descriptor.reader.DescriptorReader(test_path)
       reader.register_skip_listener(skip_listener.listener)
       with reader: list(reader) # iterates over all of the descriptors
       
@@ -409,7 +409,7 @@ class TestDescriptorReader(unittest.TestCase):
       os.chmod(test_path, 0077) # remove read permissions
       
       skip_listener = SkipListener()
-      reader = stem.descriptor.reader.DescriptorReader([test_path])
+      reader = stem.descriptor.reader.DescriptorReader(test_path)
       reader.register_skip_listener(skip_listener.listener)
       with reader: list(reader) # iterates over all of the descriptors
       
@@ -431,7 +431,7 @@ class TestDescriptorReader(unittest.TestCase):
     test_path = "/non-existant/path"
     
     skip_listener = SkipListener()
-    reader = stem.descriptor.reader.DescriptorReader([test_path])
+    reader = stem.descriptor.reader.DescriptorReader(test_path)
     reader.register_skip_listener(skip_listener.listener)
     with reader: list(reader) # iterates over all of the descriptors
     



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits