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
cd pdeprector
python -m venv .venv
source .venv/bin/activate
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
Release history Release notifications | RSS feed
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 details)
Built Distribution
File details
Details for the file pdeprecator-0.0.1.tar.gz
.
File metadata
- Download URL: pdeprecator-0.0.1.tar.gz
- Upload date:
- Size: 3.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ac2f99f541b2f0c53df9a5886f5fa1a157043ec29db1b8425d80fc9924115bb |
|
MD5 | 5c1ab53c2d9c1a2b881b8ccaa9ec95fb |
|
BLAKE2b-256 | 358dd1be21a8fe9b731739b13e6f02a283610887c4ead92476c104699e75e957 |
File details
Details for the file pdeprecator-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: pdeprecator-0.0.1-py3-none-any.whl
- Upload date:
- Size: 3.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60a34163f2d308bd68f667245f56b20a9d8ed921dfb0ead65b1197a2717ee008 |
|
MD5 | 8467b3ac28e69dea3ef280d4bef56b9b |
|
BLAKE2b-256 | 065216005bcb47246810f501a290aa9bb882a1bc571f8faf271da34cdfd06fc6 |