tracim.lib.core.notifications

Complexity

Total Complexity

6

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	INotifier.notify_content_update()	0	2	1
A	INotifier.__init__()	0	2	1
A	DummyNotifier.notify_content_update()	0	5	1
A	DummyNotifier.__init__()	0	3	1
A	NotifierFactory.create()	0	5	2

# -*- coding: utf-8 -*-

This module should have a docstring.

from tracim.lib.utils.logger import logger
from tracim.models.auth import User
from tracim.models.data import Content


class INotifier(object):
    """
    Interface for Notifier instances
    """
    def __init__(self, config, current_user: User=None):

Exactly one space required around keyword argument assignment

        pass

    def notify_content_update(self, content: Content):

This method should have a docstring.

        raise NotImplementedError


class NotifierFactory(object):

This class should have a docstring.

The variable __class__ seems to be unused.

    @classmethod
    def create(cls, config, current_user: User=None) -> INotifier:

Exactly one space required around keyword argument assignment

This method should have a docstring.

        if not config.EMAIL_NOTIFICATION_ACTIVATED:
            return DummyNotifier(config, current_user)
        return EmailNotifier(config, current_user)


class DummyNotifier(INotifier):

This class should have a docstring.

The variable __class__ seems to be unused.

    send_count = 0

    def __init__(self, config, current_user: User=None):

Exactly one space required around keyword argument assignment

        INotifier.__init__(config, current_user)
        logger.info(self, 'Instantiating Dummy Notifier')

    def notify_content_update(self, content: Content):
        type(self).send_count += 1
        logger.info(
            self,
            'Fake notifier, do not send notification for update of content {}'.format(content.content_id)  # nopep8

This line is too long as per the coding-style (115/100).

        )


class EmailNotifier(INotifier):

This class should have a docstring.

The method notify_content_update which was declared abstract in the super-class INotifier
was not overridden.

    # TODO - G.M [emailNotif] move and restore Email Notifier in another file.

TODO and FIXME comments should generally be avoided.

    pass