Skip to main content

A library provides a decorator deprecated_params that allows you to deprecate certain parameters in your class methods or function.

Project description

  • This library provides a decorator deprecated_params that allows you to deprecate certain parameters in your class methods or function.

Installation

For stable version
  • pip install pdeprector

For developement

Example

# Example usage
class MyClass:
    @deprecated_params({"old_param": "new_param"})
    def __init__(self, new_param):
        self.new_param = new_param


# Usage
obj = MyClass(old_param="value")
print(obj.new_param)

Warning

- It's recommended to write new functions or classes with a v2 suffix instead of using this deprecated library.

- If possible, migrate to the newer version with v2 suffix.

  However, if migration is not feasible at the moment, you can continue using this library with caution.

You should do following
pip install deprecated

from deprecated import deprecated

# Deprecate a function
@deprecated(reason="Use another_function instead")
def deprecated_function():
    pass

# Deprecate a class method
class MyClass:
    @deprecated(reason="Use another_method instead")
    def deprecated_method(self):
        pass

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pdeprecator-0.0.1.tar.gz (3.2 kB view hashes)

Uploaded Source

Built Distribution

pdeprecator-0.0.1-py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page