Merge pull request #1 from issackelly:add-img-attrs

Add img attrs option to `as_html` to match template tag behavior

Author: SmileyChris

docs/api.md

@@ -102,4 +102,12 @@ Template tags for rendering processed images:
 
 <!-- With responsive sizes -->
 {% easy_image obj.image_field width=1200 sizes="(max-width: 768px) 600px, (max-width: 480px) 400px" %}
-```
+
+<!-- With additional HTML attributes using img_ prefix -->
+{% img obj.image_field width="md" alt="Product" img_class="rounded-lg" img_loading="lazy" img_data_id="123" %}
+```
+
+The template tag supports adding custom HTML attributes to the generated `<img>` element by prefixing them with `img_`. For example:
+- `img_class="my-class"` becomes `class="my-class"`
+- `img_loading="lazy"` becomes `loading="lazy"`
+- `img_data_id="123"` becomes `data-id="123"`

docs/getting-started.md

@@ -32,6 +32,9 @@ thumb = Img(width="md")
 
 # Generate HTML for an image
 html = thumb(profile.photo, alt="Profile photo").as_html()
+
+# Add extra attributes to the image
+html = thumb(profile.photo, alt="Profile photo").as_html(img_attrs={"loading": "lazy"})
 ```
 
 ### Batch Processing for Multiple Images

easy_images/core.py

@@ -731,8 +731,11 @@ def sizes(self) -> str:
         # Ensure a string is returned
         return str(self._get_item_detail("sizes_attr", ""))
 
-    def as_html(self) -> str:
-        """Generate the complete <img> tag HTML with srcset and sizes."""
+    def as_html(self, img_attrs: dict[str, str] | None = None) -> str:
+        """Generate the complete <img> tag HTML with srcset and sizes.
+
+        :param img_attrs: Optional dict of additional attributes to add to the <img> tag.
+        """
         # Accessing properties triggers loading if needed
         base_img = self.base
         srcset_items = self.srcset
@@ -774,6 +777,13 @@ def as_html(self) -> str:
             if base_img.height is not None:
                 attrs.append(f'height="{base_img.height}"')
 
+        # Add any extra attributes from img_attrs
+        if img_attrs:
+            for k, v in img_attrs.items():
+                # Avoid overwriting existing attributes
+                if k and v and not any(attr.startswith(f"{k}=") for attr in attrs):
+                    attrs.append(f'{escape(k)}="{escape(v)}"')
+
         # Filter out potential empty strings if base image failed etc.
         attrs = [attr for attr in attrs if attr]
 

easy_images/engine.py

@@ -9,7 +9,6 @@
 
 from django.core.files import File
 from django.core.files.uploadedfile import InMemoryUploadedFile, TemporaryUploadedFile
-from django.db.models.fields.files import FieldFile
 
 from easy_images.core import ParsedOptions
 
@@ -138,15 +137,14 @@ def _new_image(file: str | Path | File, access, **kwargs):
 
     path = None
     if isinstance(file, File):
-        if isinstance(file, FieldFile):
-            try:
-                path = file.path
-            except Exception:
-                pass
-        elif isinstance(file, TemporaryUploadedFile):
-            path = file.temporary_file_path()
-        if not path:
-            path = getattr(file, "path", None)
+        try:
+            if isinstance(file, TemporaryUploadedFile):
+                path = file.temporary_file_path()
+            else:
+                path = file.path  # type: ignore
+        except Exception:
+            pass
+
         if not path:
             content = file.read()
             if file.seekable():

tests/test_core.py

@@ -201,3 +201,34 @@ def get_image_side_effect_sizes(pk):
     assert "/img/size_400.webp 400w" in html_output  # High density based on max width
     assert 'width="200"' in html_output
     assert 'height="112"' in html_output
+
+
+@pytest.mark.django_db
+@patch("easy_images.models.get_storage_name", return_value="default")
+def test_as_html_with_img_attrs(mock_get_storage):
+    """Test that as_html correctly adds custom img attributes."""
+    # Create mock storage and assign URL
+    mock_storage = Mock()
+    mock_storage.url.return_value = "/test.jpg"
+    
+    generator = Img(width=100)
+    source = FieldFile(instance=EasyImage(), field=FileField(), name="test.jpg")
+    source.storage = mock_storage  # Assign mock storage to instance
+    
+    bound_img = generator(source, alt="Test image")
+    
+    # Test with custom img_attrs
+    html = bound_img.as_html(img_attrs={"loading": "lazy", "class": "rounded", "data-id": "123"})
+    
+    assert 'src="/test.jpg"' in html
+    assert 'alt="Test image"' in html
+    assert 'loading="lazy"' in html
+    assert 'class="rounded"' in html
+    assert 'data-id="123"' in html
+    
+    # Test that existing attributes are not overwritten
+    html2 = bound_img.as_html(img_attrs={"alt": "Should not override", "src": "should-not-override.jpg"})
+    assert 'alt="Test image"' in html2  # Original alt should remain
+    assert 'src="/test.jpg"' in html2  # Original src should remain
+    assert 'alt="Should not override"' not in html2
+    assert 'src="should-not-override.jpg"' not in html2

tests/test_engine.py

@@ -1,11 +1,9 @@
 import tempfile
 from pathlib import Path
 
-from django.core.files.uploadedfile import (
-    SimpleUploadedFile,
-)
+from django.core.files.uploadedfile import SimpleUploadedFile
 
-from easy_images.engine import efficient_load, scale_image
+from easy_images.engine import _new_image, efficient_load, scale_image
 from easy_images.options import ParsedOptions
 from pyvips import Image
 
@@ -68,3 +66,35 @@ def test_scale():
 
     scaled_not_upscale = scale_image(small_src, (400, 500), contain=True)
     assert (scaled_not_upscale.width, scaled_not_upscale.height) == (100, 100)
+
+
+def test_new_image_file_handling():
+    """Test the file read for different File backends."""
+
+    # Create a simple test image to work with
+    image = Image.black(100, 100)
+    with tempfile.TemporaryDirectory() as tmpdir:
+        image_path = Path(tmpdir) / "test.jpg"
+        image.write_to_file(str(image_path))
+
+        # Test with a path string - should work
+        result = _new_image(str(image_path), "sequential")
+        assert result is not None
+        assert result.width == 100
+        assert result.height == 100
+
+        # Test with a Path object - should also work
+        result2 = _new_image(image_path, "sequential")
+        assert result2 is not None
+        assert result2.width == 100
+        assert result2.height == 100
+
+        # Test with SimpleUploadedFile (uses read/buffer path)
+        with open(image_path, "rb") as f:
+            content = f.read()
+        simple_file = SimpleUploadedFile("test.jpg", content, content_type="image/jpeg")
+
+        result3 = _new_image(simple_file, "sequential")
+        assert result3 is not None
+        assert result3.width == 100
+        assert result3.height == 100