summaryrefslogtreecommitdiff
path: root/python-pydeprecate.spec
blob: 43647b223253107eb655f8d36011b7f3ac1b643e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
%global _empty_manifest_terminate_build 0
Name:		python-pyDeprecate
Version:	0.3.2
Release:	1
Summary:	Deprecation tooling
License:	MIT
URL:		https://borda.github.io/pyDeprecate
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/ad/8a/04cb2f59d7d24f9dc6c690835933147f068d26b8b765c2ca1220cbc38750/pyDeprecate-0.3.2.tar.gz
BuildArch:	noarch


%description
The common use-case is moving your functions across codebase or outsourcing some functionalities to new packages.
For most of these cases, you want to hold some compatibility, so you cannot simply remove past function, and also for some time you want to warn users that functionality they have been using is moved and not it is deprecated in favor of another function (which shall be used instead) and soon it will be removed completely.
Another good aspect is to do not overwhelm a user with too many warnings, so per function/class, this warning is raised only N times in the preferable stream (warning, logger, etc.).
## Installation
Simple installation from PyPI:
```bash
pip install pyDeprecate
```
<details>
  <summary>Other installations</summary>
  Simply install with pip from source:
  ```bash
  pip install https://github.com/Borda/pyDeprecate/archive/main.zip
  ```
</details>
## Use-cases
The functionality is kept simple and all default shall be reasonable, but still you can do extra customization such as:
* define user warning message and preferable stream
* extended argument mapping to target function/method
* define deprecation logic for self arguments
* specify warning count per:
    - called function (for func deprecation)
    - used arguments (for argument deprecation)
* define conditional skip (e.g. depending on some package version)
In particular the target values (cases):
- _None_ - raise only warning message (ignore all argument mapping)
- _True_ - deprecation some argument of itself (argument mapping shall be specified)
- _Callable_ - forward call to new methods (optional also argument mapping or extras)
### Simple function forwarding
It is very straight forward, you forward your function call to new function and all arguments are mapped:
```python
def base_sum(a: int = 0, b: int = 3) -> int:
    """My new function anywhere in codebase or even other package."""
    return a + b
# ---------------------------
from deprecate import deprecated
@deprecated(target=base_sum, deprecated_in="0.1", remove_in="0.5")
def depr_sum(a: int, b: int = 5) -> int:
    """
    My deprecated function which now has empty body
     as all calls are routed to the new function.
    """
    pass  # or you can just place docstring as one above
# call this function will raise deprecation warning:
#   The `depr_sum` was deprecated since v0.1 in favor of `__main__.base_sum`.
#   It will be removed in v0.5.
print(depr_sum(1, 2))
```
<details>
  <summary>sample output:</summary>
  ```
  3
  ```
</details>
### Advanced target argument mapping
Another more complex example is using argument mapping is:
<details>
  <summary>Advanced example</summary>
  ```python
  import logging
  from sklearn.metrics import accuracy_score
  from deprecate import deprecated, void
  @deprecated(
    # use standard sklearn accuracy implementation
    target=accuracy_score,
    # custom warning stream
    stream=logging.warning,
    # number or warnings per lifetime (with -1 for always_
    num_warns=5,
    # custom message template
    template_mgs="`%(source_name)s` was deprecated, use `%(target_path)s`",
    # as target args are different, define mapping from source to target func
    args_mapping={'preds': 'y_pred', 'target': 'y_true', 'blabla': None}
  )
  def depr_accuracy(preds: list, target: list, blabla: float) -> float:
      """My deprecated function which is mapping to sklearn accuracy."""
      # to stop complain your IDE about unused argument you can use void/empty function
      return void(preds, target, blabla)
  # call this function will raise deprecation warning:
  #   WARNING:root:`depr_accuracy` was deprecated, use `sklearn.metrics.accuracy_score`
  print(depr_accuracy([1, 0, 1, 2], [0, 1, 1, 2], 1.23))
  ```
  sample output:
  ```
  0.5
  ```
</details>
### Deprecation warning only
Base use-case with no forwarding and just raising warning :
```python
from deprecate import deprecated
@deprecated(target=None, deprecated_in="0.1", remove_in="0.5")
def my_sum(a: int, b: int = 5) -> int:
    """My deprecated function which still has to have implementation."""
    return a + b
# call this function will raise deprecation warning:
#   The `my_sum` was deprecated since v0.1. It will be removed in v0.5.
print(my_sum(1, 2))
```
<details>
  <summary>sample output:</summary>
  ```
  3
  ```
</details>
### Self argument mapping
We also support deprecation and argument mapping for the function itself:
```python
from deprecate import deprecated
@deprecated(
  # define as depreaction some self argument - mapping
  target=True, args_mapping={'coef': 'new_coef'},
  # common version info
  deprecated_in="0.2", remove_in="0.4",
)
def any_pow(base: float, coef: float = 0, new_coef: float = 0) -> float:
    """My function with deprecated argument `coef` mapped to `new_coef`."""
    return base ** new_coef
# call this function will raise deprecation warning:
#   The `any_pow` uses deprecated arguments: `coef` -> `new_coef`.
#   They were deprecated since v0.2 and will be removed in v0.4.
print(any_pow(2, 3))
```
<details>
  <summary>sample output:</summary>
  ```
  8
  ```
</details>
### Multiple deprecation levels
Eventually you can set multiple deprecation levels via chaining deprecation arguments as each could be deprecated in another version:
<details>
  <summary>Multiple deprecation levels</summary>
  ```python
  from deprecate import deprecated
  @deprecated(
    True, "0.3", "0.6", args_mapping=dict(c1='nc1'),
    template_mgs="Depr: v%(deprecated_in)s rm v%(remove_in)s for args: %(argument_map)s."
  )
  @deprecated(
    True, "0.4", "0.7", args_mapping=dict(nc1='nc2'),
    template_mgs="Depr: v%(deprecated_in)s rm v%(remove_in)s for args: %(argument_map)s."
  )
  def any_pow(base, c1: float = 0, nc1: float = 0, nc2: float = 2) -> float:
      return base**nc2
  # call this function will raise deprecation warning:
  #   DeprecationWarning('Depr: v0.3 rm v0.6 for args: `c1` -> `nc1`.')
  #   DeprecationWarning('Depr: v0.4 rm v0.7 for args: `nc1` -> `nc2`.')
  print(any_pow(2, 3))
  ```
  sample output:
  ```
  8
  ```
</details>
### Conditional skip
Conditional skip of which can be used for mapping between different target functions depending on additional input such as package version
```python
from deprecate import deprecated
FAKE_VERSION = 1
def version_greater_1():
    return FAKE_VERSION > 1
@deprecated(
  True, "0.3", "0.6", args_mapping=dict(c1='nc1'), skip_if=version_greater_1
)
def skip_pow(base, c1: float = 1, nc1: float = 1) -> float:
    return base**(c1 - nc1)
# call this function will raise deprecation warning
print(skip_pow(2, 3))
# change the fake versions
FAKE_VERSION = 2
# Will not raise any warning
print(skip_pow(2, 3))
```
<details>
  <summary>sample output:</summary>
  ```
  0.25
  4
  ```
</details>
This can be beneficial with multiple deprecation levels shown above...
### Class deprecation
This case can be quite complex as you may deprecate just some methods, here we show full class deprecation:
```python
class NewCls:
    """My new class anywhere in the codebase or other package."""
    def __init__(self, c: float, d: str = "abc"):
        self.my_c = c
        self.my_d = d
# ---------------------------
from deprecate import deprecated, void
class PastCls(NewCls):
    """
    The deprecated class shall be inherited from the successor class
     to hold all methods.
    """
    @deprecated(target=NewCls, deprecated_in="0.2", remove_in="0.4")
    def __init__(self, c: int, d: str = "efg"):
        """
        You place the decorator around __init__ as you want
         to warn user just at the time of creating object.
        """
        return void(c, d)
# call this function will raise deprecation warning:
#   The `PastCls` was deprecated since v0.2 in favor of `__main__.NewCls`.
#   It will be removed in v0.4.
inst = PastCls(7)
print(inst.my_c)  # returns: 7
print(inst.my_d)  # returns: "efg"
```
<details>
  <summary>sample output:</summary>
  ```
  7
  efg
  ```
</details>
## Contribution
Have you faced this in past or even now, do you have good ideas for improvement, all is welcome!

%package -n python3-pyDeprecate
Summary:	Deprecation tooling
Provides:	python-pyDeprecate
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-pyDeprecate
The common use-case is moving your functions across codebase or outsourcing some functionalities to new packages.
For most of these cases, you want to hold some compatibility, so you cannot simply remove past function, and also for some time you want to warn users that functionality they have been using is moved and not it is deprecated in favor of another function (which shall be used instead) and soon it will be removed completely.
Another good aspect is to do not overwhelm a user with too many warnings, so per function/class, this warning is raised only N times in the preferable stream (warning, logger, etc.).
## Installation
Simple installation from PyPI:
```bash
pip install pyDeprecate
```
<details>
  <summary>Other installations</summary>
  Simply install with pip from source:
  ```bash
  pip install https://github.com/Borda/pyDeprecate/archive/main.zip
  ```
</details>
## Use-cases
The functionality is kept simple and all default shall be reasonable, but still you can do extra customization such as:
* define user warning message and preferable stream
* extended argument mapping to target function/method
* define deprecation logic for self arguments
* specify warning count per:
    - called function (for func deprecation)
    - used arguments (for argument deprecation)
* define conditional skip (e.g. depending on some package version)
In particular the target values (cases):
- _None_ - raise only warning message (ignore all argument mapping)
- _True_ - deprecation some argument of itself (argument mapping shall be specified)
- _Callable_ - forward call to new methods (optional also argument mapping or extras)
### Simple function forwarding
It is very straight forward, you forward your function call to new function and all arguments are mapped:
```python
def base_sum(a: int = 0, b: int = 3) -> int:
    """My new function anywhere in codebase or even other package."""
    return a + b
# ---------------------------
from deprecate import deprecated
@deprecated(target=base_sum, deprecated_in="0.1", remove_in="0.5")
def depr_sum(a: int, b: int = 5) -> int:
    """
    My deprecated function which now has empty body
     as all calls are routed to the new function.
    """
    pass  # or you can just place docstring as one above
# call this function will raise deprecation warning:
#   The `depr_sum` was deprecated since v0.1 in favor of `__main__.base_sum`.
#   It will be removed in v0.5.
print(depr_sum(1, 2))
```
<details>
  <summary>sample output:</summary>
  ```
  3
  ```
</details>
### Advanced target argument mapping
Another more complex example is using argument mapping is:
<details>
  <summary>Advanced example</summary>
  ```python
  import logging
  from sklearn.metrics import accuracy_score
  from deprecate import deprecated, void
  @deprecated(
    # use standard sklearn accuracy implementation
    target=accuracy_score,
    # custom warning stream
    stream=logging.warning,
    # number or warnings per lifetime (with -1 for always_
    num_warns=5,
    # custom message template
    template_mgs="`%(source_name)s` was deprecated, use `%(target_path)s`",
    # as target args are different, define mapping from source to target func
    args_mapping={'preds': 'y_pred', 'target': 'y_true', 'blabla': None}
  )
  def depr_accuracy(preds: list, target: list, blabla: float) -> float:
      """My deprecated function which is mapping to sklearn accuracy."""
      # to stop complain your IDE about unused argument you can use void/empty function
      return void(preds, target, blabla)
  # call this function will raise deprecation warning:
  #   WARNING:root:`depr_accuracy` was deprecated, use `sklearn.metrics.accuracy_score`
  print(depr_accuracy([1, 0, 1, 2], [0, 1, 1, 2], 1.23))
  ```
  sample output:
  ```
  0.5
  ```
</details>
### Deprecation warning only
Base use-case with no forwarding and just raising warning :
```python
from deprecate import deprecated
@deprecated(target=None, deprecated_in="0.1", remove_in="0.5")
def my_sum(a: int, b: int = 5) -> int:
    """My deprecated function which still has to have implementation."""
    return a + b
# call this function will raise deprecation warning:
#   The `my_sum` was deprecated since v0.1. It will be removed in v0.5.
print(my_sum(1, 2))
```
<details>
  <summary>sample output:</summary>
  ```
  3
  ```
</details>
### Self argument mapping
We also support deprecation and argument mapping for the function itself:
```python
from deprecate import deprecated
@deprecated(
  # define as depreaction some self argument - mapping
  target=True, args_mapping={'coef': 'new_coef'},
  # common version info
  deprecated_in="0.2", remove_in="0.4",
)
def any_pow(base: float, coef: float = 0, new_coef: float = 0) -> float:
    """My function with deprecated argument `coef` mapped to `new_coef`."""
    return base ** new_coef
# call this function will raise deprecation warning:
#   The `any_pow` uses deprecated arguments: `coef` -> `new_coef`.
#   They were deprecated since v0.2 and will be removed in v0.4.
print(any_pow(2, 3))
```
<details>
  <summary>sample output:</summary>
  ```
  8
  ```
</details>
### Multiple deprecation levels
Eventually you can set multiple deprecation levels via chaining deprecation arguments as each could be deprecated in another version:
<details>
  <summary>Multiple deprecation levels</summary>
  ```python
  from deprecate import deprecated
  @deprecated(
    True, "0.3", "0.6", args_mapping=dict(c1='nc1'),
    template_mgs="Depr: v%(deprecated_in)s rm v%(remove_in)s for args: %(argument_map)s."
  )
  @deprecated(
    True, "0.4", "0.7", args_mapping=dict(nc1='nc2'),
    template_mgs="Depr: v%(deprecated_in)s rm v%(remove_in)s for args: %(argument_map)s."
  )
  def any_pow(base, c1: float = 0, nc1: float = 0, nc2: float = 2) -> float:
      return base**nc2
  # call this function will raise deprecation warning:
  #   DeprecationWarning('Depr: v0.3 rm v0.6 for args: `c1` -> `nc1`.')
  #   DeprecationWarning('Depr: v0.4 rm v0.7 for args: `nc1` -> `nc2`.')
  print(any_pow(2, 3))
  ```
  sample output:
  ```
  8
  ```
</details>
### Conditional skip
Conditional skip of which can be used for mapping between different target functions depending on additional input such as package version
```python
from deprecate import deprecated
FAKE_VERSION = 1
def version_greater_1():
    return FAKE_VERSION > 1
@deprecated(
  True, "0.3", "0.6", args_mapping=dict(c1='nc1'), skip_if=version_greater_1
)
def skip_pow(base, c1: float = 1, nc1: float = 1) -> float:
    return base**(c1 - nc1)
# call this function will raise deprecation warning
print(skip_pow(2, 3))
# change the fake versions
FAKE_VERSION = 2
# Will not raise any warning
print(skip_pow(2, 3))
```
<details>
  <summary>sample output:</summary>
  ```
  0.25
  4
  ```
</details>
This can be beneficial with multiple deprecation levels shown above...
### Class deprecation
This case can be quite complex as you may deprecate just some methods, here we show full class deprecation:
```python
class NewCls:
    """My new class anywhere in the codebase or other package."""
    def __init__(self, c: float, d: str = "abc"):
        self.my_c = c
        self.my_d = d
# ---------------------------
from deprecate import deprecated, void
class PastCls(NewCls):
    """
    The deprecated class shall be inherited from the successor class
     to hold all methods.
    """
    @deprecated(target=NewCls, deprecated_in="0.2", remove_in="0.4")
    def __init__(self, c: int, d: str = "efg"):
        """
        You place the decorator around __init__ as you want
         to warn user just at the time of creating object.
        """
        return void(c, d)
# call this function will raise deprecation warning:
#   The `PastCls` was deprecated since v0.2 in favor of `__main__.NewCls`.
#   It will be removed in v0.4.
inst = PastCls(7)
print(inst.my_c)  # returns: 7
print(inst.my_d)  # returns: "efg"
```
<details>
  <summary>sample output:</summary>
  ```
  7
  efg
  ```
</details>
## Contribution
Have you faced this in past or even now, do you have good ideas for improvement, all is welcome!

%package help
Summary:	Development documents and examples for pyDeprecate
Provides:	python3-pyDeprecate-doc
%description help
The common use-case is moving your functions across codebase or outsourcing some functionalities to new packages.
For most of these cases, you want to hold some compatibility, so you cannot simply remove past function, and also for some time you want to warn users that functionality they have been using is moved and not it is deprecated in favor of another function (which shall be used instead) and soon it will be removed completely.
Another good aspect is to do not overwhelm a user with too many warnings, so per function/class, this warning is raised only N times in the preferable stream (warning, logger, etc.).
## Installation
Simple installation from PyPI:
```bash
pip install pyDeprecate
```
<details>
  <summary>Other installations</summary>
  Simply install with pip from source:
  ```bash
  pip install https://github.com/Borda/pyDeprecate/archive/main.zip
  ```
</details>
## Use-cases
The functionality is kept simple and all default shall be reasonable, but still you can do extra customization such as:
* define user warning message and preferable stream
* extended argument mapping to target function/method
* define deprecation logic for self arguments
* specify warning count per:
    - called function (for func deprecation)
    - used arguments (for argument deprecation)
* define conditional skip (e.g. depending on some package version)
In particular the target values (cases):
- _None_ - raise only warning message (ignore all argument mapping)
- _True_ - deprecation some argument of itself (argument mapping shall be specified)
- _Callable_ - forward call to new methods (optional also argument mapping or extras)
### Simple function forwarding
It is very straight forward, you forward your function call to new function and all arguments are mapped:
```python
def base_sum(a: int = 0, b: int = 3) -> int:
    """My new function anywhere in codebase or even other package."""
    return a + b
# ---------------------------
from deprecate import deprecated
@deprecated(target=base_sum, deprecated_in="0.1", remove_in="0.5")
def depr_sum(a: int, b: int = 5) -> int:
    """
    My deprecated function which now has empty body
     as all calls are routed to the new function.
    """
    pass  # or you can just place docstring as one above
# call this function will raise deprecation warning:
#   The `depr_sum` was deprecated since v0.1 in favor of `__main__.base_sum`.
#   It will be removed in v0.5.
print(depr_sum(1, 2))
```
<details>
  <summary>sample output:</summary>
  ```
  3
  ```
</details>
### Advanced target argument mapping
Another more complex example is using argument mapping is:
<details>
  <summary>Advanced example</summary>
  ```python
  import logging
  from sklearn.metrics import accuracy_score
  from deprecate import deprecated, void
  @deprecated(
    # use standard sklearn accuracy implementation
    target=accuracy_score,
    # custom warning stream
    stream=logging.warning,
    # number or warnings per lifetime (with -1 for always_
    num_warns=5,
    # custom message template
    template_mgs="`%(source_name)s` was deprecated, use `%(target_path)s`",
    # as target args are different, define mapping from source to target func
    args_mapping={'preds': 'y_pred', 'target': 'y_true', 'blabla': None}
  )
  def depr_accuracy(preds: list, target: list, blabla: float) -> float:
      """My deprecated function which is mapping to sklearn accuracy."""
      # to stop complain your IDE about unused argument you can use void/empty function
      return void(preds, target, blabla)
  # call this function will raise deprecation warning:
  #   WARNING:root:`depr_accuracy` was deprecated, use `sklearn.metrics.accuracy_score`
  print(depr_accuracy([1, 0, 1, 2], [0, 1, 1, 2], 1.23))
  ```
  sample output:
  ```
  0.5
  ```
</details>
### Deprecation warning only
Base use-case with no forwarding and just raising warning :
```python
from deprecate import deprecated
@deprecated(target=None, deprecated_in="0.1", remove_in="0.5")
def my_sum(a: int, b: int = 5) -> int:
    """My deprecated function which still has to have implementation."""
    return a + b
# call this function will raise deprecation warning:
#   The `my_sum` was deprecated since v0.1. It will be removed in v0.5.
print(my_sum(1, 2))
```
<details>
  <summary>sample output:</summary>
  ```
  3
  ```
</details>
### Self argument mapping
We also support deprecation and argument mapping for the function itself:
```python
from deprecate import deprecated
@deprecated(
  # define as depreaction some self argument - mapping
  target=True, args_mapping={'coef': 'new_coef'},
  # common version info
  deprecated_in="0.2", remove_in="0.4",
)
def any_pow(base: float, coef: float = 0, new_coef: float = 0) -> float:
    """My function with deprecated argument `coef` mapped to `new_coef`."""
    return base ** new_coef
# call this function will raise deprecation warning:
#   The `any_pow` uses deprecated arguments: `coef` -> `new_coef`.
#   They were deprecated since v0.2 and will be removed in v0.4.
print(any_pow(2, 3))
```
<details>
  <summary>sample output:</summary>
  ```
  8
  ```
</details>
### Multiple deprecation levels
Eventually you can set multiple deprecation levels via chaining deprecation arguments as each could be deprecated in another version:
<details>
  <summary>Multiple deprecation levels</summary>
  ```python
  from deprecate import deprecated
  @deprecated(
    True, "0.3", "0.6", args_mapping=dict(c1='nc1'),
    template_mgs="Depr: v%(deprecated_in)s rm v%(remove_in)s for args: %(argument_map)s."
  )
  @deprecated(
    True, "0.4", "0.7", args_mapping=dict(nc1='nc2'),
    template_mgs="Depr: v%(deprecated_in)s rm v%(remove_in)s for args: %(argument_map)s."
  )
  def any_pow(base, c1: float = 0, nc1: float = 0, nc2: float = 2) -> float:
      return base**nc2
  # call this function will raise deprecation warning:
  #   DeprecationWarning('Depr: v0.3 rm v0.6 for args: `c1` -> `nc1`.')
  #   DeprecationWarning('Depr: v0.4 rm v0.7 for args: `nc1` -> `nc2`.')
  print(any_pow(2, 3))
  ```
  sample output:
  ```
  8
  ```
</details>
### Conditional skip
Conditional skip of which can be used for mapping between different target functions depending on additional input such as package version
```python
from deprecate import deprecated
FAKE_VERSION = 1
def version_greater_1():
    return FAKE_VERSION > 1
@deprecated(
  True, "0.3", "0.6", args_mapping=dict(c1='nc1'), skip_if=version_greater_1
)
def skip_pow(base, c1: float = 1, nc1: float = 1) -> float:
    return base**(c1 - nc1)
# call this function will raise deprecation warning
print(skip_pow(2, 3))
# change the fake versions
FAKE_VERSION = 2
# Will not raise any warning
print(skip_pow(2, 3))
```
<details>
  <summary>sample output:</summary>
  ```
  0.25
  4
  ```
</details>
This can be beneficial with multiple deprecation levels shown above...
### Class deprecation
This case can be quite complex as you may deprecate just some methods, here we show full class deprecation:
```python
class NewCls:
    """My new class anywhere in the codebase or other package."""
    def __init__(self, c: float, d: str = "abc"):
        self.my_c = c
        self.my_d = d
# ---------------------------
from deprecate import deprecated, void
class PastCls(NewCls):
    """
    The deprecated class shall be inherited from the successor class
     to hold all methods.
    """
    @deprecated(target=NewCls, deprecated_in="0.2", remove_in="0.4")
    def __init__(self, c: int, d: str = "efg"):
        """
        You place the decorator around __init__ as you want
         to warn user just at the time of creating object.
        """
        return void(c, d)
# call this function will raise deprecation warning:
#   The `PastCls` was deprecated since v0.2 in favor of `__main__.NewCls`.
#   It will be removed in v0.4.
inst = PastCls(7)
print(inst.my_c)  # returns: 7
print(inst.my_d)  # returns: "efg"
```
<details>
  <summary>sample output:</summary>
  ```
  7
  efg
  ```
</details>
## Contribution
Have you faced this in past or even now, do you have good ideas for improvement, all is welcome!

%prep
%autosetup -n pyDeprecate-0.3.2

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-pyDeprecate -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Fri Apr 21 2023 Python_Bot <Python_Bot@openeuler.org> - 0.3.2-1
- Package Spec generated