selenium-expect 1.0.0__tar.gz

selenium_expect-1.0.0/.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,toml}]
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[*.{yml,yaml,json,md}]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

selenium_expect-1.0.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Report a bug or unexpected behavior
+title: "[Bug] "
+labels: bug
+---
+
+## Description
+
+<!-- A clear description of the bug -->
+
+## Reproduction
+
+```python
+# Minimal code to reproduce
+```
+
+## Expected behavior
+
+<!-- What you expected to happen -->
+
+## Actual behavior
+
+<!-- What actually happened -->
+
+## Environment
+
+- selenium-expect version:
+- Selenium version:
+- Python version:
+- OS:
+
+## Stack trace
+
+```text
+<!-- Paste any error output here -->
+```

selenium_expect-1.0.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,18 @@
+---
+name: Feature request
+about: Suggest a new assertion or enhancement
+title: "[Feature] "
+labels: enhancement
+---
+
+## Motivation
+
+<!-- Why is this needed? What problem does it solve? -->
+
+## Proposal
+
+<!-- Describe the feature or assertion you'd like to see -->
+
+## Alternatives considered
+
+<!-- Any alternatives you've considered -->

selenium_expect-1.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+## Summary
+
+<!-- Brief description of what this PR does -->
+
+## Type of change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change
+- [ ] Documentation
+- [ ] Refactor
+
+## Checklist
+
+- [ ] `ruff check .` passes
+- [ ] `ruff format --check .` passes
+- [ ] `mypy --strict selenium_expect` passes
+- [ ] `pytest` passes with >= 90% coverage
+- [ ] New behavior is covered by tests
+- [ ] `CHANGELOG.md` updated under `[Unreleased]`

selenium_expect-1.0.0/.github/dependabot.yml

@@ -0,0 +1,24 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: weekly
+    labels:
+      - dependencies
+      - python
+    groups:
+      dev-dependencies:
+        patterns:
+          - "pytest*"
+          - "ruff"
+          - "mypy"
+          - "build"
+          - "pre-commit"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
+    labels:
+      - dependencies
+      - github-actions

selenium_expect-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,66 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - run: pip install -e ".[dev]"
+      - run: ruff check .
+      - run: ruff format --check .
+      - run: mypy --strict selenium_expect
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+        include:
+          - os: windows-latest
+            python-version: "3.13"
+          - os: macos-latest
+            python-version: "3.13"
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: pytest tests/ -v --cov --cov-report=xml
+      - uses: codecov/codecov-action@v7
+        with:
+          files: ./coverage.xml
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/

selenium_expect-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - run: pip install -e ".[docs]"
+      - run: mkdocs build --strict
+      - uses: actions/configure-pages@v5
+      - uses: actions/upload-pages-artifact@v5
+        with:
+          path: ./site
+      - id: deployment
+        uses: actions/deploy-pages@v4

selenium_expect-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,57 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v7
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  release-github:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v7
+        with:
+          name: dist
+          path: dist/
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          tag="${GITHUB_REF#refs/tags/}"
+          gh release create "$tag" \
+            --title "$tag" \
+            --generate-notes \
+            dist/*

selenium_expect-1.0.0/.gitignore

@@ -0,0 +1,45 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+coverage.xml
+
+# Type checking
+.mypy_cache/
+.ruff_cache/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Docs
+site/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Project
+ref/
+screenshots/
+tests/integration/test_page.html
+
+# AI assistant context
+AGENTS.md

selenium_expect-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      - id: detect-private-key
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.0
+    hooks:
+      - id: mypy
+        additional_dependencies: ["selenium>=4.10"]
+        args: [--strict, selenium_expect]

selenium_expect-1.0.0/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-08-27
+
+### Added
+
+- Project skeleton with CI, linting, and build infrastructure
+- Regression tests for all bug fixes listed below
+- `CONTRIBUTING.md` with development setup, testing guidelines, and architecture overview
+- `SECURITY.md` with vulnerability reporting policy
+- `CODE_OF_CONDUCT.md` based on Contributor Covenant 2.1
+- GitHub issue templates for bug reports and feature requests
+- Automated release workflow (`.github/workflows/release.yml`) with PyPI trusted publishing and GitHub Releases
+- `expect.configure()` example and Features section to README
+- Ruff badge to README header
+- Comprehensive MkDocs documentation with Material theme
+- Auto-retry polling with configurable timeout and backoff schedules
+- Fluent assertion API for `WebElement`, `WebDriver`, `list[WebElement]`, `Alert`, `Select`, `ShadowRoot`, iframes, cookies, JavaScript, and windows
+- Locator-based expect to avoid `StaleElementReferenceException`
+- Soft assertions with `SoftAssertionCollector` and `assert_all()`
+- Custom matchers via `@extend` decorator and `merge_expects()`
+- `expect.poll()` for retry-based assertions on arbitrary functions
+- `ExpectConfig` dataclass for global and per-assertion configuration
+- Screenshot capture on assertion failure
+- Debug mode with per-poll logging
+- Descriptive error messages with timelines and actual vs expected values
+- Composition assertions: `to_satisfy_all`, `to_satisfy_any`, `to_satisfy_none`
+- Negation via `.not_` on all assertions
+
+### Fixed
+
+- **`_retry.py`**: Empty `polling_intervals` list caused `IndexError` on first poll
+- **`_retry.py`**: `timeout=0` skipped the first poll, never evaluating the condition
+- **`_config.py`**: `ExpectConfig` did not validate empty `polling_intervals` lists
+- **`_config.py`**: `set_default_timeout()` did not normalize milliseconds (int >= 1000 treated as seconds instead of ms)
+- **`_poll.py`**: `PollAssertion.to_contain()` crashed on falsy non-string values (`0`, `False`, `[]`)
+- **`_poll.py`**: `PollAssertion` did not normalize timeout consistently with `expect()`
+- **`_poll.py`**: Missing validation for empty per-assertion `polling` lists
+- **`_expect.py`**: `expect(timeout=5000)` stored 5000 seconds instead of 5 seconds (timeout not normalized before config overrides)
+- **`_locator.py`**: `LocatorExpect.__getattr__` did not fall back to `CustomMatcherRegistry`, breaking custom matchers on locator-based assertions
+- **`list.py`**: `to_have_texts_contains` and `to_have_texts_containing` crashed on `None` element text
+- **`js.py`**: `to_have_js_result_contains` crashed on falsy non-string values (`0`, `False`, `[]`)
+- **`js.py`**: JavaScript injection vulnerability in `localStorage`, `sessionStorage`, and `to_have_js_variable` methods (f-string interpolation replaced with `arguments[0]` parameter passing)
+- **`driver.py`**: `to_have_capability_contains` crashed on falsy non-string capability values (`False`, `0`)
+- **`element.py`**: `to_have_property_contains` crashed on falsy non-string property values (`False`, `0`)
+
+### Changed
+
+- **`_expect.py`**: Replaced `expect` function with monkeypatched `.poll`/`.configure` attributes with a proper `Expect` callable class — eliminates `type: ignore`, improves type safety and API discoverability
+- **`_base.py`**: Replaced `os`/`os.path` with `pathlib.Path` for screenshot path handling
+- **`_base.py`**: Screenshot timestamps now use timezone-aware `datetime.now(tz=UTC)` instead of naive `datetime.now()`
+- **`_config.py`**: Centralized `normalize_timeout` function imported by all modules that need timeout normalization

selenium_expect-1.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# Code of Conduct
+
+## Our pledge
+
+We pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes
+- Focusing on what is best for the overall community
+
+Examples of unacceptable behavior:
+
+- The use of sexualized language or imagery, and sexual attention or advances
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information without explicit permission
+- Other conduct which could reasonably be considered inappropriate
+
+## Enforcement responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces and also applies when an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at **mathias.paulenko@outlook.com**. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1, available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct/>.

selenium_expect-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,108 @@
+# Contributing to selenium-expect
+
+Thank you for your interest in contributing! This document covers the
+essential setup and workflow for contributors.
+
+## Development setup
+
+```bash
+git clone https://github.com/MathiasPaulenko/selenium-expect.git
+cd selenium-expect
+pip install -e ".[dev]"
+pre-commit install
+```
+
+## Daily workflow
+
+```bash
+make check      # lint + format check + type check + tests
+make lint-fix   # auto-fix lint issues
+make format     # format code
+make test       # run unit tests
+make test-cov   # run tests with coverage report
+```
+
+## Code quality gates
+
+All contributions must pass:
+
+- **ruff** — linting and formatting (`ruff check` + `ruff format --check`)
+- **mypy --strict** — type checking with no `Any` leakage
+- **pytest** — unit tests with >= 90% coverage
+- **pre-commit hooks** — trailing whitespace, YAML/TOML validation, etc.
+
+Run `make check` before pushing to catch issues early.
+
+## Testing guidelines
+
+- **Unit tests** (`tests/unit/`) — fast, no browser required. Mock all
+  Selenium objects. Every bug fix must include a regression test.
+- **Integration tests** (`tests/integration/`) — require a real browser
+  (Chrome or Firefox). Run with `pytest -m integration`.
+
+### Test conventions
+
+- Use `pytest` fixtures for shared setup (see `tests/conftest.py`).
+- Mock drivers and elements via `unittest.mock.MagicMock`.
+- Name regression tests descriptively: `test_<scenario>_<expected_behavior>`.
+- Place regression tests in `tests/unit/test_regression_fixes.py`.
+
+## Pull request process
+
+1. Create a feature branch from `main`.
+2. Write tests for your change.
+3. Ensure `make check` passes.
+4. Update `CHANGELOG.md` under `## [Unreleased]`.
+5. Open a PR with a clear description linking to any relevant issues.
+
+## Architecture overview
+
+```text
+selenium_expect/
+├── __init__.py          # Public API exports
+├── _expect.py           # Expect callable class — main dispatcher
+├── _config.py           # ExpectConfig (immutable, frozen dataclass)
+├── _retry.py            # retry_until() — agnostic retry loop
+├── _poll.py             # PollAssertion — expect.poll()
+├── _locator.py          # LocatorExpect — re-finds element each poll
+├── _soft.py             # SoftAssertionCollector
+├── _matcher.py          # Custom matcher registry (@extend)
+├── _compose.py          # to_satisfy_all/any/none
+├── _errors.py           # AssertionFormatter
+└── assertions/
+    ├── _base.py         # AssertionMixin — _run_assertion()
+    ├── alert.py         # Alert assertions
+    ├── cookie.py        # Cookie assertions
+    ├── driver.py        # WebDriver assertions
+    ├── element.py       # WebElement assertions
+    ├── iframe.py        # iframe assertions
+    ├── js.py            # JavaScript / storage assertions
+    ├── list.py          # List[WebElement] assertions
+    ├── select.py        # Select dropdown assertions
+    ├── shadow.py        # Shadow DOM assertions
+    └── window.py        # Window assertions
+```
+
+Key design principles:
+
+- **Single retry path**: All assertions go through `_run_assertion()` in
+  `_base.py`, which calls `retry_until()` in `_retry.py`.
+- **Immutable config**: `ExpectConfig` is frozen. Use `.replace()` for
+  per-assertion overrides.
+- **Negation via flag**: `not_` property sets `_negate` — no duplicated
+  methods.
+- **Registry pattern**: `ASSERTION_REGISTRY` maps type names to assertion
+  classes. `expect()` dispatches based on target type.
+
+## Release process
+
+1. Update `CHANGELOG.md` with dated version header.
+2. Update `__version__` in `selenium_expect/__init__.py`.
+3. Update `version` in `pyproject.toml`.
+4. Commit and tag: `git tag v0.x.y`.
+5. Push the tag: `git push origin v0.x.y`.
+6. CI automatically builds, publishes to PyPI (via trusted publishing), and creates a GitHub Release.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

selenium_expect-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mathias Paulenko
+
+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_expect-1.0.0/Makefile

@@ -0,0 +1,61 @@
+.PHONY: help install dev lint lint-fix format format-check test test-cov check build docs docs-serve clean
+
+help: ## Show this help message
+	@echo "Available targets:"
+	@echo "  make install       - Editable install (no dev extras)"
+	@echo "  make dev           - Editable install with dev extras"
+	@echo "  make lint          - Run ruff check + mypy --strict"
+	@echo "  make lint-fix      - Auto-fix lint issues with ruff"
+	@echo "  make format        - Format code with ruff format"
+	@echo "  make format-check  - Verify formatting without changes"
+	@echo "  make test          - Run the test suite"
+	@echo "  make test-cov      - Run tests with coverage (fail under 90%)"
+	@echo "  make check         - Run lint + format-check + test (full pre-commit check)"
+	@echo "  make build         - Build sdist + wheel into dist/"
+	@echo "  make docs          - Build documentation site"
+	@echo "  make docs-serve    - Serve documentation locally"
+	@echo "  make clean         - Remove build artifacts and caches"
+
+install: ## Editable install (no dev extras)
+	pip install -e .
+
+dev: ## Editable install with dev extras
+	pip install -e ".[dev]"
+
+lint: ## Run ruff check + mypy --strict
+	ruff check .
+	mypy --strict selenium_expect
+
+lint-fix: ## Auto-fix lint issues
+	ruff check --fix .
+
+format: ## Format code with ruff format
+	ruff format .
+
+format-check: ## Verify formatting without changes
+	ruff format --check .
+
+test: ## Run the test suite
+	pytest
+
+test-cov: ## Run tests with coverage (fail under 90%)
+	pytest --cov=selenium_expect --cov-report=term-missing --cov-fail-under=90
+
+check: ## Run lint + format-check + test (full pre-commit check)
+	ruff check .
+	ruff format --check .
+	mypy --strict selenium_expect
+	pytest
+
+build: ## Build sdist + wheel into dist/
+	python -m build
+
+docs: ## Build documentation site
+	mkdocs build --strict
+
+docs-serve: ## Serve documentation locally
+	mkdocs serve
+
+clean: ## Remove build artifacts and caches
+	python -c "import shutil, pathlib; [shutil.rmtree(p, ignore_errors=True) for p in ['dist','build','.pytest_cache','.mypy_cache','.ruff_cache','htmlcov','site'] + list(pathlib.Path('.').glob('*.egg-info'))]"
+	python -c "import shutil, pathlib; [shutil.rmtree(p, ignore_errors=True) for p in pathlib.Path('.').rglob('__pycache__')]"