A functional error handling library for working with the results of a function to improve managing errors.
def_result will not be developed anymore.
Please use on_rails library.
The on_rails project is better and more complete than this project. In addition to the features of this project, it has tools for railway oriented programming (ROP).
Thank you
Getting Started »
Report a Bug
·
Request a Feature
.
Ask a Question
def_result is a library for python.
It is a library for functional error handling to improve managing errors.
It stores result of functions and provides a simple way to handle and manipulate the return values of functions, with built-in support for error handling and more.
In functional programming, it is not always appropriate to use traditional try-except blocks because they can lead to
code that is difficult to read, understand, and maintain.
The purpose of Functional Error Handling Libraries is to provide developers with a set of abstractions and tools for managing errors in a functional way.
def_result is a functional error handling library. The goal of this library is to make error handling more explicit,
composable, and testable. By using this library, developers can write code that is more robust, maintainable, and
expressive.
The motivation behind this library is the desire to write code that is more reliable, easier to understand, and less prone to errors. In many cases, functional programming languages provide built-in abstractions for handling errors. However, for languages that do not have built-in support for functional error handling, libraries like this can provide a useful alternative.
This library can solve several problems, including:
Developers can spend less time debugging and more time writing code that adds value to their organization. Additionally, by using functional programming concepts, developers can write code that is easier to reason about and understand, which can lead to faster development cycles and better quality code.
Use pip to install package:
pip install def_result
In this example, def_result is used as a decorator to wrap the divide_numbers function.
from def_result import def_result
@def_result
def divide_numbers(a: int, b: int):
if b == 0:
raise ValueError("Cannot divide by zero")
return a / b
result = divide_numbers(10, 0)
if result.success:
print(f"Operation was successful: {result.value}")
else:
print(f"Operation failed: {str(result.detail)}")
Result in functionfrom def_result import Result
from def_result.ResultDetails.Errors import ValidationError
def divide_numbers(a: int, b: int):
if b == 0:
return Result.fail(ValidationError(message="Cannot divide by zero"))
return Result.ok(a / b)
result = divide_numbers(10, 0)
if result.success:
print(f"Operation was successful: {result.value}")
else:
print(f"Operation failed:")
print(str(result.detail))
Please see the CHANGELOG file.
def_result is designed to be simple and easy to use, with a minimal API and clear documentation.def_result can be easily added to existing codes without the need for major
refactoring. You can use decorator for wrap old functions or write new functions without worrying about
incompatibilities.See the open issues for a list of proposed features (and known issues).
Reach out to the maintainers at one of the following places:
not necessarily. You can add this library and write new functions without changing the previous codes.
Also for old functions, you can use decorator. By using decorator, The output of the function is converted
to Result format. This way, your code is wrap in a try-except block to handle all exceptions.
By using decorator, your code is wrap in a try-except block and the final output is converted to Result. In this way,
all exceptions are handled.
First of, thank you.
If you want to say thank you or/and support active development of def_result:
Together, we can make def_result better!
First off, thanks for taking the time to contribute! Contributions are what make the free/open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please read our contribution guidelines, and thank you for being involved!
Please do not forget that this project uses conventional commits, so please follow the specification in your commit messages. You can see valid types from this file.
The original setup of this repository is by Payadel.
For a full list of all authors and contributors, see the contributors page.
def_result follows good practices of security, but 100% security cannot be assured. def_result is provided "as
is" without any warranty.
For more information and to report security issues, please refer to our security documentation.
This project is licensed under the GPLv3.
See LICENSE for more information.
FAQs
A functional error handling library for working with the results of a function to improve managing errors.
We found that def-result demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.