release-2.8.7.rst

Overview

This file is the release notes document for `pytest` version **2.8.7**, a hotfix release addressing a regression introduced in the previous version 2.8.6. The regression affected the builtin `monkeypatch` plugin, causing unpredictable behavior in object resolution during testing. This release restores predictable object resolution and aims to be fully backward compatible with version 2.8.5.

`pytest` is a mature Python testing framework widely used for writing and running tests, known for its rich feature set and strong community support. The release notes provide a summary of the fix, instructions for upgrading, acknowledgments to contributors, and links to further documentation.

Purpose and Functionality

This file serves as a changelog and informational resource for users upgrading or installing `pytest` version 2.8.7. Its main purposes are:

• Communicate the nature of the release (hotfix) and the problem it resolves.

• Provide upgrade instructions.

• Acknowledge contributors to the release.

• Link to the official pytest documentation website.

• Summarize the key change and bug fix (#1338) that improves the monkeypatch plugin behavior.

Detailed Content Explanation

The file consists entirely of formatted text (reStructuredText format), structured as follows:

Title and Version

pytest-2.8.7
============

Indicates the project name and version number.

Release Description

• Describes this as a hotfix to fix a regression introduced in 2.8.6.

• Highlights pytest's maturity and extensive test coverage.

• Notes that this release is intended to be drop-in compatible with 2.8.5.

• Provides the URL for the pytest documentation: http://pytest.org.

• Gives a simple pip command to upgrade pytest: pip install -U pytest.

• Thanks contributors, specifically Ronny Pfannschmidt.

• Ends with a friendly sign-off from the development team.

Change Log Section

2.8.7 (compared to 2.8.6)
-------------------------

- fix #1338: use predictable object resolution for monkeypatch

This bullet point summarizes the critical fix:

• Issue #1338: This bug fix adjusts the monkeypatch plugin internals to ensure that object references are resolved in a predictable manner, restoring expected plugin behavior.

Usage Example

While this file itself has no executable code or API, the upgrade instruction is the main practical usage:

pip install -U pytest

This command upgrades the installed pytest package to version 2.8.7.

Important Implementation Details

• The file does not contain implementation code but documents a fix related to the monkeypatch plugin.

• The fix addresses a regression causing unpredictable behavior in monkeypatching, a pytest feature that allows dynamic modification of objects during testing.

• The release notes emphasize backward compatibility and quality assurance through extensive test coverage.

Interaction with Other System Components

• The file documents a release of the pytest testing framework, a core component in Python testing infrastructures.

• It specifically mentions the monkeypatch plugin, a builtin pytest plugin used for dynamically changing object attributes or dictionary keys during tests.

• Users of pytest will interact with this version when running tests, and the fix improves their experience by stabilizing monkeypatch behavior.

• The release notes guide users on upgrading their existing pytest installations to incorporate this fix seamlessly.

Visual Diagram: Structure of release-2.8.7.rst

Since this is a documentation/release notes file without classes or functions, a **flowchart** illustrating the file’s informational flow is the most appropriate.

flowchart TD
    A[Title: pytest-2.8.7] --> B[Release Description]
    B --> C[Upgrade Instructions]
    B --> D[Contributor Acknowledgments]
    B --> E[Documentation Link]
    B --> F[Change Log]
    F --> G[Fix #1338 - monkeypatch object resolution]
    style A fill:#f9f,stroke:#333,stroke-width:2px
    style F fill:#bbf,stroke:#333,stroke-width:1px

Summary

• release-2.8.7.rst provides concise release notes for pytest 2.8.7.

• It documents a critical fix to the monkeypatch plugin regression from 2.8.6.

• The file guides users on upgrading and links to official documentation.

• This release maintains compatibility with prior versions.

• The document plays a key role in communicating changes and ensuring a smooth upgrade path for pytest users.

**End of documentation for release-2.8.7.rst**