Upgrading

For an overview of what has changed between versions, see the Changelog.

Instructions

1. Check which version of Tagulous you are upgrading from:

   python
   >>> import tagulous
   >>> tagulous.__version__

2. Upgrade the Tagulous package:

   pip install --upgrade django-tagulous

3. Scroll down to the earliest instructions relevant to your version, and follow them up to the latest version.

   For example, to upgrade from 0.8.0, the earliest instructions relevant to you are for 0.8.0 or later. 0.7.0 is an earlier version than yours, so you don't need to follow those steps.

Upgrading from 0.14.1

Tagulous 0.14.1 was the last version to support Django 1.10 and earlier. Tagulous 1.0.0 requires Django 1.11 or later, and Python 2.7 or 3.5 or later.

Tagulous 1.0.0 changes the default JavaScript adaptor to use select2 v4. This may necessitate some styling changes on your user-facing pages if you have overridden the default styles.

Tagulous 1.0.0 no longer allows whitespace tags in SingleTagField.

Upgrading from 0.14.0

Tagulous 0.14.0 was the last version to officially support Django 1.10 or earlier.

Upgrading from 0.13.0

1. Setting null in a model TagField has raised a warning in the parent ManyToManyField since Django 1.9. The warning now correctly blames a TagField instead. The null argument in a model TagField is deprecated and has no effect, so should not be used.
2. Version 0.13.1 reduces support for Python 3.3. No known breaking changes have been introduced, but this version of Python will no longer be tested against due to lack of support in third party tools.

Upgrading from 0.12.0

1. Auto-generated tag models have been renamed.

   Django 1.11 introduced a rule that models cannot start with an underscore. Prior to this, Tagulous auto-generated tag models started _Tagulous_, to indicate they are auto-generated. From now on, they will start Tagulous_.

   Django migrations should detect this model name change:

   ./manage.py makemigrations
   Did you rename the myapp._Tagulous_MyModel model to Tagulous_MyModel? [y/N]

   Answer `y` for all Tagulous auto-generated models, and migrate:

   ./manage.py migrate

   Troubleshooting:

   • If you do not see the rename prompt when running makemigrations, you will need to edit the migration manually - see `RenameModel <https://docs.djangoproject.com/en/1.11/ref/migration-operations/#renamemodel>` in the Django documentation for more details.
   • If any AlterField changes to the SingleTagField or TagField definitions are included in this set of migrations, the new tag model's name will not be correctly detected and you will see the errors Related model ... cannot be resolved or AttributeError: 'TagField' object has no attribute 'm2m_reverse_field_name'. To resolve these, manually change the to parameter in your AlterField's tag field definition from myapp._Tagulous_... to myapp.Tagulous_....
   • If you see an error Renaming the table while in a transaction is not supported because it would break referential integrity, add atomic = False to your migration class.
2. Version 0.13.0 reduces support for Django 1.4 and Python 3.2. No known breaking changes have been introduced, but these versions of Django and Python will no longer be tested against due to lack of support in third party tools.
3. The TagField manager's __len__ has now been removed, following its deprecation in 0.12.0. If you are currently using len(instance.tagfield) then you should switch to using instance.tagfield.count() instead (see upgrade instructions).

Upgrading from 0.11.1

1. Starting with version 0.12.0, Tagulous no longer enforces uniqueness for tree path fields. This means that Django will detect a change to your models, and warn you that your migrations are out of sync. It is safe for you to create and apply a standard migration with:

   ./manage.py makemigrations
   ./manage.py migrate

   This change is to avoid MySQL (and possibly other databases) from the errror "BLOB/TEXT column 'path' used in key specification without a key length" - see https://github.com/radiac/django-tagulous/issues/1 for discussion.

2. Version 0.12.0 deprecates the model tag manager's `len` method in preparation for merging https://github.com/radiac/django-tagulous/pull/10 to resolve https://github.com/radiac/django-tagulous/issues/9.

   If you are currently using `len(instance.tagfield)` then you should switch to using `instance.tagfield.count()` instead.

Upgrading from 0.9.0

1. Starting with version 0.10.0, Tagulous is available on pypi. You can continue to run the development version direct from github, but if you would prefer to use stable releases you can reinstall:

   pip uninstall django-tagulous
   pip install django-tagulous

2. Version 0.10.0 adds label and level fields to the TagTreeModel base class (they were previously properties). This means that each of your tag tree models will need a schema and data migration.

   The schema migration will require a default value for the label; enter any valid string, eg '.'

   The data migration will need to call mytagtreemodel.objects.rebuild() to set the correct values for label and level.

   You will need to create and apply these migrations to each of your tag tree models

   Django migrations:

   python manage.py makemigrations myapp
   python manage.py migrate myapp
   python manage.py makemigrations myapp --empty
   # Add data migration operation below
   python manage.py migrate myapp

   Your Django data migration should include:

   def rebuild_tree(apps, schema_editor):
       # For an auto-generated tag tree model:
       model = apps.get_model('myapp', '_Tagulous_MyModel_tagtreefield')
   
       # For a custom tag tree model:
       #model = apps.get_model('myapp', 'MyTagTreeModel')
   
       model.objects.rebuild()
   
   class Migration(migrations.Migration):
       # ... rest of Migration as generated
       operations = [
           migrations.RunPython(rebuild_tree)
       ]

   South migrations:

   python manage.py schemamigration --auto myapp
   python manage.py migrate myapp
   python manage.py datamigration myapp upgrade_trees
   # Add data migration function below
   python manage.py migrate myapp

   Your South data migration function should be:

   def forwards(self, orm):
       # For an auto-generated tag tree model:
       model = orm['myapp._Tagulous_MyModel_tagtreefield'].objects.rebuild()
   
       # For a custom tag tree model:
       #model = orm['myapp.MyTagTreeModel'].objects.rebuild()

3. Since version 0.10.0 tree cannot be set in TagMeta; custom tag models must get their tree status from their base class.
4. In version 0.10.0, TagOptions.field_items was renamed to TagOptions.form_items, and constants.FIELD_OPTIONS was renamed to constants.FORM_OPTIONS. These were internal, so should not affect your code.
5. The tag parsers now accept a new argument to control whether space is used as a delimiter or not. These are internal, so should not affect your code, unless you have written a custom adaptor.

Upgrading from 0.8.0

1. Since 0.9.0, SingleTagField and TagField raise an exception if the tag model isn't a subclass of TagModel.
2. The documentation for tagulous.models.migrations.add_unique_column has been clarified to illustrate the risk of using it with a non-transactional database. If you use this in your migrations, read the documentation to be sure you understand the problem involved.

Upgrading from 0.7.0 or earlier

1. tagulous.admin.tag_model was deprecated in 0.8.0 and removed in 0.9.0; use tagulous.admin.register instead:

   tagulous.admin.tag_model(MyModel.tags)
   tagulous.admin.tag_model(MyModel.tags, my_admin_site)
   # becomes:
   tagulous.admin.register(MyModel.tags)
   tagulous.admin.register(MyModel.tags, site=my_admin_site)

2. Since 0.8.0, a ValueError exception is raised if a tag model field definition specifies both a tag model and tag options.

   For custom tag models, tag options must be set by adding a class TagMeta to your model. You can no longer set tag options in the tag field.

   Where an auto-generated tag model is shared with another tag field, the first tag field must set all tag options.

3. Any existing South migrations with SingleTagField or TagField definitions which automatically generate their tag models will need to be manually modified in the Migration.models definition to have the attribute '_set_tag_meta': 'True'. For example, the line:

   'labels': ('tagulous.models.fields.TagField', [], {'force_lowercase': 'True', 'to': u"orm['myapp._Tagulous_MyModel_labels']", 'blank': 'True'}),

   becomes:

   'labels': ('tagulous.models.fields.TagField', [], {'force_lowercase': 'True', 'to': u"orm['myapp._Tagulous_MyModel_labels']", 'blank': 'True', '_set_tag_meta': 'True'}),

   Any `db.add_column` calls will need to be changed too:

   db.add_column(u'myapp_mymodel', 'singletag',
                 self.gf('tagulous.models.fields.SingleTagField')(null=True, ...),
                 ...)

   becomes:

   db.add_column(u'myapp_mymodel', 'singletag',
                 self.gf('tagulous.models.fields.SingleTagField')(_set_tag_meta=True, null=True, ...),
                 ...)

   This will use the keyword tag options to update the tag model's objects, rather than raising the new ValueError.

Changelog

Releases which require special steps when upgrading to them will be marked with links to the instructions above.

Changes for upcoming releases will be listed without a release date - these are available by installing the master branch from github (see Instructions for details).

1.1.0, 2020-12-06

Feature:

• Add Django 3.0 and 3.1 support (#85)

Changes:

• Drops support for Python 2 and 3.5
• Drops support for Django 1.11 and earlier
• Drops support for South migrations

Bugfix:

• Resolves ManyToManyRel issue sometimes seen in loaddata (#110)

Thanks to:

• Diego Ubirajara (dubirajara) for FieldDoesNotExist fix for Django 3.1
• Andrew O'Brien (marxide) for admin.helpers fix for Django 3.1

1.0.0, 2020-10-08

Feature:

• Added adaptor for Select2 v4 and set as default for Django 2.2+ (#11, #12, #90)
• Support full unicode slugs with new TAGULOUS_SLUG_ALLOW_UNICODE setting (#22)

Changes:

• Drops support for Django 1.8 and earlier

Bugfix:

• Tag fields work with abstract and concrete inheritance (#8)
• Ensure weighted values are integers not floats (#69, #70)
• The admin site in Django 2.2+ now uses the Django vendored versions of jQuery and select2 (#76)
• Fix support for single character tags in trees (#82)
• Fix documentation for adding registering tagged models in admin (#83)
• Fix division by zero in weight() (#59, #61)
• Fix support for capitalised table name in PostgreSQL (#60, #61)
• Tag fields are stripped before parsing, preventing whitespace tags in SingleTagFields (#29)
• Fix documentation for quickstart (#41)
• Fix prefetch_related() on tag fields (#42)
• Correctly raise an IntegrityError when saving a tree tag without a name (#50)

Internal:

• Signals have been refactored to global handlers (instead of multiple independent handlers bound to descriptors)
• Code linting improved; project now uses black and isort, and flake8 pases

Thanks to:

• Khoa Pham (phamk) for prefetch_related() fix (#42, #87)
• Erik Van Kelst (4levels) for division by zero and capitalised table fixes (#60, #61, #62)
• hagsteel for weighted values fix (#69, #70)
• Michael Röttger (mcrot) for single character tag fix (#81, #82)
• Frank Lanitz (frlan) for admin documentation fix (#83)

0.14.1, 2019-09-04

Feature:

• Add Django 2.2 support (closes #71)
• Upgrade example project to Django 2.2 on Python 3.7

Bugfix:

• Correct issue with multiple databases (#72)

Thanks to:

• Dmitry Ivanchenko (ivanchenkodmitry) for multiple database fix (#72)

0.14.0, 2019-02-24

Feature:

• Add Django 2.0 support (fixes #48, #65)
• Add Django 2.1 support (fixes #56, #58)

Bugfix:

• Fix example project (fixes #64)

Thanks to:

• Diego Ubirajara (dubirajara) for Widget.render() fix (#58)

0.13.2, 2018-05-28

Feature:

• Tag fields now support the argument to_base=MyTagModelBase

0.13.1, 2018-05-19

See upgrade instructions

Bugfix:

• TagField(null=...) now raises a warning about the TagField, rather than the parent ManyToManyField.

Changes:

• Reduce support for Python 3.3

0.13.0, 2018-04-30

See upgrade instructions

Feature:

• Add Django 1.11 support (fixes #28)

Changes:

• Reduce support for Django 1.4 and Python 3.2
• Remove deprecated TagField manager's __len__ (#10, fixes #9)

Bugfix:

• Fix failed search in select2 v3 widget when pasting multiple tags (fixes #26)
• Fix potential race condition when creating new tags (#31)
• Temporarily disabled some migration tests which only failed under Python 2.7 with Django 1.9+ due to logic issues in the tests.
• Fix deserialization exception for model with ManyToOneRel (fixes #14)

Thanks to:

• Martín R. Guerrero (slackmart) for removing __len__ method (#9, #10)
• Mark London for select2 v3 widget fix when pasting tags (#26)
• Peter Baumgartner (ipmb) for fixing race condition (#31)
• Raniere Silva (rgaics) for fixing deserialization exeption (#14, #45)

0.12.0, 2017-02-26

See upgrade instructions

Feature:

• Add Django 1.10 support (fixes #18, #20)

Bugfix:

• Remove unique=True from tag tree models' path field (fixes #1)
• Implement slug field truncation (fixes #3)
• Correct MySQL slug clash detection in tag model save
• Correct .weight(..) to always return floored integers instead of decimals
• Correct max length calculation when adding and removing a value through assignment
• `TagDescriptor` now has a `through` attribute to match `ManyToManyDescriptor`

Deprecates:

• `TagField` manager's `len` method is now deprecated and will be removed in 0.13

Thanks to:

• Pamela McA'Nulty (PamelaM) for MySQL fixes (#1)
• Mary (minidietcoke) for max count fix (#16)
• James Pic (jpic) for documentation corrections (#13)
• Robert Erb (rerb) at AASHE (http://www.aashe.org/) for Django 1.10 support (#18, #20)
• Gaël Utard (gutard) for tag descriptor `through` fix (#19)

0.11.1, 2015-10-05

Internal:

• Fix package configuration in setup.py

0.11.0, 2015-10-04

Feature:

• Add support for Python 3.2 to 3.5

Internal:

• Change tagulous.models.initial.field_initialise_tags and model_initialise_tags to take a file handle as report.

0.10.0, 2015-09-28

See upgrade instructions

Feature:

• Add fields level and label to tagulous.models.TagTreeModel (were properties)
• Add TagTreeModel.get_siblings()
• Add tagulous.models.TagTreeModelQuerySet methods with_ancestors(), with_descendants() and with_siblings()
• Add space_delimiter tag option to disable space as a delimiter
• Tagulous available from pypi as django-tagulous
• TagModel.merge_tags can now accept a tag string
• TagTreeModel.merge_tags can now merge recursively with new argument children=True
• Support for recursively merging tree tags in admin site

Internal:

• Add support for Django 1.9a1
• TagTreeModel.tag_options.tree will now always be True
• JavaScript parseTags arguments have changed
• Added example project to github repository

Bugfix:

• TagRelatedManager instances can be compared to each other
• Admin inlines now correctly suppress popup buttons
• Select2 adaptor correctly parses ajax response
• TagMeta raises an exception if tree is set
• Default help text no longer changes for tagulous.models.SingleTagField

0.9.0, 2015-09-14

See upgrade instructions

Internal:

• Add support for Django 1.7 and 1.8

Removed:

• tagulous.admin.tag_model has been removed

Bugfix:

• Using a tag field with a non-tag model raises exception

0.8.0, 2015-08-22

See upgrade instructions

Feature:

• Tag cloud support
• Improved admin.register
• Added tag-aware serializers

Deprecated:

• tagulous.admin.tag_model will be removed in the next version

Bugfix:

• Setting tag options twice raises exception
• Tagged inline formsets work correctly

Internal:

• South migration support improved
• Tests moved to top level, tox support added
• Many small code improvements and bug fixes

0.7.0, 2015-07-01

Feature:

• Added tree support

0.6.0, 2015-05-11

Feature:

• Initial public preview