-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Importer restructure #5624
Open
semohr
wants to merge
20
commits into
beetbox:master
Choose a base branch
from
semohr:importer-restructure
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Importer restructure #5624
Conversation
This file contains 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
Makes this more readable in my opinion, we also now have typehints for the import state.
we have slightly different behavior.
in util. Also run poe format
The return type of the stage decorator should in theory be `T|None` but the return of task types is not consistent in its usage. Would need some bigger changes for which I'm not ready at the moment.
responsibilities. I identified the following: - session - state - tasks - stages Should allow to make changes more rapidly in the future.
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.
Description
Hello y'all, when working on the importer.py file in a previous PR I noticed that this file grew quite large and badly needs a restructuring. Restructuring should improve our ability to apply changes to it in the future and isolate sub-functionalities within the importer.
Overview
For now I only changed the structure keeping the code (mostly) unchanged.
I split the functions and classes in the importer.py into the following responsibilities:
importer/session.py
: Includes theImportSession
class.importer/stages.py
: Includes all stage functions, I prefixed the helper functions with a_
to allow distinguishing between stages and helper functions more easily.importer/state.py
: Includes the logic for theImportState
handling i.e. the resume feat.importer/tasks.py
: Includes theImportTask
class and all derived classes. Also includes theAction
enum which I have renamed fromaction
.importer/__init__.py
: Identified all public facing classes and functions and added them to__all__
Potential future changes
I don't want to add this to this PR but there are some places here where I see possible improvements for our code:
Am happy to tackle some of these issues in future PRs if you also think they are worth it.
Best,
Sebastian
Note: This PR is based on #5611 and can only be merged once the typing additions are accepted.