Skip to content

accept iterable inputs in write_lines type annotation #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gheshm-jpg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

accept iterable inputs in write_lines type annotation #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions path/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -928,7 +928,7 @@ def lines(

def write_lines(
self,
lines: list[str],
lines: Iterable[str],
encoding: str | None = None,
errors: str = 'strict',
*,
Expand All @@ -940,7 +940,7 @@ def write_lines(

Puts a platform-specific newline sequence on every line.

`lines` - A list of strings.
`lines` - An iterable of strings.

`encoding` - A Unicode encoding to use. This applies only if
`lines` contains any Unicode strings.
Expand Down
7 changes: 7 additions & 0 deletions tests/test_path.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1398,3 +1398,10 @@ def test_ignore(self):
def test_invalid_handler(self):
with pytest.raises(ValueError):
path.Handlers._resolve('raise')


def test_write_lines_iterables(tmp_path) -> None:
target = Path(tmp_path) / 'lines.txt'
target.write_lines(('one\r\n', 'two\n'))
target.write_lines((line for line in ('three', 'four\r')), append=True)
assert target.read_text() == 'one\ntwo\nthree\nfour\n'