python-datamodel 0.6.19__cp312-cp312-win_amd64.whl

datamodel/version.py

@@ -0,0 +1,9 @@
+"""DataModel Meta information."""
+
+__title__ = 'python-datamodel'
+__description__ = ('simple library based on python +3.8 to use Dataclass-syntax'
+                   'for interacting with Data')
+__version__ = '0.6.19'
+__author__ = 'Jesus Lara'
+__author_email__ = 'jesuslarag@gmail.com'
+__license__ = 'BSD'

python_datamodel-0.6.19.dist-info/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, phenobarbital
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

python_datamodel-0.6.19.dist-info/METADATA

@@ -0,0 +1,315 @@
+Metadata-Version: 2.1
+Name: python-datamodel
+Version: 0.6.19
+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/datamodels
+Project-URL: Funding, https://paypal.me/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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+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.9.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy ==1.24.2
+Requires-Dist: uvloop ==0.19.0
+Requires-Dist: asyncio ==3.4.3
+Requires-Dist: faust-cchardet ==2.1.19
+Requires-Dist: ciso8601 ==2.3.1
+Requires-Dist: objectpath ==0.6.1
+Requires-Dist: orjson ==3.9.10
+Requires-Dist: typing-extensions ==4.8.0
+Requires-Dist: asyncpg ==0.29.0
+Requires-Dist: python-dateutil ==2.8.2
+Requires-Dist: pendulum ==2.1.2
+Requires-Dist: python-slugify ==8.0.1
+
+# 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.6.19.dist-info/RECORD

@@ -0,0 +1,29 @@
+datamodel/__init__.py,sha256=k6FaIeF_ElduM4jAO5DCv6ZAb0nHgD2mKHxIzljvIrI,412
+datamodel/abstract.py,sha256=IlsW7Hw0NmeRIQq94Fxgoca8s2G6161MCnTjWxF4NaI,6051
+datamodel/base.py,sha256=nc9CQkAGb74xrsVr4ZPwIm-5ZM2wQ4TRdxfQqcarsx4,20037
+datamodel/converters.c,sha256=lV3dwlAS0oZk9F9wJDzHi7wLqyTGJOQ8JveL8SzIhVw,969582
+datamodel/converters.cp312-win_amd64.pyd,sha256=DjhiZaJYlxQP42VGoS-ya58gFtozXESLz2e_ZYzHp-U,147968
+datamodel/exceptions.c,sha256=dhlhYpmtJA5RPt6UDij3g2SeY2qgsor5-RVx7OPWAR8,538428
+datamodel/exceptions.cp312-win_amd64.pyd,sha256=YVwq-h7_-UATZ2PLzwyJ-vXwxug0ueWY8kXaYKDfEyY,77824
+datamodel/fields.cp312-win_amd64.pyd,sha256=vjfu70OcmDvne6l0kn-5wX5vDrxOC8P8xNVZbFn-mAM,112640
+datamodel/fields.cpp,sha256=1AW670HYEbZoxftdahz71wfAeN7HfAZZwBUlnQWnTRI,664717
+datamodel/models.py,sha256=kXBk1W2FARTtof_KWa9hDmTm1nU8j5SFfLl5_mD8chQ,3119
+datamodel/profiler.py,sha256=Cb7BYFV9886dvCHWL5V_znat1iU9XKAaoQ43olszlL4,520
+datamodel/types.c,sha256=QLZd6GtqdwNL-gkBtC1Y83GMBcxtw7_EBwrgx_LFRjI,280446
+datamodel/types.cp312-win_amd64.pyd,sha256=SpoRUYHOBnQjb8-u4O3G_RK9alfSgOuA6X3eamlhxd4,43008
+datamodel/validation.cp312-win_amd64.pyd,sha256=hKTwETaVfjppgEruYIGtL1DzvQorrz6fObKaE_QK9kE,77312
+datamodel/validation.cpp,sha256=sMHQ00zv7dn4LV-fgsMNunHF9iFcoPt6n1oKTP0cxEk,502044
+datamodel/version.py,sha256=l4L__YA5bUVvVDhPpCEkMqOOZymFqZssE9Q02DNiv-M,315
+datamodel/libs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+datamodel/libs/mapping.c,sha256=VqhFL0D8pgVI_fTZZDN6NSnhM2Th8y-wKWeLkxbKLjY,581173
+datamodel/libs/mapping.cp312-win_amd64.pyd,sha256=7iK9uU5LBDXA9x7hk4qxJtb6sSw94hi6VZV6ZmzSxgc,90624
+datamodel/libs/mutables.py,sha256=oGwOkn5ezk2qKVRjeDllAuIeVmhaHw_VppiksIpdQ5Q,3696
+datamodel/parsers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+datamodel/parsers/encoders.py,sha256=Ku02PGA9bI-yOOUrFDewhCF8wi1YICbuERpPOmLJ-1E,331
+datamodel/parsers/json.cp312-win_amd64.pyd,sha256=rxpoxX82FX31GkpD1MqdR5W4T0Qy3Tv4FC5hCV19BL8,82432
+datamodel/parsers/json.cpp,sha256=n08ApfXqt09NtLYH09QoW1kJLK6lq0d1wfPn2YdGBuc,520162
+python_datamodel-0.6.19.dist-info/LICENSE,sha256=_EiwMP8q1rs_BSFvxlBQSFwP_edqbBhOu45VBhMRPG0,1550
+python_datamodel-0.6.19.dist-info/METADATA,sha256=uxHjYBRjHxHHtXnvwm2YEIQ07_B89BLq-GO79DB_gMU,9857
+python_datamodel-0.6.19.dist-info/WHEEL,sha256=j9Aissza3750LQHFAQyYerNjmkEON1-8w_RaZNFtKSs,102
+python_datamodel-0.6.19.dist-info/top_level.txt,sha256=UsBQ6QEFuPGiQI1zqcnYox8lCSYAVgDpxxIlShl-gac,10
+python_datamodel-0.6.19.dist-info/RECORD,,

python_datamodel-0.6.19.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.42.0)
+Root-Is-Purelib: false
+Tag: cp312-cp312-win_amd64
+

python_datamodel-0.6.19.dist-info/top_level.txt

@@ -0,0 +1 @@
+datamodel