# FunML
[](https://badge.fury.io/py/funml) 
A collection of utilities to help write python as though it were an ML-kind of functional language like OCaml
**The API is still unstable. Use at your own risk.**
---
**Documentation:** [https://sopherapps.github.io/funml](https://sopherapps.github.io/funml)
**Source Code:** [https://github.com/sopherapps/funml](https://github.com/sopherapps/funml)
---
Most Notable Features are:
1. Immutable data structures like enums, records, lists
2. Piping outputs of one function to another as inputs. That's how bigger functions are created from smaller ones.
3. Pattern matching for declarative conditional control of flow instead of using 'if's
4. Error handling using the `Result` monad, courtesy of [rust](https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html).
Instead of using `try-except` all over the place, functions return
a `Result` which has the right data when successful and an exception if unsuccessful.
The result is then pattern-matched to retrieve the data or react to the exception.
5. No `None`. Instead, we use the `Option` monad, courtesy of [rust](https://doc.rust-lang.org/book/ch06-01-defining-an-enum.html?highlight=option#the-option-enum-and-its-advantages-over-null-values).
When an Option has data, it is `Option.SOME`, or else it is `Option.NONE`.
Pattern matching helps handle both scenarios.
## Dependencies
- [python 3.7+](https://docs.python.org/)
## Getting Started
- Ensure you have python 3.7 and above installed.
- Install `FunML`
```shell
pip install funml
```
- Add the following code in `main.py`
```python
from copy import copy
from datetime import date
import funml as ml
class Date(ml.Enum):
January = date
February = date
March = date
April = date
May = date
June = date
July = date
August = date
September = date
October = date
November = date
December = date
@ml.record
class Color:
r: int
g: int
b: int
a: int
def main():
"""Main program"""
"""
Primitive Expressions
"""
unit = ml.val(lambda v: v)
is_even = ml.val(lambda v: v % 2 == 0)
mul = ml.val(lambda args: args[0] * args[1])
superscript = ml.val(lambda num, power=1: num**power)
get_month = ml.val(lambda value: value.month)
is_num = ml.val(lambda v: isinstance(v, (int, float)))
is_exp = ml.val(lambda v: isinstance(v, BaseException))
if_else = lambda check=unit, do=unit, else_do=unit: ml.val(
lambda *args, **kwargs: (
ml.match(check(*args, **kwargs))
.case(True, do=lambda: do(*args, **kwargs))
.case(False, do=lambda: else_do(*args, **kwargs))
)()
)
"""
High Order Expressions
"""
factorial = lambda v, accum=1: (
ml.match(v <= 0)
.case(True, do=ml.val(accum))
.case(False, do=lambda num, ac=0: factorial(num - 1, accum=num * ac)())
)
# currying expressions is possible
cube = superscript(power=3)
get_item_types = ml.ireduce(lambda x, y: f"{type(x)}, {type(y)}")
nums_type_err = ml.val(
lambda args: TypeError(f"expected numbers, got {get_item_types(args)}")
)
is_seq_of_nums = ml.ireduce(lambda x, y: x and is_num(y), True)
to_result = ml.val(lambda v: ml.Result.ERR(v) if is_exp(v) else ml.Result.OK(v))
try_multiply = (
if_else(check=is_seq_of_nums, do=mul, else_do=nums_type_err) >> to_result
)
result_to_option = ml.if_ok(ml.Option.SOME, strict=False) >> ml.if_err(
lambda *args: ml.Option.NONE, strict=False
)
to_date_enum = ml.val(
lambda v: (
ml.match(v.month)
.case(1, do=ml.val(Date.January(v)))
.case(2, do=ml.val(Date.February(v)))
.case(3, do=ml.val(Date.March(v)))
.case(4, do=ml.val(Date.April(v)))
.case(5, do=ml.val(Date.May(v)))
.case(6, do=ml.val(Date.June(v)))
.case(7, do=ml.val(Date.July(v)))
.case(8, do=ml.val(Date.August(v)))
.case(9, do=ml.val(Date.September(v)))
.case(10, do=ml.val(Date.October(v)))
.case(11, do=ml.val(Date.November(v)))
.case(12, do=ml.val(Date.December(v)))
)()
)
get_month_str = get_month >> (
ml.match()
.case(1, do=ml.val("JAN"))
.case(2, do=ml.val("FEB"))
.case(3, do=ml.val("MAR"))
.case(4, do=ml.val("APR"))
.case(5, do=ml.val("MAY"))
.case(6, do=ml.val("JUN"))
.case(7, do=ml.val("JUL"))
.case(8, do=ml.val("AUG"))
.case(9, do=ml.val("SEP"))
.case(10, do=ml.val("OCT"))
.case(11, do=ml.val("NOV"))
.case(12, do=ml.val("DEC"))
)
"""
Data
"""
dates = [
date(200, 3, 4),
date(2009, 1, 16),
date(1993, 12, 29),
date(2004, 10, 13),
date(2020, 9, 5),
date(2004, 5, 7),
date(1228, 8, 18),
]
dates = ml.val(dates)
nums = ml.val(ml.l(12, 3, 45, 7, 8, 6, 3))
data = ml.l((2, 3), ("hey", 7), (5, "y"), (8.1, 6))
blue = Color(r=0, g=0, b=255, a=1)
"""
Pipeline Creation and Execution
"""
dates_as_enums = dates >> ml.imap(to_date_enum) >> ml.execute()
print(f"\ndates as enums: {dates_as_enums}")
print(f"\nfirst date enum: {dates_as_enums[0]}")
months_as_str = dates >> ml.imap(get_month_str) >> ml.execute()
print(f"\nmonths of dates as str:\n{months_as_str}")
print(f"\ncube of 5: {cube(5)}")
even_nums_pipeline = nums >> ml.ifilter(is_even)
# here `even_nums_pipeline` is a `Pipeline` instance
print(even_nums_pipeline)
factorials_list = (
copy(even_nums_pipeline)
>> ml.imap(lambda v: f"factorial for {v}: {factorial(v)}")
>> ml.execute()
)
# we created a new pipeline by coping the previous one
# otherwise we would be mutating the old pipeline.
# Calling ml.execute(), we get an actual iterable of strings
print(factorials_list)
factorials_str = (
even_nums_pipeline
>> ml.imap(lambda v: f"factorial for {v}: {factorial(v)}")
>> ml.ireduce(lambda x, y: f"{x}\n{y}")
>> ml.execute()
)
# here after calling ml.execute(), we get one string as output
print(factorials_str)
print(f"blue: {blue}")
data = ml.val(data) >> ml.imap(try_multiply) >> ml.execute()
print(f"\nafter multiplication:\n{data}")
data_as_options = ml.val(data) >> ml.imap(result_to_option) >> ml.execute()
print(f"\ndata as options: {data_as_options}")
data_as_actual_values = (
ml.val(data) >> ml.ifilter(ml.is_ok) >> ml.imap(ml.if_ok(unit)) >> ml.execute()
)
print(f"\ndata as actual values: {data_as_actual_values}")
if __name__ == "__main__":
main()
```
- Run the script
```shell
python main.py
```
- For more details, visit the [docs](https://sopherapps.github.io/funml)
## Contributing
Contributions are welcome. The docs have to maintained, the code has to be made cleaner, more idiomatic and faster,
and there might be need for someone else to take over this repo in case I move on to other things. It happens!
Please look at the [CONTRIBUTIONS GUIDELINES](./CONTRIBUTING.md)
## License
Licensed under both the [MIT License](./LICENSE)
Copyright (c) 2023 [Martin Ahindura](https://github.com/tinitto)
## Gratitude
> "...and His (the Father's) incomparably great power for us who believe. That power is the same as the mighty strength
> He exerted when He raised Christ from the dead and seated Him at His right hand in the heavenly realms,
> far above all rule and authority, power and dominion, and every name that is invoked, not only in the present age but
> also in the one to come."
>
> -- Ephesians 1: 19-21
All glory be to God.
<a href="https://www.buymeacoffee.com/martinahinJ" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
Raw data
{
"_id": null,
"home_page": "https://github.com/sopherapps/funml",
"name": "funml",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "functional-programming,ml,piping",
"author": "Martin",
"author_email": "team.sopherapps@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/93/fe/45cd87028310e127ed56cfbbbb1a0f23b65fcbfaedaab2280c02fde62fbb/funml-0.3.18.tar.gz",
"platform": null,
"description": "# FunML\n\n[](https://badge.fury.io/py/funml) \n\nA collection of utilities to help write python as though it were an ML-kind of functional language like OCaml\n\n**The API is still unstable. Use at your own risk.**\n\n---\n\n**Documentation:** [https://sopherapps.github.io/funml](https://sopherapps.github.io/funml)\n\n**Source Code:** [https://github.com/sopherapps/funml](https://github.com/sopherapps/funml)\n\n--- \n\nMost Notable Features are:\n\n1. Immutable data structures like enums, records, lists\n2. Piping outputs of one function to another as inputs. That's how bigger functions are created from smaller ones.\n3. Pattern matching for declarative conditional control of flow instead of using 'if's\n4. Error handling using the `Result` monad, courtesy of [rust](https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html).\n Instead of using `try-except` all over the place, functions return \n a `Result` which has the right data when successful and an exception if unsuccessful. \n The result is then pattern-matched to retrieve the data or react to the exception.\n5. No `None`. Instead, we use the `Option` monad, courtesy of [rust](https://doc.rust-lang.org/book/ch06-01-defining-an-enum.html?highlight=option#the-option-enum-and-its-advantages-over-null-values).\n When an Option has data, it is `Option.SOME`, or else it is `Option.NONE`. \n Pattern matching helps handle both scenarios.\n\n## Dependencies\n\n- [python 3.7+](https://docs.python.org/)\n\n## Getting Started\n\n- Ensure you have python 3.7 and above installed.\n- Install `FunML`\n\n```shell\npip install funml\n```\n\n- Add the following code in `main.py`\n\n```python\nfrom copy import copy\nfrom datetime import date\n\nimport funml as ml\n\n\nclass Date(ml.Enum):\n January = date\n February = date\n March = date\n April = date\n May = date\n June = date\n July = date\n August = date\n September = date\n October = date\n November = date\n December = date\n\n\n@ml.record\nclass Color:\n r: int\n g: int\n b: int\n a: int\n\n\ndef main():\n \"\"\"Main program\"\"\"\n\n \"\"\"\n Primitive Expressions\n \"\"\"\n unit = ml.val(lambda v: v)\n is_even = ml.val(lambda v: v % 2 == 0)\n mul = ml.val(lambda args: args[0] * args[1])\n superscript = ml.val(lambda num, power=1: num**power)\n get_month = ml.val(lambda value: value.month)\n is_num = ml.val(lambda v: isinstance(v, (int, float)))\n is_exp = ml.val(lambda v: isinstance(v, BaseException))\n if_else = lambda check=unit, do=unit, else_do=unit: ml.val(\n lambda *args, **kwargs: (\n ml.match(check(*args, **kwargs))\n .case(True, do=lambda: do(*args, **kwargs))\n .case(False, do=lambda: else_do(*args, **kwargs))\n )()\n )\n\n \"\"\"\n High Order Expressions\n \"\"\"\n factorial = lambda v, accum=1: (\n ml.match(v <= 0)\n .case(True, do=ml.val(accum))\n .case(False, do=lambda num, ac=0: factorial(num - 1, accum=num * ac)())\n )\n # currying expressions is possible\n cube = superscript(power=3)\n get_item_types = ml.ireduce(lambda x, y: f\"{type(x)}, {type(y)}\")\n nums_type_err = ml.val(\n lambda args: TypeError(f\"expected numbers, got {get_item_types(args)}\")\n )\n is_seq_of_nums = ml.ireduce(lambda x, y: x and is_num(y), True)\n to_result = ml.val(lambda v: ml.Result.ERR(v) if is_exp(v) else ml.Result.OK(v))\n\n try_multiply = (\n if_else(check=is_seq_of_nums, do=mul, else_do=nums_type_err) >> to_result\n )\n\n result_to_option = ml.if_ok(ml.Option.SOME, strict=False) >> ml.if_err(\n lambda *args: ml.Option.NONE, strict=False\n )\n to_date_enum = ml.val(\n lambda v: (\n ml.match(v.month)\n .case(1, do=ml.val(Date.January(v)))\n .case(2, do=ml.val(Date.February(v)))\n .case(3, do=ml.val(Date.March(v)))\n .case(4, do=ml.val(Date.April(v)))\n .case(5, do=ml.val(Date.May(v)))\n .case(6, do=ml.val(Date.June(v)))\n .case(7, do=ml.val(Date.July(v)))\n .case(8, do=ml.val(Date.August(v)))\n .case(9, do=ml.val(Date.September(v)))\n .case(10, do=ml.val(Date.October(v)))\n .case(11, do=ml.val(Date.November(v)))\n .case(12, do=ml.val(Date.December(v)))\n )()\n )\n get_month_str = get_month >> (\n ml.match()\n .case(1, do=ml.val(\"JAN\"))\n .case(2, do=ml.val(\"FEB\"))\n .case(3, do=ml.val(\"MAR\"))\n .case(4, do=ml.val(\"APR\"))\n .case(5, do=ml.val(\"MAY\"))\n .case(6, do=ml.val(\"JUN\"))\n .case(7, do=ml.val(\"JUL\"))\n .case(8, do=ml.val(\"AUG\"))\n .case(9, do=ml.val(\"SEP\"))\n .case(10, do=ml.val(\"OCT\"))\n .case(11, do=ml.val(\"NOV\"))\n .case(12, do=ml.val(\"DEC\"))\n )\n\n \"\"\"\n Data\n \"\"\"\n dates = [\n date(200, 3, 4),\n date(2009, 1, 16),\n date(1993, 12, 29),\n date(2004, 10, 13),\n date(2020, 9, 5),\n date(2004, 5, 7),\n date(1228, 8, 18),\n ]\n dates = ml.val(dates)\n nums = ml.val(ml.l(12, 3, 45, 7, 8, 6, 3))\n data = ml.l((2, 3), (\"hey\", 7), (5, \"y\"), (8.1, 6))\n blue = Color(r=0, g=0, b=255, a=1)\n\n \"\"\"\n Pipeline Creation and Execution\n \"\"\"\n dates_as_enums = dates >> ml.imap(to_date_enum) >> ml.execute()\n print(f\"\\ndates as enums: {dates_as_enums}\")\n\n print(f\"\\nfirst date enum: {dates_as_enums[0]}\")\n\n months_as_str = dates >> ml.imap(get_month_str) >> ml.execute()\n print(f\"\\nmonths of dates as str:\\n{months_as_str}\")\n\n print(f\"\\ncube of 5: {cube(5)}\")\n\n even_nums_pipeline = nums >> ml.ifilter(is_even)\n # here `even_nums_pipeline` is a `Pipeline` instance\n print(even_nums_pipeline)\n\n factorials_list = (\n copy(even_nums_pipeline)\n >> ml.imap(lambda v: f\"factorial for {v}: {factorial(v)}\")\n >> ml.execute()\n )\n # we created a new pipeline by coping the previous one\n # otherwise we would be mutating the old pipeline.\n # Calling ml.execute(), we get an actual iterable of strings\n print(factorials_list)\n\n factorials_str = (\n even_nums_pipeline\n >> ml.imap(lambda v: f\"factorial for {v}: {factorial(v)}\")\n >> ml.ireduce(lambda x, y: f\"{x}\\n{y}\")\n >> ml.execute()\n )\n # here after calling ml.execute(), we get one string as output\n print(factorials_str)\n\n print(f\"blue: {blue}\")\n\n data = ml.val(data) >> ml.imap(try_multiply) >> ml.execute()\n print(f\"\\nafter multiplication:\\n{data}\")\n\n data_as_options = ml.val(data) >> ml.imap(result_to_option) >> ml.execute()\n print(f\"\\ndata as options: {data_as_options}\")\n\n data_as_actual_values = (\n ml.val(data) >> ml.ifilter(ml.is_ok) >> ml.imap(ml.if_ok(unit)) >> ml.execute()\n )\n print(f\"\\ndata as actual values: {data_as_actual_values}\")\n\n\nif __name__ == \"__main__\":\n main()\n```\n\n- Run the script\n\n```shell\npython main.py\n```\n\n- For more details, visit the [docs](https://sopherapps.github.io/funml)\n\n## Contributing\n\nContributions are welcome. The docs have to maintained, the code has to be made cleaner, more idiomatic and faster,\nand there might be need for someone else to take over this repo in case I move on to other things. It happens!\n\nPlease look at the [CONTRIBUTIONS GUIDELINES](./CONTRIBUTING.md)\n\n## License\n\nLicensed under both the [MIT License](./LICENSE)\n\nCopyright (c) 2023 [Martin Ahindura](https://github.com/tinitto)\n\n## Gratitude\n\n> \"...and His (the Father's) incomparably great power for us who believe. That power is the same as the mighty strength\n> He exerted when He raised Christ from the dead and seated Him at His right hand in the heavenly realms, \n> far above all rule and authority, power and dominion, and every name that is invoked, not only in the present age but \n> also in the one to come.\"\n>\n> -- Ephesians 1: 19-21\n\nAll glory be to God.\n\n<a href=\"https://www.buymeacoffee.com/martinahinJ\" target=\"_blank\"><img src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 60px !important;width: 217px !important;\" ></a>",
"bugtrack_url": null,
"license": "MIT",
"summary": "A collection of utilities to help write python as though it were an ML-kind of functional language like OCaml",
"version": "0.3.18",
"split_keywords": [
"functional-programming",
"ml",
"piping"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7483ca610c764c184fab5edaf3ac37e7d312ed14dfe2fcf9d92d87467bef139a",
"md5": "539bd15e02c664ce9885af5e6b044f17",
"sha256": "cedcd15dc918cf19d6cf02a74d307b312794730032d8ee6880e1045fd3435c77"
},
"downloads": -1,
"filename": "funml-0.3.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "539bd15e02c664ce9885af5e6b044f17",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 28461,
"upload_time": "2023-03-20T13:15:09",
"upload_time_iso_8601": "2023-03-20T13:15:09.229805Z",
"url": "https://files.pythonhosted.org/packages/74/83/ca610c764c184fab5edaf3ac37e7d312ed14dfe2fcf9d92d87467bef139a/funml-0.3.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "93fe45cd87028310e127ed56cfbbbb1a0f23b65fcbfaedaab2280c02fde62fbb",
"md5": "baa2814613d9a240a5aa3a1bb09b398f",
"sha256": "dfce6829bebee33d8fd4f86116381acbcbcbae17f85f9e4dcfb083512a07ae20"
},
"downloads": -1,
"filename": "funml-0.3.18.tar.gz",
"has_sig": false,
"md5_digest": "baa2814613d9a240a5aa3a1bb09b398f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 25807,
"upload_time": "2023-03-20T13:15:10",
"upload_time_iso_8601": "2023-03-20T13:15:10.607546Z",
"url": "https://files.pythonhosted.org/packages/93/fe/45cd87028310e127ed56cfbbbb1a0f23b65fcbfaedaab2280c02fde62fbb/funml-0.3.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-20 13:15:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "sopherapps",
"github_project": "funml",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "funml"
}
JSON
