Merge pull request #9 from TexasCoding/fix_instrument_issue

Fix instrument issue

Author: TexasCoding

CHANGELOG.md

@@ -5,6 +5,42 @@ All notable changes to the ProjectX Python client will be documented in this fil
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## ⚠️ Development Phase Notice
+
+**IMPORTANT**: This project is under active development. During this phase:
+- Breaking changes may be introduced without deprecation warnings
+- Backward compatibility is not maintained
+- Old implementations are removed when improved
+- Clean, modern code architecture is prioritized
+
+## [1.1.3] - 2025-01-29
+
+### Fixed
+- **🔧 Contract Selection**: Fixed `_select_best_contract` method to properly handle futures contract naming patterns
+  - Extracts base symbols by removing month/year suffixes using regex (e.g., NQU5 → NQ, MGCH25 → MGC)
+  - Handles both single-digit (U5) and double-digit (H25) year codes correctly
+  - Prevents incorrect matches (searching "NQ" no longer returns "MNQ" contracts)
+  - Prioritizes exact base symbol matches over symbolId suffix matching
+
+### Added
+- **🎮 Interactive Instrument Demo**: New example script for testing instrument search functionality
+  - `examples/09_get_check_available_instruments.py` - Interactive command-line tool
+  - Shows the difference between `search_instruments()` (all matches) and `get_instrument()` (best match)
+  - Visual indicators for active contracts (★) and detailed contract information
+  - Includes common symbols table and help command
+  - Continuous search loop for testing multiple symbols
+
+### Enhanced
+- **🧪 Test Coverage**: Added comprehensive test suite for contract selection logic
+  - Tests for exact base symbol matching with various contract patterns
+  - Tests for handling different year code formats
+  - Tests for selection priority order (active vs inactive)
+  - Tests for edge cases (empty lists, no exact matches)
+- **📚 Documentation**: Updated README with development phase warnings
+  - Added prominent development status warning
+  - Noted that breaking changes may occur without backward compatibility
+  - Updated changelog format to highlight the development phase
+
 ## [1.1.2] - 2025-01-28
 
 ### Enhanced

CLAUDE.md

@@ -2,6 +2,23 @@
 
 This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
 
+## Development Phase Guidelines
+
+**IMPORTANT**: This project is in active development. When making changes:
+
+1. **No Backward Compatibility**: Do not maintain old implementations for compatibility
+2. **Clean Code Priority**: Always refactor to the cleanest, most modern approach
+3. **Remove Legacy Code**: Delete old logic when implementing improvements
+4. **Breaking Changes Allowed**: Make breaking changes freely to improve architecture
+5. **Modern Patterns**: Use the latest Python patterns and best practices
+6. **Simplify Aggressively**: Remove complexity rather than adding compatibility layers
+
+Example approach:
+- ❌ DON'T: Keep old method signatures with deprecation warnings
+- ✅ DO: Replace methods entirely with better implementations
+- ❌ DON'T: Add compatibility shims or adapters
+- ✅ DO: Update all callers to use new patterns
+
 ## Development Commands
 
 ### Package Management (UV)
@@ -160,4 +177,18 @@ data_manager.get_memory_stats()  # Real-time data memory
 - `max_depth_entries = 1000` (OrderBook depth per side)
 - `max_bars_per_timeframe = 1000` (Real-time data per timeframe)
 - `tick_buffer_size = 1000` (Tick data buffer)
-- `cache_max_size = 100` (Indicator cache entries)
+- `cache_max_size = 100` (Indicator cache entries)
+
+## Recent Changes (v1.1.3)
+
+### Contract Selection Fix
+The `_select_best_contract` method now properly handles futures contract naming:
+- Uses regex to extract base symbols by removing month/year suffixes
+- Handles both single-digit (U5) and double-digit (H25) year codes
+- Pattern: `^(.+?)([FGHJKMNQUVXZ]\d{1,2})$` where letters are futures month codes
+
+### Interactive Demo
+Added `examples/09_get_check_available_instruments.py`:
+- Interactive command-line tool for testing instrument search
+- Shows difference between `search_instruments()` and `get_instrument()`
+- Includes visual indicators and continuous search loop

README.md

@@ -20,9 +20,11 @@ A **high-performance Python SDK** for the [ProjectX Trading Platform](https://ww
 
 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.
 
-## 📊 SDK Status
+## ⚠️ Development Status
 
-**Current Version**: v1.1.2 (Documentation Accuracy & Enhanced Project Structure)
+**IMPORTANT**: This project is under active development. New updates may introduce breaking changes without backward compatibility. During this development phase, we prioritize clean, modern code architecture over maintaining legacy implementations.
+
+**Current Version**: v1.1.3 (Contract Selection & Interactive Demo)
 
 ✅ **Production Ready SDK Components**:
 - Complete ProjectX Gateway API integration with connection pooling
@@ -35,6 +37,8 @@ This Python SDK acts as a bridge between your trading strategies and the Project
 - **NEW**: Sub-second response times for cached operations
 - **NEW**: Complete TA-Lib overlap indicators (17 total) with full compatibility
 - **NEW**: Enhanced indicator discovery and documentation
+- **NEW**: Improved futures contract selection with proper suffix handling
+- **NEW**: Interactive instrument search demo for testing functionality
 
 🚀 **Performance Highlights**:
 - **Connection pooling** reduces API overhead by 50-70%
@@ -427,6 +431,7 @@ The `examples/` directory contains comprehensive demonstrations:
 - **`05_orderbook_analysis.py`** - Level 2 market depth analysis
 - **`06_multi_timeframe_strategy.py`** - Multi-timeframe trading strategies
 - **`07_technical_indicators.py`** - Complete technical analysis showcase
+- **`09_get_check_available_instruments.py`** - Interactive instrument search demo
 
 ### Example Trading Application Built with the SDK
 ```python
@@ -606,23 +611,31 @@ We welcome contributions! Please follow these guidelines:
 
 ## 📝 Changelog
 
-### Version 1.1.2 (Latest)
-**📊 Documentation Accuracy & Enhanced Project Structure**
-- ✅ **Documentation Alignment**: Updated all documentation to match actual codebase
-- ✅ **Version Consistency**: Corrected version references throughout project
-- ✅ **Example Organization**: Updated example file references to match actual structure
-- ✅ **Project Status Accuracy**: Aligned roadmap and feature status with reality
-- ✅ **Build on Previous**: Includes all features from v1.0.12:
-  - **Order-Position Sync**: Automatic synchronization between orders and positions
-  - **Position Order Tracking**: Orders automatically tracked and associated with positions  
-  - **Comprehensive Test Suite**: 230+ tests covering all major functionality
-  - **Enhanced Indicators**: 55+ indicators across all categories
+### Version 1.1.3 (Latest) - 2025-01-29
+**🔧 Contract Selection & Interactive Tools**
+
+**Breaking Changes:**
+- ⚠️ **Development Phase**: API changes may occur without deprecation warnings
+- ⚠️ **No Backward Compatibility**: Old implementations are removed when improved
+
+**Bug Fixes:**
+- ✅ **Fixed Contract Selection**: `get_instrument()` now correctly handles futures contract naming patterns
+  - Properly extracts base symbols by removing month/year suffixes (e.g., NQU5 → NQ, MGCH25 → MGC)
+  - Prevents incorrect matches (searching "NQ" no longer returns "MNQ" contracts)
+  - Handles both single-digit (U5) and double-digit (H25) year codes
 
 **New Features:**
-- **Bracket Order Integration**: Full lifecycle tracking for entry, stop, and target orders
-- **Position Close Handling**: Related orders automatically cancelled when positions close
-- **Integration Tests**: End-to-end workflow testing
-- **Risk Management Tests**: Comprehensive risk control validation
+- **Interactive Instrument Demo**: New example script for testing instrument search functionality
+  - `examples/09_get_check_available_instruments.py` - Interactive command-line tool
+  - Shows difference between `search_instruments()` and `get_instrument()` methods
+  - Visual indicators for active contracts and detailed contract information
+
+**Improvements:**
+- **Test Coverage**: Added comprehensive tests for contract selection logic
+- **Documentation**: Updated with development phase warnings and breaking change notices
+
+**Includes all features from v1.0.12:**
+- Order-Position Sync, Position Order Tracking, 230+ tests, 55+ indicators
 
 ### Version 1.0.2-1.0.11
 **🚀 Performance & Reliability**

docs/conf.py

@@ -23,8 +23,8 @@
 project = "project-x-py"
 copyright = "2025, Jeff West"
 author = "Jeff West"
-release = "1.1.2"
-version = "1.1.2"
+release = "1.1.3"
+version = "1.1.3"
 
 # -- General configuration ---------------------------------------------------
 

docs/index.rst

@@ -19,6 +19,9 @@ project-x-py Documentation
 
 **project-x-py** is a professional Python SDK for the `ProjectX Trading Platform <https://www.projectx.com/>`_ Gateway API. This library enables developers to build sophisticated trading strategies and applications by providing comprehensive access to futures trading operations, real-time market data, Level 2 orderbook analysis, and a complete technical analysis suite with 55+ TA-Lib compatible indicators.
 
+.. warning::
+   **Development Phase**: This project is under active development. New updates may introduce breaking changes without backward compatibility. During this development phase, we prioritize clean, modern code architecture over maintaining legacy implementations.
+
 .. note::
    **Important**: This is a **client library/SDK**, not a trading strategy. It provides the tools and infrastructure to help developers create their own trading strategies that integrate with the ProjectX platform.
 

examples/06_multi_timeframe_strategy.py

@@ -32,6 +32,10 @@
     create_trading_suite,
     setup_logging,
 )
+from project_x_py.models import Order, Position
+from project_x_py.order_manager import OrderManager
+from project_x_py.position_manager import PositionManager
+from project_x_py.realtime_data_manager import ProjectXRealtimeDataManager
 
 
 class MultiTimeframeStrategy:
@@ -370,14 +374,18 @@ def _emergency_cleanup(signum=None, frame=None):
         print("⚠️  Emergency position and order cleanup in progress...")
 
         try:
-            order_manager = _cleanup_managers.get("order_manager")
-            position_manager = _cleanup_managers.get("position_manager")
-            data_manager = _cleanup_managers.get("data_manager")
+            order_manager: OrderManager | None = _cleanup_managers.get("order_manager")
+            position_manager: PositionManager | None = _cleanup_managers.get(
+                "position_manager"
+            )
+            data_manager: ProjectXRealtimeDataManager | None = _cleanup_managers.get(
+                "data_manager"
+            )
 
             if order_manager and position_manager:
                 # Get current state
-                positions = position_manager.get_all_positions()
-                orders = order_manager.search_open_orders()
+                positions: list[Position] = position_manager.get_all_positions()
+                orders: list[Order] = order_manager.search_open_orders()
 
                 if positions or orders:
                     print(
@@ -389,7 +397,7 @@ def _emergency_cleanup(signum=None, frame=None):
                         try:
                             order_manager.cancel_order(order.id)
                             print(f"   ✅ Cancelled order {order.id}")
-                        except:
+                        except Exception:
                             print(f"   ❌ Failed to cancel order {order.id}")
 
                     # Close all positions with market orders
@@ -405,8 +413,10 @@ def _emergency_cleanup(signum=None, frame=None):
                                 print(
                                     f"   ✅ Emergency close order: {close_response.order_id}"
                                 )
-                        except:
-                            print(f"   ❌ Failed to close position {pos.contractId}")
+                        except Exception as e:
+                            print(
+                                f"   ❌ Failed to close position {pos.contractId}: {e}"
+                            )
 
                     print("⏳ Waiting 3 seconds for emergency orders to process...")
                     time.sleep(3)
@@ -418,8 +428,8 @@ def _emergency_cleanup(signum=None, frame=None):
                 try:
                     data_manager.stop_realtime_feed()
                     print("🧹 Real-time feed stopped")
-                except:
-                    pass
+                except Exception as e:
+                    print(f"❌ Error stopping real-time feed: {e}")
 
         except Exception as e:
             print(f"❌ Emergency cleanup error: {e}")
@@ -494,9 +504,9 @@ def main():
                 timeframes=timeframes,
             )
 
-            data_manager = trading_suite["data_manager"]
-            order_manager = trading_suite["order_manager"]
-            position_manager = trading_suite["position_manager"]
+            data_manager: ProjectXRealtimeDataManager = trading_suite["data_manager"]
+            order_manager: OrderManager = trading_suite["order_manager"]
+            position_manager: PositionManager = trading_suite["position_manager"]
 
             # Store managers for emergency cleanup
             _cleanup_managers["data_manager"] = data_manager
@@ -603,11 +613,11 @@ def main():
                         else:
                             print("   ❌ Signal execution failed")
                     else:
-                        print("     ℹ️  Signal execution skipped by user")
+                        print("      Signal execution skipped by user")
 
                 # Show current positions and orders
-                positions = position_manager.get_all_positions()
-                orders = order_manager.search_open_orders()
+                positions: list[Position] = position_manager.get_all_positions()
+                orders: list[Order] = order_manager.search_open_orders()
 
                 print("\n📊 Current Status:")
                 print(f"   Open Positions: {len(positions)}")
@@ -804,11 +814,11 @@ def main():
                                     if close_response.success:
                                         closed_count += 1
                                         print(
-                                            f"   ✅ Close order placed: {close_response.order_id}"
+                                            f"   ✅ Close order placed: {close_response.orderId}"
                                         )
                                     else:
                                         print(
-                                            f"   ❌ Failed to place close order: {close_response.error_message}"
+                                            f"   ❌ Failed to place close order: {close_response.errorMessage}"
                                         )
 
                                 except Exception as e:
@@ -837,7 +847,7 @@ def main():
                                     print("   ✅ All positions successfully closed")
                     else:
                         print(
-                            "   ℹ️  Cleanup skipped by user - positions and orders remain open"
+                            "Cleanup skipped by user - positions and orders remain open"
                         )
                         print("   ⚠️  IMPORTANT: Monitor your positions manually!")
                 else:

examples/07_technical_indicators.py

@@ -463,7 +463,7 @@ def create_comprehensive_analysis(data):
 
             print("\n📊 Volatility Analysis:")
             if bb_lower < price < bb_upper:
-                print("   ℹ️  Price within Bollinger Bands: Normal")
+                print("    Price within Bollinger Bands: Normal")
             elif price >= bb_upper:
                 print("   ⚠️  Price at upper BB: Potential reversal")
             else: