Add converters package

This commit is contained in:
Joakim Soderlund 2017-11-08 16:59:22 +01:00
parent d9619e993a
commit bdb7382e4e
3 changed files with 81 additions and 0 deletions

View file

@ -0,0 +1,30 @@
"""
Converter module.
"""
#
# Fimfarchive, preserves stories from Fimfiction.
# Copyright (C) 2015 Joakim Soderlund
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
from .base import Converter
__all__ = (
'Converter',
)

View file

@ -0,0 +1,50 @@
"""
Converter base class.
"""
#
# Fimfarchive, preserves stories from Fimfiction.
# Copyright (C) 2015 Joakim Soderlund
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
from abc import ABC, abstractmethod
from fimfarchive.stories import Story
__all__ = (
'Converter',
)
class Converter(ABC):
"""
Converter for stories.
"""
@abstractmethod
def __call__(self, story: Story) -> Story:
"""
Applies the conversion.
Args:
*story: The story to convert.
Returns:
A converted story.
"""

View file

@ -27,6 +27,7 @@ import pytest
MODULES = ( MODULES = (
'commands', 'commands',
'converters',
'exceptions', 'exceptions',
'fetchers', 'fetchers',
'flavors', 'flavors',