Summary

Add a utility function for returning encoded newlines for a type.

Review Request #11742 — Created July 23, 2021 and submitted July 28, 2021, 1:35 a.m.

Information

Owner

chipx86

Repository

DiffX

Branch

master

Bugs

Depends On

Reviewers

Groups

diffx

People

Description

This introduces get_newline_for_type(), a utility function that takes

a LineEndings type value and returns newlines encoded as either ASCII

or the given encoding (with BOM stripped).
This logic was previously contained in DiffXReader, but is generally

useful, so it's being split out. That simplifies the DiffXReader code

as well, making some of the logic a lot more clear.

Testing Done

Unit tests pass on Python 2 and 3.

Commits

Summary	ID
Add a utility function for returning encoded newlines for a type. This introduces `get_newline_for_type()`, a utility function that takes a `LineEndings` type value and returns newlines encoded as either ASCII or the given encoding (with BOM stripped). This logic was previously contained in `DiffXReader`, but is generally useful, so it's being split out. That simplifies the `DiffXReader` code as well, making some of the logic a lot more clear.	1245d7bec05ef7ad783c64e1cf9a807ba91e6dd7

Summary

Add a utility function for returning encoded newlines for a type.

This introduces `get_newline_for_type()`, a utility function that takes a `LineEndings` type value and returns newlines encoded as either ASCII or the given encoding (with BOM stripped). This logic was previously contained in `DiffXReader`, but is generally useful, so it's being split out. That simplifies the `DiffXReader` code as well, making some of the logic a lot more clear.

1245d7bec05ef7ad783c64e1cf9a807ba91e6dd7

Issues

Description	From	Last Updated
What's the reason to not just do encoding='ascii' in the args list?	david	July 24, 2021, 9:26 p.m.

flake8 passed.

JSHint passed.

python/pydiffx/utils/text.py (Diff revision 1)

The issue has been dropped. Show all issues

What's the reason to not just do encoding='ascii' in the args list?

chipx86 July 23, 2021, 5:56 p.m.

Values get passed down directly into this from DiffXReader and, in a change I just posted, DiffXFileSection. Those values are legally allowed to be None, and should not be hard-coded to ascii (None for a diff means "no encoding is known or guaranteed"). To default this to ascii, the call sites would need to conditionally call this with/without the encoding parameter based on their own encoding value.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (161143d)