feat: add deprecation proxies for built-in types, `dataclass` and Enum by Borda · Pull Request #114 · Borda/pyDeprecate

Borda · 2026-03-01T22:39:30Z

Before submitting

Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
Did you make sure to update the docs?
Did you write any new necessary tests?

What does this PR do?

This pull request updates the documentation and public API to introduce new proxy-based deprecation tools: deprecated_instance for wrapping constants and objects, and deprecated_class for deprecating entire Enums or dataclasses. It also adds detailed usage instructions and examples to both the README and contributing guidelines, and notes a follow-up for extending audit coverage to these new features.

Documentation and API updates:

Added documentation and usage examples for deprecated_instance and deprecated_class to the README, including runnable code blocks and output sections for clarity. [1] [2]
Updated the API reference in src/deprecate/__init__.py to include the new proxy functions, and re-exported them for public use. [1] [2]

Contributing guidelines improvements:

Added a guideline to always use full import paths with Sphinx cross-reference syntax in docstrings, and updated the module structure to include the new proxy.py file. [1] [2]
Expanded testing guidelines to clarify the three-layer separation and rules for README example tests, especially regarding the use of pytest.raises, avoiding bare assert, and not defining classes or targets inline in test files.

Future audit enhancements:

Added a TODO in audit.py noting the need to extend audit functions to detect and validate deprecated proxy objects and constants, ensuring they are treated consistently with regular callables.

Part of #109

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

…g objects and classes Co-authored-by: Claude code <noreply@anthropic.com>

for more information, see https://pre-commit.ci

…ests and implementation

for more information, see https://pre-commit.ci

dosubot · 2026-03-02T00:25:55Z

Related Documentation

Checked 1 published document(s) in 1 knowledge base(s). No updates required.

^{How did I do? Any feedback?}

…nto feat/structs

Copilot

Pull request overview

This PR introduces new proxy-based deprecation utilities to the public API (deprecated_instance and deprecated_class) to support deprecating non-callable instances/constants and whole class objects (e.g., Enums/dataclasses) with optional target redirection, and updates docs + tests accordingly.

Changes:

Added src/deprecate/proxy.py implementing _DeprecatedProxy, deprecated_instance(), and deprecated_class().
Exported the new proxy utilities via src/deprecate/__init__.py and documented them in README.md and .github/CONTRIBUTING.md.
Added new integration + unit tests and updated test collections with proxy-based deprecation examples.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
`src/deprecate/proxy.py`	Implements the new proxy abstraction and the `deprecated_instance` / `deprecated_class` APIs.
`src/deprecate/__init__.py`	Re-exports the new proxy utilities as part of the public API.
`src/deprecate/audit.py`	Adds a TODO note related to audit coverage for proxies.
`README.md`	Documents `deprecated_instance` and `deprecated_class` with runnable examples and outputs.
`.github/CONTRIBUTING.md`	Adds documentation/test-writing guidance and references the new module.
`tests/collection_targets.py`	Adds a target Enum used for forwarding tests.
`tests/collection_deprecate.py`	Adds proxy-based deprecated constants and class wrappers used by integration/unit tests.
`tests/integration/test_instance.py`	Adds integration coverage for `deprecated_instance` behavior (warnings, read-only, etc.).
`tests/unittests/test_structures.py`	Adds unit tests for `_DeprecatedProxy` internals and `deprecated_class` behavior.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

for more information, see https://pre-commit.ci

Co-authored-by: Codex <codex@openai.com>

…nto feat/structs

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.

for more information, see https://pre-commit.ci

kilo-code-bot · 2026-03-02T08:29:36Z

Code Review Summary

Status: 2 Issues Found | Recommendation: Address before merge

Overview

Severity	Count
CRITICAL	1
WARNING	1
SUGGESTION	0

Issue Details (click to expand)

CRITICAL

File	Line	Issue
`tests/integration/test_instance.py`	154	Comparison of identical values

WARNING

File	Line	Issue
`src/deprecate/proxy.py`	132	Incorrect comment

Other Observations (not in diff)

Issues found in unchanged code that cannot receive inline comments:

File	Line	Issue
`src/deprecate/proxy.py`	240	len uses source object even when target is set, while iter uses active object (target if set) - this inconsistency is noted as intentional in tests but should be documented
`README.md`	490	Example wraps a float constant but notes that arithmetic operations don't work - consider clarifying that proxy doesn't implement arithmetic dunder methods

Files Reviewed (9 files)

src/deprecate/proxy.py - 1 issue
tests/integration/test_instance.py - 1 issue
README.md - documentation concern
src/deprecate/__init__.py - no issues
src/deprecate/audit.py - no issues
tests/collection_deprecate.py - no issues
tests/collection_targets.py - no issues
tests/integration/test_audit.py - no issues
tests/unittests/test_proxy.py - no issues
.github/CONTRIBUTING.md - no issues

… values Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

for more information, see https://pre-commit.ci

…lated tests, docs, and implementation

for more information, see https://pre-commit.ci

….parametrize` and improve warning match specificity

…rning match formatting for readability

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 8 comments.

Copilot · 2026-03-02T10:10:10Z

@Borda I've opened a new pull request, #115, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Borda · 2026-03-02T10:19:02Z

@codex[agent] implement all unresolved suggestions from the code review

Codex · 2026-03-02T10:19:11Z

@Borda I've opened a new pull request, #116, to work on those changes. Once the pull request is ready, I'll request review from you.

* Initial plan * fix: address remaining proxy review feedback * test: fix audit test spacing and rerun targeted tests * test: add proxy audit edge-case coverage --------- Co-authored-by: openai-code-agent[bot] <242516109+Codex@users.noreply.github.com>

…dit tests

… 'import' and 'import from' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

…e` references in audit tests

…ext on proxy object coverage gaps

…deprecated__` dictionaries for cleaner state management and metadata alignment

for more information, see https://pre-commit.ci

feat: Add DeprecatedStruct and deprecated_instance for deprecatin…

6b14066

…g objects and classes Co-authored-by: Claude code <noreply@anthropic.com>

Borda force-pushed the feat/structs branch from 648a53f to 6b14066 Compare March 1, 2026 23:49

[pre-commit.ci] auto fixes from pre-commit.com hooks

c3c1e9e

for more information, see https://pre-commit.ci

github-advanced-security AI found potential problems Mar 1, 2026

View reviewed changes

Comment thread tests/integration/test_instance.py Fixed

Borda and others added 2 commits March 2, 2026 01:17

refactor: Replace DeprecatedStruct with _DeprecatedProxy across t…

8762e4a

…ests and implementation

[pre-commit.ci] auto fixes from pre-commit.com hooks

970f750

for more information, see https://pre-commit.ci

Borda added the enhancement New feature or request label Mar 2, 2026

Merge branch 'main' into feat/structs

14f1e99

Borda marked this pull request as ready for review March 2, 2026 00:24

Copilot AI review requested due to automatic review settings March 2, 2026 00:24

Copilot started reviewing on behalf of Borda March 2, 2026 00:24 View session

dosubot Bot added documentation Improvements or additions to documentation tests labels Mar 2, 2026

Borda added 2 commits March 2, 2026 01:26

docs: Fix unclosed <details> tags in README.md

6d8a8c3

Merge branch 'feat/structs' of https://github.com/Borda/pyDeprecate i…

5711a4a

…nto feat/structs

Copilot AI reviewed Mar 2, 2026

View reviewed changes

Borda changed the title ~~feat: add target redirection for deprecation proxies~~ feat: add deprecation proxies for built-in types, dataclass and Enum Mar 2, 2026

Borda and others added 4 commits March 2, 2026 07:26

Apply suggestions from code review

27cd9d6

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

75cfb00

for more information, see https://pre-commit.ci

Address unresolved PR #114 suggestions

e0fd9b4

Co-authored-by: Codex <codex@openai.com>

Merge branch 'feat/structs' of https://github.com/Borda/pyDeprecate i…

be342b7

…nto feat/structs

Borda requested a review from Copilot March 2, 2026 07:07

github-advanced-security AI found potential problems Mar 2, 2026

View reviewed changes

Comment thread tests/integration/test_instance.py Fixed

Copilot started reviewing on behalf of Borda March 2, 2026 07:07 View session

linting

d56953e

Copilot AI reviewed Mar 2, 2026

View reviewed changes

Comment thread src/deprecate/audit.py Outdated

Comment thread tests/integration/test_instance.py Outdated

Comment thread src/deprecate/proxy.py

Comment thread src/deprecate/proxy.py

Comment thread src/deprecate/proxy.py

Comment thread README.md Outdated

Borda and others added 2 commits March 2, 2026 09:25

tests: Add TODO-based skipped tests for proxy and audit behavior

c63825a

[pre-commit.ci] auto fixes from pre-commit.com hooks

e9f237f

for more information, see https://pre-commit.ci

github-advanced-security AI found potential problems Mar 2, 2026

View reviewed changes

Comment thread tests/integration/test_audit.py Fixed

kilo-code-bot Bot reviewed Mar 2, 2026

View reviewed changes

Comment thread tests/integration/test_instance.py Outdated

Comment thread src/deprecate/proxy.py Outdated

Borda and others added 7 commits March 2, 2026 09:33

Potential fix for code scanning alert no. 40: Comparison of identical…

07c2bf6

… values Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

Apply suggestions from code review

4f1e706

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

85c61a8

for more information, see https://pre-commit.ci

refactor(proxy): Rename arg_mapping to args_mapping and update re…

07fe8d2

…lated tests, docs, and implementation

[pre-commit.ci] auto fixes from pre-commit.com hooks

07e0e0f

for more information, see https://pre-commit.ci

refactor(tests): Consolidate repetitive test logic using `pytest.mark…

2e6a3ca

….parametrize` and improve warning match specificity

refactor(tests): Simplify and clarify test docstrings, and improve wa…

26085ba

…rning match formatting for readability

Borda requested a review from Copilot March 2, 2026 09:39

Copilot started reviewing on behalf of Borda March 2, 2026 09:40 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

Copilot AI mentioned this pull request Mar 2, 2026

Fix ineffective catch_warnings context in test_len_no_warn #115

Closed

Apply suggestions from code review

ab4c4f2

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Codex AI mentioned this pull request Mar 2, 2026

Addressing PR comments #116

Merged

Addressing PR comments (#116)

6c33b70

* Initial plan * fix: address remaining proxy review feedback * test: fix audit test spacing and rerun targeted tests * test: add proxy audit edge-case coverage --------- Co-authored-by: openai-code-agent[bot] <242516109+Codex@users.noreply.github.com>

github-advanced-security AI found potential problems Mar 2, 2026

View reviewed changes

Comment thread tests/integration/test_audit.py Fixed

Borda and others added 7 commits March 2, 2026 11:43

refactor(tests): Improve assertions for deprecated enum targets in au…

536357b

…dit tests

Potential fix for code scanning alert no. 42: Module is imported with…

4a974fd

… 'import' and 'import from' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

refactor(tests): Replace direct callable references with `proxy_modul…

0acc56a

…e` references in audit tests

refactor(audit): Replace FIXME comments with TODO for better cont…

4628793

…ext on proxy object coverage gaps

refactor(proxy): Consolidate proxy attributes into __config and `__…

89912f3

…deprecated__` dictionaries for cleaner state management and metadata alignment

[pre-commit.ci] auto fixes from pre-commit.com hooks

ce72347

for more information, see https://pre-commit.ci

Merge branch 'main' into feat/structs

b9b0fce

Borda merged commit de3be7f into main Mar 2, 2026
33 of 34 checks passed

Borda deleted the feat/structs branch March 2, 2026 12:50

Conversation

Borda commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

PR review

Did you have fun?

Uh oh!

Uh oh!

dosubot Bot commented Mar 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kilo-code-bot Bot commented Mar 2, 2026

Code Review Summary

Overview

CRITICAL

WARNING

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Mar 2, 2026

Uh oh!

Borda commented Mar 2, 2026

Uh oh!

Codex AI commented Mar 2, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Borda commented Mar 1, 2026 •

edited

Loading