Provide missing docstrings

Author: vshlapakov

scrapinghub/client/exceptions.py

@@ -57,6 +57,7 @@ class ServerError(ScrapinghubAPIError):
 
 
 def wrap_http_errors(method):
+    """Internal helper to handle exceptions gracefully."""
     @wraps(method)
     def wrapped(*args, **kwargs):
         try:
@@ -93,6 +94,7 @@ def wrapped(*args, **kwargs):
 
 
 def wrap_value_too_large(method):
+    """Internal wrapper for ValueTooLarge exception."""
     @wraps(method)
     def wrapped(*args, **kwargs):
         try:

scrapinghub/client/frontiers.py

@@ -41,6 +41,7 @@ def _get_writer(self, frontier, slot):
         return writer
 
     def _writer_callback(self, key, response):
+        """Writer callback function when new batch is added."""
         self.newcount[key] += response.json()["newcount"]
 
 
@@ -305,6 +306,10 @@ def __init__(self, slot):
         self._slot = slot
 
     def add(self, fps):
+        """Add new fingerprints to slot.
+
+        :param fps: a list of string fingerprints to add.
+        """
         origin = self._frontier._frontiers._origin
         writer = origin._get_writer(self._frontier.key, self.key)
         fps = list(fps) if not isinstance(fps, list) else fps

scrapinghub/client/projects.py

@@ -174,5 +174,10 @@ class Settings(_MappingProxy):
         >>> project.settings.delete('job_runtime_limit')
     """
     def set(self, key, value):
+        """Update project setting value by key.
+
+        :param key: a string setting key.
+        :param value: new setting value.
+        """
         # FIXME drop the method when post-by-key is implemented on server side
         self.update({key: value})

scrapinghub/client/utils.py

@@ -36,6 +36,12 @@ def __str__(self):
 
 
 def parse_project_id(project_id):
+    """Simple check for project id.
+
+    :param project_id: a numeric project id, int or string.
+    :return: a unified project id.
+    :rtype: :class:`str`
+    """
     try:
         int(project_id)
     except ValueError:
@@ -44,6 +50,12 @@ def parse_project_id(project_id):
 
 
 def parse_job_key(job_key):
+    """Inner helper to parse job key.
+
+    :param job_key: a job key (str or tuple of 3 ints).
+    :return: parsed job key.
+    :rtype: :class:`JobKey`
+    """
     if isinstance(job_key, tuple):
         parts = job_key
     elif isinstance(job_key, six.string_types):
@@ -239,6 +251,7 @@ def format_iter_filters(params):
 
 
 def update_kwargs(kwargs, **params):
+    """Update kwargs dict with non-empty params with json-encoded values."""
     kwargs.update({k: json.dumps(v) if isinstance(v, dict) else v
                    for k, v in params.items() if v is not None})