Frappe/frappe
1
0
Fork 0
mirror of https://github.com/frappe/frappe.git synced 2026-04-24 01:14:06 -06:00
Code Issues Projects Releases Packages Wiki Activity
Page: Deprecations
Pages
(Client Side Scripting)Fetch values from another document (Client Side Scripting)Fetching child tables App Development using GitHub Client Side Scripting Index Client side scripting(Archive) Client side scripting Deprecations Developer Cheatsheet Frappe Framework Front End Routing and Document Creation Frappe Push Notification Client Reference Frappe Test Record Loading: Startup Sequence Generating Test Records in Frappe Home Installing Frappe ERPNext on MacOS Migrating to Version 13 Migrating to Version 14 Migrating to nightly version Migrating to version 15 Migrating to version 16 Pull Request Review Guidelines Setup MariaDB Server Setup NFS Server The Hitchhiker's Guide to Installing Frappe on Linux The Hitchhiker's Guide to Installing Frappe on Mac OS X Tree view for custom DocType Using Desk Modules, Calendar and List View in Frappe Framework Using Frappe with Amazon RDS (or any other DBaaS) Using the VSCode Debugger with Frappe Writing an IntegrationTestCase in Frappe: A Step‐by‐Step Guide query builder migration
2 Deprecations
David Arnold edited this page 2024-11-20 01:17:22 +01:00
Table of Contents

Frappe Deprecation Warnings

Frappe uses a system of deprecation warnings to alert developers about features that are being phased out or have already been removed. These warnings are categorized based on the version in which the deprecation takes effect.

Graduation

Graduation refers to a deprecation being converted to an Error during an entire major version before being removed entirely from the next major version.

  • Conversion to error: from release of the graduation version
  • Removed entirely: from release of the next version after the graduation version

Classes of Deprecation Warnings

Deprecations warnings inherit from the following base classes for ease of managing warning notifications with PYTHONWARNINGS.

FrappeDeprecationError

Feature is being graduated during this major version.

Tip

To temporarily downgrade these errors to warnings in an emergency:

export PYTHONWARNINGS="always::frappe.deprecation_dumpster.FrappeDeprecationError"

FrappeDeprecationWarning

Feature will be graduated during the next major version.

Important

You should not ignore these warnings and follow the instructions timely.

PendingFrappeDeprecationWarning

Feature may be potentially graduated during a major version beyond the next major version.

Note

These warnings are ignored by default.

It is possible that such a deprecation decision may be reverted, meaning that the old and the new way will be considered stable.

Tip

The new variant is considered stable and preferred. You are encouraged to migrate, regardless of whether the formal deprecation of the old variant may be dropped.

VXXFrappeDeprecationWarning

As long as the corresponding base class is not suppressed, you'll see the specific version in which a feature is slated for graduation in the logs:

V15FrappeDeprecationWarning: frappe.utils.make_esc is deprecated. ...
V16FrappeDeprecationWarning: frappe.utils.make_esc is deprecated. ...
V17FrappeDeprecationWarning: frappe.utils.make_esc is deprecated. ...
V18FrappeDeprecationWarning: frappe.utils.make_esc is deprecated. ...
...

Configuration

To configure how to show warnings, you can use the PYTHONWARNINGS env variable in your development, CI and production environments according to the respective needs.

Examples

  • Ignore all deprecation warnings:

    export PYTHONWARNINGS="ignore::frappe.deprecation_dumpster.FrappeDeprecationWarning"

  • Emergency downgrade FrappeDeprecationErrors from default error to always:

    export PYTHONWARNINGS="always::frappe.deprecation_dumpster.FrappeDeprecationError"

  • Upgrade PendingFrappeDeprecationWarnings from default ignore to always:

    export PYTHONWARNINGS="always:frappe.deprecation_dumpster.PendingFrappeDeprecationWarning"

  • Specifically show deprecations which will graduate in v18:

    export PYTHONWARNINGS="always::frappe.deprecation_dumpster.V18FrappeDeprecationWarning"

References

Frappe

Support

Contribution Guidelines