Improve return types

Author: vshlapakov

scrapinghub/client/__init__.py

@@ -58,7 +58,7 @@ def get_project(self, project_id):
 
         :param project_id: integer or string numeric project id.
         :return: :class:`Project` object.
-        :rtype: scrapinghub.client.projects.Project
+        :rtype: :class:`scrapinghub.client.projects.Project`
 
         Usage::
 
@@ -74,7 +74,7 @@ def get_job(self, job_key):
         :param job_key: job key string in format 'project_id/spider_id/job_id',
             where all the components are integers.
         :return: :class:`Job` object.
-        :rtype: scrapinghub.client.jobs.Job
+        :rtype: :class:`scrapinghub.client.jobs.Job`
 
         Usage::
 

scrapinghub/client/collections.py

@@ -30,7 +30,7 @@ def get(self, type_, name):
         :param type_: a collection type string.
         :param name: a collection name string.
         :return: :class:`Collection` object.
-        :rtype: Collection
+        :rtype: :class:`Collection`
         """
         self._origin._validate_collection(type_, name)
         return Collection(self._client, self, type_, name)
@@ -40,7 +40,7 @@ def get_store(self, name):
 
         :param name: a collection name string.
         :return: :class:`Collection` object.
-        :rtype: Collection
+        :rtype: :class:`Collection`
         """
         return self.get('s', name)
 
@@ -51,7 +51,7 @@ def get_cached_store(self, name):
 
         :param name: a collection name string.
         :return: :class:`Collection` object.
-        :rtype: Collection
+        :rtype: :class:`Collection`
         """
         return self.get('cs', name)
 
@@ -62,7 +62,7 @@ def get_versioned_store(self, name):
 
         :param name: a collection name string.
         :return: :class:`Collection` object.
-        :rtype: Collection
+        :rtype: :class:`Collection`
         """
         return self.get('vs', name)
 
@@ -73,7 +73,7 @@ def get_versioned_cached_store(self, name):
 
         :param name: a collection name string.
         :return: :class:`Collection` object.
-        :rtype: Collection
+        :rtype: :class:`Collection`
         """
         return self.get('vcs', name)
 
@@ -82,7 +82,7 @@ def iter(self):
 
         :return: an iterator over collections list where each collection is
             represented by a dictionary with ('name','type') fields.
-        :rtype: collections.Iterable[dict]
+        :rtype: :class:`collections.Iterable[dict]`
         """
         return self._origin.apiget('list')
 
@@ -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[dict]
+        :rtype: :class:`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[dict]
+        :rtype: :class:`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
@@ -186,7 +186,7 @@ def get(self, key, **params):
         :param key: string item key.
         :param \*\*params: (optional) additional query params for the request.
         :return: an item dictionary if exists.
-        :rtype: dict
+        :rtype: :class:`dict`
         """
         if key is None:
             raise ValueError("key cannot be None")
@@ -228,7 +228,7 @@ def iter_raw_msgpack(self, key=None, prefix=None, prefixcount=None,
         :param requests_params: (optional) a dict with optional requests params.
         :param \*\*params: (optional) additional query params for the request.
         :return: an iterator over items list packed with msgpack.
-        :rtype: collections.Iterable[bytes]
+        :rtype: :class:`collections.Iterable[bytes]`
         """
         update_kwargs(params, key=key, prefix=prefix, prefixcount=prefixcount,
                       startts=startts, endts=endts,

scrapinghub/client/frontiers.py

@@ -22,7 +22,7 @@ def _get_writer(self, frontier, slot):
         callback to write newcount data per slot.
 
         :return: a batchuploader writer instance.
-        :rtype: scrapinghub.hubstorage.batchuploader._BatchWriter
+        :rtype: :class:`scrapinghub.hubstorage.batchuploader._BatchWriter`
         """
         key = (frontier, slot)
         writer = self._writers.get(key)
@@ -89,23 +89,23 @@ def get(self, name):
 
         :param name: a frontier name string.
         :return: :class:`Frontier` instance.
-        :rtype: Frontier
+        :rtype: :class:`Frontier`
         """
         return Frontier(self._client, self, name)
 
     def iter(self):
         """Iterate through frontiers.
 
         :return: an iterator over frontiers names.
-        :rtype: collections.Iterable[str]
+        :rtype: :class:`collections.Iterable[str]`
         """
         return iter(self.list())
 
     def list(self):
         """List frontiers names.
 
         :return: a list of frontiers names.
-        :rtype: List[str]
+        :rtype: :class:`list[str]`
         """
         return next(self._origin.apiget('list'))
 
@@ -155,23 +155,23 @@ def get(self, slot):
         """Get a slot by name.
 
         :return: :class:`FrontierSlot` instance.
-        :rtype: FrontierSlot
+        :rtype: :class:`FrontierSlot`
         """
         return FrontierSlot(self._client, self, slot)
 
     def iter(self):
         """Iterate through slots.
 
         :return: an iterator over frontier slots names.
-        :rtype: collections.Iterate[str]
+        :rtype: :class:`collections.Iterate[str]`
         """
         return iter(self.list())
 
     def list(self):
         """List all slots.
 
         :return: a list of frontier slots names.
-        :rtype: List[str]
+        :rtype: :class:`list[str]`
         """
         return next(self._frontiers._origin.apiget((self.key, 'list')))
 
@@ -250,7 +250,7 @@ def f(self):
         """Shortcut to have quick access to slot fingerprints.
 
         :return: :class:`FrontierSlotFingerprints` instance.
-        :rtype: FrontierSlotFingerprints
+        :rtype: :class:`FrontierSlotFingerprints`
         """
         return self.fingerprints
 
@@ -259,7 +259,7 @@ def q(self):
         """Shortcut to have quick access to a slot queue.
 
         :return: :class:`FrontierSlotQueue` instance.
-        :rtype: FrontierSlotQueue
+        :rtype: :class:`FrontierSlotQueue`
         """
         return self.queue
 
@@ -303,7 +303,7 @@ def iter(self, **params):
 
         :param \*\*params: (optional) additional query params for the request.
         :return: an iterator over fingerprints.
-        :rtype: collections.Iterable[str]
+        :rtype: :class:`collections.Iterable[str]`
         """
         origin = self._frontier._frontiers._origin
         path = (self._frontier.key, 's', self.key, 'f')
@@ -315,7 +315,7 @@ def list(self, **params):
 
         :param \*\*params: (optional) additional query params for the request.
         :return: a list of fingerprints.
-        :rtype: List[str]
+        :rtype: :class:`list[str]`
         """
         return list(self.iter(**params))
 
@@ -339,7 +339,7 @@ def iter(self, mincount=None, **params):
         :param \*\*params: (optional) additional query params for the request.
         :return: an iterator over request batches in the queue where each
             batch is represented with a dict with ('id', 'requests') field.
-        :rtype: collections.Iterable[dict]
+        :rtype: :class:`collections.Iterable[dict]`
         """
         origin = self._frontier._frontiers._origin
         path = (self._frontier.key, 's', self.key, 'q')
@@ -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[dict]
+        :rtype: :class:`list[dict]`
         """
         return list(self.iter(mincount=mincount, **params))
 

scrapinghub/client/items.py

@@ -50,7 +50,7 @@ def _modify_iter_params(self, params):
         """Modify iter filter to convert offset to start parameter.
 
         :return: a dict with updated set of params.
-        :rtype: dict
+        :rtype: :class:`dict`
         """
         params = super(Items, self)._modify_iter_params(params)
         offset = params.pop('offset', None)

scrapinghub/client/jobs.py

@@ -58,7 +58,7 @@ def count(self, spider=None, state=None, has_tag=None, lacks_tag=None,
         :param \*\*params: (optional) other filter params.
 
         :return: jobs count.
-        :rtype: int
+        :rtype: :class:`int`
 
         Usage::
 
@@ -97,7 +97,7 @@ def iter(self, count=None, start=None, spider=None, state=None,
 
         :return: a generator object over a list of dictionaries of jobs summary
             for a given filter params.
-        :rtype: types.GeneratorType[dict]
+        :rtype: :class:`types.GeneratorType[dict]`
 
         Usage:
 
@@ -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[dict]
+        :rtype: :class:`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()
@@ -195,7 +195,7 @@ def run(self, spider=None, units=None, priority=None, meta=None,
         :param \*\*params: (optional) additional keyword args.
 
         :return: a job key string pointing to the new job.
-        :rtype: str
+        :rtype: :class:`str`
 
         Usage::
 
@@ -236,7 +236,7 @@ def get(self, job_key):
         the spider (if :attr:`Spider.jobs` was used).
 
         :return: :class:`Job` object.
-        :rtype: scrapinghub.client.jobs.Job
+        :rtype: :class:`Job`
 
         Usage::
 
@@ -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[dict]
+        :rtype: :class:`list[dict]`
 
         Usage::
 
@@ -288,7 +288,7 @@ def iter_last(self, start=None, start_after=None, count=None,
         :param \*\*params: (optional) additional keyword args.
         :return: a generator object over a list of dictionaries of jobs summary
             for a given filter params.
-        :rtype: types.GeneratorType[dict]
+        :rtype: :class:`types.GeneratorType[dict]`
 
         Usage:
 
@@ -341,7 +341,7 @@ def update_tags(self, add=None, remove=None, spider=None):
         have to specify ``spider`` param when using :attr:`Project.jobs`).
 
         :return: amount of jobs that were updated.
-        :rtype: int
+        :rtype: :class:`int`
 
         Usage:
 
@@ -436,7 +436,7 @@ def start(self, **params):
 
         :param \*\*params: (optional) keyword meta parameters to update.
         :return: a previous string job state.
-        :rtype: str
+        :rtype: :class:`str`
 
         Usage::
 
@@ -450,7 +450,7 @@ def finish(self, **params):
 
         :param \*\*params: (optional) keyword meta parameters to update.
         :return: a previous string job state.
-        :rtype: str
+        :rtype: :class:`str`
 
         Usage::
 
@@ -464,7 +464,7 @@ def delete(self, **params):
 
         :param \*\*params: (optional) keyword meta parameters to update.
         :return: a previous string job state.
-        :rtype: str
+        :rtype: :class:`str`
 
         Usage::
 
@@ -479,7 +479,7 @@ def update(self, state, **params):
         :param state: a new job state.
         :param \*\*params: (optional) keyword meta parameters to update.
         :return: a previous string job state.
-        :rtype: str
+        :rtype: :class:`str`
 
         Usage::
 

scrapinghub/client/logs.py

@@ -60,7 +60,7 @@ def _modify_iter_params(self, params):
 
         :param params: an original dictionary with params.
         :return: a modified dictionary with params.
-        :rtype: dict
+        :rtype: :class:`dict`
         """
         params = super(Logs, self)._modify_iter_params(params)
         offset = params.pop('offset', None)

scrapinghub/client/projects.py

@@ -32,7 +32,7 @@ def get(self, project_id):
 
         :param project_id: integer or string numeric project id.
         :return: :class:`Project` object.
-        :rtype: scrapinghub.client.projects.Project
+        :rtype: :class:`scrapinghub.client.projects.Project`
 
         Usage::
 
@@ -46,7 +46,7 @@ def list(self):
         """Get list of projects available to current user.
 
         :return: a list of project ids.
-        :rtype: List[int]
+        :rtype: :class:`list[int]`
 
         Usage::
 
@@ -61,7 +61,7 @@ def iter(self):
         Provided for the sake of API consistency.
 
         :return: an iterator over project ids list.
-        :rtype: collections.Iterable[int]
+        :rtype: :class:`collections.Iterable[int]`
         """
         return iter(self.list())
 
@@ -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[dict]
+        :rtype: :class:`list[dict]`
 
         Usage::