Metadata-Version: 2.1
Name: return-result
Version: 1.0.0
Summary: This defines a decorator that causes the 'result' variable to be returned when there is no explicit return
Home-page: https://github.com/bolunthompson/return-result
Keywords: return result,result variable,nim result
Author: Bolun Thompson
Author-email: abolunthompson@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Typing :: Typed
Description-Content-Type: text/markdown

[![PyPI version](https://img.shields.io/pypi/v/return-result)](https://pypi.org/project/return-result/)
[![Python versions](https://img.shields.io/pypi/pyversions/return-result.svg)](https://pypi.org/project/return-result/)
[![Black codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# return-result

This python module defines a decorator that caused the variable `result` to be automatically returned from a function when there is no return statement. 

Inspired by the [Nim feature](https://nim-by-example.github.io/variables/result/) that does the same thing.
# Example

```python
>>> from return_result import return_result
>>> @return_result
... def test():
...     result = "Works!"
>>> test()
'Works!'
```

# Requirements

Python 3.6+

