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

Use Enum classes for the channel value formats and post processing flags #87

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

LiamOverett-AMRC
Copy link

Use Python's Enum class to group the channel value formats and post processing flags.

Doing this groups the two sets of variables into semantically meaningful classes and now the attributes within are commented in a way to show up in IntelliSense. By also grouping this way, the cf_ and proc_ prefixes can be removed to aid in readability.

image

Code changes:

  • Create Enum classes
  • Remove comments from original variables and place them under the "Compatibility Interface for old pylsl API" section
  • Update examples to use enum classes
  • Update examples to no longer use the aliased resolve_stream() function and instead replace with resolve_byprop() where appropriate

Keep those original variables in file for backwards compatibility but remove their comments and recommend to use the Enum classes instead
Also update the imports and for the examples to no longer use the aliased `resolve_stream()` function
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