Skip to content

Latest commit

 

History

History
236 lines (155 loc) · 6.62 KB

CHANGES.rst

File metadata and controls

236 lines (155 loc) · 6.62 KB

Prance 26.07.19.0

Features

  • Add --allow-recursion CLI flag to validate and compile commands, allowing specs with self-referencing $ref (e.g. recursive types like linked lists or trees) to be processed without raising ResolutionError. (#124)
  • Speed up reference resolution with pure Python optimizations: structural sharing for O(N) chained $ref resolution (was O(N^2)), resolved-reference caching, optimized iterators and path functions, optional orjson fast deepcopy (prance[fast]), keep_ref_on_recursion handler to preserve $ref on recursion, materialize=True option for independent subtree copies, and a fix for path_get returning defaultvalue for falsy values. (#169)
  • Add Python 3.14 support to classifiers, CI, and tox

Misc

  • Fix sphinx version constraint to <8.2 as 8.2+ requires Python 3.11+
  • Migrate project metadata to pyproject.toml and convert dev dependencies to PEP 735 dependency group
  • Remove obsolete requirements files and appveyor.yml, update docs with modern installation instructions
  • Update GitHub Actions to use latest action versions: checkout@v4, setup-python@v5
  • Update build dependencies: setuptools to >80, setuptools_scm to >9
  • Update core dependencies: ruamel.yaml to 0.18.16, requests to 2.32.5, packaging to 25.0
  • Update dev dependencies: tox to 4.32.0, pytest to 9.0.1, pytest-cov to 7.0.0, towncrier to 25.8.0
  • Update optional CLI dependency: click to 8.3.0
  • Update pre-commit configuration to use --py310-plus for pyupgrade and reorder-python-imports
  • Use dependency groups in tox configuration instead of manually specifying deps
  • Use pip --group flag to install dev dependency group in CI

Prance 25.04.08.0

Compatibility changes

Thank you to Mathis for bringing this forth.

  • migrate from jsonschema to referencing for references
  • drop unmaintained python 3.8/3.9
  • add support + ci for python 3.11/3.12/3.14
  • migrate convert from mermade.org.uk to converter.swagger.io
  • switch yaml mimetype from the x-yaml form to the official yaml form
  • include petstore example data to ease testing without the git subrepo
  • explicitly use openapi-spec-validator backends in tests
  • drop dependency on setuptools and six

Prance 23.06.21.0

  • first release to do away with zerover
  • prance now uses calver by date

Prance 0.23.02.22.0 (2023-02-22)

  • note: due to a mistake in tagging this was released as 0.22.2.22.0 and was not found as the latest release

Features

  • Update packaging to use modern setuptools and drop python3.7. (#147)

Bugfixes

  • Fixed bug where user's HOMEDRIVE exists, but HOMEDRIVE is offline. (#142)
  • unpin chardet to allow usage. (#144)
  • Unpin packaging to prevent pin issues. (#145)
  • unpin click to allow using modern versions. (#146)

Prance 0.22.11.04.0

Features

  • consolidate and unify openapi-spec-validator api usage (#132)
  • drop dead pythons and upgrade builds for python 3.7 - 3.10 (#137)
  • migrate from distutils.version to packaging.version (#138)

Prance 0.21.8.0 (2021-08-06)

Features

  • Initial translating parser to inline other specs to new names. (#101)
  • replace pyyaml with ruamel.yaml for modern yaml support (#110)
  • Adopt black as code formatter. (#113)

Bugfixes

  • RefResolver will again accept and if instructed resolve references using the "python" URL scheme. (#104)

Prance 0.21.2 (2021-05-18)

Bugfixes

  • widen chardet pin to ease dependency hell for when others haven't updated to >4 (#98)

v0.21.1 (2021-05-18)

  • quickfix for a missed rst issue in readme

v0.21.0 (2021-05-18)

Features

  • Implement initial part of maintainer switch (#93)
    • @RonnyPfannschmidt is the new maintainer, plans to move to jazzband
    • License is now MIT after coordination with Jens
    • begin to use pre-commit + pyupgrade
    • set up for setuptools_scm as bumpversion breaks with normalized configfiles
    • github actions
    • modernize setup.py/cfg
  • return to towncrier default templates

v0.20.2

  • #83: Properly propagate strict mode down to nested resolvers.

v0.20.1

Bugfix release:

  • #85: Update dependencies, in particular chardet
  • Miscellaneous: #86

v0.20.0

  • #77: Translate local references in external files by injecting them into the main specification.
  • #78: Fix issue in RESOLVE_INTERNAL handling

v0.19.0

  • #72: Fix behaviour when attempting to resolve nonexistent local references: raise ResolutionError instead of what the OS provides.
  • #69: Improve documentation with regards to JSON Schema and OpenAPI interoperability; some things are just not very well defined, and we make some strict assumptions in prance.
  • Miscellaneous: #71

v0.18.3

Bugfix release:

  • #67: fix syntax warning.
  • #69: when resolving references, if URL parsing fails, provide context on which URL was being parsed in error message.

v0.18.2

Bugfix release:

  • #65: fix error in resolving files only with ResolvingParser.

v0.18.1

Maintenance release, focusing on change requests from users.

  • #23: Add support for partial resolution, i.e. resolving only internal references, local files, HTTP URLs, or any combination thereof.
  • #36: Improve error handling by mentioning strict mode when openapi-spec-validator raises TypeError with very little context.
  • #46: Reduce reliance on network in tests. Tests that require a network connection can now be skipped via "-m 'not requires_network'". Other tests have mocked connections.
  • #55: RefResolver could set recursion limits, but the ResolvingParser did not pass related options on to the resolver. Fixed that. Also create & use reference cache in ResolvingParser.
  • #60: Improve output when resolving references, by indicating the type of problem (missing key, index out of bounds) in the object or sequence where the error occurred.

v0.17.0

  • #51: Try a lot more bytes when detecting file encoding. The new value is meant to be a multiple of sector/cluster size that's still reasonable on most OSes and volumes.
  • #49: Remove Python 2.7 from supported/built versions. The CI vendors also don't love 3.4 any longer. Instead, we've added 3.7 and 3.8 where available.
  • Miscellaneous: #53

v0.16.2

  • #47: Fix deprecation warning by always preferring collections.abc over collections.

v0.16.1

  • #44: Add changelog generation via towncrier