Compare commits

..

No commits in common. "main" and "7.0.0" have entirely different histories.
main ... 7.0.0

45 changed files with 156 additions and 951 deletions

View file

@ -11,14 +11,14 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v2
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v6 uses: actions/setup-python@v2
with: with:
python-version: 3.11 python-version: 3.8
- name: Install dependencies - name: Install dependencies
run: | run: |

View file

@ -5,34 +5,41 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
matrix: matrix:
python-version: ['3.10', '3.11', '3.12', '3.13', '3.14'] include:
django-version: ['4.2', '5.2', '6.0.*'] - python-version: 3.6
exclude: django-version: 3.2
- python-version: 3.13 - python-version: 3.7
django-version: 4.2 django-version: 3.2
- python-version: 3.8
- python-version: 3.14 django-version: 3.2
django-version: 4.2 - python-version: 3.9
django-version: 3.2
- python-version: 3.10 - python-version: '3.10'
django-version: 6.0.* django-version: 3.2
- python-version: 3.8
- python-version: 3.11 django-version: 4.0
django-version: 6.0.* - python-version: 3.9
fail-fast: false django-version: 4.0
- python-version: '3.10'
django-version: 4.0
- python-version: 3.8
django-version: 4.1
- python-version: 3.9
django-version: 4.1
- python-version: '3.10'
django-version: 4.1
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v3
- name: 'Set up Python ${{ matrix.python-version }}' - name: 'Set up Python ${{ matrix.python-version }}'
uses: actions/setup-python@v6 uses: actions/setup-python@v3
with: with:
python-version: '${{ matrix.python-version }}' python-version: '${{ matrix.python-version }}'
cache: 'pip' cache: 'pip'
- name: Install dependencies - name: Install dependencies
run: | run: |
pip install -r requirements.txt pip install -e .
pip install -r tests/requirements.txt pip install -r tests/requirements.txt
pip install "Django==${{ matrix.django-version }}" . pip install "Django~=${{ matrix.django-version }}.0" .
- name: Run Tests - name: Run Tests
run: | run: |
echo "$(python --version) / Django $(django-admin --version)" echo "$(python --version) / Django $(django-admin --version)"
@ -42,4 +49,4 @@ jobs:
coverage report coverage report
coverage xml coverage xml
- name: Upload coverage reports to Codecov with GitHub Action - name: Upload coverage reports to Codecov with GitHub Action
uses: codecov/codecov-action@v5 uses: codecov/codecov-action@v3

2
.gitignore vendored
View file

@ -15,5 +15,3 @@ htmlcov/
test_proj/media test_proj/media
.python-version .python-version
/test-media/ /test-media/
.envrc
.direnv/

View file

@ -1,24 +1,24 @@
repos: repos:
- repo: https://github.com/pre-commit/pre-commit-hooks - repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0 rev: v4.3.0
hooks: hooks:
- id: end-of-file-fixer - id: end-of-file-fixer
- id: trailing-whitespace - id: trailing-whitespace
- repo: https://github.com/pycqa/isort - repo: https://github.com/pycqa/isort
rev: "7.0.0" rev: "5.10.1"
hooks: hooks:
- id: isort - id: isort
args: ["--profile", "black"] args: ["--profile", "black"]
- repo: https://github.com/psf/black - repo: https://github.com/psf/black
rev: 25.12.0 rev: 22.6.0
hooks: hooks:
- id: black - id: black
args: [--target-version=py310] args: [--target-version=py310]
- repo: https://github.com/pycqa/flake8 - repo: https://github.com/pycqa/flake8
rev: '7.3.0' rev: '5.0.4'
hooks: hooks:
- id: flake8 - id: flake8
additional_dependencies: additional_dependencies:

View file

@ -1,35 +0,0 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true
# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt

View file

@ -1,35 +1,5 @@
Changelog Changelog
========= =========
* 9.0.0
* Fix files not closed in `create_thumbnail`
* Add Django 5.2 and 6.0 support
* Add Python 3.13, 3.14 support
* Drop Python 3.8, 3.9 support
* 8.0.1
* Fix Django 5.1 compatibility
* 8.0.0 (October 16, 2023)
* Add Django 4.2 support
* Remove Python 3.7 support
* Use path and path converters (changes all url names from prefix `avatar_` to `avatar:`.)
* Add support for Django STORAGES (Django 4.2)
* Add optional api app (requires djangorestframework)
* Use ``Image.Resampling.LANCZOS`` instead of ``Image.LANCZOS`` that was removed in Pillow 10.0.0
* 7.1.1 (February 23, 2023)
* Switch to setuptools for building
* 7.1.0 (February 23, 2023)
* Add LibRavatar support
* Faster admin when many users are present
* Check for corrupted image during upload
* Switch Pillow Resize method from ``Image.ANTIALIAS`` to ``Image.LANCZOS``
* Removed Python 3.6 testing
* Added Python 3.11 support
* 7.0.1 (October 27, 2022)
* Remove height requirement for providers (broke 6 to 7 upgrades)
* 7.0.0 (August 16, 2022) * 7.0.0 (August 16, 2022)
* Allowed for rectangular avatars. Custom avatar tag templates now require the specification of both a ``width`` and ``height`` attribute instead of ``size``. * Allowed for rectangular avatars. Custom avatar tag templates now require the specification of both a ``width`` and ``height`` attribute instead of ``size``.

View file

@ -25,7 +25,7 @@ django-avatar
:alt: PyPI badge :alt: PyPI badge
.. image:: https://readthedocs.org/projects/django-avatar/badge/?version=latest .. image:: https://readthedocs.org/projects/django-avatar/badge/?version=latest
:target: https://django-avatar.readthedocs.org/en/latest/?badge=latest :target: http://django-avatar.readthedocs.org/en/latest/?badge=latest
:alt: Documentation Status :alt: Documentation Status
Django-avatar is a reusable application for handling user avatars. It has the Django-avatar is a reusable application for handling user avatars. It has the
@ -33,4 +33,4 @@ ability to default to Gravatar if no avatar is found for a certain user.
Django-avatar automatically generates thumbnails and stores them to your default Django-avatar automatically generates thumbnails and stores them to your default
file storage backend for retrieval later. file storage backend for retrieval later.
For more information see the documentation at https://django-avatar.readthedocs.org/ For more information see the documentation at http://django-avatar.readthedocs.org/

View file

@ -1 +1 @@
__version__ = "9.0.0" __version__ = "7.0.0"

View file

@ -10,19 +10,20 @@ from avatar.utils import get_user_model
class AvatarAdmin(admin.ModelAdmin): class AvatarAdmin(admin.ModelAdmin):
list_display = ("get_avatar", "user", "primary", "date_uploaded") list_display = ("get_avatar", "user", "primary", "date_uploaded")
list_filter = ("primary",) list_filter = ("primary",)
autocomplete_fields = ("user",)
search_fields = ( search_fields = (
"user__%s" % getattr(get_user_model(), "USERNAME_FIELD", "username"), "user__%s" % getattr(get_user_model(), "USERNAME_FIELD", "username"),
) )
list_per_page = 50 list_per_page = 50
def get_avatar(self, avatar_in): def get_avatar(self, avatar_in):
context = { context = dict(
"user": avatar_in.user, {
"url": avatar_in.avatar.url, "user": avatar_in.user,
"alt": str(avatar_in.user), "url": avatar_in.avatar.url,
"size": 80, "alt": str(avatar_in.user),
} "size": 80,
}
)
return render_to_string("avatar/avatar_tag.html", context) return render_to_string("avatar/avatar_tag.html", context)
get_avatar.short_description = _("Avatar") get_avatar.short_description = _("Avatar")

View file

View file

@ -1,22 +0,0 @@
from django.apps import AppConfig
from django.db.models import signals
from avatar.models import Avatar
class ApiConfig(AppConfig):
default_auto_field = "django.db.models.BigAutoField"
name = "avatar.api"
def ready(self):
from .conf import settings as api_settings
from .signals import (
create_default_thumbnails,
remove_previous_avatar_images_when_update,
)
if api_settings.API_AVATAR_CHANGE_IMAGE:
signals.pre_save.connect(
remove_previous_avatar_images_when_update, sender=Avatar
)
signals.post_save.connect(create_default_thumbnails, sender=Avatar)

View file

@ -1,6 +0,0 @@
from appconf import AppConf
class AvatarAPIConf(AppConf):
# allow updating avatar image in put method
AVATAR_CHANGE_IMAGE = False

View file

@ -1 +0,0 @@
djangorestframework

View file

@ -1,126 +0,0 @@
import os
from django.template.defaultfilters import filesizeformat
from django.utils.translation import gettext_lazy as _
from PIL import Image, ImageOps
from rest_framework import serializers
from avatar.conf import settings
from avatar.conf import settings as api_setting
from avatar.models import Avatar
class AvatarSerializer(serializers.ModelSerializer):
avatar_url = serializers.HyperlinkedIdentityField(
view_name="avatar-detail",
)
user = serializers.HiddenField(default=serializers.CurrentUserDefault())
class Meta:
model = Avatar
fields = ["id", "avatar_url", "avatar", "primary", "user"]
extra_kwargs = {"avatar": {"required": True}}
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
request = kwargs.get("context").get("request", None)
self.user = request.user
def get_fields(self, *args, **kwargs):
fields = super(AvatarSerializer, self).get_fields(*args, **kwargs)
request = self.context.get("request", None)
# remove avatar url field in detail page
if bool(self.context.get("view").kwargs):
fields.pop("avatar_url")
# remove avatar field in put method
if request and getattr(request, "method", None) == "PUT":
# avatar updates only when primary=true and API_AVATAR_CHANGE_IMAGE = True
if (
not api_setting.API_AVATAR_CHANGE_IMAGE
or self.instance
and not self.instance.primary
):
fields.pop("avatar")
else:
fields.get("avatar", None).required = False
return fields
def validate_avatar(self, value):
data = value
if settings.AVATAR_ALLOWED_MIMETYPES:
try:
import magic
except ImportError:
raise ImportError(
"python-magic library must be installed in order to use uploaded file content limitation"
)
# Construct 256 bytes needed for mime validation
magic_buffer = bytes()
for chunk in data.chunks():
magic_buffer += chunk
if len(magic_buffer) >= 256:
break
# https://github.com/ahupp/python-magic#usage
mime = magic.from_buffer(magic_buffer, mime=True)
if mime not in settings.AVATAR_ALLOWED_MIMETYPES:
raise serializers.ValidationError(
_(
"File content is invalid. Detected: %(mimetype)s Allowed content types are: %(valid_mime_list)s"
)
% {
"valid_mime_list": ", ".join(settings.AVATAR_ALLOWED_MIMETYPES),
"mimetype": mime,
}
)
if settings.AVATAR_ALLOWED_FILE_EXTS:
root, ext = os.path.splitext(data.name.lower())
if ext not in settings.AVATAR_ALLOWED_FILE_EXTS:
valid_exts = ", ".join(settings.AVATAR_ALLOWED_FILE_EXTS)
error = _(
"%(ext)s is an invalid file extension. "
"Authorized extensions are : %(valid_exts_list)s"
)
raise serializers.ValidationError(
error % {"ext": ext, "valid_exts_list": valid_exts}
)
if data.size > settings.AVATAR_MAX_SIZE:
error = _(
"Your file is too big (%(size)s), "
"the maximum allowed size is %(max_valid_size)s"
)
raise serializers.ValidationError(
error
% {
"size": filesizeformat(data.size),
"max_valid_size": filesizeformat(settings.AVATAR_MAX_SIZE),
}
)
try:
image = Image.open(data)
ImageOps.exif_transpose(image)
except TypeError:
raise serializers.ValidationError(_("Corrupted image"))
count = Avatar.objects.filter(user=self.user).count()
if 1 < settings.AVATAR_MAX_AVATARS_PER_USER <= count:
error = _(
"You already have %(nb_avatars)d avatars, "
"and the maximum allowed is %(nb_max_avatars)d."
)
raise serializers.ValidationError(
error
% {
"nb_avatars": count,
"nb_max_avatars": settings.AVATAR_MAX_AVATARS_PER_USER,
}
)
return data

View file

@ -1,27 +0,0 @@
from django.shortcuts import _get_queryset
def get_object_or_none(klass, *args, **kwargs):
"""
Use get() to return an object, or return None if the object
does not exist.
klass may be a Model, Manager, or QuerySet object. All other passed
arguments and keyword arguments are used in the get() query.
Like with QuerySet.get(), MultipleObjectsReturned is raised if more than
one object is found.
"""
queryset = _get_queryset(klass)
if not hasattr(queryset, "get"):
klass__name = (
klass.__name__ if isinstance(klass, type) else klass.__class__.__name__
)
raise ValueError(
"First argument to get_object_or_404() must be a Model, Manager, "
"or QuerySet, not '%s'." % klass__name
)
try:
return queryset.get(*args, **kwargs)
except queryset.model.DoesNotExist:
return None

View file

@ -1,48 +0,0 @@
import os
from avatar.api.shortcut import get_object_or_none
from avatar.conf import settings
from avatar.models import Avatar, invalidate_avatar_cache
def create_default_thumbnails(sender, instance, created=False, **kwargs):
invalidate_avatar_cache(sender, instance)
if not created:
for size in settings.AVATAR_AUTO_GENERATE_SIZES:
if isinstance(size, int):
if not instance.thumbnail_exists(size, size):
instance.create_thumbnail(size, size)
else:
# Size is specified with height and width.
if not instance.thumbnail_exists(size[0, size[0]]):
instance.create_thumbnail(size[0], size[1])
def remove_previous_avatar_images_when_update(
sender, instance=None, created=False, update_main_avatar=True, **kwargs
):
if not created:
old_instance = get_object_or_none(Avatar, pk=instance.pk)
if old_instance and not old_instance.avatar == instance.avatar:
base_filepath = old_instance.avatar.name
path, filename = os.path.split(base_filepath)
# iterate through resized avatars directories and delete resized avatars
resized_path = os.path.join(path, "resized")
try:
resized_widths, _ = old_instance.avatar.storage.listdir(resized_path)
for width in resized_widths:
resized_width_path = os.path.join(resized_path, width)
resized_heights, _ = old_instance.avatar.storage.listdir(
resized_width_path
)
for height in resized_heights:
if old_instance.thumbnail_exists(width, height):
old_instance.avatar.storage.delete(
old_instance.avatar_name(width, height)
)
if update_main_avatar:
if old_instance.avatar.storage.exists(old_instance.avatar.name):
old_instance.avatar.storage.delete(old_instance.avatar.name)
except FileNotFoundError:
pass

View file

@ -1,8 +0,0 @@
from rest_framework.routers import SimpleRouter
from avatar.api.views import AvatarViewSets
router = SimpleRouter()
router.register("avatar", AvatarViewSets)
urlpatterns = router.urls

View file

@ -1,52 +0,0 @@
from html.parser import HTMLParser
from avatar.conf import settings
class HTMLTagParser(HTMLParser):
"""
URL parser for getting (url ,width ,height) from avatar templatetags
"""
def __init__(self, output=None):
HTMLParser.__init__(self)
if output is None:
self.output = {}
else:
self.output = output
def handle_starttag(self, tag, attrs):
self.output.update(dict(attrs))
def assign_width_or_height(query_params):
"""
Getting width and height in url parameters and specifying them
"""
avatar_default_size = settings.AVATAR_DEFAULT_SIZE
width = query_params.get("width", avatar_default_size)
height = query_params.get("height", avatar_default_size)
if width == "":
width = avatar_default_size
if height == "":
height = avatar_default_size
if height == avatar_default_size and height != "":
height = width
elif width == avatar_default_size and width != "":
width = height
width = int(width)
height = int(height)
context = {"width": width, "height": height}
return context
def set_new_primary(query_set, instance):
queryset = query_set.exclude(id=instance.id).first()
if queryset:
queryset.primary = True
queryset.save()

View file

@ -1,134 +0,0 @@
from django.db.models import QuerySet
from django.utils.translation import gettext_lazy as _
from rest_framework import permissions, status, viewsets
from rest_framework.decorators import action
from rest_framework.exceptions import ValidationError
from rest_framework.response import Response
from avatar.api.serializers import AvatarSerializer
from avatar.api.utils import HTMLTagParser, assign_width_or_height, set_new_primary
from avatar.models import Avatar
from avatar.templatetags.avatar_tags import avatar
from avatar.utils import get_default_avatar_url, get_primary_avatar, invalidate_cache
class AvatarViewSets(viewsets.ModelViewSet):
serializer_class = AvatarSerializer
permission_classes = [permissions.IsAuthenticated]
queryset = Avatar.objects.select_related("user").order_by(
"-primary", "-date_uploaded"
)
@property
def parse_html_to_json(self):
default_avatar = avatar(self.request.user)
html_parser = HTMLTagParser()
html_parser.feed(default_avatar)
return html_parser.output
def get_queryset(self):
assert self.queryset is not None, (
"'%s' should either include a `queryset` attribute, "
"or override the `get_queryset()` method." % self.__class__.__name__
)
queryset = self.queryset
if isinstance(queryset, QuerySet):
# Ensure queryset is re-evaluated on each request.
queryset = queryset.filter(user=self.request.user)
return queryset
def list(self, request, *args, **kwargs):
queryset = self.filter_queryset(self.get_queryset())
if queryset:
page = self.paginate_queryset(queryset)
if page is not None:
serializer = self.get_serializer(page, many=True)
return self.get_paginated_response(serializer.data)
serializer = self.get_serializer(queryset, many=True)
data = serializer.data
return Response(data)
return Response(
{
"message": "You haven't uploaded an avatar yet. Please upload one now.",
"default_avatar": self.parse_html_to_json,
}
)
def create(self, request, *args, **kwargs):
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
self.perform_create(serializer)
headers = self.get_success_headers(serializer.data)
message = _("Successfully uploaded a new avatar.")
context_data = {"message": message, "data": serializer.data}
return Response(context_data, status=status.HTTP_201_CREATED, headers=headers)
def destroy(self, request, *args, **kwargs):
instance = self.get_object()
if instance.primary is True:
# Find the next avatar, and set it as the new primary
set_new_primary(self.get_queryset(), instance)
self.perform_destroy(instance)
message = _("Successfully deleted the requested avatars.")
return Response(message, status=status.HTTP_204_NO_CONTENT)
def update(self, request, *args, **kwargs):
partial = kwargs.pop("partial", False)
instance = self.get_object()
serializer = self.get_serializer(instance, data=request.data, partial=partial)
serializer.is_valid(raise_exception=True)
avatar_image = serializer.validated_data.get("avatar")
primary_avatar = serializer.validated_data.get("primary")
if not primary_avatar and avatar_image:
raise ValidationError("You cant update an avatar image that is not primary")
if instance.primary is True:
# Find the next avatar, and set it as the new primary
set_new_primary(self.get_queryset(), instance)
self.perform_update(serializer)
invalidate_cache(request.user)
message = _("Successfully updated your avatar.")
if getattr(instance, "_prefetched_objects_cache", None):
# If 'prefetch_related' has been applied to a queryset, we need to
# forcibly invalidate the prefetch cache on the instance.
instance._prefetched_objects_cache = {}
context_data = {"message": message, "data": serializer.data}
return Response(context_data)
@action(
["GET"], detail=False, url_path="render_primary", name="Render Primary Avatar"
)
def render_primary(self, request, *args, **kwargs):
"""
URL Example :
1 - render_primary/
2 - render_primary/?width=400 or render_primary/?height=400
3 - render_primary/?width=500&height=400
"""
context_data = {}
avatar_size = assign_width_or_height(request.query_params)
width = avatar_size.get("width")
height = avatar_size.get("height")
primary_avatar = get_primary_avatar(request.user, width=width, height=height)
if primary_avatar and primary_avatar.primary:
url = primary_avatar.avatar_url(width, height)
else:
url = get_default_avatar_url()
if bool(request.query_params):
context_data.update(
{"message": "Resize parameters not working for default avatar"}
)
context_data.update({"image_url": request.build_absolute_uri(url)})
return Response(context_data)

View file

@ -5,7 +5,7 @@ from PIL import Image
class AvatarConf(AppConf): class AvatarConf(AppConf):
DEFAULT_SIZE = 80 DEFAULT_SIZE = 80
RESIZE_METHOD = Image.Resampling.LANCZOS RESIZE_METHOD = Image.ANTIALIAS
STORAGE_DIR = "avatars" STORAGE_DIR = "avatars"
PATH_HANDLER = "avatar.models.avatar_path_handler" PATH_HANDLER = "avatar.models.avatar_path_handler"
GRAVATAR_BASE_URL = "https://www.gravatar.com/avatar/" GRAVATAR_BASE_URL = "https://www.gravatar.com/avatar/"
@ -24,9 +24,7 @@ class AvatarConf(AppConf):
ALLOWED_FILE_EXTS = None ALLOWED_FILE_EXTS = None
ALLOWED_MIMETYPES = None ALLOWED_MIMETYPES = None
CACHE_TIMEOUT = 60 * 60 CACHE_TIMEOUT = 60 * 60
if hasattr(settings, "DEFAULT_FILE_STORAGE"): STORAGE = settings.DEFAULT_FILE_STORAGE
STORAGE = settings.DEFAULT_FILE_STORAGE # deprecated settings
STORAGE_ALIAS = "default"
CLEANUP_DELETED = True CLEANUP_DELETED = True
AUTO_GENERATE_SIZES = (DEFAULT_SIZE,) AUTO_GENERATE_SIZES = (DEFAULT_SIZE,)
FACEBOOK_GET_ID = None FACEBOOK_GET_ID = None
@ -37,7 +35,6 @@ class AvatarConf(AppConf):
DELETE_TEMPLATE = "" DELETE_TEMPLATE = ""
PROVIDERS = ( PROVIDERS = (
"avatar.providers.PrimaryAvatarProvider", "avatar.providers.PrimaryAvatarProvider",
"avatar.providers.LibRAvatarProvider",
"avatar.providers.GravatarAvatarProvider", "avatar.providers.GravatarAvatarProvider",
"avatar.providers.DefaultAvatarProvider", "avatar.providers.DefaultAvatarProvider",
) )

View file

@ -5,7 +5,6 @@ from django.forms import widgets
from django.template.defaultfilters import filesizeformat from django.template.defaultfilters import filesizeformat
from django.utils.safestring import mark_safe from django.utils.safestring import mark_safe
from django.utils.translation import gettext_lazy as _ from django.utils.translation import gettext_lazy as _
from PIL import Image, ImageOps
from avatar.conf import settings from avatar.conf import settings
from avatar.models import Avatar from avatar.models import Avatar
@ -83,12 +82,6 @@ class UploadAvatarForm(forms.Form):
} }
) )
try:
image = Image.open(data)
ImageOps.exif_transpose(image)
except TypeError:
raise forms.ValidationError(_("Corrupted image"))
count = Avatar.objects.filter(user=self.user).count() count = Avatar.objects.filter(user=self.user).count()
if 1 < settings.AVATAR_MAX_AVATARS_PER_USER <= count: if 1 < settings.AVATAR_MAX_AVATARS_PER_USER <= count:
error = _( error = _(

View file

@ -7,6 +7,7 @@ import avatar.models
class Migration(migrations.Migration): class Migration(migrations.Migration):
dependencies = [ dependencies = [
migrations.swappable_dependency(settings.AUTH_USER_MODEL), migrations.swappable_dependency(settings.AUTH_USER_MODEL),
] ]

View file

@ -8,6 +8,7 @@ import avatar.models
class Migration(migrations.Migration): class Migration(migrations.Migration):
dependencies = [ dependencies = [
("avatar", "0001_initial"), ("avatar", "0001_initial"),
] ]

View file

@ -4,6 +4,7 @@ import avatar.models
class Migration(migrations.Migration): class Migration(migrations.Migration):
dependencies = [ dependencies = [
("avatar", "0002_add_verbose_names_to_avatar_fields"), ("avatar", "0002_add_verbose_names_to_avatar_fields"),
] ]

View file

@ -1,11 +1,11 @@
import binascii import binascii
import hashlib import hashlib
import os import os
from contextlib import closing
from io import BytesIO from io import BytesIO
from django.core.files import File from django.core.files import File
from django.core.files.base import ContentFile from django.core.files.base import ContentFile
from django.core.files.storage import get_storage_class
from django.db import models from django.db import models
from django.db.models import signals from django.db.models import signals
from django.utils.encoding import force_bytes, force_str from django.utils.encoding import force_bytes, force_str
@ -17,14 +17,7 @@ from PIL import Image, ImageOps
from avatar.conf import settings from avatar.conf import settings
from avatar.utils import get_username, invalidate_cache from avatar.utils import get_username, invalidate_cache
try: # Django 4.2+ avatar_storage = get_storage_class(settings.AVATAR_STORAGE)()
from django.core.files.storage import storages
avatar_storage = storages[settings.AVATAR_STORAGE_ALIAS]
except ImportError:
from django.core.files.storage import get_storage_class
avatar_storage = get_storage_class(settings.AVATAR_STORAGE)()
def avatar_path_handler( def avatar_path_handler(
@ -143,38 +136,38 @@ class Avatar(models.Model):
orig = self.avatar.storage.open(self.avatar.name, "rb") orig = self.avatar.storage.open(self.avatar.name, "rb")
except IOError: except IOError:
return # What should we do here? Render a "sorry, didn't work" img? return # What should we do here? Render a "sorry, didn't work" img?
try:
with closing(orig): image = Image.open(orig)
try: image = self.transpose_image(image)
image = Image.open(orig) quality = quality or settings.AVATAR_THUMB_QUALITY
except IOError: w, h = image.size
thumb_file = File(orig) if w != width or h != height:
ratioReal = 1.0 * w / h
ratioWant = 1.0 * width / height
if ratioReal > ratioWant:
diff = int((w - (h * ratioWant)) / 2)
image = image.crop((diff, 0, w - diff, h))
elif ratioReal < ratioWant:
diff = int((h - (w / ratioWant)) / 2)
image = image.crop((0, diff, w, h - diff))
if settings.AVATAR_THUMB_FORMAT == "JPEG" and image.mode == "RGBA":
image = image.convert("RGB")
elif image.mode not in (settings.AVATAR_THUMB_MODES):
image = image.convert(settings.AVATAR_THUMB_MODES[0])
image = image.resize((width, height), settings.AVATAR_RESIZE_METHOD)
thumb = BytesIO()
image.save(thumb, settings.AVATAR_THUMB_FORMAT, quality=quality)
thumb_file = ContentFile(thumb.getvalue())
else: else:
image = self.transpose_image(image) thumb_file = File(orig)
quality = quality or settings.AVATAR_THUMB_QUALITY
w, h = image.size
if w != width or h != height:
ratioReal = 1.0 * w / h
ratioWant = 1.0 * width / height
if ratioReal > ratioWant:
diff = int((w - (h * ratioWant)) / 2)
image = image.crop((diff, 0, w - diff, h))
elif ratioReal < ratioWant:
diff = int((h - (w / ratioWant)) / 2)
image = image.crop((0, diff, w, h - diff))
if settings.AVATAR_THUMB_FORMAT == "JPEG" and image.mode == "RGBA":
image = image.convert("RGB")
elif image.mode not in (settings.AVATAR_THUMB_MODES):
image = image.convert(settings.AVATAR_THUMB_MODES[0])
image = image.resize((width, height), settings.AVATAR_RESIZE_METHOD)
thumb = BytesIO()
image.save(thumb, settings.AVATAR_THUMB_FORMAT, quality=quality)
thumb_file = ContentFile(thumb.getvalue())
else:
thumb_file = File(orig)
thumb_name = self.avatar_name(width, height) thumb_name = self.avatar_name(width, height)
thumb = self.avatar.storage.save(thumb_name, thumb_file) thumb = self.avatar.storage.save(thumb_name, thumb_file)
invalidate_cache(self.user, width, height) except IOError:
thumb_file = File(orig)
thumb = self.avatar.storage.save(
self.avatar_name(width, height), thumb_file
)
invalidate_cache(self.user, width, height)
def avatar_url(self, width, height=None): def avatar_url(self, width, height=None):
return self.avatar.storage.url(self.avatar_name(width, height)) return self.avatar.storage.url(self.avatar_name(width, height))

View file

@ -1,8 +1,6 @@
import hashlib import hashlib
import re
from urllib.parse import urlencode, urljoin from urllib.parse import urlencode, urljoin
import dns.resolver
from django.utils.module_loading import import_string from django.utils.module_loading import import_string
from avatar.conf import settings from avatar.conf import settings
@ -26,7 +24,7 @@ class DefaultAvatarProvider(object):
""" """
@classmethod @classmethod
def get_avatar_url(cls, user, width, height=None): def get_avatar_url(cls, user, width, height):
return get_default_avatar_url() return get_default_avatar_url()
@ -36,9 +34,7 @@ class PrimaryAvatarProvider(object):
""" """
@classmethod @classmethod
def get_avatar_url(cls, user, width, height=None): def get_avatar_url(cls, user, width, height):
if not height:
height = width
avatar = get_primary_avatar(user, width, height) avatar = get_primary_avatar(user, width, height)
if avatar: if avatar:
return avatar.avatar_url(width, height) return avatar.avatar_url(width, height)
@ -50,7 +46,7 @@ class GravatarAvatarProvider(object):
""" """
@classmethod @classmethod
def get_avatar_url(cls, user, width, _height=None): def get_avatar_url(cls, user, width, _height):
params = {"s": str(width)} params = {"s": str(width)}
if settings.AVATAR_GRAVATAR_DEFAULT: if settings.AVATAR_GRAVATAR_DEFAULT:
params["d"] = settings.AVATAR_GRAVATAR_DEFAULT params["d"] = settings.AVATAR_GRAVATAR_DEFAULT
@ -66,49 +62,13 @@ class GravatarAvatarProvider(object):
return urljoin(settings.AVATAR_GRAVATAR_BASE_URL, path) return urljoin(settings.AVATAR_GRAVATAR_BASE_URL, path)
class LibRAvatarProvider:
"""
Returns the url of an avatar by the LibRavatar service.
"""
@classmethod
def get_avatar_url(cls, user, width, _height=None):
email = getattr(user, settings.AVATAR_GRAVATAR_FIELD).encode("utf-8")
try:
_, domain = email.split(b"@")
answers = dns.resolver.query("_avatars._tcp." + domain, "SRV")
hostname = re.sub(r"\.$", "", str(answers[0].target))
# query returns "example.com." and while http requests are fine with this,
# https most certainly do not consider "example.com." and "example.com" to be the same.
port = str(answers[0].port)
if port == "443":
baseurl = "https://" + hostname + "/avatar/"
else:
baseurl = "http://" + hostname + ":" + port + "/avatar/"
except Exception:
baseurl = "https://seccdn.libravatar.org/avatar/"
params = {"s": str(width)}
if settings.AVATAR_GRAVATAR_DEFAULT:
params["d"] = settings.AVATAR_GRAVATAR_DEFAULT
if settings.AVATAR_GRAVATAR_FORCEDEFAULT:
params["f"] = "y"
path = "%s/?%s" % (
hashlib.md5(force_bytes(email.strip().lower())).hexdigest(),
urlencode(params),
)
return urljoin(baseurl, path)
class FacebookAvatarProvider(object): class FacebookAvatarProvider(object):
""" """
Returns the url of a Facebook profile image. Returns the url of a Facebook profile image.
""" """
@classmethod @classmethod
def get_avatar_url(cls, user, width, height=None): def get_avatar_url(cls, user, width, height):
if not height:
height = width
fb_id = get_facebook_id(user) fb_id = get_facebook_id(user)
if fb_id: if fb_id:
url = "https://graph.facebook.com/{fb_id}/picture?type=square&width={width}&height={height}" url = "https://graph.facebook.com/{fb_id}/picture?type=square&width={width}&height={height}"
@ -122,7 +82,7 @@ class InitialsAvatarProvider(object):
""" """
@classmethod @classmethod
def get_avatar_url(cls, user, width, _height=None): def get_avatar_url(cls, user, width, _height):
initials = user.first_name[:1] + user.last_name[:1] initials = user.first_name[:1] + user.last_name[:1]
if not initials: if not initials:
initials = user.username[:1] initials = user.username[:1]

View file

@ -7,7 +7,7 @@
{% if not avatars %} {% if not avatars %}
<p>{% trans "You haven't uploaded an avatar yet. Please upload one now." %}</p> <p>{% trans "You haven't uploaded an avatar yet. Please upload one now." %}</p>
{% endif %} {% endif %}
<form enctype="multipart/form-data" method="POST" action="{% url 'avatar:add' %}"> <form enctype="multipart/form-data" method="POST" action="{% url 'avatar_add' %}">
{{ upload_avatar_form.as_p }} {{ upload_avatar_form.as_p }}
<p>{% csrf_token %}<input type="submit" value="{% trans "Upload New Image" %}" /></p> <p>{% csrf_token %}<input type="submit" value="{% trans "Upload New Image" %}" /></p>
</form> </form>

View file

@ -7,14 +7,14 @@
{% if not avatars %} {% if not avatars %}
<p>{% trans "You haven't uploaded an avatar yet. Please upload one now." %}</p> <p>{% trans "You haven't uploaded an avatar yet. Please upload one now." %}</p>
{% else %} {% else %}
<form method="POST" action="{% url 'avatar:change' %}"> <form method="POST" action="{% url 'avatar_change' %}">
<ul> <ul>
{{ primary_avatar_form.as_ul }} {{ primary_avatar_form.as_ul }}
</ul> </ul>
<p>{% csrf_token %}<input type="submit" value="{% trans "Choose new Default" %}" /></p> <p>{% csrf_token %}<input type="submit" value="{% trans "Choose new Default" %}" /></p>
</form> </form>
{% endif %} {% endif %}
<form enctype="multipart/form-data" method="POST" action="{% url 'avatar:add' %}"> <form enctype="multipart/form-data" method="POST" action="{% url 'avatar_add' %}">
{{ upload_avatar_form.as_p }} {{ upload_avatar_form.as_p }}
<p>{% csrf_token %}<input type="submit" value="{% trans "Upload New Image" %}" /></p> <p>{% csrf_token %}<input type="submit" value="{% trans "Upload New Image" %}" /></p>
</form> </form>

View file

@ -3,11 +3,11 @@
{% block content %} {% block content %}
{% if not avatars %} {% if not avatars %}
{% url 'avatar:change' as avatar_change_url %} {% url 'avatar_change' as avatar_change_url %}
<p>{% blocktrans %}You have no avatars to delete. Please <a href="{{ avatar_change_url }}">upload one</a> now.{% endblocktrans %}</p> <p>{% blocktrans %}You have no avatars to delete. Please <a href="{{ avatar_change_url }}">upload one</a> now.{% endblocktrans %}</p>
{% else %} {% else %}
<p>{% trans "Please select the avatars that you would like to delete." %}</p> <p>{% trans "Please select the avatars that you would like to delete." %}</p>
<form method="POST" action="{% url 'avatar:delete' %}"> <form method="POST" action="{% url 'avatar_delete' %}">
<ul> <ul>
{{ delete_avatar_form.as_ul }} {{ delete_avatar_form.as_ul }}
</ul> </ul>

View file

@ -94,7 +94,7 @@ def primary_avatar(user, width=settings.AVATAR_DEFAULT_SIZE, height=None):
else: else:
kwargs["height"] = height kwargs["height"] = height
url = reverse("avatar:render_primary", kwargs=kwargs) url = reverse("avatar_render_primary", kwargs=kwargs)
return """<img src="%s" width="%s" height="%s" alt="%s" />""" % ( return """<img src="%s" width="%s" height="%s" alt="%s" />""" % (
url, url,
width, width,

View file

@ -1,24 +1,19 @@
from django.urls import path from django.urls import re_path
from avatar import views from avatar import views
# For reversing namespaced urls
# https://docs.djangoproject.com/en/4.1/topics/http/urls/#reversing-namespaced-urls
app_name = "avatar"
urlpatterns = [ urlpatterns = [
path("add/", views.add, name="add"), re_path(r"^add/$", views.add, name="avatar_add"),
path("change/", views.change, name="change"), re_path(r"^change/$", views.change, name="avatar_change"),
path("delete/", views.delete, name="delete"), re_path(r"^delete/$", views.delete, name="avatar_delete"),
# https://docs.djangoproject.com/en/4.1/topics/http/urls/#path-converters re_path(
path( r"^render_primary/(?P<user>[\w\d\@\.\-_]+)/(?P<width>[\d]+)/$",
"render_primary/<slug:user>/<int:width>/",
views.render_primary, views.render_primary,
name="render_primary", name="avatar_render_primary",
), ),
path( re_path(
"render_primary/<slug:user>/<int:width>/<int:height>/", r"^render_primary/(?P<user>[\w\d\@\.\-_]+)/(?P<width>[\d]+)/(?P<height>[\d]+)/$",
views.render_primary, views.render_primary,
name="render_primary", name="avatar_render_primary",
), ),
] ]

View file

@ -21,11 +21,7 @@ def get_username(user):
def get_user(userdescriptor): def get_user(userdescriptor):
"""Return user from a username/ID/ish identifier""" """Return user from a username/ID/ish identifier"""
User = get_user_model() User = get_user_model()
if isinstance(userdescriptor, int): if userdescriptor.isdigit():
user = User.objects.filter(id=userdescriptor).first()
if user:
return user
elif userdescriptor.isdigit():
user = User.objects.filter(id=int(userdescriptor)).first() user = User.objects.filter(id=int(userdescriptor)).first()
if user: if user:
return user return user

View file

@ -9,7 +9,7 @@ BUILDDIR = _build
# User-friendly check for sphinx-build # User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif endif
# Internal variables. # Internal variables.

View file

@ -1,191 +0,0 @@
API Descriptions
================
Avatar List
^^^^^^^^^^^
send a request for listing user avatars as shown below.
``GET`` ``/api/avatar/``
default response of avatar list : ::
{
"message": "You haven't uploaded an avatar yet. Please upload one now.",
"default_avatar": {
"src": "https://seccdn.libravatar.org/avatar/4a9328d595472d0728195a7c8191a50b",
"width": "80",
"height": "80",
"alt": "User Avatar"
}
}
if you have an avatar object : ::
[
{
"id": "image_id",
"avatar_url": "https://example.com/api/avatar/1/",
"avatar": "https://example.com/media/avatars/1/first_avatar.png",
"primary": true
},
]
-----------------------------------------------
Create Avatar
^^^^^^^^^^^^^
send a request for creating user avatar as shown below .
``POST`` ``/api/avatar/``
Request : ::
{
"avatar": "image file",
"primary": true
}
``Note`` : avatar field is required.
Response : ::
{
"message": "Successfully uploaded a new avatar.",
"data": {
"id": "image_id",
"avatar_url": "https://example.com/api/avatar/1/",
"avatar": "https://example.com/media/avatars/1/example.png",
"primary": true
}
}
-----------------------------------------------
Avatar Detail
^^^^^^^^^^^^^
send a request for retrieving user avatar.
``GET`` ``/api/avatar/image_id/``
Response : ::
{
"id": "image_id",
"avatar": "https://example.com/media/avatars/1/example.png",
"primary": true
}
-----------------------------------------------
Update Avatar
^^^^^^^^^^^^^
send a request for updating user avatar.
``PUT`` ``/api/avatar/image_id/``
Request : ::
{
"avatar":"image file"
"primary": true
}
``Note`` : for update avatar image set ``API_AVATAR_CHANGE_IMAGE = True`` in your settings file and set ``primary = True``.
Response : ::
{
"message": "Successfully updated your avatar.",
"data": {
"id": "image_id",
"avatar": "https://example.com/media/avatars/1/custom_admin_en.png",
"primary": true
}
}
-----------------------------------------------
Delete Avatar
^^^^^^^^^^^^^
send a request for deleting user avatar.
``DELETE`` ``/api/avatar/image_id/``
Response : ::
"Successfully deleted the requested avatars."
-----------------------------------------------
Render Primary Avatar
^^^^^^^^^^^^^^^^^^^^^
send a request for retrieving resized primary avatar .
default sizes ``80``:
``GET`` ``/api/avatar/render_primary/``
Response : ::
{
"image_url": "https://example.com/media/avatars/1/resized/80/80/example.png"
}
custom ``width`` and ``height`` :
``GET`` ``/api/avatar/render_primary/?width=width_size&height=height_size``
Response : ::
{
"image_url": "http://127.0.0.1:8000/media/avatars/1/resized/width_size/height_size/python.png"
}
If the entered parameter is one of ``width`` or ``height``, it will be considered for both .
``GET`` ``/api/avatar/render_primary/?width=size`` :
Response : ::
{
"image_url": "http://127.0.0.1:8000/media/avatars/1/resized/size/size/python.png"
}
``Note`` : Resize parameters not working for default avatar.
API Setting
===========
.. py:data:: API_AVATAR_CHANGE_IMAGE
It Allows the user to Change the avatar image in ``PUT`` method. Default is ``False``.

View file

@ -32,7 +32,7 @@ extensions = []
templates_path = ["_templates"] templates_path = ["_templates"]
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = ".rst" source_suffix = ".txt"
# The encoding of source files. # The encoding of source files.
# source_encoding = 'utf-8-sig' # source_encoding = 'utf-8-sig'

View file

@ -1,4 +1,3 @@
django-avatar django-avatar
============= =============
@ -8,7 +7,7 @@ or Facebook) if no avatar is found for a certain user. Django-avatar
automatically generates thumbnails and stores them to your default file automatically generates thumbnails and stores them to your default file
storage backend for retrieval later. storage backend for retrieval later.
.. _Gravatar: https://gravatar.com .. _Gravatar: http://gravatar.com
Installation Installation
------------ ------------
@ -55,7 +54,7 @@ that are required. A minimal integration can work like this:
4. Somewhere in your template navigation scheme, link to the change avatar 4. Somewhere in your template navigation scheme, link to the change avatar
page:: page::
<a href="{% url 'avatar:change' %}">Change your avatar</a> <a href="{% url 'avatar_change' %}">Change your avatar</a>
5. Wherever you want to display an avatar for a user, first load the avatar 5. Wherever you want to display an avatar for a user, first load the avatar
template tags:: template tags::
@ -181,7 +180,6 @@ appear on the site. Listed below are those settings:
( (
'avatar.providers.PrimaryAvatarProvider', 'avatar.providers.PrimaryAvatarProvider',
'avatar.providers.LibRAvatarProvider',
'avatar.providers.GravatarAvatarProvider', 'avatar.providers.GravatarAvatarProvider',
'avatar.providers.DefaultAvatarProvider', 'avatar.providers.DefaultAvatarProvider',
) )
@ -212,13 +210,14 @@ appear on the site. Listed below are those settings:
.. py:data:: AVATAR_RESIZE_METHOD .. py:data:: AVATAR_RESIZE_METHOD
The method to use when resizing images, based on the options available in The method to use when resizing images, based on the options available in
Pillow. Defaults to ``Image.Resampling.LANCZOS``. Pillow. Defaults to ``Image.ANTIALIAS``.
.. py:data:: AVATAR_STORAGE_DIR .. py:data:: AVATAR_STORAGE_DIR
The directory under ``MEDIA_ROOT`` to store the images. If using a The directory under ``MEDIA_ROOT`` to store the images. If using a
non-filesystem storage device, this will simply be appended to the beginning non-filesystem storage device, this will simply be appended to the beginning
of the file name. Defaults to ``avatars``. of the file name. Defaults to ``avatars``.
Pillow. Defaults to ``Image.ANTIALIAS``.
.. py:data:: AVATAR_THUMB_FORMAT .. py:data:: AVATAR_THUMB_FORMAT
@ -263,11 +262,6 @@ appear on the site. Listed below are those settings:
Suggested safe setting: ``("image/png", "image/gif", "image/jpeg")``. Suggested safe setting: ``("image/png", "image/gif", "image/jpeg")``.
When enabled you'll get the following error on the form upload *File content is invalid. Detected: image/tiff Allowed content types are: image/png, image/gif, image/jpg*. When enabled you'll get the following error on the form upload *File content is invalid. Detected: image/tiff Allowed content types are: image/png, image/gif, image/jpg*.
.. py:data:: AVATAR_STORAGE_ALIAS
Default: 'default'
Alias of the storage backend (from STORAGES settings) to use for storing avatars.
Management Commands Management Commands
------------------- -------------------
@ -278,37 +272,4 @@ the avatars for the pixel sizes specified in the
:py:data:`AVATAR_AUTO_GENERATE_SIZES` setting. :py:data:`AVATAR_AUTO_GENERATE_SIZES` setting.
.. _pip: https://www.pip-installer.org/ .. _pip: http://www.pip-installer.org/
-----------------------------------------------
API
---
To use API there are relatively few things that are required.
after `Installation <#installation>`_ .
1. in your ``INSTALLED_APPS`` of your settings file : ::
INSTALLED_APPS = (
# ...
'avatar',
'rest_framework'
)
2. Add the avatar api urls to the end of your root url config : ::
urlpatterns = [
# ...
path('api/', include('avatar.api.urls')),
]
-----------------------------------------------
.. toctree::
:maxdepth: 1
avatar

View file

@ -56,7 +56,7 @@ if errorlevel 9009 (
echo.may add the Sphinx directory to PATH. echo.may add the Sphinx directory to PATH.
echo. echo.
echo.If you don't have Sphinx installed, grab it from echo.If you don't have Sphinx installed, grab it from
echo.https://sphinx-doc.org/ echo.http://sphinx-doc.org/
exit /b 1 exit /b 1
) )

View file

@ -1,40 +0,0 @@
[build-system]
requires = ["setuptools>=65.6.3", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "django-avatar"
description = "A Django app for handling user avatars"
authors = [{email = "floguy@gmail.com", name = "Eric Florenzano"}]
maintainers = [{email = "johannes@fiduswriter.org", name = "Johannes Wilm"}]
license = {text = "BSD-4-Clause"}
readme = "README.rst"
keywords=["avatar", "django"]
classifiers=[
"Development Status :: 5 - Production/Stable",
"Environment :: Web Environment",
"Intended Audience :: Developers",
"Framework :: Django",
"Framework :: Django :: 4.2",
"Framework :: Django :: 5.0",
"Framework :: Django :: 5.2",
"Framework :: Django :: 6.0",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3.14",
]
dynamic = ["version", "dependencies"]
[project.urls]
homepage = "https://github.com/jazzband/django-avatar"
repository = "https://github.com/jazzband/django-avatar"
documentation = "https://django-avatar.readthedocs.io"
[tool.setuptools.dynamic]
version = {attr = "avatar.__version__"}
dependencies = {file = "requirements.txt"}

View file

@ -1,3 +0,0 @@
Pillow>=10.0.1
django-appconf>=1.0.5
dnspython>=2.3.0

View file

@ -20,6 +20,35 @@ def find_version(*file_paths):
setup( setup(
name="django-avatar",
version=find_version("avatar", "__init__.py"),
description="A Django app for handling user avatars",
long_description=read("README.rst"),
classifiers=[
"Development Status :: 5 - Production/Stable",
"Environment :: Web Environment",
"Framework :: Django",
"Intended Audience :: Developers",
"Framework :: Django",
"Framework :: Django :: 3.2",
"Framework :: Django :: 4.0",
"Framework :: Django :: 4.1",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
],
keywords="avatar, django",
author="Eric Florenzano",
author_email="floguy@gmail.com",
maintainer="Johannes Wilm",
maintainer_email="johannes@fiduswriter.org",
url="http://github.com/jazzband/django-avatar/",
license="BSD",
packages=find_packages(exclude=["tests"]), packages=find_packages(exclude=["tests"]),
package_data={ package_data={
"avatar": [ "avatar": [
@ -29,5 +58,9 @@ setup(
"media/avatar/img/default.jpg", "media/avatar/img/default.jpg",
], ],
}, },
install_requires=[
"Pillow>=8.4.0",
"django-appconf>=1.0.5",
],
zip_safe=False, zip_safe=False,
) )

View file

@ -38,7 +38,6 @@ INSTALLED_APPS = [
"django.contrib.messages", "django.contrib.messages",
"django.contrib.staticfiles", "django.contrib.staticfiles",
"avatar", "avatar",
"rest_framework",
] ]
MIDDLEWARE = [ MIDDLEWARE = [

View file

@ -1,18 +1,16 @@
from django.conf import settings from django.conf import settings
from django.conf.urls import include from django.conf.urls import include, url
from django.contrib import admin from django.contrib import admin
from django.urls import re_path
from django.views.static import serve from django.views.static import serve
urlpatterns = [ urlpatterns = [
re_path(r"^admin/", admin.site.urls), url(r"^admin/", admin.site.urls),
re_path(r"^avatar/", include("avatar.urls")), url(r"^avatar/", include("avatar.urls")),
re_path(r"^api/", include("avatar.api.urls")),
] ]
if settings.DEBUG: if settings.DEBUG:
# static files (images, css, javascript, etc.) # static files (images, css, javascript, etc.)
urlpatterns += [ urlpatterns += [
re_path(r"^media/(?P<path>.*)$", serve, {"document_root": settings.MEDIA_ROOT}) url(r"^media/(?P<path>.*)$", serve, {"document_root": settings.MEDIA_ROOT})
] ]

View file

@ -1,3 +1,3 @@
coverage~=7.1.0 coverage==6.2
django django
python-magic python-magic

View file

@ -1,9 +1,7 @@
import math import math
import os.path import os.path
import sys
from pathlib import Path from pathlib import Path
from shutil import rmtree from shutil import rmtree
from unittest import skipIf
from django.contrib.admin.sites import AdminSite from django.contrib.admin.sites import AdminSite
from django.core import management from django.core import management
@ -45,7 +43,7 @@ class AssertSignal:
def upload_helper(o, filename): def upload_helper(o, filename):
f = open(os.path.join(o.testdatapath, filename), "rb") f = open(os.path.join(o.testdatapath, filename), "rb")
response = o.client.post( response = o.client.post(
reverse("avatar:add"), reverse("avatar_add"),
{ {
"avatar": f, "avatar": f,
}, },
@ -120,7 +118,6 @@ class AvatarTests(TestCase):
self.assertTrue(avatar.primary) self.assertTrue(avatar.primary)
# We allow the .tiff file extension but not the mime type # We allow the .tiff file extension but not the mime type
@skipIf(sys.platform == "win32", "Skipping test on Windows platform")
@override_settings(AVATAR_ALLOWED_FILE_EXTS=(".png", ".gif", ".jpg", ".tiff")) @override_settings(AVATAR_ALLOWED_FILE_EXTS=(".png", ".gif", ".jpg", ".tiff"))
@override_settings( @override_settings(
AVATAR_ALLOWED_MIMETYPES=("image/png", "image/gif", "image/jpeg") AVATAR_ALLOWED_MIMETYPES=("image/png", "image/gif", "image/jpeg")
@ -133,7 +130,6 @@ class AvatarTests(TestCase):
self.assertNotEqual(response.context["upload_avatar_form"].errors, {}) self.assertNotEqual(response.context["upload_avatar_form"].errors, {})
# We allow the .tiff file extension and the mime type # We allow the .tiff file extension and the mime type
@skipIf(sys.platform == "win32", "Skipping test on Windows platform")
@override_settings(AVATAR_ALLOWED_FILE_EXTS=(".png", ".gif", ".jpg", ".tiff")) @override_settings(AVATAR_ALLOWED_FILE_EXTS=(".png", ".gif", ".jpg", ".tiff"))
@override_settings( @override_settings(
AVATAR_ALLOWED_MIMETYPES=("image/png", "image/gif", "image/jpeg", "image/tiff") AVATAR_ALLOWED_MIMETYPES=("image/png", "image/gif", "image/jpeg", "image/tiff")
@ -145,7 +141,6 @@ class AvatarTests(TestCase):
self.assertEqual(len(response.redirect_chain), 1) # Redirect only if it worked self.assertEqual(len(response.redirect_chain), 1) # Redirect only if it worked
self.assertEqual(response.context["upload_avatar_form"].errors, {}) self.assertEqual(response.context["upload_avatar_form"].errors, {})
@skipIf(sys.platform == "win32", "Skipping test on Windows platform")
@override_settings(AVATAR_ALLOWED_FILE_EXTS=(".jpg", ".png")) @override_settings(AVATAR_ALLOWED_FILE_EXTS=(".jpg", ".png"))
def test_image_without_wrong_extension(self): def test_image_without_wrong_extension(self):
response = upload_helper(self, "imagefilewithoutext") response = upload_helper(self, "imagefilewithoutext")
@ -153,7 +148,6 @@ class AvatarTests(TestCase):
self.assertEqual(len(response.redirect_chain), 0) # Redirect only if it worked self.assertEqual(len(response.redirect_chain), 0) # Redirect only if it worked
self.assertNotEqual(response.context["upload_avatar_form"].errors, {}) self.assertNotEqual(response.context["upload_avatar_form"].errors, {})
@skipIf(sys.platform == "win32", "Skipping test on Windows platform")
@override_settings(AVATAR_ALLOWED_FILE_EXTS=(".jpg", ".png")) @override_settings(AVATAR_ALLOWED_FILE_EXTS=(".jpg", ".png"))
def test_image_with_wrong_extension(self): def test_image_with_wrong_extension(self):
response = upload_helper(self, "imagefilewithwrongext.ogg") response = upload_helper(self, "imagefilewithwrongext.ogg")
@ -171,7 +165,7 @@ class AvatarTests(TestCase):
def test_default_url(self): def test_default_url(self):
response = self.client.get( response = self.client.get(
reverse( reverse(
"avatar:render_primary", "avatar_render_primary",
kwargs={ kwargs={
"user": self.user.username, "user": self.user.username,
"width": 80, "width": 80,
@ -202,7 +196,7 @@ class AvatarTests(TestCase):
receiver = AssertSignal() receiver = AssertSignal()
avatar_deleted.connect(receiver) avatar_deleted.connect(receiver)
response = self.client.post( response = self.client.post(
reverse("avatar:delete"), reverse("avatar_delete"),
{ {
"choices": [avatar[0].id], "choices": [avatar[0].id],
}, },
@ -222,7 +216,7 @@ class AvatarTests(TestCase):
primary = get_primary_avatar(self.user) primary = get_primary_avatar(self.user)
oid = primary.id oid = primary.id
self.client.post( self.client.post(
reverse("avatar:delete"), reverse("avatar_delete"),
{ {
"choices": [oid], "choices": [oid],
}, },
@ -235,7 +229,7 @@ class AvatarTests(TestCase):
def test_change_avatar_get(self): def test_change_avatar_get(self):
self.test_normal_image_upload() self.test_normal_image_upload()
response = self.client.get(reverse("avatar:change")) response = self.client.get(reverse("avatar_change"))
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertIsNotNone(response.context["avatar"]) self.assertIsNotNone(response.context["avatar"])
@ -245,7 +239,7 @@ class AvatarTests(TestCase):
old_primary = Avatar.objects.get(user=self.user, primary=True) old_primary = Avatar.objects.get(user=self.user, primary=True)
choice = Avatar.objects.filter(user=self.user, primary=False)[0] choice = Avatar.objects.filter(user=self.user, primary=False)[0]
response = self.client.post( response = self.client.post(
reverse("avatar:change"), reverse("avatar_change"),
{ {
"choice": choice.pk, "choice": choice.pk,
}, },