updating the docs

Author: seperman

CHANGELOG.md

@@ -1,5 +1,9 @@
 # DeepDiff Change log
 
+- v8-2-0
+    - Small optimizations so we don't load functions that are not needed
+    - Updated the minimum version of Orderly-set 
+    - Normalize all datetimes into UTC. Assume timezone naive datetimes are UTC. 
 
 - v8-1-0
     - Removing deprecated lines from setup.py

README.md

@@ -23,6 +23,12 @@ Tested on Python 3.8+ and PyPy3.
 
 Please check the [ChangeLog](CHANGELOG.md) file for the detailed information.
 
+DeepDiff 8-2-0
+
+- Small optimizations so we don't load functions that are not needed
+- Updated the minimum version of Orderly-set 
+- Normalize all datetimes into UTC. Assume timezone naive datetimes are UTC. 
+
 DeepDiff 8-1-0
 
 - Removing deprecated lines from setup.py
@@ -40,56 +46,6 @@ DeepDiff 8-1-0
 - Fixes accessing the affected_root_keys property on the diff object returned by DeepDiff fails when one of the dicts is empty
 - Fixes accessing the affected_root_keys property on the diff object returned by DeepDiff fails when one of the dicts is empty #508
 
-DeepDiff 8-0-1
-
-- Bugfix. Numpy should be optional.
-
-DeepDiff 8-0-0
-
-With the introduction of `threshold_to_diff_deeper`, the values returned are different than in previous versions of DeepDiff. You can still get the older values by setting `threshold_to_diff_deeper=0`. However to signify that enough has changed in this release that the users need to update the parameters passed to DeepDiff, we will be doing a major version update.
-
-- `use_enum_value=True` makes it so when diffing enum, we use the enum's value. It makes it so comparing an enum to a string or any other value is not reported as a type change.
-- `threshold_to_diff_deeper=float` is a number between 0 and 1. When comparing dictionaries that have a small intersection of keys, we will report the dictionary as a `new_value` instead of reporting individual keys changed. If you set it to zero, you get the same results as DeepDiff 7.0.1 and earlier, which means this feature is disabled. The new default is 0.33 which means if less that one third of keys between dictionaries intersect, report it as a new object.
-- Deprecated `ordered-set` and switched to `orderly-set`. The `ordered-set` package was not being maintained anymore and starting Python 3.6, there were better options for sets that ordered. I forked one of the new implementations, modified it, and published it as `orderly-set`.
-- Added `use_log_scale:bool` and `log_scale_similarity_threshold:float`. They can be used to ignore small changes in numbers by comparing their differences in logarithmic space. This is different than ignoring the difference based on significant digits.
-- json serialization of reversed lists.
-- Fix for iterable moved items when `iterable_compare_func` is used.
-- Pandas and Polars support.
-
-DeepDiff 7-0-1
-
-- Fixes the translation between Difflib opcodes and Delta flat rows.
-
-DeepDiff 7-0-0
-
-- DeepDiff 7 comes with an improved delta object. [Delta to flat dictionaries](https://zepworks.com/deepdiff/current/serialization.html#delta-serialize-to-flat-dictionaries) have undergone a major change. We have also introduced [Delta serialize to flat rows](https://zepworks.com/deepdiff/current/serialization.html#delta-serialize-to-flat-rows).
-- Subtracting delta objects have dramatically improved at the cost of holding more metadata about the original objects.
-- When `verbose=2`, and the "path" of an item has changed in a report between t1 and t2, we include it as `new_path`.
-- `path(use_t2=True)` returns the correct path to t2 in any reported change in the [`tree view`](https://zepworks.com/deepdiff/current/view.html#tree-view)
-- Python 3.7 support is dropped and Python 3.12 is officially supported.
-
-
-DeepDiff 6-7-1
-
-- Support for subtracting delta objects when iterable_compare_func is used.
-- Better handling of force adding a delta to an object. 
-- Fix for [`Can't compare dicts with both single and double quotes in keys`](https://github.com/seperman/deepdiff/issues/430)
-- Updated docs for Inconsistent Behavior with math_epsilon and ignore_order = True
-
-DeepDiff 6-7-0
-
-- Delta can be subtracted from other objects now.
-- verify_symmetry is deprecated. Use bidirectional instead.
-- always_include_values flag in Delta can be enabled to include values in the delta for every change.
-- Fix for Delta.__add__ breaks with esoteric dict keys.
-- You can load a delta from the list of flat dictionaries.
-
-DeepDiff 6-6-1
-
-- Fix for [DeepDiff raises decimal exception when using significant digits](https://github.com/seperman/deepdiff/issues/426)
-- Introducing group_by_sort_key
-- Adding group_by 2D. For example `group_by=['last_name', 'zip_code']`
-
 
 ## Installation
 

docs/basics.rst

@@ -148,6 +148,19 @@ Object attribute added:
      'values_changed': {'root.b': {'new_value': 2, 'old_value': 1}}}
 
 
+Datetime
+    DeepDiff converts all datetimes into UTC. If a datetime is timezone naive, we assume it is in UTC too.
+    That is different than what Python does. Python assumes your timezone naive datetime is in your local timezone.
+    >>> from deepdiff import DeepDiff
+    >>> from datetime import datetime, timezone
+    >>> d1 = datetime(2020, 8, 31, 13, 14, 1)
+    >>> d2 = datetime(2020, 8, 31, 13, 14, 1, tzinfo=timezone.utc)
+    >>> d1 == d2
+    False
+    >>> DeepDiff(d1, d2)
+    {}
+
+
 .. note::
     All the examples above use the default :ref:`text_view_label`.
     If you want traversing functionality in the results, use the :ref:`tree_view_label`.

docs/changelog.rst

@@ -6,6 +6,12 @@ Changelog
 DeepDiff Changelog
 
 
+- v8-2-0
+    - Small optimizations so we don't load functions that are not needed
+    - Updated the minimum version of Orderly-set 
+    - Normalize all datetimes into UTC. Assume timezone naive datetimes are UTC. 
+
+
 - v8-1-0
 
     - Removing deprecated lines from setup.py

docs/faq.rst

@@ -148,6 +148,28 @@ Or use the tree view so you can use path(output_format='list'):
     [4, 'b']
 
 
+Q: Why my datetimes are reported in UTC?
+
+**Answer**
+
+DeepDiff converts all datetimes into UTC. If a datetime is timezone naive, we assume it is in UTC too.
+That is different than what Python does. Python assumes your timezone naive datetime is in your local timezone.
+
+    >>> from deepdiff import DeepDiff
+    >>> from datetime import datetime, timezone
+    >>> d1 = datetime(2020, 8, 31, 13, 14, 1)
+    >>> d2 = datetime(2020, 8, 31, 13, 14, 1, tzinfo=timezone.utc)
+    >>> d1 == d2
+    False
+    >>> DeepDiff(d1, d2)
+    {}
+
+    >>> d3 = d2.astimezone(pytz.timezone('America/New_York'))
+    >>> DeepDiff(d1, d3)
+    {}
+    >>> d1 == d3
+    False
+
 ---------
 
 .. admonition:: A message from `Sep <https://github.com/seperman>`__, the creator of DeepDiff

tests/test_diff_datetime.py

@@ -95,6 +95,7 @@ def test_datetime_within_array_with_timezone_diff(self):
         d1 = [datetime(2020, 8, 31, 13, 14, 1)]
         d2 = [datetime(2020, 8, 31, 13, 14, 1, tzinfo=timezone.utc)]
 
+        assert d1 != d2, "Python doesn't think these are the same datetimes"
         assert not DeepDiff(d1, d2)
         assert not DeepDiff(d1, d2, ignore_order=True)
         assert not DeepDiff(d1, d2, truncate_datetime='second')