feat: Add NXOpen Python intellisense integration
Implemented NXOpen Python stub file integration for intelligent code completion in VSCode, significantly improving development workflow for NXOpen API usage. Features Added: - VSCode configuration for Pylance with NXOpen stub files - Test script to verify intellisense functionality - Comprehensive setup documentation with examples - Updated development guidance with completed milestone Configuration: - Stub path: C:\Program Files\Siemens\Simcenter3D_2412\ugopen\pythonStubs - Type checking mode: basic (balances help vs. false positives) - Covers all NXOpen modules: Session, Part, CAE, Assemblies, etc. Benefits: - Autocomplete for NXOpen classes, methods, and properties - Inline documentation and parameter type hints - Faster development with reduced API lookup time - Better LLM-assisted coding with visible API structure - Catch type errors before runtime Files: - .vscode/settings.json - VSCode Pylance configuration - tests/test_nxopen_intellisense.py - Verification test script - docs/NXOPEN_INTELLISENSE_SETUP.md - Complete setup guide - DEVELOPMENT_GUIDANCE.md - Updated with completion status Testing: - Stub files verified in NX 2412 installation - Test script created with comprehensive examples - Documentation includes troubleshooting guide Next Steps: - Research authenticated Siemens documentation access - Investigate documentation scraping for LLM knowledge base - Enable LLM to reference NXOpen API during code generation This is Step 1 of NXOpen integration strategy outlined in DEVELOPMENT_GUIDANCE.md. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -918,7 +918,7 @@ When prioritizing work, ask:
|
|||||||
|
|
||||||
### Stakeholders
|
### Stakeholders
|
||||||
|
|
||||||
- **You (Antoine)**: Main developer, architect, decision maker
|
- **Antoine Letarte**: Main developer, architect, decision maker
|
||||||
- **Claude Code**: Development assistant for Atomizer software
|
- **Claude Code**: Development assistant for Atomizer software
|
||||||
- **Future Contributors**: Will follow established patterns and documentation
|
- **Future Contributors**: Will follow established patterns and documentation
|
||||||
- **Future Users**: Will use LLM features for optimization workflows
|
- **Future Users**: Will use LLM features for optimization workflows
|
||||||
@@ -998,6 +998,6 @@ python dashboard/start_dashboard.py
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Document Maintained By**: Antoine (Main Developer)
|
**Document Maintained By**: Antoine Letarte (Main Developer)
|
||||||
**Last Review**: 2025-11-17
|
**Last Review**: 2025-11-17
|
||||||
**Next Review**: 2025-11-24
|
**Next Review**: 2025-11-24
|
||||||
|
|||||||
270
docs/NXOPEN_INTELLISENSE_SETUP.md
Normal file
270
docs/NXOPEN_INTELLISENSE_SETUP.md
Normal file
@@ -0,0 +1,270 @@
|
|||||||
|
# NXOpen Python Intellisense Setup
|
||||||
|
|
||||||
|
> **Status**: ✅ Implemented (2025-11-17)
|
||||||
|
>
|
||||||
|
> Enable intelligent code completion for NXOpen Python API using Siemens-provided stub files
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Siemens NX 2412 includes Python stub files (`.pyi`) that provide full type hints for the NXOpen API. These enable:
|
||||||
|
|
||||||
|
- **Autocomplete**: Suggestions for classes, methods, and properties
|
||||||
|
- **Type Hints**: Parameter types and return values
|
||||||
|
- **Documentation**: Inline docstrings and API descriptions
|
||||||
|
- **Error Detection**: Type checking catches errors before runtime
|
||||||
|
|
||||||
|
This dramatically improves development speed and reduces NXOpen API lookup time.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- **Siemens NX 2412** (or later) installed with Programming Tools
|
||||||
|
- **VSCode** with **Pylance extension** (usually installed with Python extension)
|
||||||
|
- **Python 3.10+** environment
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Setup Instructions
|
||||||
|
|
||||||
|
### Step 1: Verify Stub Files Exist
|
||||||
|
|
||||||
|
Check that stub files are installed:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Windows path:
|
||||||
|
dir "C:\Program Files\Siemens\Simcenter3D_2412\ugopen\pythonStubs\NXOpen"
|
||||||
|
|
||||||
|
# Should show: __init__.pyi and many module folders (CAE, Assemblies, etc.)
|
||||||
|
```
|
||||||
|
|
||||||
|
**If missing**: Reinstall NX 2412 and ensure "Programming Tools" is checked during installation.
|
||||||
|
|
||||||
|
### Step 2: Configure VSCode
|
||||||
|
|
||||||
|
Update `.vscode/settings.json` in your Atomizer project:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"python.analysis.typeCheckingMode": "basic",
|
||||||
|
"python.analysis.stubPath": "C:\\Program Files\\Siemens\\Simcenter3D_2412\\ugopen\\pythonStubs"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note**: Use double backslashes (`\\`) in Windows paths for JSON.
|
||||||
|
|
||||||
|
### Step 3: Restart VSCode
|
||||||
|
|
||||||
|
Close and reopen VSCode to load the new stub files.
|
||||||
|
|
||||||
|
### Step 4: Verify Intellisense Works
|
||||||
|
|
||||||
|
Open `tests/test_nxopen_intellisense.py` and verify:
|
||||||
|
|
||||||
|
1. **Import Autocomplete**:
|
||||||
|
- Type `import NXOpen.` → Should suggest: Part, Session, CAE, Assemblies, etc.
|
||||||
|
|
||||||
|
2. **Method Autocomplete**:
|
||||||
|
- Type `session.` → Should suggest: GetSession(), Parts, etc.
|
||||||
|
- Type `expressions.` → Should suggest: FindObject, CreateExpression, etc.
|
||||||
|
|
||||||
|
3. **Parameter Hints**:
|
||||||
|
- Hover over `CreateExpression()` → Shows parameter types and documentation
|
||||||
|
|
||||||
|
4. **Documentation Tooltips**:
|
||||||
|
- Hover over any NXOpen class/method → Shows docstring
|
||||||
|
|
||||||
|
**If working**: ✅ Intellisense is configured correctly!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## What You Get
|
||||||
|
|
||||||
|
### Before Intellisense:
|
||||||
|
```python
|
||||||
|
import NXOpen
|
||||||
|
session = NXOpen.Session.GetSession()
|
||||||
|
# ❌ No suggestions when typing "session."
|
||||||
|
# ❌ No parameter hints for methods
|
||||||
|
# ❌ Must look up API in documentation
|
||||||
|
```
|
||||||
|
|
||||||
|
### After Intellisense:
|
||||||
|
```python
|
||||||
|
import NXOpen
|
||||||
|
session = NXOpen.Session.GetSession()
|
||||||
|
# ✅ Type "session." → See: Parts, ListingWindow, LogFile, etc.
|
||||||
|
# ✅ Type "session.Parts." → See: Work, Display, FindObject, etc.
|
||||||
|
# ✅ Hover over methods → See parameter types and documentation
|
||||||
|
# ✅ Catch type errors before running code
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Available Modules
|
||||||
|
|
||||||
|
The stub files cover **all** NXOpen modules:
|
||||||
|
|
||||||
|
**Core Modules**:
|
||||||
|
- `NXOpen.Session` - NX session management
|
||||||
|
- `NXOpen.Part` - Part objects and operations
|
||||||
|
- `NXOpen.Assemblies` - Assembly operations
|
||||||
|
|
||||||
|
**CAE Modules**:
|
||||||
|
- `NXOpen.CAE` - Finite element analysis
|
||||||
|
- `NXOpen.CAE.FemPart` - FEM models
|
||||||
|
- `NXOpen.CAE.SimSolution` - Solutions and solver control
|
||||||
|
|
||||||
|
**Design Modules**:
|
||||||
|
- `NXOpen.Features` - Parametric features
|
||||||
|
- `NXOpen.Sketches` - Sketch operations
|
||||||
|
- `NXOpen.Modeling` - Modeling operations
|
||||||
|
|
||||||
|
**And many more**: Drafting, Display, Motion, Optimization, etc.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Example: Using Intellisense During Development
|
||||||
|
|
||||||
|
### Scenario: Update Part Expression
|
||||||
|
|
||||||
|
**Without Intellisense** (manual lookup required):
|
||||||
|
```python
|
||||||
|
# 1. Google: "NXOpen get expression"
|
||||||
|
# 2. Find documentation
|
||||||
|
# 3. Copy method signature
|
||||||
|
# 4. Hope you got it right
|
||||||
|
work_part.Expressions.FindObject("tip_thickness")
|
||||||
|
```
|
||||||
|
|
||||||
|
**With Intellisense** (guided development):
|
||||||
|
```python
|
||||||
|
# 1. Type "work_part.Exp" → Autocomplete suggests "Expressions"
|
||||||
|
# 2. Type "work_part.Expressions." → See all methods
|
||||||
|
# 3. Select "FindObject" → See parameter types
|
||||||
|
# 4. Hover for documentation
|
||||||
|
work_part.Expressions.FindObject("tip_thickness") # ✅ Correct!
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Benefits for Atomizer Development
|
||||||
|
|
||||||
|
### 1. **Faster Development**
|
||||||
|
- No context switching to documentation
|
||||||
|
- Discover APIs as you type
|
||||||
|
- Reduce typos and API misuse
|
||||||
|
|
||||||
|
### 2. **Better Code Quality**
|
||||||
|
- Type checking catches errors early
|
||||||
|
- Method signatures documented inline
|
||||||
|
- Parameter validation before runtime
|
||||||
|
|
||||||
|
### 3. **LLM-Assisted Coding**
|
||||||
|
When using Claude Code to develop Atomizer:
|
||||||
|
- Claude can "see" NXOpen API structure via stub files
|
||||||
|
- Better code generation suggestions
|
||||||
|
- Reduced hallucination of API methods
|
||||||
|
|
||||||
|
### 4. **Onboarding**
|
||||||
|
- New contributors learn NXOpen API faster
|
||||||
|
- Inline documentation reduces learning curve
|
||||||
|
- Explore API without leaving IDE
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Integration with Atomizer Workflow
|
||||||
|
|
||||||
|
### Journal Script Development
|
||||||
|
|
||||||
|
When writing NX journal scripts (`optimization_engine/solve_simulation.py`):
|
||||||
|
|
||||||
|
```python
|
||||||
|
import NXOpen
|
||||||
|
|
||||||
|
theSession = NXOpen.Session.GetSession()
|
||||||
|
workPart = theSession.Parts.Work
|
||||||
|
|
||||||
|
# Intellisense shows:
|
||||||
|
# - workPart.Expressions.FindObject(...)
|
||||||
|
# - workPart.Expressions.EditWithUnits(...)
|
||||||
|
# - workPart.Update()
|
||||||
|
# - workPart.Save(...)
|
||||||
|
```
|
||||||
|
|
||||||
|
### LLM Code Generation
|
||||||
|
|
||||||
|
When LLM generates NXOpen code, stub files help:
|
||||||
|
- Validate generated code against actual API
|
||||||
|
- Suggest corrections for API misuse
|
||||||
|
- Provide parameter type hints
|
||||||
|
|
||||||
|
### Future: NXOpen Documentation Integration
|
||||||
|
|
||||||
|
This is **Step 1** of NXOpen integration. Future work:
|
||||||
|
|
||||||
|
1. ✅ **Stub files for intellisense** (current)
|
||||||
|
2. 🔜 **Documentation scraping** for LLM knowledge base
|
||||||
|
3. 🔜 **Authenticated docs access** for latest API references
|
||||||
|
4. 🔜 **LLM-generated journal scripts** with validation
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Intellisense Not Working
|
||||||
|
|
||||||
|
**Problem**: No autocomplete suggestions appear
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. **Check Pylance Extension**: VSCode → Extensions → Search "Pylance" → Ensure installed
|
||||||
|
2. **Verify Settings**: `.vscode/settings.json` has correct stub path
|
||||||
|
3. **Check Python Interpreter**: VSCode bottom-left → Select correct Python environment
|
||||||
|
4. **Restart VSCode**: Close all windows and reopen
|
||||||
|
5. **Check Stub Path**: Ensure path exists and contains `NXOpen` folder
|
||||||
|
|
||||||
|
### Wrong Suggestions
|
||||||
|
|
||||||
|
**Problem**: Autocomplete shows incorrect or outdated methods
|
||||||
|
|
||||||
|
**Solution**: Ensure stub files match your NX version:
|
||||||
|
- NX 2412 → Use `Simcenter3D_2412\ugopen\pythonStubs`
|
||||||
|
- Different NX version → Update stub path in settings
|
||||||
|
|
||||||
|
### Type Errors Shown
|
||||||
|
|
||||||
|
**Problem**: Pylance shows type errors for valid code
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Set `"python.analysis.typeCheckingMode": "basic"` (not "strict")
|
||||||
|
2. Add `# type: ignore` for false positives
|
||||||
|
3. Update stub files if using newer NX version
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
- **Siemens NX Documentation**: [PLM Portal](https://plm.sw.siemens.com)
|
||||||
|
- **TheScriptingEngineer**: [Blog with NXOpen examples](https://thescriptingengineer.com)
|
||||||
|
- **Pylance Documentation**: [VSCode Python](https://code.visualstudio.com/docs/python/editing)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
Now that intellisense is configured:
|
||||||
|
|
||||||
|
1. **Try It**: Open `tests/test_nxopen_intellisense.py` and explore
|
||||||
|
2. **Develop Faster**: Use autocomplete when writing journal scripts
|
||||||
|
3. **Contribute**: Help improve Atomizer's NXOpen integration
|
||||||
|
|
||||||
|
**See**: [DEVELOPMENT_GUIDANCE.md](../DEVELOPMENT_GUIDANCE.md) for strategic roadmap including NXOpen documentation access.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Implemented By**: Antoine Letarte
|
||||||
|
**Date**: 2025-11-17
|
||||||
|
**NX Version**: 2412
|
||||||
|
**Status**: Production Ready
|
||||||
61
tests/test_nxopen_intellisense.py
Normal file
61
tests/test_nxopen_intellisense.py
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
"""
|
||||||
|
Test script to verify NXOpen Python intellisense is working with stub files.
|
||||||
|
|
||||||
|
This script is NOT meant to be executed - it's for testing IDE code completion.
|
||||||
|
Open this file in VSCode and verify that:
|
||||||
|
1. Import statements show autocomplete suggestions
|
||||||
|
2. NXOpen classes show available methods/properties
|
||||||
|
3. Method parameters show type hints
|
||||||
|
4. Hovering over objects shows documentation
|
||||||
|
|
||||||
|
Setup Required:
|
||||||
|
- VSCode with Pylance extension installed
|
||||||
|
- .vscode/settings.json configured with stub path:
|
||||||
|
"python.analysis.stubPath": "C:\\Program Files\\Siemens\\Simcenter3D_2412\\ugopen\\pythonStubs"
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Test 1: Import autocomplete
|
||||||
|
# Type "import NXOpen." and verify you see module suggestions:
|
||||||
|
# NXOpen.Part, NXOpen.Session, NXOpen.CAE, NXOpen.Assemblies, etc.
|
||||||
|
import NXOpen
|
||||||
|
import NXOpen.Part
|
||||||
|
import NXOpen.Session
|
||||||
|
import NXOpen.CAE
|
||||||
|
import NXOpen.Assemblies
|
||||||
|
|
||||||
|
# Test 2: Session object autocomplete
|
||||||
|
# Type "session." and verify you see methods like GetSession(), Parts, etc.
|
||||||
|
session = NXOpen.Session.GetSession()
|
||||||
|
|
||||||
|
# Test 3: Part methods autocomplete
|
||||||
|
# Type "part." and verify you see methods
|
||||||
|
work_part = session.Parts.Work
|
||||||
|
|
||||||
|
# Test 4: Expression methods autocomplete
|
||||||
|
# Type "expression." and verify you see methods like FindObject, CreateExpression, etc.
|
||||||
|
if work_part:
|
||||||
|
expressions = work_part.Expressions
|
||||||
|
# Type "expressions." and verify methods appear:
|
||||||
|
# expressions.FindObject, CreateExpression, EditWithUnits, etc.
|
||||||
|
|
||||||
|
# Test 5: Parameter type hints
|
||||||
|
# Hover over CreateExpression and verify you see parameter types
|
||||||
|
# expression = expressions.CreateExpression("test", "1.0")
|
||||||
|
|
||||||
|
# Test 6: CAE autocomplete
|
||||||
|
# Type "fem_part." and verify CAE-specific methods appear
|
||||||
|
fem_part = NXOpen.CAE.FemPart
|
||||||
|
# Type "fem_part." to see: BaseFemPart, FemModel, etc.
|
||||||
|
|
||||||
|
# Test 7: Assembly autocomplete
|
||||||
|
# Type "assemblies." and verify assembly methods appear
|
||||||
|
assemblies = work_part.ComponentAssembly if work_part else None
|
||||||
|
# Type "assemblies." to see: AddComponent, CreateComponent, etc.
|
||||||
|
|
||||||
|
# Test 8: Documentation tooltips
|
||||||
|
# Hover over any NXOpen class/method and verify documentation appears
|
||||||
|
# Example: Hover over "GetSession()" above - should show docstring
|
||||||
|
|
||||||
|
print("Intellisense test file - Do not execute!")
|
||||||
|
print("Open in VSCode and test autocomplete functionality")
|
||||||
|
print("If you see type hints and autocomplete suggestions, intellisense is working!")
|
||||||
Reference in New Issue
Block a user