Created docstrings for BulkData

scrython/bulk_data/bulk_data.py

@@ -5,26 +5,16 @@ from threading import Thread
 
 class BulkData(object):
     """
-    Master object for all bulk data objects.
+    /bulk-data
-
+    Queries and creates an object relating to the /bulk-data endpoint.
-    Positional Arguments:
+    
-        No arguments are required.
+    Raises:
-
+        Exception: Raised if Scryfall sends an error object.
-    Attributes:
+        KeyError: Raised if you attempt to access a key that doesn't exist.
-        object : str ...... Returns the type of object it is. (card, error, etc)
+        KeyError: Raise if you attempt to access a tuple key that doesn't exist.
-        total_values : int ..................... The number of items in `data()`
+    
-        has_more : bool ........ True if there is more than one page of results.
+    Returns:
-        data : list .............. A list of all types returned by the endpoint.
+        object: The Scryfall endpoint object.
-        bulk_object(num) : str .. Returns the type of object the specified tuple is
-        bulk_id(num) : str ..................... The unique ID of the bulk item
-        bulk_type(num) : str ............................ The type of bulk data
-        bulk_updated_at(num) : str ......... The time the item was last updated
-        bulk_name(num) : str ......... The name of the type of bulk data object
-        bulk_description(num) : str ............... A description of the object
-        bulk_compressed_size(num) : int ......... The size of the file in bytes
-        bulk_permalink_uri(num) : str ........ The URL that hosts the bulk file
-        bulk_content_type(num) : str ................ The MIME type of the file
-        bulk_content_encoding(num) : str ............. The encoding of the file
     """
     def __init__(self, **kwargs):
 
@@ -50,59 +40,154 @@ class BulkData(object):
             raise Exception(self.scryfallJson['details'])
 
     def _checkForKey(self, key):
+        """Checks for a key in the scryfallJson object.
+        This function should be considered private, and
+        should not be accessed in production.
+        
+        Args:
+            key (string): The key to check
+        
+        Raises:
+            KeyError: If key is not found.
+        """
         if not key in self.scryfallJson:
             raise KeyError('This card has no key \'{}\''.format(key))
 
     def _checkForTupleKey(self, parent, num, key):
+        """Checks for a key of an object in an array.
+        This function should be considered private, and
+        should not be accessed in production.
+        
+        Args:
+            parent (string): The key for the array to be accessed
+            num (int): The index of the array
+            key (string): The key to check
+        
+        Raises:
+            KeyError: If key is not found.
+        """
         if not key in self.scryfallJson[parent][num]:
             raise KeyError('This tuple has no key \'{}\''.format(key))
 
     def object(self):
+        """Returns the type of object it is.
+        (card, error, etc)
+        
+        Returns:
+            string: The type of object
+        """
         self._checkForKey('object')
 
         return self.scryfallJson['object']
 
     def has_more(self):
+        """True if there is more than one page of results
+        
+        Returns:
+            boolean: True if there are more results
+        """
         self._checkForKey('has_more')
 
         return self.scryfallJson['has_more']
 
     def data(self):
+        """A list of all types of types returned by the endpoints
+        
+        Returns:
+            list: List of all types
+        """
         self._checkForKey('data')
 
         return self.scryfallJson['data']
 
     def bulk_object(self, num):
+        """Returns the type of object the specified index is
+        
+        Args:
+            num (int): The index of the object in the `data` key
+        
+        Returns:
+            string: The type of object
+        """
         self._checkForTupleKey('data', num, 'object')
 
         return self.scryfallJson['data'][num]['object']
 
     def bulk_id(self, num):
+        """The unique ID of the bulk item
+        
+        Args:
+            num (int): The index of the object in the `data` key
+        
+        Returns:
+            string: The Scryfall id of the object
+        """
         self._checkForTupleKey('data', num, 'id')
 
         return self.scryfallJson['data'][num]['id']
 
     def bulk_type(self, num):
+        """The type of bulk data
+        
+        Args:
+            num (int): The index of the object in the `data` key
+        
+        Returns:
+            string: The type of the data item
+        """
         self._checkForTupleKey('data', num, 'type')
 
         return self.scryfallJson['data'][num]['type']
 
     def bulk_updated_at(self, num):
+        """The time the item was last updated
+        
+        Args:
+            num (int): The index of the object in the `data` key
+        
+        Returns:
+            string: Timestamp
+        """
         self._checkForTupleKey('data', num, 'updated_at')
 
         return self.scryfallJson['data'][num]['updated_at']
 
     def bulk_name(self, num):
+        """The name of the type of bulk data object
+        
+        Args:
+            num (int): The index of the object in the `data` key
+        
+        Returns:
+            string: The name of the data item
+        """
         self._checkForTupleKey('data', num, 'name')
 
         return self.scryfallJson['data'][num]['name']
 
     def bulk_description(self, num):
+        """A description of the object
+        
+        Args:
+            num (int): The index of the object in the `data` key
+        
+        Returns:
+            string: The description of the data item
+        """
         self._checkForTupleKey('data', num, 'description')
 
         return self.scryfallJson['data'][num]['description']
 
     def bulk_compressed_size(self, num, human_readable=False):
+        """The size of the file in bytes
+        
+        Args:
+            num (int): The index of the object in the `data` key
+            human_readable (bool, optional): Defaults to False. Converts the bytes into a human readable format
+        
+        Returns:
+            integer or string: Returns integer by default. If human_readable is True, returns a string.
+        """
         self._checkForTupleKey('data', num, 'compressed_size')
 
         if human_readable:
@@ -118,16 +203,40 @@ class BulkData(object):
         return self.scryfallJson['data'][num]['compressed_size']
 
     def bulk_permalink_uri(self, num):
+        """The URL that hosts the bulk file
+        
+        Args:
+            num (int): The index of the object in the `data` key
+        
+        Returns:
+            string: A URI to download the compressed data
+        """
         self._checkForTupleKey('data', num, 'permalink_uri')
 
         return self.scryfallJson['data'][num]['permalink_uri']
 
     def bulk_content_type(self, num):
+        """The MIME type of the file
+        
+        Args:
+            num (int): The index of the object in the `data` key
+        
+        Returns:
+            string: The MIME type
+        """
         self._checkForTupleKey('data', num, 'content_type')
 
         return self.scryfallJson['data'][num]['content_type']
 
     def bulk_content_encoding(self, num):
+        """The encoding of the file
+        
+        Args:
+            num (int): The index of the object in the `data` key
+        
+        Returns:
+            string: The encoding of the file
+        """
         self._checkForTupleKey('data', num, 'content_encoding')
 
         return self.scryfallJson['data'][num]['content_encoding']