Issues (29)

fizzbotz/util.py (6 issues)

Check that every module, function, class and method has a docstring.

Coding Style Informational
1
import aiohttp
0 ignored issues
show
This module should have a docstring.

The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods:

class SomeClass:
    def some_method(self):
        """Do x and return foo."""

If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions.

Loading history...
2
import asyncio
3
4
5
@asyncio.coroutine
6
def get_markup(url):
0 ignored issues
show
This function should have a docstring.

The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods:

class SomeClass:
    def some_method(self):
        """Do x and return foo."""

If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions.

Loading history...
7
    response = yield from aiohttp.get(url)
8
    markup = yield from response.text()
9
    return markup
10
11
12
class Buffer:
0 ignored issues
show
This class should have a docstring.

The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods:

class SomeClass:
    def some_method(self):
        """Do x and return foo."""

If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions.

Loading history...
13
    def __init__(self, get_item_class, queue_size=20):
14
        self.queue_size = queue_size
15
        self.queue = asyncio.Queue(maxsize=self.queue_size)
16
        self.get_item_class = get_item_class
17
18
    @asyncio.coroutine
19
    def populate(self):
0 ignored issues
show
This method should have a docstring.

The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods:

class SomeClass:
    def some_method(self):
        """Do x and return foo."""

If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions.

Loading history...
20
        for _ in range(self.queue_size):
21
            yield from asyncio.async(self._put_new_entry())
22
23
    @asyncio.coroutine
24
    def get(self):
0 ignored issues
show
This method should have a docstring.

The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods:

class SomeClass:
    def some_method(self):
        """Do x and return foo."""

If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions.

Loading history...
25
        item = yield from self.queue.get()
26
        yield from asyncio.async(self._put_new_entry())
27
        return item
28
29
    @asyncio.coroutine
30
    def _put_new_entry(self):
0 ignored issues
show
This method should have a docstring.

The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods:

class SomeClass:
    def some_method(self):
        """Do x and return foo."""

If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions.

Loading history...
31
        item = yield from self.get_item_class.get()
32
        self.queue.put_nowait(item)
33