Add type information

autoslug/fields.py

@@ -11,6 +11,7 @@
 #
 
 # django
+from typing import Any, Dict, List, Tuple
 from django.conf import settings
 from django.db.models.fields import SlugField
 from django.db.models.signals import post_save
@@ -250,7 +251,7 @@ def deconstruct(self):
 
         return name, path, args, kwargs
 
-    def pre_save(self, instance, add):
+    def pre_save(self, instance, add) -> str | None:
 
         # get currently entered slug
         value = self.value_from_object(instance)

autoslug/settings.py

@@ -58,6 +58,7 @@
 .. _modeltranslation: http://django-modeltranslation.readthedocs.org
 
 """
+from typing import Callable
 from django.conf import settings
 from django import VERSION
 
@@ -68,7 +69,7 @@
 
 # use custom slugifying function if any
 slugify_function_path = getattr(settings, 'AUTOSLUG_SLUGIFY_FUNCTION', 'autoslug.utils.slugify')
-slugify = get_callable(slugify_function_path)
+slugify: Callable[[str], str] = get_callable(slugify_function_path)
 
 # enable/disable modeltranslation support
 autoslug_modeltranslation_enable = getattr(settings, 'AUTOSLUG_MODELTRANSLATION_ENABLE', False)

setup.py

@@ -25,6 +25,7 @@
     name     = 'django-autoslug',
     version  = __version__,
     packages = ['autoslug'],
+    package_data={'autoslug': ['py.typed']},
 
     requires = ['python (>= 3.5)', 'django (>= 1.11)'],
     # in case you want to use slugify() with support for transliteration: