mirror of
https://github.com/Ultimaker/Cura.git
synced 2025-07-25 07:33:57 -06:00
Add @api decorator
CURA-6665
This commit is contained in:
parent
59e55dab5e
commit
b2afaf305d
1 changed files with 19 additions and 0 deletions
19
cura/Utils/Decorators.py
Normal file
19
cura/Utils/Decorators.py
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
# Copyright (c) 2019 Ultimaker B.V.
|
||||||
|
# Cura is released under the terms of the LGPLv3 or higher.
|
||||||
|
|
||||||
|
import functools
|
||||||
|
|
||||||
|
|
||||||
|
## Decorator for functions that belong to a set of APIs. For now, this should only be used for officially supported
|
||||||
|
# APIs, meaning that those APIs should be versioned and maintained.
|
||||||
|
#
|
||||||
|
# \param since The earliest version since when this API becomes supported. This means that since this version, this
|
||||||
|
# API function is supposed to behave the same. This parameter is not used. It's just a documentation.
|
||||||
|
#
|
||||||
|
def api(since = "Unknown"):
|
||||||
|
def api_decorator(function):
|
||||||
|
@functools.wraps(function)
|
||||||
|
def api_wrapper(*args, **kwargs):
|
||||||
|
return function(*args, **kwargs)
|
||||||
|
return api_wrapper
|
||||||
|
return api_decorator
|
Loading…
Add table
Add a link
Reference in a new issue