Pass object to and PEP8 fixes

Author: rliebz

dataverse/__init__.py

@@ -4,4 +4,4 @@
 from .connection import Connection
 from .dataverse import Dataverse
 from .dataset import Dataset
-from .file import DataverseFile
+from .file import DataverseFile

dataverse/connection.py

@@ -51,19 +51,21 @@ def create_dataverse(self, alias, name, email, parent=':root'):
             raise exceptions.OperationFailedError('{0} Dataverse could not be created.'.format(name))
 
         self.get_service_document(refresh=True)
+        return self.get_dataverse(alias)
+
+    def delete_dataverse(self, dataverse):
 
-    def delete_dataverse(self, alias):
         resp = requests.delete(
-            'https://{0}/api/dataverses/{1}'.format(self.host, alias),
+            'https://{0}/api/dataverses/{1}'.format(self.host, dataverse.alias),
             params={'key': self.token},
         )
 
         if resp.status_code == 401:
             raise exceptions.UnauthorizedError('Delete Dataverse unauthorized.')
         elif resp.status_code == 404:
-            raise exceptions.DataverseNotFoundError('Dataverse {0} was not found.'.format(alias))
+            raise exceptions.DataverseNotFoundError('Dataverse {0} was not found.'.format(dataverse.alias))
         elif resp.status_code != 200:
-            raise exceptions.OperationFailedError('Dataverse {0} could not be deleted.'.format(alias))
+            raise exceptions.OperationFailedError('Dataverse {0} could not be deleted.'.format(dataverse.alias))
 
         self.get_service_document(refresh=True)
 

dataverse/dataset.py

@@ -262,10 +262,10 @@ def get_files(self, version='latest', refresh=False):
         except VersionJsonNotFoundError:
             return []
 
-    def add_file(self, filepath):
-        self.add_files([filepath])
+    def upload_filepath(self, filepath):
+        self.upload_filepaths([filepath])
 
-    def add_files(self, filepaths):
+    def upload_filepaths(self, filepaths):
         # Convert a directory to a list of files
         if len(filepaths) == 1 and os.path.isdir(filepaths[0]):
             filepaths = get_files_in_path(filepaths[0])
@@ -278,10 +278,10 @@ def add_files(self, filepaths):
         zip_file.close()
         content = s.getvalue()
 
-        self.upload_file('temp.zip', content, zip=False)
+        self.upload_file('temp.zip', content, zip_files=False)
 
-    def upload_file(self, filename, content, zip=True):
-        if zip:
+    def upload_file(self, filename, content, zip_files=True):
+        if zip_files:
             s = StringIO.StringIO()
             zip_file = ZipFile(s, 'w')
             zip_file.writestr(filename, content)
@@ -304,6 +304,7 @@ def upload_file(self, filename, content, zip=True):
         )
 
         self.get_metadata(refresh=True)
+        # Note: We can't determine which file was uploaded. Returns None
 
     def delete_file(self, dataverse_file):
         resp = requests.delete(

dataverse/dataverse.py

@@ -2,8 +2,7 @@
 
 from dataset import Dataset
 from exceptions import (
-    InsufficientMetadataError, MethodNotAllowedError, OperationFailedError,
-    ConnectionError
+    ConnectionError, MethodNotAllowedError, OperationFailedError,
 )
 from utils import get_element, get_elements, sanitize
 
@@ -96,6 +95,7 @@ def create_dataset(self, title, description, creator, **kwargs):
         )
 
         self._add_dataset(dataset)
+        return dataset
 
     def _add_dataset(self, dataset):
 

dataverse/exceptions.py

@@ -50,4 +50,4 @@ class VersionJsonNotFoundError(DataverseError):
 
 class DataverseNotFoundError(DataverseError):
     """Raised when a Dataverse cannot be found"""
-    pass
+    pass

dataverse/settings/defaults.py

@@ -42,4 +42,4 @@
     'restriction': 'rights',
     'keyword': 'subject',
     'publication': 'isReferencedBy'
-}
+}

dataverse/test/test_dataverse.py

@@ -100,19 +100,19 @@ def test_create_dataverse(self):
             assert dataverse.alias == alias
             assert dataverse.title == 'Test Name'
         finally:
-            connection.delete_dataverse(alias)
+            connection.delete_dataverse(dataverse)
 
     def test_delete_dataverse(self):
         connection = Connection(TEST_HOST, TEST_TOKEN)
         alias = str(uuid.uuid1())   # must be unique
-        connection.create_dataverse(
+        dataverse = connection.create_dataverse(
             alias,
             'Test Name',
             '[email protected]',
         )
 
-        connection.delete_dataverse(alias)
-        dataverse = connection.get_dataverse(alias, True)
+        connection.delete_dataverse(dataverse)
+        dataverse = connection.get_dataverse(alias)
 
         assert dataverse is None
 
@@ -123,7 +123,7 @@ def test_get_dataverses(self):
 
         alias = str(uuid.uuid1())   # must be unique
 
-        connection.create_dataverse(
+        dataverse = connection.create_dataverse(
             alias,
             'Test Name',
             '[email protected]',
@@ -132,30 +132,29 @@ def test_get_dataverses(self):
         current_dataverses = connection.get_dataverses()
         try:
             assert len(current_dataverses) == len(original_dataverses) + 1
-            assert alias in [dataverse.alias for dataverse in current_dataverses]
+            assert alias in [dv.alias for dv in current_dataverses]
         finally:
-            connection.delete_dataverse(alias)
+            connection.delete_dataverse(dataverse)
 
         current_dataverses = connection.get_dataverses()
-        assert [dataverse.alias for dataverse in current_dataverses] == [dataverse.alias for dataverse in original_dataverses]
+        assert [dv.alias for dv in current_dataverses] == [dv.alias for dv in original_dataverses]
 
     def test_get_dataverse(self):
         connection = Connection(TEST_HOST, TEST_TOKEN)
         alias = str(uuid.uuid1())   # must be unique
         assert connection.get_dataverse(alias) is None
 
-        connection.create_dataverse(
+        dataverse = connection.create_dataverse(
             alias,
             'Test Name',
             '[email protected]',
         )
 
-        dataverse = connection.get_dataverse(alias)
         try:
             assert dataverse is not None
             assert dataverse.alias == alias
         finally:
-            connection.delete_dataverse(alias)
+            connection.delete_dataverse(dataverse)
 
 
 class TestDataset(object):
@@ -213,7 +212,7 @@ def setup_class(cls):
     def teardown_class(cls):
 
         print 'Removing test Dataverse'
-        cls.connection.delete_dataverse(cls.alias)
+        cls.connection.delete_dataverse(cls.dataverse)
         dataverse = cls.connection.get_dataverse(cls.alias, True)
         assert dataverse is None
 
@@ -247,7 +246,7 @@ def test_add_dataset_from_xml(self):
         self.dataverse.delete_dataset(retrieved_dataset)
 
     def test_add_files(self):
-        self.dataset.add_files(EXAMPLE_FILES)
+        self.dataset.upload_filepaths(EXAMPLE_FILES)
         actual_files = [f.name for f in self.dataset.get_files()]
 
         assert '__init__.py' in actual_files
@@ -266,26 +265,26 @@ def test_display_atom_entry(self):
         # not do anything with that xml yet. however, we do use get_entry
         # in other methods so this test case is probably covered
         assert self.dataset.get_entry()
-        
+
     def test_display_dataset_statement(self):
         # this just tests we can get an entry back, but does
         # not do anything with that xml yet. however, we do use get_statement
         # in other methods so this test case is probably covered
         assert self.dataset.get_statement()
-    
+
     def test_delete_a_file(self):
         self.dataset.upload_file('cat.jpg', b'Whatever a cat looks like goes here.')
-        
+
         # Add file and confirm
         files = self.dataset.get_files()
         assert len(files) == 1
         assert files[0].name == 'cat.jpg'
-        
+
         # Delete file and confirm
         self.dataset.delete_file(files[0])
         files = self.dataset.get_files()
         assert not files
-        
+
     def test_delete_a_dataset(self):
         xmlDataset = Dataset.from_xml_file(ATOM_DATASET)
         self.dataverse._add_dataset(xmlDataset)
@@ -305,7 +304,6 @@ def test_publish_dataset(self):
         self.dataverse.delete_dataset(self.dataset)
         assert self.dataset.get_state(refresh=True) == 'DEACCESSIONED'
 
-    
+
 if __name__ == '__main__':
     pytest.main()
-

dataverse/utils.py

@@ -97,4 +97,4 @@ def get_files_in_path(path):
 
 
 def sanitize(value):
-    return bleach.clean(value, strip=True, tags=[], attributes=[], styles=[])
+    return bleach.clean(value, strip=True, tags=[], attributes=[], styles=[])