python-datamodel 0.10.1__cp313-cp313-win32.whl

python_datamodel-0.10.1.dist-info/METADATA

@@ -0,0 +1,320 @@
+Metadata-Version: 2.1
+Name: python-datamodel
+Version: 0.10.1
+Summary: simple library based on python +3.8 to use Dataclass-syntaxfor interacting with Data
+Home-page: https://github.com/phenobarbital/python-datamodel
+Author: Jesus Lara
+Author-email: jesuslarag@gmail.com
+License: BSD
+Project-URL: Source, https://github.com/phenobarbital/datamodel
+Project-URL: Funding, https://paypal.me/phenobarbital
+Project-URL: Tracker, https://github.com/phenobarbital/datamodel/issues
+Project-URL: Documentation, https://datamodel.readthedocs.io/en/latest/
+Project-URL: Buy Me A Coffee!, https://www.buymeacoffee.com/phenobarbital
+Project-URL: Say Thanks!, https://saythanks.io/to/phenobarbital
+Keywords: asyncio,dataclass,dataclasses,data models
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Framework :: AsyncIO
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Classifier: Environment :: Web Environment
+Requires-Python: >=3.10.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: uvloop>=0.21.0
+Requires-Dist: asyncio==3.4.3
+Requires-Dist: faust-cchardet==2.1.19
+Requires-Dist: ciso8601==2.3.2
+Requires-Dist: objectpath==0.6.1
+Requires-Dist: orjson>=3.10.11
+Requires-Dist: typing-extensions>=4.9.0
+Requires-Dist: asyncpg>=0.29.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: python-slugify==8.0.1
+Requires-Dist: psycopg2-binary==2.9.10
+Requires-Dist: msgspec==0.19.0
+
+# DataModel
+DataModel is a simple library based on python +3.8 to use Dataclass-syntax for interacting with
+Data, using the same syntax of Dataclass, users can write Python Objects
+and work with Data in the same way (like ORM's), is a reimplementation of python Dataclasses supporting true inheritance (without decorators), true composition and other good features.
+
+The key features are:
+* **Easy to use**: No more using decorators, concerns abour re-ordering attributes or common problems with using dataclasses with inheritance.
+* **Extensibility**: Can use other dataclasses, Data objects or primitives as data-types.
+* **Fast**: DataModel is a replacement 100% full compatible with dataclasses, without any overhead.
+
+
+
+## Requirements
+
+Python 3.8+
+
+## Installation
+
+<div class="termy">
+
+```console
+$ pip install python-datamodel
+---> 100%
+Successfully installed datamodel
+```
+
+
+</div>
+
+## Quickstart
+
+
+```python
+
+from datamodel import Field, BaseModel
+from dataclasses import dataclass, fields, is_dataclass
+
+
+# This pure Dataclass:
+@dataclass
+class Point:
+    x: int = Field(default=0, min=0, max=10)
+    y: int = Field(default=0, min=0, max=10)
+
+point = Point(x=10, y=10)
+print(point)
+print(fields(point))
+print('IS a Dataclass?: ', is_dataclass(point))
+
+# Can be represented by BaseModel
+class newPoint(BaseModel):
+    x: int = Field(default=0, min=0, max=10)
+    y: int = Field(default=0, min=0, max=10)
+
+    def get_coordinate(self):
+        return (self.x, self.y)
+
+point = newPoint(x=10, y=10)
+print(point)
+print(fields(point))
+print('IS a Dataclass?: ', is_dataclass(point))
+print(point.get_coordinate())
+```
+## Supported types
+
+DataModel support recursive transformation of fields, so you can easily work with nested dataclasses or complex types.
+
+DataModel supports automatic conversion of:
+
+- [datetime](https://docs.python.org/3/library/datetime.html#available-types)
+objects. `datetime` objects are encoded to str exactly like orjson conversion, any str typed as datetime is decoded to datetime.
+The same behavior is used to decoding time, date and timedelta objects.
+
+- [UUID](https://docs.python.org/3/library/uuid.html#uuid.UUID) objects. They
+are encoded as `str` (JSON string) and decoded back to uuid.UUID objects.
+
+- [Decimal](https://docs.python.org/3/library/decimal.html) objects. They are
+also encoded as `float` and decoded back to Decimal.
+
+Also, "custom" encoders are supported.
+
+```python
+
+import uuid
+from typing import (
+    List,
+    Optional,
+    Union
+)
+from dataclasses import dataclass, field
+from datamodel import BaseModel, Field
+
+@dataclass
+class Point:
+    x: int = Field(default=0, min=0, max=10)
+    y: int = Field(default=0, min=0, max=10)
+
+class coordinate(BaseModel, intSum):
+    latitude: float
+    longitude: float
+
+    def get_location(self) -> tuple:
+        return (self.latitude, self.longitude)
+
+def auto_uid():
+    return uuid.uuid4()
+
+def default_rect():
+    return [0,0,0,0]
+
+def valid_zipcode(field, value):
+    return value > 1000
+
+class Address(BaseModel):
+    id: uuid.UUID = field(default_factory=auto_uid)
+    street: str = Field(required=True)
+    zipcode: int = Field(required=False, default=1010, validator=valid_zipcode)
+    location: Optional[coordinate]
+    box: List[Optional[Point]]
+    rect: List[int] = Field(factory=default_rect)
+
+
+addr = Address(street="Calle Mayor", location=(18.1, 22.1), zipcode=3021, box=[(2, 10), (4, 8)], rect=[1, 2, 3, 4])
+print('IS a Dataclass?: ', is_dataclass(addr))
+
+print(addr.location.get_location())
+```
+```console
+# returns
+Address(id=UUID('24b34dd5-8d35-4cfd-8916-7876b28cdae3'), street='Calle Mayor', zipcode=3021, location=coordinate(latitude=18.1, longitude=22.1), box=[Point(x=2, y=10), Point(x=4, y=8)], rect=[1, 2, 3, 4])
+```
+
+* Fast and convenience conversion from-to JSON (using orjson):
+
+```python
+import orjson
+
+b = addr.json()
+print(b)
+```
+```console
+{"id":"24b34dd5-8d35-4cfd-8916-7876b28cdae3","street":"Calle Mayor","zipcode":3021,"location":{"latitude":18.1,"longitude":22.1}, "box":[{"x":2,"y":10},{"x":4,"y":8}],"rect":[1,2,3,4]}
+```
+
+```python
+# and re-imported from json
+new_addr = Address.from_json(b) # load directly from json string
+# or using a dictionary decoded by orjson
+data = orjson.loads(b)
+new_addr = Address(**data)
+
+```
+
+## Inheritance
+
+python-datamodel supports inheritance of classes.
+
+```python
+import uuid
+from typing import Union, List
+from dataclasses import dataclass, field
+from datamodel import BaseModel, Column, Field
+
+
+def auto_uid():
+    return uuid.uuid4()
+
+class User(BaseModel):
+    id: uuid.UUID = field(default_factory=auto_uid)
+    name: str
+    first_name: str
+    last_name: str
+
+
+@dataclass
+class Address:
+    street: str
+    city: str
+    state: str
+    zipcode: str
+    country: Optional[str] = 'US'
+
+    def __str__(self) -> str:
+        """Provides pretty response of address"""
+        lines = [self.street]
+        lines.append(f"{self.city}, {self.zipcode} {self.state}")
+        lines.append(f"{self.country}")
+        return "\n".join(lines)
+
+class Employee(User):
+    """
+    Base Employee.
+    """
+    role: str
+    address: Address # composition of a dataclass inside of DataModel is possible.
+
+# Supporting multiple inheritance and composition
+# Wage Policies
+class MonthlySalary(BaseModel):
+    salary: Union[float, int]
+
+    def calculate_payroll(self) -> Union[float, int]:
+        return self.salary
+
+class HourlySalary(BaseModel):
+    salary: Union[float, int] = Field(default=0)
+    hours_worked: Union[float, int] = Field(default=0)
+
+    def calculate_payroll(self) -> Union[float, int]:
+        return (self.hours_worked * self.salary)
+
+# employee types
+class Secretary(Employee, MonthlySalary):
+    """Secretary.
+
+    Person with montly salary policy and no commissions.
+    """
+    role: str = 'Secretary'
+
+class FactoryWorker(Employee, HourlySalary):
+    """
+    FactoryWorker is an employee with hourly salary policy and no commissions.
+    """
+    role: str = 'Factory Worker'
+
+class PayrollSystem:
+    def calculate_payroll(self, employees: List[dataclass]) -> None:
+        print('=== Calculating Payroll === ')
+        for employee in employees:
+            print(f"Payroll for employee {employee.id} - {employee.name}")
+            print(f"- {employee.role} Amount: {employee.calculate_payroll()}")
+            if employee.address:
+                print('- Sent to:')
+                print(employee.address)
+            print("")
+
+jane = Secretary(name='Jane Doe', first_name='Jane', last_name='Doe', salary=1500)
+bob = FactoryWorker(name='Bob Doyle', first_name='Bob', last_name='Doyle', salary=15, hours_worked=40)
+mitch = FactoryWorker(name='Mitch Brian', first_name='Mitch', last_name='Brian', salary=20, hours_worked=35)
+
+payroll = PayrollSystem()
+payroll.calculate_payroll([jane, bob, mitch])
+```
+A sample of output:
+```
+```console
+=== Calculating Payroll ===
+Payroll for employee 745a2623-d4d2-4da6-bf0a-1fa691bafd33 - Jane Doe
+- Secretary Amount: 1500
+- Sent to:
+Rodeo Drive, Rd
+Los Angeles, 31050 CA
+US
+```
+## Contributing
+
+First of all, thank you for being interested in contributing to this library.
+I really appreciate you taking the time to work on this project.
+
+- If you're just interested in getting into the code, a good place to start are
+issues tagged as bugs.
+- If introducing a new feature, especially one that modifies the public API,
+consider submitting an issue for discussion before a PR. Please also take a look
+at existing issues / PRs to see what you're proposing has  already been covered
+before / exists.
+- I like to follow the commit conventions documented [here](https://www.conventionalcommits.org/en/v1.0.0/#summary)
+
+## License
+
+This project is licensed under the terms of the BSD v3. license.

python_datamodel-0.10.1.dist-info/RECORD

@@ -0,0 +1,78 @@
+datamodel/__init__.py,sha256=k6FaIeF_ElduM4jAO5DCv6ZAb0nHgD2mKHxIzljvIrI,412
+datamodel/abstract.py,sha256=2JYGm3-ULGZmpl-wEBUznAtlLVRnwxdV0XZQUKVr4bk,15028
+datamodel/base.py,sha256=wmN4bDdreqsNmvg88XtShtyzqdoalzVe6iDoDaHcHfs,6661
+datamodel/converters.c,sha256=wk59sr29Ne183Z7O82WiGdMh7260BLoCPRuTTwAvIcU,1714546
+datamodel/converters.cp313-win32.pyd,sha256=7VoeNJ09fhNmnGb3BpZ-JkppNTASXD4wAnKSdLrCOm4,263680
+datamodel/converters.html,sha256=gjMLrgttL-6cyBRMuHg2LGTgZsoxPkR86ggVMCiQKXo,1284885
+datamodel/converters.pyx,sha256=aov8sVjj4Il0L-KM2mE7pfN71-hRhNtiyyxgZpvxcKQ,48419
+datamodel/exceptions.c,sha256=MbPv56O7yIVE2xgMTAtrpDc0BMfloSLli5C8FQ0YI5k,551384
+datamodel/exceptions.cp313-win32.pyd,sha256=OQpEAgCNQlSTq_uSfeHBRPT7p0w_Ips9I3R2HiDKwaU,71168
+datamodel/exceptions.html,sha256=dbHntZlC_BHTDGustG4DAUKLWdJjHYAnAUpxr7LuTUU,78353
+datamodel/exceptions.pxd,sha256=ihBXBLm-Svdo5gBPBrPfErz7K7rcnrNyvTHcLtKtTmw,392
+datamodel/exceptions.pyx,sha256=UKWBQIe6upa2aykIclPXXpApoS1Et5Sz65Q_MpAdUUE,1649
+datamodel/fields.cp313-win32.pyd,sha256=57r5D3K9rXdsw11eqbDRb2jgVZoAblLvAkj-JcQCh68,108032
+datamodel/fields.cpp,sha256=nGZD_gklCWKYGUx6T1PFWVbXgYpA8xhEtKUmJ-TA3g4,696051
+datamodel/fields.html,sha256=lkSi7qIrs_ofnZYR5mLYrf1ZHvsdf0k0RRC6GLZXG_U,294149
+datamodel/fields.pyx,sha256=Em5Z_ZF9l25jUYhjsJ_VOJ3dDSKT20NndzwJjQgCcR8,9033
+datamodel/functions.cp313-win32.pyd,sha256=Sxq5yTESgxdWwoM82kbVuwtBFYXOzma14OWtrpLBrWY,44032
+datamodel/functions.cpp,sha256=KahSY_SFWYGYqrWo0t-y8mMAyUxD7TdYHGASN5p2i_E,349206
+datamodel/functions.html,sha256=Bf_IqcvaN0iDfSUJFoGJr6BxOaeZNgkBoL5-F69bZF4,111246
+datamodel/functions.pxd,sha256=Bx7dvwyaq7sxKcrXHP2XEtrLyfWzOwfCJT0Bh6JjfMg,291
+datamodel/functions.pyx,sha256=HgeC4IhEJ9e9gA1iwkCwZBOa-zWtfe2RqGd70BPq58A,2467
+datamodel/models.py,sha256=yuZozblW5QIvjgQ9xjI4ohQO12IHsFAVngwn9llYCn8,27513
+datamodel/profiler.py,sha256=Cb7BYFV9886dvCHWL5V_znat1iU9XKAaoQ43olszlL4,520
+datamodel/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+datamodel/rs_parsers.cp313-win32.pyd,sha256=Clpg7L7p5LOUFRjU5aXLHzBCZ42I6aN7zeaLSTLmLLY,359936
+datamodel/types.c,sha256=Guw46CDZgIeoKj_gx8LkYvRPxEEsnVe5P1H6Nip2F0A,278676
+datamodel/types.cp313-win32.pyd,sha256=wGrwp7QAVWYNYCowmJQUk8pxECnAWF-DqHxewY4kAGo,36352
+datamodel/types.html,sha256=dxGXzsRm7hDnNNddIaEov5zNSVUyHD6_N6nuCvHOs0E,66946
+datamodel/types.pyx,sha256=P8W0yycg8vRwoU_-2PrTsA6H-5AXhJZydcPuOXT_blU,2041
+datamodel/validation.cp313-win32.pyd,sha256=DL32naPKixrUWMzASZw8AsWxTU1CwwP4_qy3jCP84TY,110080
+datamodel/validation.cpp,sha256=fVkNy7jlubmOUufhBvmvq2TziBOfpJqKS18N1unOXdY,726993
+datamodel/validation.html,sha256=kc2LaH_O6v9kt9_me_GKk1FDWKu9I6Kvz_-0zyOMvUI,388110
+datamodel/validation.pyx,sha256=NonZ_HXPmSZpo_79wdDMgIKYzvN7pDNKQynCXXnjW5A,13803
+datamodel/version.py,sha256=I3GWaY2RyGNNIR8vhAU1W-iCSN-kUb82m7NNofMiW5A,364
+datamodel/adaptive/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+datamodel/adaptive/models.py,sha256=NGftGgznEPSJfe5lHFVLa5xaVr1z0v6XXIAk-vFnWs4,18725
+datamodel/aliases/__init__.py,sha256=-LqJfuqgbFngQg-27tbomLtQYFCXXOwlBdWIU6qyR6o,736
+datamodel/jsonld/__init__.py,sha256=mRo4_tJnrK8B36Omsd6XCee2s9Rjj4RACte83OhNjSg,1041
+datamodel/jsonld/models.py,sha256=nR7b0zUL7Hlu1aPfH6Sa5b-54Hfw709tRjgLMlaBcvI,14911
+datamodel/libs/__init__.py,sha256=axMKtDOtWdjqnXah4AwsqwxV5TBAd2THecoonpAAO98,49
+datamodel/libs/mapping.c,sha256=ktvwNdgNVhEw86t6yCxik67BVZc0Wf5HbdcQZ_sbJAA,588860
+datamodel/libs/mapping.cp313-win32.pyd,sha256=AyT9caXuS8cxrUUX7qisPpUni9q4U2EedgKKN9l2UmY,80896
+datamodel/libs/mapping.html,sha256=UdB5SWzeq9X0h11igkfG5k4woNba05Z-OvnODzd8Ma8,179419
+datamodel/libs/mapping.pxd,sha256=SmSrWkf8nbSrzpljnCkfFFnu6eigBs84Ik6d9Let630,328
+datamodel/libs/mapping.pyx,sha256=5t3FCUBSowYXpmFHRIzUfHhaaEuOUJyAibB_eqq8Qjg,3899
+datamodel/libs/mutables.py,sha256=9o6UT1qcjAwQeMIcobxknVrZ1M9u64ttK4Op2DycVzE,4017
+datamodel/parsers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+datamodel/parsers/encoders.py,sha256=foClP0XMpBvObI7i-Yb0sGL7sU-ldEzd5zsRGMAyDIA,345
+datamodel/parsers/json.cp313-win32.pyd,sha256=4bYoFA_1lsTzyU0mLatqKIpmqcpSyCQwI4_cqjRPaj8,96768
+datamodel/parsers/json.cpp,sha256=wF77LkltyQsFt2iLEj70vHKM6zxyfmjl81AUArKkfFA,685363
+datamodel/parsers/json.html,sha256=q3ADuecKSVkKajiMeqRLmFw6US8Vrc6qx6395IJyRoI,241675
+datamodel/parsers/json.pyx,sha256=ihtihZqWl3M5ksuugYPX3dUGwEX3Pc56GCURqcQeFuE,8205
+datamodel/rs_core/Cargo.toml,sha256=pmD3mRm2bporJwK_YAtDnAKGjbF9dMlaEPIDE9YA4N0,456
+datamodel/rs_core/src/lib.rs,sha256=GuNgLEaFf6Wn31WhxhprhPnu7oqkMPkFRlmM7hEqh1A,10662
+datamodel/rs_parsers/Cargo.toml,sha256=qkBSel8ZLokX6-MGBi8UuvPEREpzE37jXaTIkIp5Piw,576
+datamodel/rs_parsers/src/lib.rs,sha256=6Dd_76AXm-Bkdghpa9I7TUTdKaVpRSmkLDDkZFlFgJc,22234
+datamodel/rs_validators/Cargo.toml,sha256=hQtLEC9YTPXQQ_-CGOUOw6VM1tCVuVGKHxtV02Be3HY,464
+datamodel/rs_validators/src/lib.rs,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+datamodel/typedefs/__init__.py,sha256=w7zm6MZsQGGshwPscl0GT6DyF_h59HgRcfv1o_RWj4g,176
+datamodel/typedefs/singleton.c,sha256=fQrpWFoaS1ljvHgzmP2n101CYC5ceo7yuMCYd5aH0aY,361165
+datamodel/typedefs/singleton.cp313-win32.pyd,sha256=sYOBxuZXr0cl4QDSVQyp1La-2AGmmWAW44aA7xcbOCw,45056
+datamodel/typedefs/singleton.html,sha256=BsrSGVioXgIP_6V_EhsHRvaR-WaXIAi4qfP3n_MrBCg,38235
+datamodel/typedefs/singleton.pxd,sha256=1e3JiVDwFfScyZCcYk1l97JCBeZVTxbLnxSh58jUfn0,179
+datamodel/typedefs/singleton.pyx,sha256=ZwIkr-H9VaJhQ_Vtw0AeAeUlDUQor5_A8FVyfIFIVd8,994
+datamodel/typedefs/types.c,sha256=IxkJ9R4-m2klZOd8EXl5_sxcD1leevEgOla_ThYi2Lg,472909
+datamodel/typedefs/types.cp313-win32.pyd,sha256=fvalw_HbIb8m2_wG506QyclnneByLxQuVNyNfyGNGXw,58880
+datamodel/typedefs/types.html,sha256=Xn7oYO7sKPs4xDEt65UvpMtNZkCV5b-J9U1WC1aHi1A,42536
+datamodel/typedefs/types.pxd,sha256=vgCdYThqN190S6OrdTTTjxQCcSjeqV0LiiNGLkszMe8,255
+datamodel/typedefs/types.pyx,sha256=x2eSJetDHH6QjZT4PHqVZgZeNYtYa_75Bw0Obng5Ug0,918
+examples/nn/examples.py,sha256=PJu2zGOzMHY42ip4FE9czLalzesUtK1Deudw5U8sxto,8434
+examples/nn/stores.py,sha256=2ZTWkrQtq8GJOI3qN_cOE5qPYLnWHs8HIdTMdnnBYVI,5746
+examples/tests/sp_types.py,sha256=kc6aQmPc0TTolZC-7-Uz5_mn60uVpuTJSgUNyBlDacQ,9363
+examples/tests/speed_dates.py,sha256=QJDJ1a8wEv6OJotlWK0IjWYVKNpvSsY1UAWTCwgX2qI,647
+python_datamodel-0.10.1.dist-info/LICENSE,sha256=_EiwMP8q1rs_BSFvxlBQSFwP_edqbBhOu45VBhMRPG0,1550
+python_datamodel-0.10.1.dist-info/METADATA,sha256=1ThNcnIF0ihRGfno-06670eTFz9r9TEBMnyhaeRPFA4,10159
+python_datamodel-0.10.1.dist-info/WHEEL,sha256=THCVKa0AucVYb_k5HFuyY66tqOKV0qBxbZGS-T_VISI,97
+python_datamodel-0.10.1.dist-info/top_level.txt,sha256=Oq3m8AY0Ez8C_SdQTOCz_fMX-lnxNINojNE3FINesiI,48
+python_datamodel-0.10.1.dist-info/RECORD,,

python_datamodel-0.10.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (74.0.0)
+Root-Is-Purelib: false
+Tag: cp313-cp313-win32
+

python_datamodel-0.10.1.dist-info/top_level.txt

@@ -0,0 +1,7 @@
+build
+datamodel
+dist
+examples
+locale
+src
+target