معرفی شرکت ها
ctor-0.3.4
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Object tree serialization library for python
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | ctor-0.3.4 |
| نام | ctor |
| نسخه کتابخانه | 0.3.4 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Boris Shishov |
| ایمیل نویسنده | borisshishov@gmail.com |
| آدرس صفحه اصلی | https://github.com/bshishov/ctor |
| آدرس اینترنتی | https://pypi.org/project/ctor/ |
| مجوز | MIT |
# ctor
`ctor` is an object tree construction and deconstruction library for python>=3.7.
It provides non-invasive way of constructing and deconstructing objects based on type annotations.
Installation:
```shell
pip install ctor
```
### Features
* 0 dependencies
* Your classes are yours! Library does not mess with your code.
* No subclassing / metaclassing
* No special class-level field annotations
* Library does no replace/generate `__init__` and/or other methods
* Works with `dataclasses`, `attrs`, `PyDantic` and even pure-python classes.
* Extendable if needed
* Supports `Union`, `Literal`, `Annotated`, forward references, cyclic-types ...
* PyCharm and other IDEs highlight constructor arguments natively without plugins
* Supports Python 3.7+
### Example with python dataclasses
```python
from dataclasses import dataclass # standard python
@dataclass
class MyClass:
name: str
value: int
# some_other_file.py
# note that this import might be in a different file
# so that your code remains untouched by serialization logic
import ctor
# Dumping
my_object = MyClass(name='hello', value=42)
data = ctor.dump(my_object)
print(data) # {'name': 'hello', 'value': 42}
# Loading
data = {'name': 'World', 'value': -42}
restored_object = ctor.load(MyClass, data)
print(restored_object) # MyClass(name='world', value=-42)
```
### Nested objects with dataclasses
```python
from dataclasses import dataclass # standard python
from typing import List
@dataclass
class TreeNode:
name: str
children: List['TreeNode'] # Note: forward reference making class cyclic
graph = TreeNode(name="root", children=[
TreeNode(name="A", children=[]),
TreeNode(name="B", children=[
TreeNode(name="x", children=[]),
TreeNode(name="y", children=[]),
]),
TreeNode(name="C", children=[]),
])
# Note: Even in this complex scenario, classes and data are still untouched by the library code.
import ctor
graph_data = ctor.dump(graph)
print(
graph_data) # {'name': 'root', 'children': [{'name': 'A', 'children': []}, {'name': 'B', 'children': [{'name': 'x', 'children': []}, {'name': 'y', 'children': []}]}, {'name': 'C', 'children': []}]}
```
### Bare classes
```python
class User:
def __init__(self, uid: int, email: str, name: str):
self.uid = uid
self.email = email
self.name = name
class Post:
def __init__(self, title: str, content: str, author: User):
self.title = title
self.content = content
self.author = author
import ctor # Import placed here just to highlight that your business-level code still does not require serialization library
data = {
'content': 'Fields can go in any order also',
'author': {
'uid': 123,
'email': 'john@doe.org',
'name': 'John Doe'
},
'title': 'Unbelievable'
}
post = ctor.load(Post, data) # post is a normal python object here
print(post.author.name) # post.user is a User
```
Note that this is not just `Post(**data)` because you need to construct `User` object first.
This works with objects of any depth.
Implementation described lower in the README.
## Rationale
* Serialization logic should not be coupled with business logic
* Business logic should not depend on 3rd party libraries
## Implementation
`ctor` heavily relies on typing annotations and utilizes lots of features from python `typing` module.
To obtain object schema `ctor` looks at the signature of the callable you want to construct/deconstruct.
Classes are callable, so `ctor` looks at `__init__` method to find information about attributes and annotations, trying to specify a converter for each of the arguments.
### About python 3.6 or less
`typing` became more or less stable only after python 3.7 (including).
API for types in 3.6 differs significantly from 3.7 onward.
It is hard to maintain two different APIs that's why I decided to stick to the newer one.
However, if you feel brave enough and really need that 3.6 support you can open a PullRequest and contact me if you have any questions.
## Running tests
* To test against current python version: `pytest`
* To tests all python versions: `tox --parallel`
نیازمندی
| مقدار | نام |
|---|---|
| - | pytest |
| - | pytest-cov |
| - | coverage |
| - | attrs |
| - | mypy |
| - | black |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7 | Python |
نحوه نصب
نصب پکیج whl ctor-0.3.4:
pip install ctor-0.3.4.whl
نصب پکیج tar.gz ctor-0.3.4:
pip install ctor-0.3.4.tar.gz