Summary

Add utilities for merging dictionaries and deduplicating lists of items.

Review Request #11217 — Created Oct. 13, 2020 and submitted Oct. 30, 2020, 3:27 p.m.

Information

Owner

chipx86

Repository

Django Evolution

Branch

master

Bugs

Depends On

Reviewers

Groups

django-evolution

People

Description

This introduces a couple of new datastructure-related utility functions
that will be used in some upcoming changes.

filter_dup_list_items() takes a list of items and filters out any
duplicates, ensuring that there is one of each instance in the list.
This is similar to passing a list into set(), but preserves the order.

merge_dicts() merges two dictionaries together. Its approach is
simplistic but sufficient for our needs. Keys present only in the source
dictionary are placed in the destination. Lists are concatenated.
Dictionaries are recursively merged. Anything else triggers an error.

Unit tests and doc generation were added for these new functions.

Testing Done

Unit tests pass.

Tested these in upcoming changes.

Commits

Summary	ID
Add utilities for merging dictionaries and deduplicating lists of items. This introduces a couple of new datastructure-related utility functions that will be used in some upcoming changes. `filter_dup_list_items()` takes a list of items and filters out any duplicates, ensuring that there is one of each instance in the list. This is similar to passing a list into `set()`, but preserves the order. `merge_dicts()` merges two dictionaries together. Its approach is simplistic but sufficient for our needs. Keys present only in the source dictionary are placed in the destination. Lists are concatenated. Dictionaries are recursively merged. Anything else triggers an error. Unit tests and doc generation were added for these new functions.	2669cb334de31915c139e317273b4fe92f5c7af7

Summary

Add utilities for merging dictionaries and deduplicating lists of items.

This introduces a couple of new datastructure-related utility functions that will be used in some upcoming changes. `filter_dup_list_items()` takes a list of items and filters out any duplicates, ensuring that there is one of each instance in the list. This is similar to passing a list into `set()`, but preserves the order. `merge_dicts()` merges two dictionaries together. Its approach is simplistic but sufficient for our needs. Keys present only in the source dictionary are placed in the destination. Lists are concatenated. Dictionaries are recursively merged. Anything else triggers an error. Unit tests and doc generation were added for these new functions.

2669cb334de31915c139e317273b4fe92f5c7af7

Issues

Description	From	Last Updated
E721 do not compare types, use 'isinstance()'	reviewbot	Oct. 13, 2020, 3:07 a.m.

flake8 failed.

JSHint passed.

flake8

django_evolution/utils/datastructures.py (Diff revision 1)

The issue has been dropped. Show all issues

E721 do not compare types, use 'isinstance()'

david Oct. 13, 2020, 10 a.m.

Did you drop this because you wanted to do an exact type comparison?

chipx86 Oct. 13, 2020, 1:23 p.m.

Yeah, I'm not looking to allow for a high degree of flexibility at this point. For the usage intended (and considering this is an internal utility), if there's any difference in type whatsoever, I want to be sure this fails.

chipx86 Oct. 13, 2020, 2:31 p.m.

Decided to make it a little more flexible and add some better error handling in the process.

Change Summary:


Replaced an assert type is type check with more specific checks that result in more useful exceptions.
Added "Version Added" sections in the docstrings.

Commits:

	Summary	ID
	Add utilities for merging dictionaries and deduplicating lists of items. This introduces a couple of new datastructure-related utility functions that will be used in some upcoming changes. `filter_dup_list_items()` takes a list of items and filters out any duplicates, ensuring that there is one of each instance in the list. This is similar to passing a list into `set()`, but preserves the order. `merge_dicts()` merges two dictionaries together. Its approach is simplistic but sufficient for our needs. Keys present only in the source dictionary are placed in the destination. Lists are concatenated. Dictionaries are recursively merged. Anything else triggers an error. Unit tests and doc generation were added for these new functions.	f1ead5bb911c812e8a9d42a0ca5a4da35274aa9f
	Add utilities for merging dictionaries and deduplicating lists of items. This introduces a couple of new datastructure-related utility functions that will be used in some upcoming changes. `filter_dup_list_items()` takes a list of items and filters out any duplicates, ensuring that there is one of each instance in the list. This is similar to passing a list into `set()`, but preserves the order. `merge_dicts()` merges two dictionaries together. Its approach is simplistic but sufficient for our needs. Keys present only in the source dictionary are placed in the destination. Lists are concatenated. Dictionaries are recursively merged. Anything else triggers an error. Unit tests and doc generation were added for these new functions.	6f628bbed56c43c177a007a0c1721b7da7cd1b5f

Diff:

Revision 2 (+512)

Show changes

	django_evolution/tests/test_datastructures_utils.py
	django_evolution/utils/datastructures.py
	docs/coderef/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Change Summary:

Fixed an issue with some expected exceptions on Python 2.

Commits:

	Summary	ID
	Add utilities for merging dictionaries and deduplicating lists of items. This introduces a couple of new datastructure-related utility functions that will be used in some upcoming changes. `filter_dup_list_items()` takes a list of items and filters out any duplicates, ensuring that there is one of each instance in the list. This is similar to passing a list into `set()`, but preserves the order. `merge_dicts()` merges two dictionaries together. Its approach is simplistic but sufficient for our needs. Keys present only in the source dictionary are placed in the destination. Lists are concatenated. Dictionaries are recursively merged. Anything else triggers an error. Unit tests and doc generation were added for these new functions.	6f628bbed56c43c177a007a0c1721b7da7cd1b5f
	Add utilities for merging dictionaries and deduplicating lists of items. This introduces a couple of new datastructure-related utility functions that will be used in some upcoming changes. `filter_dup_list_items()` takes a list of items and filters out any duplicates, ensuring that there is one of each instance in the list. This is similar to passing a list into `set()`, but preserves the order. `merge_dicts()` merges two dictionaries together. Its approach is simplistic but sufficient for our needs. Keys present only in the source dictionary are placed in the destination. Lists are concatenated. Dictionaries are recursively merged. Anything else triggers an error. Unit tests and doc generation were added for these new functions.	2669cb334de31915c139e317273b4fe92f5c7af7

Diff:

Revision 3 (+514)

Show changes

	django_evolution/tests/test_datastructures_utils.py
	django_evolution/utils/datastructures.py
	docs/coderef/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (58cd060)