Skip to content

[codex] Add typed method alternatives and tested docs#18

Merged
Code0x58 merged 8 commits into
masterfrom
feature/methods
May 10, 2026
Merged

[codex] Add typed method alternatives and tested docs#18
Code0x58 merged 8 commits into
masterfrom
feature/methods

Conversation

@Code0x58
Copy link
Copy Markdown
Owner

Summary

  • Move the public typing surface into alternative.pyi while keeping alternative.py focused on runtime behavior.
  • Add typed and runtime support for instance methods, classmethods, and staticmethods.
  • Add pyright to the dev workflow and keep PyCharm type probes as an IDE regression check.
  • Run documentation Python snippets as individual pytest-collected Sybil tests and remove duplicate examples/test_*.py files in favor of Read the Docs sections.
  • Update the README to describe descriptor support, IDE typing behavior, and the known JetBrains PyNestedDecoratorsInspection false-positive.

Validation

  • uv sync --dev --group=docs
  • uv run --dev ruff format --check --diff .
  • uv run --dev ruff check .
  • uv run --dev pyrefly check .
  • uv run --dev pyright typing_tests
  • uv run --dev mypy .
  • uv run --dev pytest --verbosity=2 --cov=alternative --cov-report=xml --cov-fail-under=100 --junit-xml=test-results.xml
  • uv run --group=docs sphinx-build --fail-on-warning --keep-going --builder=html docs /tmp/alternative-docs-html
  • uv run --dev stubtest alternative
  • scripts/pycharm-type-probes.sh
  • git diff --check

@codecov
Copy link
Copy Markdown

codecov Bot commented May 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (288bc48) to head (c2b3e07).
⚠️ Report is 1 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff            @@
##            master       #18   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines          198       244   +46     
=========================================
+ Hits           198       244   +46     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Code0x58 Code0x58 marked this pull request as ready for review May 10, 2026 13:23
@Code0x58 Code0x58 merged commit 3d76598 into master May 10, 2026
5 checks passed
@Code0x58 Code0x58 deleted the feature/methods branch May 10, 2026 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant