Fix copyright, use typing notation for lists

Author: vshlapakov

docs/conf.py

@@ -18,9 +18,16 @@
 #
 import os
 import sys
+from datetime import datetime
+
+
 sys.path.insert(0, os.path.abspath('..'))
 
+
 from scrapinghub import __version__  # noqa
+
+
+YEAR = datetime.now().year
 VERSION = __version__.rsplit('.', 2)[0]
 
 # -- General configuration ------------------------------------------------
@@ -48,8 +55,8 @@
 
 # General information about the project.
 project = u'scrapinghub'
-copyright = u'2017, Pablo Hoffman, Daniel Graña'
-author = u'Pablo Hoffman, Daniel Graña'
+copyright = u'2010-{}, Scrapinghub'.format(YEAR)
+author = u'Scrapinghub'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

scrapinghub/client/collections.py

@@ -91,7 +91,7 @@ def list(self):
 
         :return: a list of collections where each collection is
             represented by a dictionary with ('name','type') fields.
-        :rtype: list of dicts
+        :rtype: List[dict]
         """
         return list(self.iter())
 
@@ -171,7 +171,7 @@ def list(self, key=None, prefix=None, prefixcount=None, startts=None,
         :param requests_params: (optional) a dict with optional requests params.
         :param \*\*params: (optional) additional query params for the request.
         :return: a list of items where each item is represented with a dict.
-        :rtype: list of dicts
+        :rtype: List[dict]
         """
         # FIXME there should be similar docstrings for iter/iter_raw_json
         # but as we proxy them as-is, it's not in place, should be improved

scrapinghub/client/frontiers.py

@@ -171,7 +171,7 @@ def list(self):
         """List all slots.
 
         :return: a list of frontier slots names.
-        :rtype: list of strings
+        :rtype: List[str]
         """
         return next(self._frontiers._origin.apiget((self.key, 'list')))
 
@@ -315,7 +315,7 @@ def list(self, **params):
 
         :param \*\*params: (optional) additional query params for the request.
         :return: a list of fingerprints.
-        :rtype: list of strings
+        :rtype: List[str]
         """
         return list(self.iter(**params))
 
@@ -353,7 +353,7 @@ def list(self, mincount=None, **params):
         :param \*\*params: (optional) additional query params for the request.
         :return: a list of request batches in the queue where each batch
             is represented with a dict with ('id', 'requests') field.
-        :rtype: list of dicts
+        :rtype: List[dict]
         """
         return list(self.iter(mincount=mincount, **params))
 

scrapinghub/client/jobs.py

@@ -164,7 +164,7 @@ def list(self, count=None, start=None, spider=None, state=None,
         :param \*\*params: (optional) other filter params.
 
         :return: list of dictionaries of jobs summary for a given filter params
-        :rtype: list of dicts
+        :rtype: List[dict]
 
         Please note that list() method can use a lot of memory and for a large
         amount of jobs it's recommended to iterate through it via iter()
@@ -260,7 +260,7 @@ def summary(self, state=None, spider=None, **params):
         :param \*\*params: (optional) additional keyword args.
         :return: a list of dictionaries of jobs summary
             for a given filter params grouped by job state.
-        :rtype: list of dicts
+        :rtype: List[dict]
 
         Usage::
 

scrapinghub/client/projects.py

@@ -46,7 +46,7 @@ def list(self):
         """Get list of projects available to current user.
 
         :return: a list of project ids.
-        :rtype: list of integers
+        :rtype: List[int]
 
         Usage::
 
@@ -72,7 +72,7 @@ def summary(self, state=None, **params):
         :return: a list of dictionaries: each dictionary represents a project
             summary (amount of pending/running/finished jobs and a flag if it
             has a capacity to run new jobs).
-        :rtype: list of dicts
+        :rtype: List[dict]
 
         Usage::
 

scrapinghub/client/spiders.py

@@ -52,7 +52,7 @@ def list(self):
         """Get a list of spiders for a project.
 
         :return: a list of dictionaries with spiders metadata.
-        :rtype: list of dicts
+        :rtype: List[dict]
 
         Usage::
 
@@ -122,7 +122,7 @@ def list_tags(self):
         """List spider tags.
 
         :return: a list of spider tags.
-        :rtype: list of strings
+        :rtype: List[str]
         """
         path = 'v2/projects/{}/spiders/{}'.format(self.project_id, self._id)
         url = urljoin(self._client._connection.url, path)