Restapi refactor #2890
Closed
Restapi refactor #2890
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
This is a first step and only adds docstrings, etc. It doesn't refactor any code.
cmc333333
force-pushed
the
restapi-linting
branch
2 times, most recently
from
ad0578b to
de4ffb1
Compare
added 4 commits
May 22, 2017 23:54
In several cases, we can use the provided `request` rather than access `self` (which could make these functions easier to test in isolation). In others, the unused args could be folded into an unnamed kwarg param.
Smaller functions should be easier to test independently. This will also resolve a pyflakes warning.
This worked as intended, but only because the overridden section variable would later evaluate to True. Using a different variable name makes this a bit less error-prone.
By splitting the function up, we not only resolve pyflakes issues around local variables, we also make this function easier to test. I don't like the SectionIndexer approach, but there was a chunk of state (section_index_list) which was extended in each loop iteration. To recreate that functionality while limiting the number of lines in each loop, the state is moved into a separate object. If the original logic was faulty, this could be much more legible.
cmc333333
force-pushed
the
restapi-linting
branch
from
de4ffb1 to
c955155
Compare
|
Okay, so i've cherry-picked the linting changes in #2938 and got that merged, so lets view this as a refactor only PR -- could you rebase, or perhaps it's easier to even just create a new branch? Whatever works. The refactor here was slowing this PR down and I think there might need to be some more back and forth before the refactor gets merged. Some of the patterns in the refactor could be reduced or more generalized, so I'd like to find a good balance there. |
agjohnson
added
PR: work in progress
agjohnson
removed
the
PR: work in progress
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This includes some simple tweaks in addition to slightly more significant refactors to split up some functions. Easiest to review changeset by changeset.