versions.py

"""Using Versions to describe the changes in this versioning library -- wow so meta."""
from drf_versioning.versions import Version

VERSION_2_1_0 = Version(
    "2.1.0",
    notes=["Added documentation"],
)
VERSION_2_0_5 = Version(
    "2.0.5",
    notes=[
        (
            "VersionedSerializer now uses transforms to mutate data in-place instead of "
            "overwriting the data dict with the transform output each time",
        ),
        "Added an actual useful readme.",
    ],
)
VERSION_2_0_4 = Version(
    "2.0.4",
    notes=[
        (
            "Added Version.parse() which can be overridden for custom parsing behaviour in "
            "Version subclasses. ",
        )
    ],
)
VERSION_2_0_3 = Version(
    "2.0.3",
    notes=[
        "Middleware no longer hard errors if the request version is not in the list of versions.",
        "Changed VersionDoesNotExist.status_code to 406",
        (
            "Overriding the Version model is now supported. You can include the 'VERSION_MODEL' "
            "key in the DRF_VERSIONING_SETTINGS, where the value is a string describing the path "
            "to your Version model."
        ),
    ],
)
VERSION_2_0_2 = Version(
    "2.0.2",
    notes=[
        (
            "Better error messages if None or some other non-Version|str object gets passed to "
            "Version.get(). "
        )
    ],
)
VERSION_2_0_1 = Version(
    "2.0.1",
    notes=[
        "VersionViewSet now sorts the version list in reverse order (once, at class definition).",
        (
            "VersionDoesNotExist is now a subclass of APIException, so the error handler can now "
            "gracefully handle it "
        ),
    ],
)
VERSION_2_0_0 = Version(
    "2.0.0",
    notes=[
        "Restructured the project to make importing stuff more intuitive.",
    ],
)
VERSION_1_0_0 = Version(
    "1.0.0",
    notes=[
        (
            "VersionedViewSetMeta now checks that all VersionedViewSet subclasses have defined "
            "introduced_in and/or removed_in."
        ),
        "Renamed VersioningSerializer to VersionedSerializer.",
        "VersionedSerializer now supports multiple transforms per version.",
        (
            "VersionedSerializer must now import their list of Transforms and attach it to the "
            "class definition "
        ),
        "Added dateutil as a requirement.",
        "VersionedSerializer can now be used inline.",
    ],
)
VERSION_0_2_0 = Version(
    "0.2.0",
    notes=[
        "Added a list of Versions to track changes to this library.",
        (
            "The link between Version instances and Transform/VersionedViewSet is now defined on "
            "the Transform/VersionedViewSet subclass, and not in the versions list. It makes more "
            "sense to do it this way round because we are passing the Version instance at the "
            "class creation anyway."
        ),
        (
            "On VersionedSerializer subclasses, we now import the Transforms directly using "
            "import_transforms. This has several benefits: 1) Transforms are imported at the "
            "serializer class definition rather than when the Serializer's to_representation is "
            "triggered for the first time. This ensures that the Transform's metaclass (which "
            "adds the Transform to the Version.transforms list) is triggered at startup, "
            "not during first serialization. 2) The Transforms are imported _once_ at class "
            "definition, not every time serialization is performed, so we get a performance "
            "improvement there. "
        ),
        (
            "VersionedSerializer.__init__ checks that transforms have been imported. This means "
            "if they haven't, you'll get the error at startup, not during first serialization."
        ),
    ],
)
VERSION_0_1_1 = Version(
    "0.1.1",
    notes=[
        (
            "Added VersionedViewSet class and versioned_view decorator to allow versioning views. "
            "If the request.version is outside the bounds specified in the ViewSet/method's "
            "`introduced_in` and `removed_in` parameters, a 404 Not Found is returned as if the "
            "view doesn't exist. "
        ),
    ],
)
VERSION_0_1_11 = Version(
    "0.1.11",
    notes=[
        (
            "First semi-usable version of this library. Not worth documenting versions earlier "
            "than this as they were changing so fast and erratically."
        ),
    ],
)