Refactor the frontend. #89
Merged
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
dvander
force-pushed
the
refactor
branch
7 times, most recently
from
1ef45fe
to
a083596
Compare
WildCard65
reviewed
Aug 12, 2020
Comment on lines
+101
to
+104
| if api_version >= '2.1': | ||
| from ambuild2.frontend.v2_1.context_manager import ContextManager | ||
| elif api_version >= '2.0': | ||
| from ambuild2.frontend.v2_0.context_manager import ContextManager |
There was a problem hiding this comment.
I have a better import suggestion:
Suggested change
| if api_version >= '2.1': | |
| from ambuild2.frontend.v2_1.context_manager import ContextManager | |
| elif api_version >= '2.0': | |
| from ambuild2.frontend.v2_0.context_manager import ContextManager | |
| ContextManager = __import__('ambuild2.frontend.v{0}.context_manager'.format(api_version.replace('.', '_')), | |
| fromlist=('*',)).ContextManager |
Idk if it's format correct though.
WildCard65
reviewed
Aug 12, 2020
Comment on lines
+110
to
+113
| if 'originalCwd' in self.vars: | ||
| originalCwd = self.vars['originalCwd'] | ||
| else: | ||
| originalCwd = self.vars['sourcePath'] |
There was a problem hiding this comment.
'self.vars' is just a dict no? If so, this is simpler to read is it not?
Suggested change
| if 'originalCwd' in self.vars: | |
| originalCwd = self.vars['originalCwd'] | |
| else: | |
| originalCwd = self.vars['sourcePath'] | |
| originalCwd = self.vars.get('originalCwd', self.vars['sourcePath']) |
WildCard65
reviewed
Aug 12, 2020
|
|
||
| @property | ||
| def backend(self): | ||
| raise Exception('Must be implemented!') |
There was a problem hiding this comment.
If we were using pylint for linting, you'll be chewed out for using Exception
Suggested change
| raise Exception('Must be implemented!') | |
| raise NotImplementedError('Must be implemented!') |
Infact, we can just turn this into an instance of ABCMeta no?
Though to do that, we require the "six" module.
WildCard65
reviewed
Aug 12, 2020
| raise Exception('Must be implemented!') | ||
|
|
||
| def addSymlink(self, context, source, output_path): | ||
| raise Exception('Must be implemented!') |
There was a problem hiding this comment.
Suggested change
| raise Exception('Must be implemented!') | |
| raise NotImplementedError('Must be implemented!') |
WildCard65
reviewed
Aug 12, 2020
| raise Exception('Must be implemented!') | ||
|
|
||
| def addFolder(self, context, folder): | ||
| raise Exception('Must be implemented!') |
There was a problem hiding this comment.
Suggested change
| raise Exception('Must be implemented!') | |
| raise NotImplementedError('Must be implemented!') |
WildCard65
reviewed
Aug 12, 2020
| raise Exception('Must be implemented!') | ||
|
|
||
| def addCopy(self, context, source, output_path): | ||
| raise Exception('Must be implemented!') |
There was a problem hiding this comment.
Suggested change
| raise Exception('Must be implemented!') | |
| raise NotImplementedError('Must be implemented!') |
WildCard65
reviewed
Aug 12, 2020
| weak_inputs = [], | ||
| shared_outputs = [], | ||
| env_data = None): | ||
| raise Exception('Must be implemented!') |
There was a problem hiding this comment.
Suggested change
| raise Exception('Must be implemented!') | |
| raise NotImplementedError('Must be implemented!') |
WildCard65
reviewed
Aug 12, 2020
| raise Exception('Must be implemented!') | ||
|
|
||
| def addConfigureFile(self, context, path): | ||
| raise Exception('Must be implemented!') |
There was a problem hiding this comment.
Suggested change
| raise Exception('Must be implemented!') | |
| raise NotImplementedError('Must be implemented!') |
When it was time to do the 2.1 API, I figured it'd be good to simply copy and paste the entire frontend to minimize compatibility issues. That doesn't really work because a good deal of code (eg the database) is shared, so really everything in one API has to be sensitive to the overall system. Also, a great deal of delicate code (amb2.py, for example), winds up duplicated with very little changes. This patch splits the API-specific stuff out of generators, so we can reduce the number of generators from 4 to 2. The API specific parts have been renamed to what they actually are: ContextManagers. Some of that can be shared and now exists in a base class, but most of the details of context management will remain API specific. An amount of the C++-specific stuff has been moved out of generators as well, since this tended to be API specific. While we're at it, this also simplifies the directory structure a bit.
|
Thanks for the tips, I'll keep this in mind as I rejigger stuff for 2.2. |
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.
When it was time to do the 2.1 API, I figured it'd be good to simply
copy and paste the entire frontend to minimize compatibility issues.
That doesn't really work because a good deal of code (eg the database)
is shared, so really everything in one API has to be sensitive to the
overall system. Also, a great deal of delicate code (amb2.py, for
example), winds up duplicated with very little changes.
This patch splits the API-specific stuff out of generators, so we can
reduce the number of generators from 4 to 2. The API specific parts have
been renamed to what they actually are: ContextManagers. Some of that
can be shared and now exists in a base class, but most of the details of
context management will remain API specific.
An amount of the C++-specific stuff has been moved out of generators as
well, since this tended to be API specific.
While we're at it, this also simplifies the directory structure a bit.