Prefer single quotes and PEP8 improvements

Author: rliebz

dataverse/connection.py

@@ -11,9 +11,9 @@ class Connection(object):
     def __init__(self, host, token):
         self.token = token
         self.host = host
-        self.sd_uri = "https://{host}/dvn/api/data-deposit/v1.1/swordv2/service-document".format(host=self.host)
+        self.sd_uri = 'https://{host}/dvn/api/data-deposit/v1.1/swordv2/service-document'.format(host=self.host)
         self.service_document = None
-        
+
         self.connect()
 
     @property
@@ -65,9 +65,9 @@ def get_dataverses(self, refresh=False):
 
         collections = get_elements(
             self.service_document[0],
-            tag="collection",
+            tag='collection',
         )
-        
+
         return [Dataverse(self, col) for col in collections]
 
     def get_dataverse(self, alias, refresh=False):

dataverse/dataset.py

@@ -55,13 +55,13 @@ def from_xml_file(cls, xml_file):
     def from_dataverse(cls, entry_element, dataverse):
 
         # Entry not in appropriate format--extract relevant metadata
-        id_element = get_element(entry_element, tag="id")
-        title_element = get_element(entry_element, tag="title")
+        id_element = get_element(entry_element, tag='id')
+        title_element = get_element(entry_element, tag='title')
         edit_media_element = get_element(
             entry_element,
-            tag="link",
-            attribute="rel",
-            attribute_value="edit-media",
+            tag='link',
+            attribute='rel',
+            attribute_value='edit-media',
         )
 
         return cls(
@@ -78,7 +78,7 @@ def doi(self):
             raise NoContainerError('This dataset has not been added to a Dataverse.')
 
         # Note: This depends strongly on URL structure, and may break easily
-        return self.edit_media_uri.rsplit("/study/", 1)[-1]
+        return self.edit_media_uri.rsplit('/study/', 1)[-1]
 
     @property
     def id(self):
@@ -105,7 +105,7 @@ def citation(self):
         return get_element(
             self.get_entry(),
             namespace='http://purl.org/dc/terms/',
-            tag="bibliographicCitation"
+            tag='bibliographicCitation'
         ).text
 
     @property
@@ -136,19 +136,19 @@ def get_statement(self, refresh=False):
             # Try to find statement uri without a request to the server
             link = get_element(
                 self.get_entry(),
-                tag="link",
-                attribute="rel",
-                attribute_value="http://purl.org/net/sword/terms/statement",
+                tag='link',
+                attribute='rel',
+                attribute_value='http://purl.org/net/sword/terms/statement',
             )
             if link is None:
                 # Find link with request to server
                 link = get_element(
                     self.get_entry(refresh=True),
-                    tag="link",
-                    attribute="rel",
-                    attribute_value="http://purl.org/net/sword/terms/statement",
+                    tag='link',
+                    attribute='rel',
+                    attribute_value='http://purl.org/net/sword/terms/statement',
                 )
-            self.statement_uri = link.get("href")
+            self.statement_uri = link.get('href')
 
         resp = requests.get(self.statement_uri, auth=self.connection.auth)
 
@@ -164,13 +164,13 @@ def get_state(self, refresh=False):
 
         self._state = get_element(
             self.get_statement(refresh),
-            tag="category",
-            attribute="term",
-            attribute_value="latestVersionState"
+            tag='category',
+            attribute='term',
+            attribute_value='latestVersionState'
         ).text
         return self._state
 
-    def get_json(self, version="latest", refresh=False):
+    def get_json(self, version='latest', refresh=False):
         if not refresh and self._json.get(version):
             return self._json.get(version)
 
@@ -193,15 +193,15 @@ def get_json(self, version="latest", refresh=False):
         self._json[version] = resp.json()['data']
         return self._json[version]
 
-    def get_file(self, file_name, version="latest", refresh=True):
+    def get_file(self, file_name, version='latest', refresh=True):
         files = self.get_files(version, refresh)
         return next((f for f in files if f.name == file_name), None)
 
-    def get_file_by_id(self, file_id, version="latest", refresh=True):
+    def get_file_by_id(self, file_id, version='latest', refresh=True):
         files = self.get_files(version, refresh)
         return next((f for f in files if f.id == file_id), None)
 
-    def get_files(self, version="latest", refresh=True):
+    def get_files(self, version='latest', refresh=True):
         try:
             files_json = self.get_json(version, refresh)['files']
             return [DataverseFile.from_json(self, file_json)
@@ -264,7 +264,7 @@ def publish(self):
 
         receipt = resp.content
         self._refresh(receipt=receipt)
-    
+
     def delete_file(self, dataverse_file):
         resp = requests.delete(
             dataverse_file.edit_media_uri,
@@ -273,7 +273,7 @@ def delete_file(self, dataverse_file):
 
         if resp.status_code != 204:
             raise OperationFailedError('The file could not be deleted.')
-        
+
     def delete_all_files(self):
         for f in self.get_files():
             self.delete_file(f)

dataverse/dataverse.py

@@ -24,8 +24,8 @@ def is_published(self):
 
         status_tag = get_element(
             collection_info,
-            namespace="http://purl.org/net/sword/terms/state",
-            tag="dataverseHasBeenReleased",
+            namespace='http://purl.org/net/sword/terms/state',
+            tag='dataverseHasBeenReleased',
         )
         status = status_tag.text
 
@@ -94,7 +94,7 @@ def add_dataset(self, dataset):
 
         dataset.dataverse = self
         dataset._refresh(receipt=resp.content)
-        
+
     def delete_dataset(self, dataset):
         if dataset._state == 'DELETED' or dataset._state == 'DEACCESSIONED':
             return
@@ -104,12 +104,14 @@ def delete_dataset(self, dataset):
             auth=self.connection.auth,
         )
         if resp.status_code == 405:
-            raise MethodNotAllowedError('Published datasets can only be '
-                'deleted from the GUI. For more information, please refer to '
-                'https://github.com/IQSS/dataverse/issues/778')
+            raise MethodNotAllowedError(
+                'Published datasets can only be deleted from the GUI. For '
+                'more information, please refer to '
+                'https://github.com/IQSS/dataverse/issues/778'
+            )
 
         dataset._state = 'DEACCESSIONED'
-        
+
     def get_datasets(self):
 
         collection_info = requests.get(

dataverse/settings/defaults.py

@@ -1,36 +1,36 @@
 import os
 
-TEST_HOST = "apitest.dataverse.org"
-TEST_TOKEN = "changeme"
+TEST_HOST = 'apitest.dataverse.org'
+TEST_TOKEN = 'changeme'
 
 HERE = os.path.dirname(os.path.abspath(__file__))
 BASE_PATH = os.path.abspath(os.path.join(HERE, os.pardir))
 
 EXAMPLE_DICT = {
-    "title": "ExampleTitle",
-    "id": "ExampleID",
-    "author": ["ExampleAuthor1", "ExampleAuthor2"],
-    "producer": "ExampleProducer",
-    "date": "1992-10-04",
-    "description": "ExampleDescription",
-    "abstract": "ExampleAbstract",
-    "type": "ExampleType",
-    "source": "ExampleSource",
-    "restriction": "ExampleRestriction",
-    "relation": "ExampleRelation",
-    "keyword": "ExampleKeyword",
-    "coverage": "ExampleCoverage",
-    "publication": "ExamplePublication",
+    'title': 'ExampleTitle',
+    'id': 'ExampleID',
+    'author': ['ExampleAuthor1', 'ExampleAuthor2'],
+    'producer': 'ExampleProducer',
+    'date': '1992-10-04',
+    'description': 'ExampleDescription',
+    'abstract': 'ExampleAbstract',
+    'type': 'ExampleType',
+    'source': 'ExampleSource',
+    'restriction': 'ExampleRestriction',
+    'relation': 'ExampleRelation',
+    'keyword': 'ExampleKeyword',
+    'coverage': 'ExampleCoverage',
+    'publication': 'ExamplePublication',
 }
 
-SWORD_BOOTSTRAP = """<?xml version="1.0"?>
-<entry xmlns="http://www.w3.org/2005/Atom"
-        xmlns:dcterms="http://purl.org/dc/terms/">
-</entry>"""
+SWORD_BOOTSTRAP = '''<?xml version='1.0'?>
+<entry xmlns='http://www.w3.org/2005/Atom'
+        xmlns:dcterms='http://purl.org/dc/terms/'>
+</entry>'''
 
 SWORD_NAMESPACE = {
-    "dcterms": "http://purl.org/dc/terms/",
-    "atom": "http://www.w3.org/2005/Atom",
+    'dcterms': 'http://purl.org/dc/terms/',
+    'atom': 'http://www.w3.org/2005/Atom',
 }
 
 UNIQUE_FIELDS = ['title', 'id', 'updated', 'summary']

dataverse/test/test_dataverse.py

@@ -79,7 +79,7 @@ def test_connect_unauthorized(self):
     def test_connect_unknown_failure(self):
         httpretty.register_uri(
             httpretty.GET,
-            "https://{host}/dvn/api/data-deposit/v1.1/swordv2/service-document".format(host=TEST_HOST),
+            'https://{host}/dvn/api/data-deposit/v1.1/swordv2/service-document'.format(host=TEST_HOST),
             status=400,
         )
 
@@ -155,10 +155,10 @@ class TestDatasetOperations(object):
 
     @classmethod
     def setup_class(cls):
-        print "Connecting to DVN."
+        print 'Connecting to Dataverse host at {0}'.format(TEST_HOST)
         cls.connection = Connection(TEST_HOST, TEST_TOKEN)
 
-        print "Creating test Dataverse"
+        print 'Creating test Dataverse'
         cls.alias = str(uuid.uuid1())
         cls.connection.create_dataverse(
             cls.alias,
@@ -171,7 +171,7 @@ def setup_class(cls):
     @classmethod
     def teardown_class(cls):
 
-        print "Removing test Dataverse"
+        print 'Removing test Dataverse'
         cls.connection.delete_dataverse(cls.alias)
         dataverse = cls.connection.get_dataverse(cls.alias, True)
         assert dataverse is None
@@ -192,7 +192,7 @@ def teardown_method(self, method):
     def test_create_dataset_from_xml(self):
         new_dataset = Dataset.from_xml_file(ATOM_DATASET)
         self.dataverse.add_dataset(new_dataset)
-        retrieved_dataset = self.dataverse.get_dataset_by_title("Roasting at Home")
+        retrieved_dataset = self.dataverse.get_dataset_by_title('Roasting at Home')
         assert retrieved_dataset
         self.dataverse.delete_dataset(retrieved_dataset)
 
@@ -239,7 +239,7 @@ def test_delete_a_file(self):
     def test_delete_a_dataset(self):
         xmlDataset = Dataset.from_xml_file(ATOM_DATASET)
         self.dataverse.add_dataset(xmlDataset)
-        atomDataset = self.dataverse.get_dataset_by_title("Roasting at Home")
+        atomDataset = self.dataverse.get_dataset_by_title('Roasting at Home')
         num_datasets = len(self.dataverse.get_datasets())
 
         assert num_datasets > 0
@@ -249,11 +249,11 @@ def test_delete_a_dataset(self):
 
     @pytest.mark.skipif(True, reason='Published datasets can no longer be deaccessioned via API')
     def test_publish_dataset(self):
-        assert self.dataset.get_state() == "DRAFT"
+        assert self.dataset.get_state() == 'DRAFT'
         self.dataset.publish()
-        assert self.dataset.get_state() == "PUBLISHED"
+        assert self.dataset.get_state() == 'PUBLISHED'
         self.dataverse.delete_dataset(self.dataset)
-        assert self.dataset.get_state(refresh=True) == "DEACCESSIONED"
+        assert self.dataset.get_state(refresh=True) == 'DEACCESSIONED'
 
 
 if __name__ == '__main__':

dataverse/utils.py

@@ -23,12 +23,12 @@ def get_elements(root, tag='*', namespace=None, attribute=None, attribute_value=
     if namespace is None:
         xpath = tag
     else:
-        xpath = "{{{ns}}}{tag}".format(ns=namespace, tag=tag)
+        xpath = '{{{ns}}}{tag}'.format(ns=namespace, tag=tag)
 
     if attribute and not attribute_value:
-        xpath += "[@{att}]".format(att=attribute)
+        xpath += '[@{att}]'.format(att=attribute)
     elif not attribute and attribute_value:
-        raise Exception("You must pass an attribute with attribute_value")
+        raise Exception('You must pass an attribute with attribute_value')
     elif attribute and attribute_value:
         xpath += "[@{att}='{val}']".format(att=attribute, val=attribute_value)
 

readme.md

@@ -37,17 +37,18 @@ Create a file at `dataverse/settings/local.py`. The file should contain the foll
 information:
 
 ```python
-TEST_HOST = "apitest.dataverse.org"
-TEST_TOKEN = "" # Token can be generated at {host}/account/apitoken
+TEST_HOST = 'apitest.dataverse.org'  # or 'dataverse-demo.iq.harvard.edu'
+TEST_TOKEN = '' # Token can be generated at {host}/account/apitoken
 ```
 
 Do not commit this file.
 
 ### Running Tests
 
-In order to run any tests, you must first create a Dataverse on the
-host you wish to test. Do not run tests on the production server.
-
 To run tests:
 
     $ py.test
+
+Or, to run a specific test:
+
+    $ py.test dataverse/test/test_dataverse.py::TestClassName::test_method_name