From ef4512fd6fa42699db445b61dcb6ef7328009b4f Mon Sep 17 00:00:00 2001 From: stubbfel Date: Sun, 24 Aug 2014 22:30:20 +0200 Subject: [PATCH] add coments --- src/feed/feed.py | 49 +++++++++- src/utilities/serializer.py | 3 +- testenv/testfeeds/podcast/sbk/sbk.json | 120 ++++++++++++------------- 3 files changed, 109 insertions(+), 63 deletions(-) diff --git a/src/feed/feed.py b/src/feed/feed.py index c0f6638..9495aa8 100644 --- a/src/feed/feed.py +++ b/src/feed/feed.py @@ -9,6 +9,13 @@ import utilities.file_methods as fm class Feed: def __init__(self, feed_name=None, feed_type=None, link_type=None, feed_url=None): + """ + method ini a feed object + :param feed_name: str - name of the feed + :param feed_type: str - type of the feed + :param link_type: str - application type of the episodes + :param feed_url: str - url of the feed + """ self.config_path = None self.feed_folder_path = None self.feed_config = None @@ -18,16 +25,26 @@ class Feed: self.setup_feed(feed_name, feed_type, link_type, feed_url) def load_feed(self): + """ + method load a feed from the FeedUrl + :return: FeedParserDict - the feed as a dict + """ assert self.feed_config is not None return feedparser.parse(self.feed_config["FeedUrl"]) def load_new_feed(self): + """ + method load a feed and write the feed json file, which has no feed folder + """ assert (not os.path.exists(self.feed_file_path)) assert (self.serializer is not None) fm.write_feed_json_file(self.feed_file_path, self.load_feed(), self.serializer) def load_existing_feed(self): + """ + method load a feed and write the feed json file, which has a feed folder + """ assert (os.path.exists(self.feed_file_path)) assert (self.serializer is not None) @@ -40,11 +57,22 @@ class Feed: fm.check_and_remove_file(tmp_feed_file_path) def get_serializer(self): + """ + Method get the correct serializer + :return: Serializer - the serializer of the feed + """ return { "podcast": PodcastSerializer(self.feed_config["LinkType"]) }.get(self.feed_config["FeedType"], PodcastSerializer(self.feed_config["LinkType"])) def setup_feed(self, feed_name, feed_type, link_type, feed_url): + """ + method create, read, write the feed config, determine serializer + :param feed_name: str - name of the feed + :param feed_type: str - type of the feed + :param link_type: str - application type of the episodes + :param feed_url: str - url of the feed + """ assert feed_name is not None assert feed_type is not None assert link_type is not None @@ -59,7 +87,10 @@ class Feed: self.serializer = self.get_serializer() def new_feed_folder(self): - + """ + method creates a feed folder + :return: str - return the path of the new folder + """ if self.feed_folder_path is None: assert self.feed_config is not None self.feed_folder = Config.get("FeedStorageFolder") @@ -84,16 +115,32 @@ class Feed: return self.feed_folder_path def create_feed_config_path(self): + """ + method determine the path of the config file + :return: str - path of the config file + """ if self.config_path is None: self.config_path = self.new_feed_folder() + "/" + self.feed_config["FeedName"] + Config[ "ConfigFileSuffix"] + Config["ConfigFileExtension"] return self.config_path def write_feed_config_file(self): + """ + method write the config file + """ + assert (self.feed_config is not None) fm.write_json_file(self.create_feed_config_path(), self.feed_config) @staticmethod def create_feed_config_file(feed_name, feed_type, link_type, feed_url): + """ + method creates a config dict + :param feed_name: str - name of the feed + :param feed_type: str - type of the feed + :param link_type: str - application type of the episodes + :param feed_url: str - url of the feed + :return: dict : config of the feed + """ assert feed_name is not None assert feed_type is not None assert link_type is not None diff --git a/src/utilities/serializer.py b/src/utilities/serializer.py index 170bf1d..a2dc642 100644 --- a/src/utilities/serializer.py +++ b/src/utilities/serializer.py @@ -8,8 +8,7 @@ class Serializer(): method convert i dict to a string. this method should be override by any subclasses :param dict_object: object wich his to bee convert to a string - :return: rhe string reprasention of the dict_object - :depicated + :return: the string reprasention of the dict_object """ assert isinstance(dict_object, dict) return dict_object \ No newline at end of file diff --git a/testenv/testfeeds/podcast/sbk/sbk.json b/testenv/testfeeds/podcast/sbk/sbk.json index 932269b..457fdfe 100644 --- a/testenv/testfeeds/podcast/sbk/sbk.json +++ b/testenv/testfeeds/podcast/sbk/sbk.json @@ -1,152 +1,152 @@ { - "title": "Staatsb\u00fcrgerkunde", "subtitle": "Vom Leben in der DDR", "episodes": [ { - "title": "SBK028 Arbeit", "subtitle": "Von Kollektivleistungen, Planstellen und dem Lohn der Arbeit", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK028_Arbeit.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK028_Arbeit.mp3.torrent", + "title": "SBK028 Arbeit" }, { - "title": "SBK027 Lehrerberuf", "subtitle": "Vom Traumberuf, Experimenten und Schulpolitik", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK027_Lehrerberuf.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK027_Lehrerberuf.mp3.torrent", + "title": "SBK027 Lehrerberuf" }, { - "title": "SBK026 Lebensmittel", "subtitle": "Vom Konsum, geheimem Rotwein und Tieren ohne Lenden", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK026_Lebensmittel.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK026_Lebensmittel.mp3.torrent", + "title": "SBK026 Lebensmittel" }, { - "title": "SBK025 Wohnen", "subtitle": "Von sch\u00f6nen Plattenbauten, viel Kohle und ganz viel Eigenleistung", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK025_Wohnen.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK025_Wohnen.mp3.torrent", + "title": "SBK025 Wohnen" }, { - "title": "SBK024 Kirchenmusik", "subtitle": "Von gezogenen Registern, ungew\u00f6hnlichen Berufswegen und gro\u00dfer Musik", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK024_Kirchenmusik.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK024_Kirchenmusik.mp3.torrent", + "title": "SBK024 Kirchenmusik" }, { - "title": "SBK023 Feier- und Gedenktage", "subtitle": "Von Halbtags-Demonstranten, Papiertauben und Tagedieben", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK023_Feier_und_Gedenktage.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK023_Feier_und_Gedenktage.mp3.torrent", + "title": "SBK023 Feier- und Gedenktage" }, { - "title": "SBK022 Station", "subtitle": "Vom Forscherdrang, Wechselblinkern und n\u00e4chtlichen Bastelrunden", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK022_Station.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK022_Station.mp3.torrent", + "title": "SBK022 Station" }, { - "title": "SBK021 Wahlen", "subtitle": "Wir sprechen \u00fcber Blockparteien, gefaltete Zettel und Wahlbeobachtungen in beide Richtungen.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK021_Wahlen.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK021_Wahlen.mp3.torrent", + "title": "SBK021 Wahlen" }, { - "title": "SBK020 Gesundheitssystem", "subtitle": "Gesundheit \u2013 ist das Thema unserer heutigen Folge. Wie war es, wenn man in der DDR krank war und zum Arzt, zur \u00c4rztin oder gar ins Krankenhaus musste? Wie war man krankenversichert und warum sind Polikliniken auch heute noch modern?", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK020_Gesundheitssystem.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK020_Gesundheitssystem.mp3.torrent", + "title": "SBK020 Gesundheitssystem" }, { - "title": "SBK019 NVA", "subtitle": "Wir sprechen \u00fcber den Grundwehrdienst meines Vaters in der Nationalen Volksarmee und welche Erfahrungen er und wir in dieser Zeit gemacht haben.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK019_NVA.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK019_NVA.mp3.torrent", + "title": "SBK019 NVA" }, { - "title": "SBK018 Ausreise (Teil 2)", "subtitle": "Die Ausreise ist genehmigt \u2013 wie ging es nun weiter? Wir sprechen in dieser Folge \u00fcber die Zeit bis zum Ausreisetag, unsere Ankunft in der BRD und die ersten Schritte in diesem f\u00fcr uns neuen Land.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK018_Ausreise_Teil_2.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK018_Ausreise_Teil_2.mp3.torrent", + "title": "SBK018 Ausreise (Teil 2)" }, { - "title": "SBK017 Ausreise (Teil 1)", "subtitle": "Meine Eltern haben 1987 einen Ausreiseantrag gestellt. Warum sie diesen Schritt gewagt haben, welche Konsequenzen er mit sich brachte und was w\u00e4hrend der zweij\u00e4hrigen Wartezeit bis zur Ausreisegenehmigung alles geschah, dar\u00fcber sprechen wir in dieser Folge.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK017_Ausreise_Teil_1.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK017_Ausreise_Teil_1.mp3.torrent", + "title": "SBK017 Ausreise (Teil 1)" }, { - "title": "SBK016 Geschlechterrollen", "subtitle": "Ost, West, Mann, Frau: Mit Katrin R\u00f6nicke spreche ich \u00fcber die unterschiedlichen Geschlechterbilder in der DDR und der BRD und wie es war, als M\u00e4dchen oder Junge in den beiden Deutschlands aufzuwachsen.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK016_Geschlechterrollen.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK016_Geschlechterrollen.mp3.torrent", + "title": "SBK016 Geschlechterrollen" }, { - "title": "SBK015 Deutsche Reichsbahn", "subtitle": "Alle einsteigen und Vorsicht bei der Abfahrt! Mit Ingo Ebel spreche ich in dieser Episode \u00fcber die Deutsche Reichsbahn.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK015_Deutsche_Reichsbahn.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK015_Deutsche_Reichsbahn.mp3.torrent", + "title": "SBK015 Deutsche Reichsbahn" }, { - "title": "SBK014 Weihnachten", "subtitle": "In der letzten Sendung f\u00fcr 2012 sprechen wir \u00fcber das Weihnachtsfest in der DDR.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK014_Weihnachten.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK014_Weihnachten.mp3.torrent", + "title": "SBK014 Weihnachten" }, { - "title": "SBK013 Computer", "subtitle": "Die Anf\u00e4nge des digitalen Zeitalters in der DDR besch\u00e4ftigen meinen Papa und mich in dieser Episode.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK013_Computer.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK013_Computer.mp3.torrent", + "title": "SBK013 Computer" }, { - "title": "SBK012 Kino", "subtitle": "In Spielfilml\u00e4nge pr\u00e4sentiert sich die aktuelle Episode. Mit Eric vom Kinocast spreche ich \u00fcber das Kino in der DDR.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK012_Kino.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK012_Kino.mp3.torrent", + "title": "SBK012 Kino" }, { - "title": "SBK011 Radio und Fernsehfunk", "subtitle": "Die Massenmedien Radio und Fernsehen besch\u00e4ftigen uns im dritten Teil unserer Medienreihe. Darin sprechen wir \u00fcber den Rundfunk in der DDR.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK011_Radio_und_Fernsehfunk.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK011_Radio_und_Fernsehfunk.mp3.torrent", + "title": "SBK011 Radio und Fernsehfunk" }, { - "title": "SBK010 B\u00fccher", "subtitle": "In dieser Ausgabe \u2013 dem zweiten Teil unserer Medienreihe \u2013 sprechen wir \u00fcber B\u00fccher in der DDR.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK010_Buecher.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK010_Buecher.mp3.torrent", + "title": "SBK010 B\u00fccher" }, { - "title": "SBK009 Zeitungen und Zeitschriften", "subtitle": "In dieser und den n\u00e4chsten beiden Episoden sprechen wir \u00fcber verschiedene DDR-Medien, von der gedruckten Zeitung \u00fcber B\u00fccher bis hin zum Rundfunk. Im ersten Teil schauen wir uns das Presseangebot etwas genauer an.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK009_Zeitungen_und_Zeitschriften.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK009_Zeitungen_und_Zeitschriften.mp3.torrent", + "title": "SBK009 Zeitungen und Zeitschriften" }, { - "title": "SBK008 Comic MOSAIK", "subtitle": "Comics in der DDR? Klar, auch die gab es! Und deren ber\u00fchmtester Vertreter ist das MOSAIK. Ich spreche mit dem k\u00fcnstlerischen Leiter des MOSAIK, J\u00f6rg Reuter, \u00fcber seine Zeit als Comicmacher in der DDR \u2013 und heute.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK008_Comic_MOSAIK.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK008_Comic_MOSAIK.mp3.torrent", + "title": "SBK008 Comic MOSAIK" }, { - "title": "SBK007 Verkehrsmittel", "subtitle": "Wie kam man als DDR-B\u00fcrger von A nach B? Zu Fu\u00df, mit Bus und Bahn oder gar mit dem eigenen Auto? Womit man in der DDR alles unterwegs war, dar\u00fcber sprechen wir in der heutigen Episode.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK007_Verkehrsmittel.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK007_Verkehrsmittel.mp3.torrent", + "title": "SBK007 Verkehrsmittel" }, { - "title": "SBK006 Urlaub", "subtitle": "Sommer, Sonne, Strand und Meer: Auch in der DDR zog es die Menschen im Urlaub in die Ferne. In unserer Urlaubsfolge sprechen wir in gewohnter Besetzung \u00fcber Ferienspiele, wichtige Anmeldelisten und FDGB-Heime.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK006_Urlaub.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK006_Urlaub.mp3.torrent", + "title": "SBK006 Urlaub" }, { - "title": "SBK005 Spielekopien", "subtitle": "Die Brettspiele Monopoly, Sagaland oder Scotland Yard gab es in der DDR nicht zu kaufen. Und sie wurden dennoch gespielt, weil kreative Bastler sie einfach nachgemacht haben. Das Projekt \"Nachgemacht\" rettet solche Spielekopien vor dem Vergessen.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK005_Spielekopien.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK005_Spielekopien.mp3.torrent", + "title": "SBK005 Spielekopien" }, { - "title": "SBK004 Kleidung und Mode", "subtitle": "Diese Folge ist komplett durchgestylt: Wir sprechen \u00fcber Kleidung und Mode in der DDR.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK004_Kleidung_und_Mode.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK004_Kleidung_und_Mode.mp3.torrent", + "title": "SBK004 Kleidung und Mode" }, { - "title": "SBK003 Schulsystem (Teil 2)", "subtitle": "Nahtlos schlie\u00dfen wir an die letzte Folge an und sprechen \u00fcber den Oberstufenunterricht im DDR-Schulsystem.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK003_Schulsystem_Teil_2.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK003_Schulsystem_Teil_2.mp3.torrent", + "title": "SBK003 Schulsystem (Teil 2)" }, { - "title": "SBK002 Schulsystem (Teil 1)", "subtitle": "Auf dem Stundenplan steht heute das Schulsystem in der DDR. Aufgrund der vielen Aspekte, die dieses Themenfeld in sich birgt, ist diese Ausgabe der erste Teil einer Doppelfolge.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK002_Schulsystem_Teil_1.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK002_Schulsystem_Teil_1.mp3.torrent", + "title": "SBK002 Schulsystem (Teil 1)" }, { - "title": "SBK001 Stab\u00fc", "subtitle": "Die erste Folge nimmt sich das Schulfach vor, das dem Podcast seinen Namen gegeben hat: Staatsb\u00fcrgerkunde oder kurz \"Stab\u00fc\" genannt. Welchem Zweck diente dieses Fach? Welche Inhalte sollten im Unterricht vermittelt werden? Und wie gingen Lehrer und Sch\u00fcler mit offensichtlichen Widerspr\u00fcchen zwischen Fach und Realit\u00e4t um?", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK001_Stabue.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK001_Stabue.mp3.torrent", + "title": "SBK001 Stab\u00fc" }, { - "title": "SBK000 Nullnummer", "subtitle": "Los geht's: Die Nullnummer ist da! Darin erkl\u00e4re ich, was ich mit \"Staatsb\u00fcrgerkunde\" vorhabe, wann die erste regul\u00e4re Folge zu h\u00f6ren sein wird um worum es darin geht.", - "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK000_Nullnummer.mp3.torrent" + "filelink": "http://bitlove.org/nitramred/staatsbuergerkunde-mp3/SBK000_Nullnummer.mp3.torrent", + "title": "SBK000 Nullnummer" } ], - "summary": "Ein Podcast \u00fcber das Leben in der DDR. Im Gespr\u00e4ch mit G\u00e4sten schaut Martin Fischer in jeder Folge zur\u00fcck auf die Lebensaspekte eines B\u00fcrgers der ehemaligen Deutschen Demokratischen Republik. Vom Schulsystem, dem kulturellen Leben bis hin zu den politischen Repressionen reicht das Themenspektrum. Der Podcast erscheint ungef\u00e4hr alle drei Wochen." + "summary": "Ein Podcast \u00fcber das Leben in der DDR. Im Gespr\u00e4ch mit G\u00e4sten schaut Martin Fischer in jeder Folge zur\u00fcck auf die Lebensaspekte eines B\u00fcrgers der ehemaligen Deutschen Demokratischen Republik. Vom Schulsystem, dem kulturellen Leben bis hin zu den politischen Repressionen reicht das Themenspektrum. Der Podcast erscheint ungef\u00e4hr alle drei Wochen.", + "title": "Staatsb\u00fcrgerkunde" } \ No newline at end of file