Add MATLAB-Python bridge contracts for epoch and common namespaces#24
Merged
Merged
Conversation
…gger alias Create ndi_matlab_python_bridge.yaml contracts for the ndi.epoch and ndi.common namespaces, documenting all classes, methods, properties, and standalone functions with their MATLAB-Python type mappings. Remove the backwards-compat get_logger alias in favor of the MATLAB-mirrored getLogger per Strict Naming policy. https://claude.ai/code/session_012G5yTp2wY8NwPHZzNbbahD
This file contains hidden or 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
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.
Summary
This PR introduces formal MATLAB-Python bridge contracts via YAML specification files for the
ndi.epochandndi.commonnamespaces. These contracts document the API mapping between MATLAB and Python implementations, establishing clear naming policies, indexing conventions, and design decisions for cross-language compatibility.Key Changes
Added
src/ndi/epoch/ndi_matlab_python_bridge.yaml: Comprehensive bridge contract for the epoch namespace covering:epochrange,findepochnode,is_epoch_or_empty,parse_devicestring,build_devicestring)epochset(abstract base),epoch,epochprobemap, andepochprobemap_daqsystemAdded
src/ndi/common/ndi_matlab_python_bridge.yaml: Bridge contract for the common namespace covering:timestamp,getLogger,getCache,getDatabaseHierarchy,assertDIDInstalled)PathConstantswith class properties and configuration methodsRemoved deprecated
get_loggeralias: Cleaned up backwards compatibility wrapper insrc/ndi/common/__init__.pyand updated imports insrc/ndi/__init__.pyto use only the canonicalgetLoggerfunction nameNotable Implementation Details
findepochnode: MATLAB returns 1-based indices for user concepts, Python returns 0-based indices for internal array accessparse_devicestring,build_devicestring) are documented as Python-specific refactorings of inline MATLAB logichttps://claude.ai/code/session_012G5yTp2wY8NwPHZzNbbahD