python-ulid v1.0.0 Release Notes

Release Date: 2020-04-30 // almost 4 years ago
  • โž• Added

    * โž• Added type annotations
    * Added the named constructors :meth:`.ULID.from_datetime`, :meth:`.ULID.from_timestamp` and
      :meth:`.ULID.from_hex`.
    
    ๐Ÿ”„ Changed
    
    • โฌ‡๏ธ Dropped support for Python 2. Only Python 3.6+ is supported.
    • ๐Ÿšš The named constructor :meth:.ULID.new has been removed. Use one of the specifc named constructors instead. For a new :class:.ULID created from the current timestamp use the standard constructor.

    .. code-block:: python

    # old
    ulid = ULID.new()
    ulid = ULID.new(time.time())
    ulid = ULID.new(datetime.now())
    
    # new
    ulid = ULID()
    ulid = ULID.from_timestamp(time.time())
    ulid = ULID.from_datetime(datetime.now())
    
    • ๐Ÿšš The :meth:.ULID.str and :meth:.ULID.int methods have been removed in favour of the more Pythonic special dunder-methods. Use str(ulid) and int(ulid) instead.
    • โž• Added the property :meth:.ULID.hex that returns a hex representation of the :class:.ULID.

    .. code-block:: python

    >>> ULID().hex
    '0171caa5459a8631a6894d072c8550a8'
    
    • Equality checks and ordering now also work with str-instances.
    • ๐Ÿ“ฆ The package now has no external dependencies.
    • โœ… The test-coverage has been raised to 100%.

    .. _1.1.0: https://github.com/mdomke/python-ulid/compare/1.0.3...1.1.0 .. _1.0.3: https://github.com/mdomke/python-ulid/compare/1.0.2...1.0.3 .. _1.0.0: https://github.com/mdomke/python-ulid/compare/0.2.0...1.0.0

    .. _PEP-0561: https://www.python.org/dev/peps/pep-0561/#packaging-type-information