(οΎβοΎ) v5.0 have breaking changes
-
TIterator#group_by- Return
TDict[TList[T]]instead ofTDict[TIterator[T]]
- Return
(οΎβοΎ) v4.0 have breaking changes
-
OwlMixin- Must use keyword arguments in
from_XXXandto_XXXexcept for some ones -
from_csvf->from_csvf_to_list
- Must use keyword arguments in
-
TList-
head->take -
partial->partition(switch left and right)
-
-
transformers.XXX- Must use keyword arguments in
to_dictto_dictsto_jsonto_jsonfto_yamlto_yamlfto_csvto_csvf
- Must use keyword arguments in
Have you ever wanted to write robust code in Python? This library will make such your wishes come true.
Define your data class which is extend OwlMixin, you can use some useful methods which help your codes robust.
See following Example and API Reference sections.
pip install owlmixinhttps://tadashi-aikawa.github.io/owlmixin/
from owlmixin import OwlMixin, OwlEnum, TOption, TList
class Color(OwlEnum):
RED = "red"
GREEN = "green"
BLUE = "blue"
class Food(OwlMixin):
id: int
name: str
color: TOption[Color]
class Human(OwlMixin):
id: int
name: str
favorite: TList[Food]
jiro = Human.from_dict({
"id": 10,
"name": "jiro",
"favorite": [
{"id": 1, "name": "apple"},
{"id": 2, "name": "orange", "color": "green"}
]
})Then...
>>> jiro.id
10
>>> jiro.name
'jiro'
>>> print(jiro.to_dict())
{'id': 10, 'name': 'jiro', 'favorite': [{'id': 1, 'name': 'apple'}, {'id': 2, 'name': 'orange', 'color': 'green'}]}
>>> print(jiro.favorite[0].to_pretty_json())
{
"id": 1,
"name": "apple"
}
>>> print(jiro.to_yaml())
favorite:
- id: 1
name: apple
- color: green
id: 2
name: orange
id: 10
name: jiro
>>> print(jiro.favorite.to_csv(['id', 'name', 'color'], with_header=True))
id,name,color
1,apple,
2,orange,green
You can also use methods chains as following.
from owlmixin import OwlMixin, TOption, TIterator
class Repository(OwlMixin):
id: int
name: str
description: TOption[str]
stargazers_count: int
class GithubRepository(OwlMixin):
total_count: int
incomplete_results: bool
items: TIterator[Repository]Then...
>>> print(
... GithubRepository
... .from_json_url("https://api.github.com/search/repositories?q=git")
... .items
... .filter(lambda x: x.stargazers_count > 100)
... .order_by(lambda x: x.stargazers_count, True)
... .take(5)
... .emap(lambda v, i: {
... 'RANK': i+1,
... 'STAR': v.stargazers_count,
... 'NAME': v.name,
... 'DESCRIPTION': v.description
... })
... .to_csv(fieldnames=["RANK", "STAR", "NAME", "DESCRIPTION"], with_header=True)
... )
RANK,STAR,NAME,DESCRIPTION
1,84643,gitignore,A collection of useful .gitignore templates
2,30456,gogs,Gogs is a painless self-hosted Git service.
3,29908,git-flight-rules,Flight rules for git
4,27704,git,Git Source Code Mirror - This is a publish-only repository and all pull requests are ignored. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
5,15541,tips,Most commonly used git tips and tricks.Don't you think smart?
- poetry
- make
- Development on master and if you need branches and issues, create them
- Commit with prefix emoji such as "π", and suffix issue number like "#120"
# Create env
$ poetry env use <path of python 3.8>
$ poetry install
# Build documentation and run server locally
$ make serve-docs
# Test (Doc test & Unit test)
$ make testhttps://github.com/tadashi-aikawa/owlmixin/actions/workflows/release.yaml?query=workflow%3ARelease
If you can't or don't want to use GitHub Actions, you can release locally as following.
- Windows is not supported!!!
- poetry (with pypi authentications)
- make
make release version=x.y.z
![dependabot[bot]](https://avatars.githubusercontent.com/u/49699333?size=120)