Merge pull request #557 from seperman/dev

8.6.0

Author: seperman

.direnvrc.example

@@ -0,0 +1,11 @@
+function load_venv () {
+    ACTUAL_VENV_PATH="$HOME/.venvs/$1"
+
+    if [ -d "$ACTUAL_VENV_PATH" ] && [ -f "$ACTUAL_VENV_PATH/bin/activate" ]; then
+      echo "direnv: Activating $ACTUAL_VENV_PATH..."
+      source "$ACTUAL_VENV_PATH/bin/activate"
+      export UV_PROJECT_ENVIRONMENT="$ACTUAL_VENV_PATH"
+    else
+      echo "direnv: Virtual environment at $ACTUAL_VENV_PATH not found or is incomplete."
+    fi
+}

.envrc.example

@@ -0,0 +1 @@
+load_venv deep

.gitignore

@@ -9,6 +9,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
+.venv
 build/
 develop-eggs/
 dist/
@@ -71,3 +72,6 @@ temp*
 .env
 
 pyrightconfig.json
+
+# direnv file
+.envrc

CHANGELOG.md

@@ -1,5 +1,25 @@
 # DeepDiff Change log
 
+- v8-6-0
+    - Added Colored View thanks to @mauvilsa 
+    - Added support for applying deltas to NamedTuple thanks to @paulsc 
+    - Fixed test_delta.py with Python 3.14 thanks to @Romain-Geissler-1A
+    - Added python property serialization to json
+    - Added ip address serialization
+    - Switched to UV from pip
+    - Added Claude.md
+    - Added uuid hashing thanks to @akshat62
+    - Added `ignore_uuid_types` flag to DeepDiff to avoid type reports when comparing UUID and string.
+    - Added comprehensive type hints across the codebase (multiple commits for better type safety)
+    - Added support for memoryview serialization
+    - Added support for bytes serialization (non-UTF8 compatible)
+    - Fixed bug where group_by with numbers would leak type info into group path reports
+    - Fixed bug in `_get_clean_to_keys_mapping without` explicit significant digits
+    - Added support for python dict key serialization
+    - Enhanced support for IP address serialization with safe module imports
+    - Added development tooling improvements (pyright config, .envrc example)
+    - Updated documentation and development instructions
+
 - v8-5-0
     - Updating deprecated pydantic calls
     - Switching to pyproject.toml

CLAUDE.md

@@ -0,0 +1,108 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+DeepDiff is a Python library for deep comparison, searching, and hashing of Python objects. It provides:
+- **DeepDiff**: Deep difference detection between objects
+- **DeepSearch**: Search for objects within other objects  
+- **DeepHash**: Content-based hashing for any object
+- **Delta**: Git-like diff objects that can be applied to other objects
+- **CLI**: Command-line interface via `deep` command
+
+## Development Commands
+
+### Setup
+```bash
+# Install with all development dependencies
+uv pip install -e ".[cli,coverage,dev,docs,static,test]"
+# OR using uv (recommended)
+uv sync --all-extras
+```
+
+**Virtual Environment**: Activate with `source ~/.venvs/deep/bin/activate` before running tests or Python commands
+
+
+### Testing
+```bash
+# Run tests with coverage
+source ~/.venvs/deep/bin/activate && pytest --cov=deepdiff --cov-report term-missing
+
+# Run tests including slow ones
+source ~/.venvs/deep/bin/activate && pytest --cov=deepdiff --runslow
+
+# Run single test file
+source ~/.venvs/deep/bin/activate && pytest tests/test_diff_text.py
+
+# Run tests across multiple Python versions. No need to use this unless getting ready for creating a new build
+source ~/.venvs/deep/bin/activate && nox -s pytest
+```
+
+### **Type Checking with Pyright:**
+Always use this pattern for type checking:
+```bash
+source ~/.venvs/deep/bin/activate && pyright {file_path}
+```
+
+Examples:
+- `source ~/.venvs/deep/bin/activate && pyright deepdiff/diff.py` - Type check specific file
+- `source ~/.venvs/deep/bin/activate && pyright deepdiff/` - Type check entire module
+- `source ~/.venvs/deep/bin/activate && pyright .` - Type check entire repo
+
+
+### Common Pitfalls to Avoid
+
+1. **Forgetting Virtual Environment**: ALWAYS activate venv before ANY Python command:
+   ```bash
+   source ~/.venvs/deep/bin/activate
+   ```
+2. **Running pytest without venv**: This will cause import errors. Always use:
+   ```bash
+   source ~/.venvs/deep/bin/activate && pytest
+   ```
+3. **Running module commands without venv**: Commands like `capi run`, `cettings shell`, etc. all require venv to be activated first
+
+
+### Slow quality checks only to run before creating a build
+```bash
+# Linting (max line length: 120)
+nox -s flake8
+
+# Type checking
+nox -s mypy
+
+# Run all quality checks
+nox
+```
+
+
+## Architecture
+
+### Core Structure
+- **deepdiff/diff.py**: Main DeepDiff implementation (most complex component)
+- **deepdiff/deephash.py**: DeepHash functionality
+- **deepdiff/base.py**: Shared base classes and functionality
+- **deepdiff/model.py**: Core data structures and result objects
+- **deepdiff/helper.py**: Utility functions and type definitions
+- **deepdiff/delta.py**: Delta objects for applying changes
+
+### Key Patterns
+- **Inheritance**: `Base` class provides common functionality with mixins
+- **Result Objects**: Different result formats (`ResultDict`, `TreeResult`, `TextResult`)
+- **Path Navigation**: Consistent path notation for nested object access
+- **Performance**: LRU caching and numpy array optimization
+
+### Testing
+- Located in `/tests/` directory
+- Organized by functionality (e.g., `test_diff_text.py`, `test_hash.py`)
+- Aims for ~100% test coverage
+- Uses pytest with comprehensive fixtures
+
+## Development Notes
+
+- **Python Support**: 3.9+ and PyPy3
+- **Main Branch**: `master` (PRs typically go to `dev` branch)
+- **Build System**: Modern `pyproject.toml` with `flit_core`
+- **Dependencies**: Core dependency is `orderly-set>=5.4.1,<6`
+- **CLI Tool**: Available as `deep` command after installation with `[cli]` extra

MANIFEST.in

@@ -7,6 +7,7 @@ include *.txt
 include *.sh
 include pytest.ini
 include *.py
+exclude uv.lock
 recursive-include docs/ *.rst
 recursive-include docs/ *.png
 recursive-include tests *.csv

README.md

@@ -23,6 +23,28 @@ Tested on Python 3.9+ and PyPy3.
 
 Please check the [ChangeLog](CHANGELOG.md) file for the detailed information.
 
+DeepDiff 8-6-0
+
+- Added Colored View thanks to @mauvilsa 
+- Added support for applying deltas to NamedTuple thanks to @paulsc 
+- Fixed test_delta.py with Python 3.14 thanks to @Romain-Geissler-1A
+- Added python property serialization to json
+- Added ip address serialization
+- Switched to UV from pip
+- Added Claude.md
+- Added uuid hashing thanks to @akshat62
+- Added `ignore_uuid_types` flag to DeepDiff to avoid type reports when comparing UUID and string.
+- Added comprehensive type hints across the codebase (multiple commits for better type safety)
+- Added support for memoryview serialization
+- Added support for bytes serialization (non-UTF8 compatible)
+- Fixed bug where group_by with numbers would leak type info into group path reports
+- Fixed bug in `_get_clean_to_keys_mapping without` explicit significant digits
+- Added support for python dict key serialization
+- Enhanced support for IP address serialization with safe module imports
+- Added development tooling improvements (pyright config, .envrc example)
+- Updated documentation and development instructions
+
+
 DeepDiff 8-5-0
 
 - Updating deprecated pydantic calls
@@ -84,6 +106,17 @@ Please take a look at the [CHANGELOG](CHANGELOG.md) file.
 
 :mega: **Please fill out our [fast 5-question survey](https://forms.gle/E6qXexcgjoKnSzjB8)** so that we can learn how & why you use DeepDiff, and what improvements we should make. Thank you! :dancers:
 
+# Local dev
+
+1. Clone the repo
+2. Switch to the dev branch
+3. Create your own branch
+4. Install dependencies
+
+    - Method 1: Use [`uv`](https://github.com/astral-sh/uv) to install the dependencies:  `uv sync --all-extras`.
+    - Method 2: Use pip: `pip install -e ".[cli,coverage,dev,docs,static,test]"`
+5. Build `flit build`
+
 # Contribute
 
 1. Please make your PR against the dev branch

deepdiff/base.py

@@ -1,3 +1,5 @@
+import uuid
+from typing import List, Optional, Union, Tuple, Any, Type
 from deepdiff.helper import strings, numbers, SetOrdered
 
 
@@ -9,7 +11,7 @@ class Base:
     numbers = numbers
     strings = strings
 
-    def get_significant_digits(self, significant_digits, ignore_numeric_type_changes):
+    def get_significant_digits(self, significant_digits: Optional[int], ignore_numeric_type_changes: bool) -> Optional[int]:
         if significant_digits is not None and significant_digits < 0:
             raise ValueError(
                 "significant_digits must be None or a non-negative integer")
@@ -18,10 +20,12 @@ def get_significant_digits(self, significant_digits, ignore_numeric_type_changes
                 significant_digits = DEFAULT_SIGNIFICANT_DIGITS_WHEN_IGNORE_NUMERIC_TYPES
         return significant_digits
 
-    def get_ignore_types_in_groups(self, ignore_type_in_groups,
-                                   ignore_string_type_changes,
-                                   ignore_numeric_type_changes,
-                                   ignore_type_subclasses):
+    def get_ignore_types_in_groups(self, 
+                                   ignore_type_in_groups: Optional[Union[List[Any], Tuple[Any, ...]]], 
+                                   ignore_string_type_changes: bool,
+                                   ignore_numeric_type_changes: bool,
+                                   ignore_type_subclasses: bool,
+                                   ignore_uuid_types: bool = False) -> List[Union[SetOrdered, Tuple[Type[Any], ...]]]:
         if ignore_type_in_groups:
             if isinstance(ignore_type_in_groups[0], type):
                 ignore_type_in_groups = [ignore_type_in_groups]
@@ -43,6 +47,12 @@ def get_ignore_types_in_groups(self, ignore_type_in_groups,
         if ignore_numeric_type_changes and self.numbers not in ignore_type_in_groups:
             ignore_type_in_groups.append(SetOrdered(self.numbers))
 
+        if ignore_uuid_types:
+            # Create a group containing both UUID and str types
+            uuid_str_group = SetOrdered([uuid.UUID, str])
+            if uuid_str_group not in ignore_type_in_groups:
+                ignore_type_in_groups.append(uuid_str_group)
+
         if not ignore_type_subclasses:
             # is_instance method needs tuples. When we look for subclasses, we need them to be tuples
             ignore_type_in_groups = list(map(tuple, ignore_type_in_groups))