mlflow-optimization 0.1.0__tar.gz

mlflow_optimization-0.1.0/LICENSE-APACHE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

mlflow_optimization-0.1.0/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 CoffeeGiNu
+
+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.

mlflow_optimization-0.1.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: mlflow-optimization
+Version: 0.1.0
+Summary: Automatic MLflow logging of mathematical optimization solves
+Author: CoffeeGiNu
+License-Expression: MIT OR Apache-2.0
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Requires-Dist: mlflow-skinny>=3.18.0
+Requires-Python: >=3.12
+Project-URL: Repository, https://github.com/CoffeeGiNu/mlflow-optimization
+Description-Content-Type: text/markdown
+
+# mlflow-optimization
+
+Automatic MLflow logging of mathematical optimization solves.
+
+Supported libraries: [gurobipy, PySCIPOpt, Pyomo, OR-Tools (MathOpt, CP-SAT, Routing)]
+
+## install
+
+Log to a tracking server (`MLFLOW_TRACKING_URI`):
+
+```bash
+pip install mlflow-optimization
+```
+
+> [!NOTE]
+> `mlflow-optimization` installs `mlflow-skinny`, which lacks MLflow's default local store. To log without a tracking server, install `mlflow` as well:
+>
+> ```bash
+> pip install mlflow-optimization mlflow
+> ```
+
+## usage
+
+```python
+import mlflow_optimization
+
+mlflow_optimization.autolog()
+
+with mlflow_optimization.context(instance="knapsack-50", tags={"team": "ops"}):
+    model.optimize()
+
+run = mlflow_optimization.last_solve()
+if run is not None:
+    run.log_metric("gap_to_best_known", 0.02)
+```
+
+## License
+
+Either of Apache License 2.0 or MIT license, at your option.

mlflow_optimization-0.1.0/README.md

@@ -0,0 +1,39 @@
+# mlflow-optimization
+
+Automatic MLflow logging of mathematical optimization solves.
+
+Supported libraries: [gurobipy, PySCIPOpt, Pyomo, OR-Tools (MathOpt, CP-SAT, Routing)]
+
+## install
+
+Log to a tracking server (`MLFLOW_TRACKING_URI`):
+
+```bash
+pip install mlflow-optimization
+```
+
+> [!NOTE]
+> `mlflow-optimization` installs `mlflow-skinny`, which lacks MLflow's default local store. To log without a tracking server, install `mlflow` as well:
+>
+> ```bash
+> pip install mlflow-optimization mlflow
+> ```
+
+## usage
+
+```python
+import mlflow_optimization
+
+mlflow_optimization.autolog()
+
+with mlflow_optimization.context(instance="knapsack-50", tags={"team": "ops"}):
+    model.optimize()
+
+run = mlflow_optimization.last_solve()
+if run is not None:
+    run.log_metric("gap_to_best_known", 0.02)
+```
+
+## License
+
+Either of Apache License 2.0 or MIT license, at your option.

mlflow_optimization-0.1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "mlflow-optimization"
+version = "0.1.0"
+description = "Automatic MLflow logging of mathematical optimization solves"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+license-files = ["LICENSE-*"]
+requires-python = ">=3.12"
+dependencies = ["mlflow-skinny>=3.18.0"]
+
+[[project.authors]]
+name = "CoffeeGiNu"
+
+[project.urls]
+Repository = "https://github.com/CoffeeGiNu/mlflow-optimization"
+
+[tool.ruff]
+target-version = "py312"
+line-length = 88
+
+[tool.basedpyright]
+typeCheckingMode = "standard"
+include = [
+    "src",
+    "tests",
+]
+venvPath = "."
+venv = ".venv"
+pythonVersion = "3.12"
+
+[build-system]
+requires = ["uv_build>=0.13.6,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "basedpyright==1.40.2",
+    "gurobipy>=14.0.0",
+    "highspy>=1.16.0",
+    "ortools>=9.15.6755",
+    "pyomo>=6.10.1",
+    "pyscipopt>=6.3.0",
+    "pytest>=9.2.0",
+    "ruff==0.17.3",
+]

mlflow_optimization-0.1.0/pyproject.toml.orig

@@ -0,0 +1,44 @@
+[project]
+name = "mlflow-optimization"
+version = "0.1.0"
+description = "Automatic MLflow logging of mathematical optimization solves"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+license-files = ["LICENSE-*"]
+authors = [
+    { name = "CoffeeGiNu" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "mlflow-skinny>=3.18.0",
+]
+
+[project.urls]
+Repository = "https://github.com/CoffeeGiNu/mlflow-optimization"
+
+[tool.ruff]
+target-version = "py312"
+line-length = 88
+
+[tool.basedpyright]
+typeCheckingMode = "standard"
+include = ["src", "tests"]
+venvPath = "."
+venv = ".venv"
+pythonVersion = "3.12"
+
+[build-system]
+requires = ["uv_build>=0.13.6,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "basedpyright==1.40.2",
+    "gurobipy>=14.0.0",
+    "highspy>=1.16.0",
+    "ortools>=9.15.6755",
+    "pyomo>=6.10.1",
+    "pyscipopt>=6.3.0",
+    "pytest>=9.2.0",
+    "ruff==0.17.3",
+]

mlflow_optimization-0.1.0/src/mlflow_optimization/__init__.py

@@ -0,0 +1,50 @@
+"""Automatic MLflow logging of mathematical optimization solves."""
+
+from collections.abc import Iterable
+
+from mlflow_optimization import _bootstrap
+from mlflow_optimization.common.diagnostics import MlflowOptimizationWarning
+from mlflow_optimization.features.annotations.annotate import context
+from mlflow_optimization.features.runs.record import SolveRun, last_solve
+
+__all__ = ["MlflowOptimizationWarning", "SolveRun", "autolog", "context", "last_solve"]
+
+
+def autolog(
+    disable: bool = False,
+    *,
+    libraries: Iterable[str] | None = None,
+    log_solver_parameters: bool = True,
+    log_solver_metrics: bool = True,
+    log_artifacts: bool = True,
+) -> None:
+    """Configure automatic logging of optimization solves.
+
+    Parameters
+    ----------
+    disable : bool, default False
+        Disable automatic logging; other settings are ignored when True.
+    libraries : Iterable[str] or None, optional
+        Supported names: gurobipy, pyscipopt, pyomo, mathopt, cp_sat, routing.
+        None selects all available integrations; an empty iterable selects none.
+    log_solver_parameters : bool, default True
+        Whether solver parameters are logged.
+    log_solver_metrics : bool, default True
+        Whether native solver metrics are logged.
+    log_artifacts : bool, default True
+        Whether files attached through ``SolveRun.log_artifact`` are logged.
+
+    Raises
+    ------
+    ImportError
+        An explicitly selected integration cannot be imported.
+    ValueError
+        An unsupported library name is selected while logging is enabled.
+    """
+    _bootstrap.configure(
+        disable=disable,
+        libraries=libraries,
+        log_solver_parameters=log_solver_parameters,
+        log_solver_metrics=log_solver_metrics,
+        log_artifacts=log_artifacts,
+    )

mlflow_optimization-0.1.0/src/mlflow_optimization/_bootstrap.py

@@ -0,0 +1,129 @@
+"""Composition root: wires feature ports to concrete adapters."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from importlib import import_module
+from types import ModuleType
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from mlflow_optimization.features.autolog.ports import SolverIntegration
+    from mlflow_optimization.features.autolog.service import AutologManager
+    from mlflow_optimization.features.runs.record import RecordSolve
+    from mlflow_optimization.features.runs.types import RecordOptions
+    from mlflow_optimization.integrations.mlflow.artifacts import MlflowArtifactStore
+    from mlflow_optimization.integrations.mlflow.runs import MlflowRunStore
+
+INTEGRATION_MODULES: dict[str, tuple[str, str]] = {
+    "gurobipy": ("mlflow_optimization.integrations.gurobipy.adapter", "GurobiAdapter"),
+    "pyscipopt": (
+        "mlflow_optimization.integrations.pyscipopt.adapter",
+        "PyScipOptAdapter",
+    ),
+    "pyomo": ("mlflow_optimization.integrations.pyomo.adapter", "PyomoAdapter"),
+    "mathopt": ("mlflow_optimization.integrations.mathopt.adapter", "MathOptAdapter"),
+    "cp_sat": ("mlflow_optimization.integrations.cp_sat.adapter", "CpSatAdapter"),
+    "routing": ("mlflow_optimization.integrations.routing.adapter", "RoutingAdapter"),
+}
+
+_record_solve: RecordSolve | None = None
+_autolog_manager: AutologManager | None = None
+_integration_cache: dict[type[SolverIntegration], SolverIntegration] = {}
+
+
+def configure(
+    *,
+    disable: bool,
+    libraries: Iterable[str] | None,
+    log_solver_parameters: bool,
+    log_solver_metrics: bool,
+    log_artifacts: bool,
+) -> None:
+    """Apply an autolog configuration to the process-wide wiring."""
+    global _autolog_manager
+    global _record_solve
+
+    integrations: list[SolverIntegration] = []
+    if not disable:
+        integrations = _resolve_integrations(libraries)
+
+    if _autolog_manager is None:
+        from mlflow_optimization.features.autolog.service import AutologManager
+        from mlflow_optimization.features.runs.record import RecordSolve
+        from mlflow_optimization.features.runs.types import RecordOptions
+        from mlflow_optimization.integrations.mlflow.artifacts import (
+            MlflowArtifactStore,
+        )
+        from mlflow_optimization.integrations.mlflow.runs import MlflowRunStore
+
+        run_store: MlflowRunStore = MlflowRunStore()
+        artifact_store: MlflowArtifactStore = MlflowArtifactStore()
+        record_options: RecordOptions = RecordOptions()
+        if not disable:
+            record_options = RecordOptions(
+                log_solver_parameters=log_solver_parameters,
+                log_solver_metrics=log_solver_metrics,
+                log_artifacts=log_artifacts,
+            )
+        record_solve: RecordSolve = RecordSolve(
+            run_store, artifact_store, record_options
+        )
+        autolog_manager: AutologManager = AutologManager(record_solve)
+
+        _record_solve = record_solve
+        _autolog_manager = autolog_manager
+    else:
+        assert _record_solve is not None
+        if not disable:
+            _record_solve.options.log_solver_parameters = log_solver_parameters
+            _record_solve.options.log_solver_metrics = log_solver_metrics
+            _record_solve.options.log_artifacts = log_artifacts
+
+    assert _autolog_manager is not None
+    if disable:
+        _autolog_manager.disable()
+        return
+
+    _autolog_manager.enable(integrations)
+
+
+def _resolve_integrations(libraries: Iterable[str] | None) -> list[SolverIntegration]:
+    """The selected solver integrations."""
+    library_modules: dict[str, tuple[str, str]] = dict(INTEGRATION_MODULES)
+    selected_libraries: tuple[str, ...] = (
+        tuple(library_modules) if libraries is None else tuple(dict.fromkeys(libraries))
+    )
+
+    for library_name in selected_libraries:
+        if library_name not in library_modules:
+            valid_library_names: str = ", ".join(library_modules)
+            raise ValueError(
+                f"Unknown library {library_name!r}. Valid names: {valid_library_names}"
+            )
+
+    integrations: list[SolverIntegration] = []
+    for library_name in selected_libraries:
+        module_name: str
+        class_name: str
+        module_name, class_name = library_modules[library_name]
+        try:
+            integration_module: ModuleType = import_module(module_name)
+            integration_class: type[SolverIntegration] = getattr(
+                integration_module, class_name
+            )
+            cached_integration: SolverIntegration | None = _integration_cache.get(
+                integration_class
+            )
+            if cached_integration is not None:
+                integration: SolverIntegration = cached_integration
+            else:
+                integration = integration_class()
+                _integration_cache[integration_class] = integration
+        except ImportError:
+            if libraries is not None:
+                raise
+            continue
+        integrations.append(integration)
+
+    return integrations

mlflow_optimization-0.1.0/src/mlflow_optimization/common/diagnostics.py

@@ -0,0 +1,19 @@
+"""Notification channel shared by every feature and integration."""
+
+import logging
+import warnings
+
+
+class MlflowOptimizationWarning(UserWarning):
+    """The category of every warning emitted by this library."""
+
+
+def warn(message: str, *, stacklevel: int = 2) -> None:
+    """Emit an ``MlflowOptimizationWarning``."""
+    try:
+        warnings.warn(message, MlflowOptimizationWarning, stacklevel=stacklevel + 1)
+    except BaseException:  # noqa: BLE001
+        try:
+            logging.getLogger("mlflow_optimization").warning(message)
+        except BaseException:  # noqa: BLE001,S110
+            pass

mlflow_optimization-0.1.0/src/mlflow_optimization/common/patching.py

@@ -0,0 +1,82 @@
+"""Reversible attribute replacement."""
+
+import sys
+from collections.abc import Callable, Mapping
+from inspect import signature
+from types import ModuleType
+from typing import Any
+
+
+def receiver_of(
+    original: Callable[..., Any], args: tuple[Any, ...], kwargs: Mapping[str, Any]
+) -> Any:
+    """The receiver of a method call."""
+    receiver_name: str | None = next(iter(signature(original).parameters), None)
+    if receiver_name is None:
+        return None
+    if args:
+        return args[0]
+    return kwargs.get(receiver_name)
+
+
+def rebind_module_names(
+    original: Any,
+    replacement: Any,
+) -> list[tuple[ModuleType, str]]:
+    """The module-level names rebound from an original object to a replacement."""
+    rebound_names: list[tuple[ModuleType, str]] = []
+    modules: tuple[Any, ...] = tuple(sys.modules.values())
+    for module_value in modules:
+        if not isinstance(module_value, ModuleType):
+            continue
+        module: ModuleType = module_value
+        module_values: dict[str, Any] = vars(module)
+        module_bindings: tuple[tuple[str, Any], ...] = tuple(module_values.items())
+        for name, value in module_bindings:
+            if value is not original:
+                continue
+            module_values[name] = replacement
+            rebound_names.append((module, name))
+    return rebound_names
+
+
+def restore_module_names(
+    rebound_names: list[tuple[ModuleType, str]],
+    original: Any,
+    replacement: Any,
+) -> None:
+    """A conditional restoration of module-level names."""
+    for module, name in reversed(rebound_names):
+        module_values: dict[str, Any] = vars(module)
+        if name not in module_values or module_values[name] is not replacement:
+            continue
+        module_values[name] = original
+
+
+class Patch:
+    """A reversible replacement of one attribute on a class or module."""
+
+    def __init__(self, owner: Any, name: str) -> None:
+        self.owner: Any = owner
+        self.name: str = name
+        self._installed: bool = False
+
+    def install(self, factory: Callable[[Any], Any]) -> None:
+        """Replace the attribute with ``factory(original)``; no-op when installed."""
+        if self._installed:
+            return
+        original: Any = getattr(self.owner, self.name)
+        self._own: bool = self.name in vars(self.owner)
+        self._descriptor: Any = vars(self.owner).get(self.name)
+        setattr(self.owner, self.name, factory(original))
+        self._installed = True
+
+    def uninstall(self) -> None:
+        """Restore the exact original attribute; no-op when not installed."""
+        if not self._installed:
+            return
+        if self._own:
+            setattr(self.owner, self.name, self._descriptor)
+        else:
+            delattr(self.owner, self.name)
+        self._installed = False