selenium-selector-autocorrect 0.1.0__tar.gz

selenium_selector_autocorrect-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

selenium_selector_autocorrect-0.1.0/PKG-INFO

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: selenium-selector-autocorrect
+Version: 0.1.0
+Summary: Automatic Selenium selector correction using AI when elements fail to be found
+Author-email: Marty Zhou <marty.zhou@example.com>
+Maintainer-email: Marty Zhou <marty.zhou@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/MartyZhou/selenium-selector-autocorrect
+Project-URL: Documentation, https://github.com/MartyZhou/selenium-selector-autocorrect#readme
+Project-URL: Repository, https://github.com/MartyZhou/selenium-selector-autocorrect
+Project-URL: Issues, https://github.com/MartyZhou/selenium-selector-autocorrect/issues
+Project-URL: Changelog, https://github.com/MartyZhou/selenium-selector-autocorrect/blob/main/CHANGELOG.md
+Keywords: selenium,testing,automation,ai,web-testing,test-automation,selector,auto-correction
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Framework :: Pytest
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: selenium>=4.0.0
+Requires-Dist: requests>=2.25.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# Selenium Selector AutoCorrect
+
+A Python package that automatically corrects Selenium element selectors using AI when they fail, reducing test maintenance and improving test reliability.
+
+## Features
+
+- **Automatic Selector Correction**: When a WebDriverWait times out, the package uses AI to analyze the page and suggest working alternatives
+- **Local AI Integration**: Uses a local AI service with OpenAI-compatible API
+- **Correction Tracking**: Records all corrections with source file and line information
+- **Optional Auto-Update**: Can automatically update test files with corrected selectors
+- **Zero Code Changes**: Works by hooking into Selenium's WebDriverWait
+
+## Installation
+
+```bash
+pip install selenium-selector-autocorrect
+```
+
+## Quick Start
+
+```python
+from selenium import webdriver
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support.wait import WebDriverWait
+from selenium.webdriver.support import expected_conditions as EC
+from selenium_selector_autocorrect import install_auto_correct_hook
+
+install_auto_correct_hook()
+
+driver = webdriver.Chrome()
+driver.get("https://example.com")
+
+element = WebDriverWait(driver, 10).until(
+    EC.presence_of_element_located((By.ID, "some-element"))
+)
+```
+
+## AI Service Setup
+
+This package requires a local AI service with an OpenAI-compatible API. We recommend using **[VS Code Copilot as Service](https://marketplace.visualstudio.com/items?itemName=MartyZhou.vscode-copilot-as-service)**, which exposes GitHub Copilot through a local HTTP server.
+
+### Installing VS Code Copilot as Service
+
+1. Install from VS Code Marketplace or run:
+   ```bash
+   code --install-extension MartyZhou.vscode-copilot-as-service
+   ```
+
+2. The extension automatically starts a server on `http://localhost:8765`
+
+3. Requires an active GitHub Copilot subscription
+
+
+## Configuration
+
+Configure via environment variables:
+
+- `LOCAL_AI_API_URL`: URL of local AI service (default: `http://localhost:8765`)
+- `SELENIUM_AUTO_CORRECT`: Enable/disable auto-correction (default: `"1"`)
+- `SELENIUM_SUGGEST_BETTER`: Suggest better selectors for found elements (default: `"0"`)
+- `SELENIUM_AUTO_UPDATE_TESTS`: Auto-update test files with corrections (default: `"0"`)
+
+### Example
+
+```python
+import os
+
+os.environ['LOCAL_AI_API_URL'] = 'http://localhost:8765'
+os.environ['SELENIUM_AUTO_CORRECT'] = '1'
+os.environ['SELENIUM_AUTO_UPDATE_TESTS'] = '1'  # Enable auto-update
+```
+
+## Usage
+
+### Basic Usage
+
+```python
+from selenium_selector_autocorrect import install_auto_correct_hook
+
+install_auto_correct_hook()
+```
+
+### Advanced Usage
+
+```python
+from selenium_selector_autocorrect import (
+    install_auto_correct_hook,
+    get_auto_correct,
+    get_correction_tracker,
+    export_corrections_report
+)
+
+install_auto_correct_hook()
+
+auto_correct = get_auto_correct()
+auto_correct.enabled = True
+auto_correct.suggest_better_selectors = False
+
+# Export corrections report at end of test run
+tracker = get_correction_tracker()
+export_corrections_report("corrections_report.json")
+tracker = get_correction_tracker()
+export_corrections_report("corrections_report.json")
+
+print(f"Total corrections: {len(tracker.get_corrections())}")
+print(f"Successful corrections: {len(tracker.get_successful_corrections())}")
+```
+
+### Custom AI Provider
+
+```python
+from selenium_selector_autocorrect import AIProvider, configure_provider
+
+class CustomAIProvider(AIProvider):
+    def is_available(self) -> bool:
+        return True
+    
+    def suggest_selector(self, system_prompt: str, user_prompt: str):))
+```
+
+## How It Works
+
+1. **Hook Installation**: Patches `WebDriverWait.until()` to add auto-correction
+2. **Timeout Detection**: When a selector times out, the original exception is caught
+3. **Page Analysis**: JavaScript extracts visible elements and their attributes
+4. **AI Suggestion**: Sends page context to AI provider for selector suggestion
+5. **Verification**: Tests the suggested selector
+6. **Success Handling**: If successful, records the correction and optionally updates the test file
+7. **Fallback**: If correction fails, raises the original TimeoutException
+
+## AI Provider Setup
+
+### Local AI Service
+
+The package requires a local AI service with OpenAI-compatible API:
+
+```bash
+POST http://localhost:8765/v1/chat/completions
+```
+
+For file auto-updates:
+```bash
+POST http://localhost:8765/v1/workspace/files/read
+POST http://localhost:8765/v1/workspace/files/edit
+## Correction Reports
+
+Export correction reports in JSON format:
+
+```python
+from selenium_selector_autocorrect import export_corrections_report
+
+export_corrections_report("corrections_report.json")
+```
+
+Report format:
+```json
+{
+  "corrections": [
+    {
+      "original_by": "id",
+      "original_value": "old-selector",
+      "corrected_by": "css selector",
+      "corrected_value": ".new-selector",
+      "success": true,
+      "test_file": "/path/to/test.py",
+      "test_line": 42,
+      "timestamp": "2024-01-31T10:30:00"
+    }
+  ],
+  "summary": {
+    "total": 10,
+    "successful": 8,
+    "generated_at": "2024-01-31T10:35:00"
+  }
+}
+```
+
+## Best Practices
+
+1. **Install Once**: Call `install_auto_correct_hook()` once at test suite startup (e.g., in `conftest.py`)
+2. **Review Corrections**: Regularly review correction reports to identify brittle selectors
+3. **Update Tests**: Use auto-update sparingly and review changes before committing
+4. **Monitor AI Service**: Ensure your AI service is running and responsive
+5. **Use Strong Selectors**: The tool helps with failures but writing robust selectors is still preferred
+
+## Requirements
+
+- Python >= 3.8
+- selenium >= 4.0.0
+- requests >= 2.25.0
+
+## License
+
+MITInstall hook once at test suite startup (e.g., in conftest.py)
+2. Review correction reports regularly to identify brittle selectors
+3. Use auto-update sparingly and review changes before committing
+4. Ensure your AI service is running and responsive
+5. Write robust selectors - the tool helps with failures but prevention is better
+
+When contributing:
+1. Follow PEP 8 style guidelines
+2. Add tests for new features
+3. Update documentation
+4. No emojis in code or documentation
+
+## Troubleshooting
+
+### AI Service Not Available
+
+Contributions are welcome! Please:
+1. Follow PEP 8 style guidelines
+2. Add tests for new features
+3. Update documentation
+4. Maintain consistency with existing code
+
+**Possible causes**:
+- `SELENIUM_AUTO_UPDATE_TESTS` not set to `"1"`
+- Test file path not detected correctly
+- Selector string not found in source file (check quotes)
+
+### No Corrections Happening
+Solution: Ensure your local AI service is running on the configured port.
+
+### Test File Not Updated
+
+Possible causes:
+- `SELENIUM_AUTO_UPDATE_TESTS` not set to "1"
+- Test file path not detected correctly
+- Selector string not found in source file
+
+### No Corrections Happening
+
+Check:
+1. Hook is installed - look for log message
+2. AI service is available - check `get_auto_correct().is_service_available()`
+3. Auto-correct is enabled - c
+See CHANGELOG.md for version history and changes.

selenium_selector_autocorrect-0.1.0/README.md

@@ -0,0 +1,237 @@
+# Selenium Selector AutoCorrect
+
+A Python package that automatically corrects Selenium element selectors using AI when they fail, reducing test maintenance and improving test reliability.
+
+## Features
+
+- **Automatic Selector Correction**: When a WebDriverWait times out, the package uses AI to analyze the page and suggest working alternatives
+- **Local AI Integration**: Uses a local AI service with OpenAI-compatible API
+- **Correction Tracking**: Records all corrections with source file and line information
+- **Optional Auto-Update**: Can automatically update test files with corrected selectors
+- **Zero Code Changes**: Works by hooking into Selenium's WebDriverWait
+
+## Installation
+
+```bash
+pip install selenium-selector-autocorrect
+```
+
+## Quick Start
+
+```python
+from selenium import webdriver
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support.wait import WebDriverWait
+from selenium.webdriver.support import expected_conditions as EC
+from selenium_selector_autocorrect import install_auto_correct_hook
+
+install_auto_correct_hook()
+
+driver = webdriver.Chrome()
+driver.get("https://example.com")
+
+element = WebDriverWait(driver, 10).until(
+    EC.presence_of_element_located((By.ID, "some-element"))
+)
+```
+
+## AI Service Setup
+
+This package requires a local AI service with an OpenAI-compatible API. We recommend using **[VS Code Copilot as Service](https://marketplace.visualstudio.com/items?itemName=MartyZhou.vscode-copilot-as-service)**, which exposes GitHub Copilot through a local HTTP server.
+
+### Installing VS Code Copilot as Service
+
+1. Install from VS Code Marketplace or run:
+   ```bash
+   code --install-extension MartyZhou.vscode-copilot-as-service
+   ```
+
+2. The extension automatically starts a server on `http://localhost:8765`
+
+3. Requires an active GitHub Copilot subscription
+
+
+## Configuration
+
+Configure via environment variables:
+
+- `LOCAL_AI_API_URL`: URL of local AI service (default: `http://localhost:8765`)
+- `SELENIUM_AUTO_CORRECT`: Enable/disable auto-correction (default: `"1"`)
+- `SELENIUM_SUGGEST_BETTER`: Suggest better selectors for found elements (default: `"0"`)
+- `SELENIUM_AUTO_UPDATE_TESTS`: Auto-update test files with corrections (default: `"0"`)
+
+### Example
+
+```python
+import os
+
+os.environ['LOCAL_AI_API_URL'] = 'http://localhost:8765'
+os.environ['SELENIUM_AUTO_CORRECT'] = '1'
+os.environ['SELENIUM_AUTO_UPDATE_TESTS'] = '1'  # Enable auto-update
+```
+
+## Usage
+
+### Basic Usage
+
+```python
+from selenium_selector_autocorrect import install_auto_correct_hook
+
+install_auto_correct_hook()
+```
+
+### Advanced Usage
+
+```python
+from selenium_selector_autocorrect import (
+    install_auto_correct_hook,
+    get_auto_correct,
+    get_correction_tracker,
+    export_corrections_report
+)
+
+install_auto_correct_hook()
+
+auto_correct = get_auto_correct()
+auto_correct.enabled = True
+auto_correct.suggest_better_selectors = False
+
+# Export corrections report at end of test run
+tracker = get_correction_tracker()
+export_corrections_report("corrections_report.json")
+tracker = get_correction_tracker()
+export_corrections_report("corrections_report.json")
+
+print(f"Total corrections: {len(tracker.get_corrections())}")
+print(f"Successful corrections: {len(tracker.get_successful_corrections())}")
+```
+
+### Custom AI Provider
+
+```python
+from selenium_selector_autocorrect import AIProvider, configure_provider
+
+class CustomAIProvider(AIProvider):
+    def is_available(self) -> bool:
+        return True
+    
+    def suggest_selector(self, system_prompt: str, user_prompt: str):))
+```
+
+## How It Works
+
+1. **Hook Installation**: Patches `WebDriverWait.until()` to add auto-correction
+2. **Timeout Detection**: When a selector times out, the original exception is caught
+3. **Page Analysis**: JavaScript extracts visible elements and their attributes
+4. **AI Suggestion**: Sends page context to AI provider for selector suggestion
+5. **Verification**: Tests the suggested selector
+6. **Success Handling**: If successful, records the correction and optionally updates the test file
+7. **Fallback**: If correction fails, raises the original TimeoutException
+
+## AI Provider Setup
+
+### Local AI Service
+
+The package requires a local AI service with OpenAI-compatible API:
+
+```bash
+POST http://localhost:8765/v1/chat/completions
+```
+
+For file auto-updates:
+```bash
+POST http://localhost:8765/v1/workspace/files/read
+POST http://localhost:8765/v1/workspace/files/edit
+## Correction Reports
+
+Export correction reports in JSON format:
+
+```python
+from selenium_selector_autocorrect import export_corrections_report
+
+export_corrections_report("corrections_report.json")
+```
+
+Report format:
+```json
+{
+  "corrections": [
+    {
+      "original_by": "id",
+      "original_value": "old-selector",
+      "corrected_by": "css selector",
+      "corrected_value": ".new-selector",
+      "success": true,
+      "test_file": "/path/to/test.py",
+      "test_line": 42,
+      "timestamp": "2024-01-31T10:30:00"
+    }
+  ],
+  "summary": {
+    "total": 10,
+    "successful": 8,
+    "generated_at": "2024-01-31T10:35:00"
+  }
+}
+```
+
+## Best Practices
+
+1. **Install Once**: Call `install_auto_correct_hook()` once at test suite startup (e.g., in `conftest.py`)
+2. **Review Corrections**: Regularly review correction reports to identify brittle selectors
+3. **Update Tests**: Use auto-update sparingly and review changes before committing
+4. **Monitor AI Service**: Ensure your AI service is running and responsive
+5. **Use Strong Selectors**: The tool helps with failures but writing robust selectors is still preferred
+
+## Requirements
+
+- Python >= 3.8
+- selenium >= 4.0.0
+- requests >= 2.25.0
+
+## License
+
+MITInstall hook once at test suite startup (e.g., in conftest.py)
+2. Review correction reports regularly to identify brittle selectors
+3. Use auto-update sparingly and review changes before committing
+4. Ensure your AI service is running and responsive
+5. Write robust selectors - the tool helps with failures but prevention is better
+
+When contributing:
+1. Follow PEP 8 style guidelines
+2. Add tests for new features
+3. Update documentation
+4. No emojis in code or documentation
+
+## Troubleshooting
+
+### AI Service Not Available
+
+Contributions are welcome! Please:
+1. Follow PEP 8 style guidelines
+2. Add tests for new features
+3. Update documentation
+4. Maintain consistency with existing code
+
+**Possible causes**:
+- `SELENIUM_AUTO_UPDATE_TESTS` not set to `"1"`
+- Test file path not detected correctly
+- Selector string not found in source file (check quotes)
+
+### No Corrections Happening
+Solution: Ensure your local AI service is running on the configured port.
+
+### Test File Not Updated
+
+Possible causes:
+- `SELENIUM_AUTO_UPDATE_TESTS` not set to "1"
+- Test file path not detected correctly
+- Selector string not found in source file
+
+### No Corrections Happening
+
+Check:
+1. Hook is installed - look for log message
+2. AI service is available - check `get_auto_correct().is_service_available()`
+3. Auto-correct is enabled - c
+See CHANGELOG.md for version history and changes.

selenium_selector_autocorrect-0.1.0/pyproject.toml

@@ -0,0 +1,138 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "selenium-selector-autocorrect"
+version = "0.1.0"
+description = "Automatic Selenium selector correction using AI when elements fail to be found"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+authors = [
+    {name = "Marty Zhou", email = "marty.zhou@example.com"}
+]
+maintainers = [
+    {name = "Marty Zhou", email = "marty.zhou@example.com"}
+]
+keywords = [
+    "selenium",
+    "testing",
+    "automation",
+    "ai",
+    "web-testing",
+    "test-automation",
+    "selector",
+    "auto-correction"
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development :: Quality Assurance",
+    "Framework :: Pytest",
+]
+dependencies = [
+    "selenium>=4.0.0",
+    "requests>=2.25.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "black>=23.0.0",
+    "isort>=5.12.0",
+    "mypy>=1.0.0",
+    "ruff>=0.1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/MartyZhou/selenium-selector-autocorrect"
+Documentation = "https://github.com/MartyZhou/selenium-selector-autocorrect#readme"
+Repository = "https://github.com/MartyZhou/selenium-selector-autocorrect"
+Issues = "https://github.com/MartyZhou/selenium-selector-autocorrect/issues"
+Changelog = "https://github.com/MartyZhou/selenium-selector-autocorrect/blob/main/CHANGELOG.md"
+
+[tool.setuptools]
+packages = ["selenium_selector_autocorrect"]
+package-dir = {"" = "src"}
+
+[tool.setuptools.package-data]
+selenium_selector_autocorrect = ["py.typed"]
+
+[tool.black]
+line-length = 120
+target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
+include = '\.pyi?$'
+
+[tool.isort]
+profile = "black"
+line_length = 120
+src_paths = ["src"]
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 120
+target-version = "py38"
+src = ["src"]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "UP",  # pyupgrade
+]
+ignore = [
+    "E501",  # line too long (handled by black)
+    "B008",  # do not perform function calls in argument defaults
+    "C901",  # too complex
+]
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401"]
+"tests/**" = ["F401", "F841"]
+
+[tool.pytest.ini_options]
+minversion = "7.0"
+testpaths = ["tests"]
+python_files = ["test_*.py", "*_test.py"]
+addopts = "-ra --strict-markers --cov=src/selenium_selector_autocorrect --cov-report=term-missing --cov-report=html"
+markers = [
+    "unit: Unit tests",
+    "integration: Integration tests",
+    "slow: Slow tests",
+]
+
+[tool.coverage.run]
+source = ["src/selenium_selector_autocorrect"]
+branch = true
+omit = ["*/tests/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "pass",
+]
+precision = 2

selenium_selector_autocorrect-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+