esmerald

Changed

• Added support for Starlette 0.25.0

Fixed

• Internal mapping types #45

Changed

• Added support for Starlette 0.24.0.

Fixed

• debug parameter regression.

Changed

• Code clean for responses and encoders.
• JWTConfig leeway parameter to accept int and str.

Fixed

• ujson dumps parameter error.

Changed

• Improved OrJSON, UJSON, ORJSONResponse and UJSONResponse when importing dependency.

Added

To make esmerald more optional and feature modular, this release brings some backwards
incompatibilities that should be addressed when moving to this version. Check out
the dcumentation for more details if this release notes doesn't cover it all.

Changed

• Moved UJSON, UJSONResponse, OrJSON and ORJSONResponse to be optional dependencies #45.
• Changed the imports for ORJSONResponse to from esmerald.responses.encoders import ORJSONResponse #45.
• Changed the imports for UJSONResponse to from esmerald.responses.encoders import UJSONResponse #45.
• Changed the imports for OrJSON to from esmerald.datastructures.encoders import OrJSON #45.
• Changed the imports for UJSON to from esmerald.datastructures.encoders import UJSON #45.
• Moved the scheduler to optional installation with pip install esmerald[schedulers] #45.

Backwards compatibility

This is only applied for those who have esmerald prior to 0.11.0.
If you already had template configurations, jwt, schedulers or all the features you need to update the imports to:

• TemplateConfig:

  from esmerald.config.template import TemplateConfig
  

• JWTConfig:

  from esmerald.config.jwt import JWTConfig
  

• Scheduler class is now imported directly from asyncz:

  from asyncz.schedulers import AsyncIOScheduler # for the Scheduler class
  from asyncz.contrib.esmerald.decorator import scheduler # for the decorator
  

Optionally, you can simply run pip install esmerald[all]

Added

• add_apiview to the Esmerald class.
• JSON, OrJSON and UJSON responses #44.

Changed

• Template now accepts an extra alternative_template for the cases of raising TemplateNotFound #44.
• Removed handle_status_code internal functionality as it is no longer used.

Fixed

• handler type for Gateway and WebsocketGateway.
• The split bytes instead of b''.

Added

• DirectInjects object for the direct dependency injection without using Inject and dependencies from the handler #42.

Fixed

• include_in_schema on a Gateway level for OpenAPI specification #42.
• redirect_slashes when instantiating an Esmerald/ChildEsmerald application wasn't
  validating the value properly.
• TemplateNotFound raised when a template is not found #42.
• jinja2 Environment to have autoescape by default #43.

Added

• Added Template and Redirect to app imports.
  This was supposed to go in the release 0.8.0 but somehow it was missed.

Added

• New File and Form params to Esmerald.
• Add new Injects as parameter function.
• Add new ArbitraryHashableBaseModel to handle the Inject with arbitrary types.
• Add new settings_config parameter. #40.

Changed

• Removed unused internal parameters for old functions.
• scheduler_class is now a property in the EsmeraldSettings. This allows to override fields
  without issues.
• Deprecate settings parameter from RequestSettingsMiddleware.

Fixed

• Error messages being thrown.
• Fix enable_openapi boolean for ChildEsmerald and submodules and include_in_schema for Include #37
• Fix types for OpenAPI for applications that are subclasses of Esmerald or ChildEsmerald #38

Added

• New RequestSettingsMiddleware allowing accessing the settings of the application
  from the request.
• Settings resolution for the whole application #30.

Changed

• Request now has a settings property that can be accessed upon the installation
  of the RequestSettingsMiddleware.

Fixed

• license reference upon instantiation from the settings.

Changed

• Add support for kwargs in the Dao and AsyncDAO #28

Fixed

• Mypy References for the Gateway and WebsocketGateway being added to the handler.
• Refences to the Esmerald types.

Changed

• Include now supports its own middleware handling and loading.

Fixed

• JWT Token encoding and decoding
• JWT middleware handling the headers

Added

• Added support to the new Interceptors.

Changed

• Added support to httpx 0.23.3
• Updated document references pointing to Interceptors.

Fixed

• JWTAuthMiddleware from esmerald.contrib.auth.tortoise.middleware raising exception
  on invalid token.
• Fixed code references to the Void.

Changed

• Updated version of asyncz to support 0.1.4.
• Fixed dependencies when installing Esmerald based on Asyncz requirements.
• Minor fixes.

Changed

• Added support to httpx 0.23.2

0.5.2

• Support fo Asyncz 0.1.3

Changed

• Add support for Asyncz 0.1.2

Changed

• Deprecated the integration with APScheduler in favour of Asyncz.
• Upgraded the Esmerald official symbol.

Note

If you are using the @scheduler with the func and identifier params, please check the documentation to understand how to upgrade to the new scheduler. It is almost the same but with some minor changes to the parameters

Changed

• Created BaseModelExtra parser removing repetition of code across transformers.

Fix

• Configurations for scheduler being passed as params.
• Scheduler in the slots.

Changed

• Added support for Starlette 0.23.1
• Fix some documentation references.