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

HasEnvironment: Ensure that kernel_invariants always exists #2465

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

charlesbaynham
Copy link
Contributor

@charlesbaynham charlesbaynham commented Jun 28, 2024

ARTIQ Pull Request

Description of Changes

A simple usability tweak. Ensures that kernel_invariants always exists, so that user code doesn't need to add the usual boilerplate of self.kernel_invariants = getattr(self, "kernel_invariants", set()) before each addition.

Related Issue

Type of Changes

Type
✨ New feature

Steps (Choose relevant, delete irrelevant before submitting)

All Pull Requests

  • Use correct spelling and grammar.
  • Update RELEASE_NOTES.rst if there are noteworthy changes, especially if there are changes to existing APIs.
  • Close/update issues.
  • Check the copyright situation of your changes and sign off your patches (git commit --signoff, see copyright).

Code Changes

  • Run flake8 to check code style (follow PEP-8 style). flake8 has issues with parsing Migen/gateware code, ignore as necessary.
  • Test your changes or have someone test them. Mention what was tested and how.
  • Add and check docstrings and comments
  • Check, test, and update the unittests in /artiq/test/ or gateware simulations in /artiq/gateware/test

Documentation Changes

  • Check, test, and update the documentation in doc/. Build documentation (cd doc/manual/; make html) to ensure no errors.

Git Logistics

  • Split your contribution into logically separate changes (git rebase --interactive). Merge/squash/fixup commits that just fix or amend previous commits. Remove unintended changes & cleanup. See tutorial.
  • Write short & meaningful commit messages. Review each commit for messages (git show). Format:
    topic: description. < 50 characters total.
    
    Longer description. < 70 characters per line
    

Licensing

See copyright & licensing for more info.
ARTIQ files that do not contain a license header are copyrighted by M-Labs Limited and are licensed under LGPLv3+.

Signed-off-by: Charles Baynham <c.baynham@imperial.ac.uk>
@sbourdeauducq
Copy link
Member

This breaks abstraction layers, HasEnvironment does not otherwise know about kernels.
Note that NAC3 does not use kernel_invariants.

@charlesbaynham
Copy link
Contributor Author

This breaks abstraction layers, HasEnvironment does not otherwise know about kernels. Note that NAC3 does not use kernel_invariants.

True. Is there a better place for it you can think of?

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.

2 participants