Summary

Add an object model for DiffX files.

Review Request #11729 — Created July 17, 2021 and submitted July 20, 2021, 2:44 p.m.

Information

Owner

chipx86

Repository

DiffX

Branch

master

Bugs

Depends On

Reviewers

Groups

diffx

People

Description

There's an object for each type of section, organized into a tree. These
are divided into container and content sections, just as in the
specification.

To ease use, consumers really only have to deal with the container
sections (DiffX, DiffXChangeSection, and DiffXFileSection). The
content and options for each child content section is accessible via
forwarding attributes. For example, a DiffXChangeSection's preamble
text can be accessed directly through a preamble attribute, and the
preamble encoding can be accessed through preamble_encoding.

All attributes are type-safe, ensuring there are no problems when
writing a DiffX file. The classes are also limited in what attributes
can be set by defining __slots__, which helps to avoid accidentally
setting the wrong attribute name.

These objects manage data storage. All reading/writing is still done via
the underlying stream reader/writer, with specializations to convert
to-and-from the DOM.

It's expected that most users of the pydiffx module will use the DOM
implementaton, as it provides the easiest way of working with DiffX.
Future updates are planned to automatically calculate insert/line/file
statistics for metadata and to extract information from vendor-specific
Unified Diff variants.

Testing Done

Unit tests pass on Python 2 and 3.

Used this with an experimental diff parser for Review Board and diff
generator for RBTools.

Commits

Summary	ID
Add an object model for DiffX files. This introduces the DOM, the DiffX Object Model, which is a hierarchical representation of DiffX files. It can be used to assemble a DiffX file section-by-section, or to load in a DiffX file and process or manipulate it. There's an object for each type of section, organized into a tree. These are divided into container and content sections, just as in the specification. To ease use, consumers really only have to deal with the container sections (`DiffX`, `DiffXChangeSection`, and `DiffXFileSection`). The content and options for each child content section is accessible via forwarding attributes. For example, a `DiffXChangeSection`'s preamble text can be accessed directly through a `preamble` attribute, and the preamble encoding can be accessed through `preamble_encoding`. All attributes are type-safe, ensuring there are no problems when writing a DiffX file. The classes are also limited in what attributes can be set by defining `__slots__`, which helps to avoid accidentally setting the wrong attribute name. These objects manage data storage. All reading/writing is still done via the underlying stream reader/writer, with specializations to convert to-and-from the DOM. It's expected that most users of the `pydiffx` module will use the DOM implementaton, as it provides the easiest way of working with DiffX. Future updates are planned to automatically calculate insert/line/file statistics for metadata and to extract information from vendor-specific Unified Diff variants.	b4701d61ff6556b1d1f6d5020f51e930e7a008f4

Summary

Add an object model for DiffX files.

This introduces the DOM, the DiffX Object Model, which is a hierarchical representation of DiffX files. It can be used to assemble a DiffX file section-by-section, or to load in a DiffX file and process or manipulate it. There's an object for each type of section, organized into a tree. These are divided into container and content sections, just as in the specification. To ease use, consumers really only have to deal with the container sections (`DiffX`, `DiffXChangeSection`, and `DiffXFileSection`). The content and options for each child content section is accessible via forwarding attributes. For example, a `DiffXChangeSection`'s preamble text can be accessed directly through a `preamble` attribute, and the preamble encoding can be accessed through `preamble_encoding`. All attributes are type-safe, ensuring there are no problems when writing a DiffX file. The classes are also limited in what attributes can be set by defining `__slots__`, which helps to avoid accidentally setting the wrong attribute name. These objects manage data storage. All reading/writing is still done via the underlying stream reader/writer, with specializations to convert to-and-from the DOM. It's expected that most users of the `pydiffx` module will use the DOM implementaton, as it provides the easiest way of working with DiffX. Future updates are planned to automatically calculate insert/line/file statistics for metadata and to extract information from vendor-specific Unified Diff variants.

b4701d61ff6556b1d1f6d5020f51e930e7a008f4

Issues

Description	From	Last Updated
E501 line too long (80 > 79 characters)	reviewbot	July 17, 2021, 6:22 p.m.
E501 line too long (80 > 79 characters)	reviewbot	July 17, 2021, 6:22 p.m.
F401 'io' imported but unused	reviewbot	July 17, 2021, 6:23 p.m.
F401 'pydiffx.errors.DiffXSectionOrderError' imported but unused	reviewbot	July 17, 2021, 6:23 p.m.
F401 'pydiffx.errors.DiffXContentError' imported but unused	reviewbot	July 17, 2021, 6:23 p.m.
F401 'pydiffx.reader.DiffXReader' imported but unused	reviewbot	July 17, 2021, 6:23 p.m.
F401 'pydiffx.writer.DiffXWriter' imported but unused	reviewbot	July 17, 2021, 6:23 p.m.

flake8 failed.

JSHint passed.

flake8

python/pydiffx/dom/objects.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E501 line too long (80 > 79 characters)
```
python/pydiffx/dom/objects.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E501 line too long (80 > 79 characters)
```
python/pydiffx/tests/test_dom_objects.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F401 'io' imported but unused
```
python/pydiffx/tests/test_dom_objects.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F401 'pydiffx.errors.DiffXSectionOrderError' imported but unused
```
python/pydiffx/tests/test_dom_objects.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F401 'pydiffx.errors.DiffXContentError' imported but unused
```
python/pydiffx/tests/test_dom_objects.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F401 'pydiffx.reader.DiffXReader' imported but unused
```
python/pydiffx/tests/test_dom_objects.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F401 'pydiffx.writer.DiffXWriter' imported but unused
```

Change Summary:


Removed the __bytes__ cast function, as it behaves differently on Python 2/3 and isn't worth worrying about.
Fixed some string representations in unit tests on Python 2.
Removed unused imports.
Fixed line length issues.

Commits:

	Summary	ID
	Add an object model for DiffX files. This introduces the DOM, the DiffX Object Model, which is a hierarchical representation of DiffX files. It can be used to assemble a DiffX file section-by-section, or to load in a DiffX file and process or manipulate it. There's an object for each type of section, organized into a tree. These are divided into container and content sections, just as in the specification. To ease use, consumers really only have to deal with the container sections (`DiffX`, `DiffXChangeSection`, and `DiffXFileSection`). The content and options for each child content section is accessible via forwarding attributes. For example, a `DiffXChangeSection`'s preamble text can be accessed directly through a `preamble` attribute, and the preamble encoding can be accessed through `preamble_encoding`. All attributes are type-safe, ensuring there are no problems when writing a DiffX file. The classes are also limited in what attributes can be set by defining `__slots__`, which helps to avoid accidentally setting the wrong attribute name. These objects manage data storage. All reading/writing is still done via the underlying stream reader/writer, with specializations to convert to-and-from the DOM. It's expected that most users of the `pydiffx` module will use the DOM implementaton, as it provides the easiest way of working with DiffX. Future updates are planned to automatically calculate insert/line/file statistics for metadata and to extract information from vendor-specific Unified Diff variants.	583b1e82b5833a044868d8d8c1854def298d306b
	Add an object model for DiffX files. This introduces the DOM, the DiffX Object Model, which is a hierarchical representation of DiffX files. It can be used to assemble a DiffX file section-by-section, or to load in a DiffX file and process or manipulate it. There's an object for each type of section, organized into a tree. These are divided into container and content sections, just as in the specification. To ease use, consumers really only have to deal with the container sections (`DiffX`, `DiffXChangeSection`, and `DiffXFileSection`). The content and options for each child content section is accessible via forwarding attributes. For example, a `DiffXChangeSection`'s preamble text can be accessed directly through a `preamble` attribute, and the preamble encoding can be accessed through `preamble_encoding`. All attributes are type-safe, ensuring there are no problems when writing a DiffX file. The classes are also limited in what attributes can be set by defining `__slots__`, which helps to avoid accidentally setting the wrong attribute name. These objects manage data storage. All reading/writing is still done via the underlying stream reader/writer, with specializations to convert to-and-from the DOM. It's expected that most users of the `pydiffx` module will use the DOM implementaton, as it provides the easiest way of working with DiffX. Future updates are planned to automatically calculate insert/line/file statistics for metadata and to extract information from vendor-specific Unified Diff variants.	7aac5e89ad9ce2b8a3a40e6b4d980781ffdf05d5

Diff:

Revision 2 (+5878)

Show changes

	python/pydiffx/errors.py
	python/pydiffx/dom/__init__.py
	python/pydiffx/dom/objects.py
	python/pydiffx/dom/properties.py
	python/pydiffx/dom/reader.py
	python/pydiffx/dom/writer.py
	python/pydiffx/tests/test_dom_objects.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:


Improved the pydiffx.dom module docstring, preparing for autodocs.
Fixed a bad reference to Section in a docstring.

Commits:

	Summary	ID
	Add an object model for DiffX files. This introduces the DOM, the DiffX Object Model, which is a hierarchical representation of DiffX files. It can be used to assemble a DiffX file section-by-section, or to load in a DiffX file and process or manipulate it. There's an object for each type of section, organized into a tree. These are divided into container and content sections, just as in the specification. To ease use, consumers really only have to deal with the container sections (`DiffX`, `DiffXChangeSection`, and `DiffXFileSection`). The content and options for each child content section is accessible via forwarding attributes. For example, a `DiffXChangeSection`'s preamble text can be accessed directly through a `preamble` attribute, and the preamble encoding can be accessed through `preamble_encoding`. All attributes are type-safe, ensuring there are no problems when writing a DiffX file. The classes are also limited in what attributes can be set by defining `__slots__`, which helps to avoid accidentally setting the wrong attribute name. These objects manage data storage. All reading/writing is still done via the underlying stream reader/writer, with specializations to convert to-and-from the DOM. It's expected that most users of the `pydiffx` module will use the DOM implementaton, as it provides the easiest way of working with DiffX. Future updates are planned to automatically calculate insert/line/file statistics for metadata and to extract information from vendor-specific Unified Diff variants.	7aac5e89ad9ce2b8a3a40e6b4d980781ffdf05d5
	Add an object model for DiffX files. This introduces the DOM, the DiffX Object Model, which is a hierarchical representation of DiffX files. It can be used to assemble a DiffX file section-by-section, or to load in a DiffX file and process or manipulate it. There's an object for each type of section, organized into a tree. These are divided into container and content sections, just as in the specification. To ease use, consumers really only have to deal with the container sections (`DiffX`, `DiffXChangeSection`, and `DiffXFileSection`). The content and options for each child content section is accessible via forwarding attributes. For example, a `DiffXChangeSection`'s preamble text can be accessed directly through a `preamble` attribute, and the preamble encoding can be accessed through `preamble_encoding`. All attributes are type-safe, ensuring there are no problems when writing a DiffX file. The classes are also limited in what attributes can be set by defining `__slots__`, which helps to avoid accidentally setting the wrong attribute name. These objects manage data storage. All reading/writing is still done via the underlying stream reader/writer, with specializations to convert to-and-from the DOM. It's expected that most users of the `pydiffx` module will use the DOM implementaton, as it provides the easiest way of working with DiffX. Future updates are planned to automatically calculate insert/line/file statistics for metadata and to extract information from vendor-specific Unified Diff variants.	b4701d61ff6556b1d1f6d5020f51e930e7a008f4

Diff:

Revision 3 (+5898)

Show changes

	python/pydiffx/errors.py
	python/pydiffx/dom/__init__.py
	python/pydiffx/dom/objects.py
	python/pydiffx/dom/properties.py
	python/pydiffx/dom/reader.py
	python/pydiffx/dom/writer.py
	python/pydiffx/tests/test_dom_objects.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (4fabf93)