Skip to content
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

split 'vunit/ui.py' into a submodule/package 'vunit/ui/*' #572

Merged
merged 5 commits into from
Oct 22, 2019

Conversation

eine
Copy link
Collaborator

@eine eine commented Oct 21, 2019

The main motivation of this PR is to make it easier to navigate/edit classes and functions in vunit.ui.

  1. Classes Library, PackageFacade, Results, Test, etc. are moved to a separate file each.
  2. All the files are moved to subdir vunit/ui, and ui.py is renamed to vunit/ui__init__.py.
  3. Class VUnit is moved from vunit/ui/__init__.py to vunit/ui/vunit.py.
  4. Relative imports are used (required for Python 2.7).
  5. docs are updated. The docstring from ui.py (now vunit/ui/__init__.py) is moved/split to docs/py/vunit.rst and docs/py/opts.rst. And docs/python_interface.rst is renamed docs/py/ui.rst. Also, headers are added so that classes Library, Test, etc. are shown in the sidebar.

@eine eine force-pushed the split-ui branch 7 times, most recently from 5868046 to 0e4144a Compare October 21, 2019 21:52
@eine eine changed the title Split ui.py split 'vunit/ui.py' into a submodule/package 'vunit/ui/*' Oct 22, 2019
@eine eine merged commit fef1e26 into VUnit:master Oct 22, 2019
@eine eine deleted the split-ui branch October 22, 2019 17:48
eine pushed a commit to eine/vunit that referenced this pull request Oct 23, 2019
* refactor: split 'ui.py' into multiple 'ui_*.py' files
* refactor: split/move 'ui' to submodule
* ui: split 'VUnit' to ui/vunit.py
* ui: python2 requires relative imports
* docs: create subdir 'py', move content from py sources, add headers/subsections
eine pushed a commit to eine/vunit that referenced this pull request Oct 23, 2019
* refactor: split 'ui.py' into multiple 'ui_*.py' files
* refactor: split/move 'ui' to submodule
* ui: split 'VUnit' to ui/vunit.py
* ui: python2 requires relative imports
* docs: create subdir 'py', move content from py sources, add headers/subsections
eine pushed a commit to eine/vunit that referenced this pull request Oct 23, 2019
* refactor: split 'ui.py' into multiple 'ui_*.py' files
* refactor: split/move 'ui' to submodule
* ui: split 'VUnit' to ui/vunit.py
* ui: python2 requires relative imports
* docs: create subdir 'py', move content from py sources, add headers/subsections
eine pushed a commit to eine/vunit that referenced this pull request Oct 23, 2019
* refactor: split 'ui.py' into multiple 'ui_*.py' files
* refactor: split/move 'ui' to submodule
* ui: split 'VUnit' to ui/vunit.py
* ui: python2 requires relative imports
* docs: create subdir 'py', move content from py sources, add headers/subsections
eine pushed a commit to eine/vunit that referenced this pull request Oct 23, 2019
* refactor: split 'ui.py' into multiple 'ui_*.py' files
* refactor: split/move 'ui' to submodule
* ui: split 'VUnit' to ui/vunit.py
* ui: python2 requires relative imports
* docs: create subdir 'py', move content from py sources, add headers/subsections
eine pushed a commit to eine/vunit that referenced this pull request Oct 23, 2019
* refactor: split 'ui.py' into multiple 'ui_*.py' files
* refactor: split/move 'ui' to submodule
* ui: split 'VUnit' to ui/vunit.py
* ui: python2 requires relative imports
* docs: create subdir 'py', move content from py sources, add headers/subsections
eine pushed a commit to eine/vunit that referenced this pull request Oct 23, 2019
* refactor: split 'ui.py' into multiple 'ui_*.py' files
* refactor: split/move 'ui' to submodule
* ui: split 'VUnit' to ui/vunit.py
* ui: python2 requires relative imports
* docs: create subdir 'py', move content from py sources, add headers/subsections
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant