You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: comprehensive TradingSuite testing and documentation (v3.5.2)
## 🧪 Testing Improvements
- Added 51 new comprehensive tests for TradingSuite achieving 100% coverage
- Created test_trading_suite_complete_coverage.py with full test suite
- Tests all multi-instrument functionality, container protocol, and edge cases
- Validates session management, deprecation warnings, and error handling
- Total 88 tests now cover all methods and properties
## 🐛 Bug Fixes
- Fixed AttributeError in multi-instrument session methods:
- set_session_type() incorrectly referenced _contexts instead of _instruments
- get_session_data() incorrectly referenced _contexts instead of _instruments
- get_session_statistics() incorrectly referenced _contexts instead of _instruments
- All session management now works correctly in multi-instrument mode
## 📚 Documentation Updates
- Updated all TradingSuite documentation for 100% accuracy
- Fixed parameter usage examples (positional vs named arguments)
- Added comprehensive multi-instrument examples and best practices
- Updated deprecation notices with correct access patterns
- Enhanced API reference with container protocol documentation
- Corrected all code examples to match actual implementation
## 🔧 Version Updates
- Bumped version to 3.5.2 in __init__.py
- Updated CHANGELOG.md with v3.5.2 release notes
- Updated README.md version references
This release ensures TradingSuite is thoroughly tested with 100% coverage
and all documentation accurately reflects the implementation.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
Copy file name to clipboardExpand all lines: CHANGELOG.md
+34Lines changed: 34 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
14
14
- Migration guides will be provided for all breaking changes
15
15
- Semantic versioning (MAJOR.MINOR.PATCH) is strictly followed
16
16
17
+
## [3.5.2] - 2025-01-31
18
+
19
+
### 🐛 Fixed
20
+
21
+
**Session Management Bug Fixes**:
22
+
-**Fixed AttributeError in Multi-Instrument Mode**: Session management methods (`set_session_type()`, `get_session_data()`, `get_session_statistics()`) were incorrectly using `_contexts` instead of `_instruments` attribute, causing AttributeError in multi-instrument mode
23
+
-**Implementation Bugs**: Fixed actual implementation issues discovered during comprehensive testing (lines 1403, 1441, 1472 in trading_suite.py)
24
+
-**Documentation Accuracy**: Updated all documentation to correctly reflect the actual API implementation
25
+
26
+
### 📝 Documentation
27
+
28
+
**Comprehensive Documentation Updates**:
29
+
-**API Documentation**: Fixed all incorrect parameter usage examples (positional vs named arguments)
30
+
-**Multi-Instrument Examples**: Added comprehensive multi-instrument usage examples with correct syntax
31
+
-**Container Protocol**: Added complete documentation for dictionary-like access methods
32
+
-**Deprecated Patterns**: Clearly marked deprecated access patterns with migration guidance
33
+
-**Example Files**: Updated example files to use recommended API patterns
34
+
35
+
### ✅ Testing
36
+
37
+
**Comprehensive Test Coverage**:
38
+
-**Added 51 new tests** in `test_trading_suite_complete_coverage.py` for 100% coverage
39
+
-**TradingSuiteConfig Methods**: Full test coverage for all configuration generation methods
40
+
-**Multi-Instrument Support**: Tests for parallel context creation and cleanup
41
+
-**Container Protocol**: Complete testing of all dictionary-like methods
42
+
-**Session Handling**: Tests for both single and multi-instrument session management
43
+
-**Edge Cases**: Comprehensive error handling and edge case testing
44
+
-**Backward Compatibility**: Tests ensuring deprecated patterns still work with warnings
45
+
46
+
### 🔧 Changed
47
+
48
+
-**Test-Driven Development**: All tests now follow strict TDD principles - tests define expected behavior, not current implementation
49
+
-**88 total tests** for TradingSuite module, all passing with proper expectations
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,9 +21,9 @@ A **high-performance async Python SDK** for the [ProjectX Trading Platform](http
21
21
22
22
This Python SDK acts as a bridge between your trading strategies and the ProjectX platform, handling all the complex API interactions, data processing, and real-time connectivity.
23
23
24
-
## 🚀 v3.5.1 - Multi-Instrument TradingSuite with Critical Bug Fixes
24
+
## 🚀 v3.5.2 - TradingSuite with Enhanced Testing & Documentation
25
25
26
-
**Latest Version**: v3.5.1 - Critical bug fixes for TradingSuite including context manager re-entry, event loop handling, and session management in multi-instrument mode. The v3.5.0 release introduced multi-instrument support enabling complex multi-asset trading strategies while maintaining full backward compatibility.
26
+
**Latest Version**: v3.5.2 - Comprehensive bug fixes for session management in multi-instrument mode, complete test coverage for TradingSuite module, and thoroughly updated documentation. Fixed critical bugs where session methods were using incorrect attribute names (`_contexts` instead of `_instruments`).
27
27
28
28
**Key Benefits**:
29
29
- 🎯 **Multi-Asset Strategies**: Trade ES vs NQ pairs, commodity spreads, sector rotation
@@ -32,7 +32,7 @@ This Python SDK acts as a bridge between your trading strategies and the Project
32
32
- 🛡️ **Backward Compatible**: Existing single-instrument code continues to work
33
33
- ⚡ **Performance Optimized**: Parallel context creation and resource sharing
34
34
35
-
See [CHANGELOG.md](CHANGELOG.md) for complete v3.5.1 bug fixes and v3.5.0 release notes with migration guide.
35
+
See [CHANGELOG.md](CHANGELOG.md) for complete v3.5.2 bug fixes, testing improvements, and documentation updates.
0 commit comments