From 43a9cc8950c64be8f90530baea585433c676659d Mon Sep 17 00:00:00 2001 From: Ritvik Nag Date: Sat, 30 Nov 2024 08:45:38 -0500 Subject: [PATCH] Update docs --- HISTORY.rst | 41 +++++++++++++++++++++++++ dataclass_wizard/utils/typing_compat.py | 2 -- 2 files changed, 41 insertions(+), 2 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index eb96cb8b..8b374ed6 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -2,6 +2,47 @@ History ======= +0.31.0 (2024-11-30) +------------------- + +Happy Thanksgiving 🦃, y'all! In this release, Dataclass Wizard introduces the long-awaited :class:`EnvWizard` 😳🎉. + + +**Features and Improvements** + +- :class:`EnvWizard`: + - Support for working with environment variables, secret files, and `.env` files. + +- **New Functions and Helpers**: + - :func:`EnvMeta`: Helper function to set up the ``Meta`` Config for :class:`EnvWizard`. + - :func:`env_field`: Alias for ``dataclasses.Field()`` to set a custom environment variable for a field. + - **Helper Functions**: + - :func:`as_bool`, :func:`as_int`, :func:`as_str` optimized. + - :func:`as_list`, :func:`as_dict` added. + +- **Meta Class Enhancements**: + - New meta classes such as :class:`AbstractEnvMeta`. + - New fields added to the ``Meta`` class: + - :attr:`env_var_to_field` + - :attr:`field_to_env_var` + - :attr:`debug_enabled` + - :attr:`recursive` + - :attr:`env_file` + - :attr:`env_prefix` + - :attr:`secrets_dir` + - :attr:`key_lookup_with_load` + - :attr:`key_transform_with_dump` + - :attr:`skip_defaults` + - :attr:`skip_if` + - :attr:`skip_defaults_if` + +- **Benchmark Updates**: + - Updated benchmarks to include new libraries. + - Added the ``--all | -A`` option to benchmark tests for running longer tests against some libraries. + +- **Documentation**: + - General documentation updates. + 0.30.1 (2024-11-25) ------------------- diff --git a/dataclass_wizard/utils/typing_compat.py b/dataclass_wizard/utils/typing_compat.py index b2d9567f..c83153b1 100644 --- a/dataclass_wizard/utils/typing_compat.py +++ b/dataclass_wizard/utils/typing_compat.py @@ -73,8 +73,6 @@ def is_literal(cls) -> bool: def _process_forward_annotation(base_type): return PyForwardRef(base_type, is_argument=False) - # def _process_forward_annotation(base_type): - # return PyForwardRef(base_type, is_argument=False, is_class=True) def _get_origin(cls, raise_=False): if isinstance(cls, types.UnionType):