From bdb7382e4efd323f667cedfedad6875131640281 Mon Sep 17 00:00:00 2001 From: Joakim Soderlund Date: Wed, 8 Nov 2017 16:59:22 +0100 Subject: [PATCH] Add converters package --- fimfarchive/converters/__init__.py | 30 ++++++++++++++++++ fimfarchive/converters/base.py | 50 ++++++++++++++++++++++++++++++ tests/test_imports.py | 1 + 3 files changed, 81 insertions(+) create mode 100644 fimfarchive/converters/__init__.py create mode 100644 fimfarchive/converters/base.py diff --git a/fimfarchive/converters/__init__.py b/fimfarchive/converters/__init__.py new file mode 100644 index 0000000..54b534d --- /dev/null +++ b/fimfarchive/converters/__init__.py @@ -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 . +# + + +from .base import Converter + + +__all__ = ( + 'Converter', +) diff --git a/fimfarchive/converters/base.py b/fimfarchive/converters/base.py new file mode 100644 index 0000000..aea8913 --- /dev/null +++ b/fimfarchive/converters/base.py @@ -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 . +# + + +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. + """ diff --git a/tests/test_imports.py b/tests/test_imports.py index ef3d234..be4a974 100644 --- a/tests/test_imports.py +++ b/tests/test_imports.py @@ -27,6 +27,7 @@ import pytest MODULES = ( 'commands', + 'converters', 'exceptions', 'fetchers', 'flavors',