Fix module imports

simonkurtz-MSFT · simonkurtz-MSFT · commit 699b4c8bf4bb · 2025-06-06T10:44:50.000-04:00
diff --git a/.devcontainer/README.md b/.devcontainer/README.md
@@ -86,11 +86,30 @@ az account show
 ### Continue with Development
 After setup is complete:
 1. **Verify your Azure setup**: Execute `shared/jupyter/verify-az-account.ipynb`
-2. **Start exploring**:
+2. **Test your environment**: Run `python .devcontainer/verify-setup.py`
+3. **Start exploring**:
    - Navigate to any infrastructure folder (`infrastructure/`)
    - Run the `create.ipynb` notebook to set up infrastructure
    - Explore samples in the `samples/` directory
 
+## 🔧 Troubleshooting
+
+If you encounter import errors or module resolution issues, see:
+- [Import Troubleshooting Guide](.devcontainer/IMPORT-TROUBLESHOOTING.md)
+- [Setup Notes](.devcontainer/SETUP-NOTES.md)
+
+Common quick fixes:
+```bash
+# Fix Python path for local development
+python setup/setup_python_path.py --generate-env
+
+# Verify setup
+python .devcontainer/verify-setup.py
+
+# Rebuild dev container if needed
+Dev Containers: Rebuild Container
+```
+
 ## 🏗️ Architecture
 
 The dev container is built on:
diff --git a/.devcontainer/configure-azure-mount.py b/.devcontainer/configure-azure-mount.py
@@ -60,10 +60,10 @@ def get_user_choice() -> str:
     print("\nHow would you like to handle Azure CLI authentication?")
     print("\n   1. Mount local Azure CLI config")
     print("      - Preserves login between container rebuilds")
-    print("      - Uses your existing tenant-specific 'az login' from host machine")
+    print("      - Uses your existing 'az login' from host machine")
     print("      - Best for: Personal development with stable logins")
     print("\n   2. Use manual login inside container [RECOMMENDED]") 
-    print("      - Run tenant-specific 'az login' each time container starts")
+    print("      - Run 'az login' each time container starts")
     print("      - More secure, fresh authentication each session")
     print("      - Best for: Shared environments, GitHub Codespaces")
     print("\n   3. Let me configure this manually later")
@@ -215,11 +215,8 @@ def configure_azure_mount(choice: str) -> bool:
         print("✅ Configured Azure CLI mounting for {platform_name}")
         
     elif choice == "2":  # Manual login
-        print("✅ Configured for manual Azure CLI login with tenant/subscription specification")
-        print("   You'll need to run tenant-specific login after container startup:")
-        print("   az login --tenant <your-tenant-id-or-domain>")
-        print("   az account set --subscription <your-subscription-id-or-name>")
-        print("   az account show  # Verify your context")
+        print("✅ Configured for manual Azure CLI login (az login)")
+        print("   You'll need to run 'az login' after container startup")
         print("   (Removed any existing Azure CLI mounts)")
         
     elif choice == "3":  # Manual configuration
@@ -272,16 +269,10 @@ def main() -> int:
             print("\nNext steps:")
             if is_initial_setup:
                 print("1. The setup script will complete automatically")
-                print("2. Sign in with tenant-specific authentication when setup finishes:")
-                print("   az login --tenant <your-tenant-id-or-domain>")
-                print("   az account set --subscription <your-subscription-id-or-name>")
-                print("   az account show  # Verify your context")
+                print("2. Run 'az login' inside the container when setup finishes")
             else:
                 print("1. Start/rebuild your dev container")
-                print("2. Sign in with tenant-specific authentication inside the container:")
-                print("   az login --tenant <your-tenant-id-or-domain>")
-                print("   az account set --subscription <your-subscription-id-or-name>")
-                print("   az account show  # Verify your context")
+                print("2. Run 'az login' inside the container")
         else:
             print("\nNext steps:")
             print("1. Edit .devcontainer/devcontainer.json manually if needed")
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -60,7 +60,7 @@
     }
   },
   "containerEnv": {
-    "PYTHONPATH": "/workspaces/Apim-Samples/shared/python"
+    "PYTHONPATH": "/workspaces/Apim-Samples/shared/python:/workspaces/Apim-Samples"
   },
   "postCreateCommand": "bash .devcontainer/setup.sh",
   "forwardPorts": [
diff --git a/.devcontainer/setup.sh b/.devcontainer/setup.sh
@@ -95,6 +95,9 @@ cat > .vscode/settings.json << 'EOF'
 {
   "python.terminal.activateEnvironment": true,
   "python.defaultInterpreterPath": "/usr/local/bin/python",
+  "python.analysis.extraPaths": [
+    "/workspaces/Apim-Samples/shared/python"
+  ],
   "jupyter.kernels.filter": [
     {
       "path": "/usr/local/bin/python",
diff --git a/.devcontainer/test_config.py b/.devcontainer/test_config.py
diff --git a/.devcontainer/test_mount.py b/.devcontainer/test_mount.py
diff --git a/.devcontainer/test_mount_logic.py b/.devcontainer/test_mount_logic.py
diff --git a/.devcontainer/verify-setup.py b/.devcontainer/verify-setup.py
@@ -53,6 +53,28 @@ def check_python_packages():
     return True
 
 
+def check_shared_python_modules():
+    """Check if shared Python modules can be imported."""
+    print("📦 Checking shared Python modules...")
+    shared_modules = ['utils', 'apimrequests', 'apimtypes', 'authfactory', 'users']
+    missing_modules = []
+    
+    for module in shared_modules:
+        try:
+            importlib.import_module(module)
+            print(f"  ✅ {module}")
+        except ImportError as e:
+            missing_modules.append(module)
+            print(f"  ❌ {module} - {e}")
+    
+    if missing_modules:
+        print(f"  ⚠️  Missing shared modules: {', '.join(missing_modules)}")
+        print("  💡 Tip: Run 'python setup/setup_python_path.py --generate-env' to fix the Python path")
+        return False
+    
+    return True
+
+
 def check_commands():
     """Check if required command-line tools are available."""
     print("\n🔧 Checking command-line tools...")
@@ -135,6 +157,7 @@ def main():
     
     checks = [
         check_python_packages(),
+        check_shared_python_modules(),
         check_commands(),
         check_jupyter_kernel(),
         check_azure_cli()
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -14,7 +14,7 @@
     "python.analysis.extraPaths": [
         "${workspaceFolder}/shared/python"
     ],
-    "python.defaultInterpreterPath": "./venv/bin/python",
+    "python.defaultInterpreterPath": "./.venv/Scripts/python.exe",
     "python.envFile": "${workspaceFolder}/.env",
     "python.terminal.activateEnvironment": true,
     "terminal.integrated.env.windows": {
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -56,6 +56,25 @@
             },
             "problemMatcher": [],
             "detail": "Manually run the dev container setup script"
+        },
+        {
+            "label": "Verify Setup",
+            "type": "shell",
+            "command": "${config:python.pythonPath}",
+            "args": [
+                ".devcontainer/verify-setup.py"
+            ],
+            "group": "test",
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": false
+            },
+            "problemMatcher": [],
+            "detail": "Verify that the development environment is set up correctly"
         }
     ],
     "inputs": [
diff --git a/README.md b/README.md
@@ -81,11 +81,32 @@ If you're setting up locally without the dev container:
 1. Check _requirements.txt_ to install the Python dependencies we need for this repo, then press _OK_. The install may take a few minutes. You can check on progress in the _OUTPUT_ window (select `Python`).
 1. Verify the virtual environment is set up. You should see a new _.venv_ directory with a _pyveng.cfg_ file and the Python version you selected earlier.
 1. Set up the project environment by running `python setup/setup_python_path.py --generate-env` to configure the Python path.
-  a. If for some reason the `python` command is not found, please try adding your virtual environment's `bin` or `Scripts` directory to your system's PATH variable.  An example command to do this for a virtual environment named `venv` would be to run `source .venv/bin/activate`
+   a. If for some reason the `python` command is not found, please try adding your virtual environment's `bin` or `Scripts` directory to your system's PATH variable.  An example command to do this for a virtual environment named `venv` would be to run `source .venv/bin/activate`
 1. Install the Jupyter kernel: `python -m ipykernel install --user --name=apim-samples --display-name="APIM Samples Python"`
+1. **Restart VS Code** to ensure all environment settings are loaded properly.
 
 The first time you run a Jupyter notebook, you may be asked to install the Jupyter kernel package (ipykernel) if not already available.
 
+#### 🔧 Troubleshooting Setup Issues
+
+If you encounter import errors (e.g., `ModuleNotFoundError: No module named 'requests'` or cannot import shared modules), try these steps:
+
+1. **Fix Python path configuration**:
+   ```bash
+   python setup/setup_python_path.py --generate-env
+   ```
+
+2. **Verify setup**:
+   ```bash
+   python .devcontainer/verify-setup.py
+   ```
+
+3. **Restart VS Code** after running the above commands.
+
+4. **Check Python interpreter**: Use `Ctrl+Shift+P` → "Python: Select Interpreter" and choose your `.venv` interpreter.
+
+For detailed troubleshooting, see [Import Troubleshooting Guide](.devcontainer/IMPORT-TROUBLESHOOTING.md).
+
 ### 📁 List of Samples
 
 | Sample Name                                                     | Description                                                                                                         | Supported Infrastructure(s)   |
diff --git a/test_imports.py b/test_imports.py
@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+"""
+Quick test script to verify shared module imports work correctly.
+"""
+
+import sys
+import os
+from pathlib import Path
+
+# Add shared Python modules to path
+project_root = Path(__file__).parent
+shared_python_path = project_root / 'shared' / 'python'
+sys.path.insert(0, str(shared_python_path))
+
+print("Testing shared module imports...")
+print(f"Project root: {project_root}")
+print(f"Shared Python path: {shared_python_path}")
+print(f"Path exists: {shared_python_path.exists()}")
+print()
+
+try:
+    import utils
+    print("✅ utils imported successfully")
+except ImportError as e:
+    print(f"❌ Failed to import utils: {e}")
+
+try:
+    import apimrequests
+    print("✅ apimrequests imported successfully")
+except ImportError as e:
+    print(f"❌ Failed to import apimrequests: {e}")
+
+try:
+    import apimtypes
+    print("✅ apimtypes imported successfully")
+except ImportError as e:
+    print(f"❌ Failed to import apimtypes: {e}")
+
+try:
+    import authfactory
+    print("✅ authfactory imported successfully")
+except ImportError as e:
+    print(f"❌ Failed to import authfactory: {e}")
+
+try:
+    import users
+    print("✅ users imported successfully")
+except ImportError as e:
+    print(f"❌ Failed to import users: {e}")
+
+print()
+print("Testing standard packages...")
+
+try:
+    import requests
+    print(f"✅ requests {requests.__version__} imported successfully")
+except ImportError as e:
+    print(f"❌ Failed to import requests: {e}")
+
+try:
+    import pandas
+    print(f"✅ pandas {pandas.__version__} imported successfully")
+except ImportError as e:
+    print(f"❌ Failed to import pandas: {e}")
+
+print()
+print("All import tests completed!")

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@`
`60`	`60`	`}`
`61`	`61`	`},`
`62`	`62`	`"containerEnv": {`
`63`		`- "PYTHONPATH": "/workspaces/Apim-Samples/shared/python"`
	`63`	`+ "PYTHONPATH": "/workspaces/Apim-Samples/shared/python:/workspaces/Apim-Samples"`
`64`	`64`	`},`
`65`	`65`	`"postCreateCommand": "bash .devcontainer/setup.sh",`
`66`	`66`	`"forwardPorts": [`
Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,9 @@ cat > .vscode/settings.json << 'EOF'`
`95`	`95`	`{`
`96`	`96`	`"python.terminal.activateEnvironment": true,`
`97`	`97`	`"python.defaultInterpreterPath": "/usr/local/bin/python",`
	`98`	`+ "python.analysis.extraPaths": [`
	`99`	`+ "/workspaces/Apim-Samples/shared/python"`
	`100`	`+ ],`
`98`	`101`	`"jupyter.kernels.filter": [`
`99`	`102`	`{`
`100`	`103`	`"path": "/usr/local/bin/python",`