Skip to content

Commit

Permalink
Add package.readme properties to ensure retrocompatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
wagnerluis1982 committed Nov 19, 2021
1 parent a436056 commit cbe43f3
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
20 changes: 20 additions & 0 deletions poetry/core/packages/package.py
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,26 @@ def urls(self) -> Dict[str, str]:

return urls

@property
def readme(self) -> Path:
import warnings

warnings.warn(
"`readme` is deprecated: you are getting only the first readme file. Please use the plural form `readmes`",
DeprecationWarning,
)
return next(iter(self.readmes), None)

@readme.setter
def readme(self, path: Path) -> None:
import warnings

warnings.warn(
"`readme` is deprecated. Please assign a tuple to the plural form `readmes`",
DeprecationWarning,
)
self.readmes = (path,)

def is_prerelease(self) -> bool:
return self._version.is_unstable()

Expand Down
19 changes: 19 additions & 0 deletions tests/packages/test_package.py
Original file line number Diff line number Diff line change
Expand Up @@ -408,3 +408,22 @@ def test_only_with_dependency_groups(package_with_groups: Package):

assert len(package.requires) == 2
assert len(package.all_requires) == 2


def test_get_readme_property_with_multiple_readme_files():
package = Package("foo", "0.1.0")

package.readmes = ("README.md", "HISTORY.md")
with pytest.deprecated_call():
assert package.readme == "README.md"


def test_set_readme_property():
package = Package("foo", "0.1.0")

with pytest.deprecated_call():
package.readme = "README.md"

assert package.readmes == ("README.md",)
with pytest.deprecated_call():
assert package.readme == "README.md"

0 comments on commit cbe43f3

Please sign in to comment.