IN-907 Define classes for XML feeds #106
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonavellecuerdo
force-pushed
the
IN-907-define-feed-classes
branch
from
00c9fec to
8f08aa0
Compare
Why these changes are being introduced: * Improve code coherency by encapsulating functions for creating and running XML feeds in classes based on feed type. How this addresses that need: * Update app module to use XML feed classes * Rename classes in app module: * Writer -> FileWriter * PipeWriter -> ConcurrentFileWriter * FtpFileWriter (fka FTPReader) -> FtpFile * Move tests for helper functions to test_helpers.py Side effects of this change: * None Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/IN-907
jonavellecuerdo
force-pushed
the
IN-907-define-feed-classes
branch
from
8f08aa0 to
0ff26a2
Compare
ehanson8
reviewed
Sep 11, 2023
ehanson8
approved these changes
Sep 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Introduce a module (
feed.py) containing classes for creatingtwo types of XML feeds--
PeopleXmlFeedandArticlesXmlFeedto improve code coherency.Encapsulating the previously 'loose' functions in
app.pyinto these two classes results incleaner and more readable code, which will make it easier for future developers to maintain
and/or introduce new features to the Carbon application.
Helpful background context
feed.pyConsists of a 'base' XML feed class that is used by thePeopleXmlFeed' andArticlesXmlFeed` subclasses.How can a reviewer manually see the effects of these changes?
IN-907-define-feed-classes.make install.make lint.make test.All tests should pass, and since
carbon.app.FileWriterand allpytesttests have been updated to use the XML feed classes, it's safe to say that the XML feed class methods work as expected!Includes new or updated dependencies?
NO
Developer
Code Reviewer
(not just this pull request message)