as-aiopynamodb 1.0.1__tar.gz

as_aiopynamodb-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Jharrod LaFon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

as_aiopynamodb-1.0.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include mypy.ini
+include requirements-*.txt

as_aiopynamodb-1.0.1/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: as-aiopynamodb
+Version: 1.0.1
+Summary: An Async Pythonic Interface to DynamoDB
+Home-page: http://jlafon.io/pynamodb.html
+Author: Jharrod LaFon
+Author-email: jlafon@eyesopen.com
+License: MIT
+Project-URL: Fork, https://github.com/AppSolves/AioPynamoDB
+Project-URL: Original, https://github.com/brunobelloni/AioPynamoDB
+Keywords: python dynamodb amazon async asyncio aiobotocore
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: aiobotocore>=2.24.1
+Requires-Dist: typing-extensions>=4; python_version < "3.11"
+Provides-Extra: signals
+Requires-Dist: blinker<2.0,>=1.3; extra == "signals"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+===========
+AioPynamoDB
+===========
+Work in progress. Careful in production.
+
+This library is as fork of `PynamoDB <https://github.com/pynamodb/PynamoDB>`_ to add async support.
+
+Basic functionality is working, help to improve it is welcome.
+
+
+** Known Issues **
+ - Python type hints needs migration. MyPy testing implementation is pending and contributions in this area are welcome.
+
+Installation
+============
+From GitHub::
+
+    $ pip install git+https://github.com/brunobelloni/AioPynamoDB#egg=aiopynamodb
+
+Basic Usage
+===========
+
+Create a model that describes your DynamoDB table.
+
+.. code-block:: python
+
+    from aiopynamodb.models import Model
+    from aiopynamodb.attributes import UnicodeAttribute
+
+    class UserModel(Model):
+        """
+        A DynamoDB User
+        """
+        class Meta:
+            table_name = "dynamodb-user"
+        email = UnicodeAttribute(null=True)
+        first_name = UnicodeAttribute(range_key=True)
+        last_name = UnicodeAttribute(hash_key=True)
+
+PynamoDB allows you to create the table if needed (it must exist before you can use it!):
+
+.. code-block:: python
+
+    await UserModel.create_table(read_capacity_units=1, write_capacity_units=1)
+
+Create a new user:
+
+.. code-block:: python
+
+    user = UserModel("John", "Denver")
+    user.email = "djohn@company.org"
+    await user.save()
+
+Now, search your table for all users with a last name of 'Denver' and whose
+first name begins with 'J':
+
+.. code-block:: python
+
+    async for user in UserModel.query("Denver", UserModel.first_name.startswith("J")):
+        print(user.first_name)
+
+Examples of ways to query your table with filter conditions:
+
+.. code-block:: python
+
+    async for user in UserModel.query("Denver", UserModel.email=="djohn@company.org"):
+        print(user.first_name)
+
+Retrieve an existing user:
+
+.. code-block:: python
+
+    try:
+        user = await UserModel.get("John", "Denver")
+        print(user)
+    except UserModel.DoesNotExist:
+        print("User does not exist")
+
+Advanced Usage
+==============
+
+Want to use indexes? No problem:
+
+.. code-block:: python
+
+    from aiopynamodb.models import Model
+    from aiopynamodb.indexes import GlobalSecondaryIndex, AllProjection
+    from aiopynamodb.attributes import NumberAttribute, UnicodeAttribute
+
+    class ViewIndex(GlobalSecondaryIndex):
+        class Meta:
+            read_capacity_units = 2
+            write_capacity_units = 1
+            projection = AllProjection()
+        view = NumberAttribute(default=0, hash_key=True)
+
+    class TestModel(Model):
+        class Meta:
+            table_name = "TestModel"
+        forum = UnicodeAttribute(hash_key=True)
+        thread = UnicodeAttribute(range_key=True)
+        view = NumberAttribute(default=0)
+        view_index = ViewIndex()
+
+Now query the index for all items with 0 views:
+
+.. code-block:: python
+
+    async for item in TestModel.view_index.query(0):
+        print("Item queried from index: {0}".format(item))
+
+It's really that simple.

as_aiopynamodb-1.0.1/README.rst

@@ -0,0 +1,112 @@
+===========
+AioPynamoDB
+===========
+Work in progress. Careful in production.
+
+This library is as fork of `PynamoDB <https://github.com/pynamodb/PynamoDB>`_ to add async support.
+
+Basic functionality is working, help to improve it is welcome.
+
+
+** Known Issues **
+ - Python type hints needs migration. MyPy testing implementation is pending and contributions in this area are welcome.
+
+Installation
+============
+From GitHub::
+
+    $ pip install git+https://github.com/brunobelloni/AioPynamoDB#egg=aiopynamodb
+
+Basic Usage
+===========
+
+Create a model that describes your DynamoDB table.
+
+.. code-block:: python
+
+    from aiopynamodb.models import Model
+    from aiopynamodb.attributes import UnicodeAttribute
+
+    class UserModel(Model):
+        """
+        A DynamoDB User
+        """
+        class Meta:
+            table_name = "dynamodb-user"
+        email = UnicodeAttribute(null=True)
+        first_name = UnicodeAttribute(range_key=True)
+        last_name = UnicodeAttribute(hash_key=True)
+
+PynamoDB allows you to create the table if needed (it must exist before you can use it!):
+
+.. code-block:: python
+
+    await UserModel.create_table(read_capacity_units=1, write_capacity_units=1)
+
+Create a new user:
+
+.. code-block:: python
+
+    user = UserModel("John", "Denver")
+    user.email = "djohn@company.org"
+    await user.save()
+
+Now, search your table for all users with a last name of 'Denver' and whose
+first name begins with 'J':
+
+.. code-block:: python
+
+    async for user in UserModel.query("Denver", UserModel.first_name.startswith("J")):
+        print(user.first_name)
+
+Examples of ways to query your table with filter conditions:
+
+.. code-block:: python
+
+    async for user in UserModel.query("Denver", UserModel.email=="djohn@company.org"):
+        print(user.first_name)
+
+Retrieve an existing user:
+
+.. code-block:: python
+
+    try:
+        user = await UserModel.get("John", "Denver")
+        print(user)
+    except UserModel.DoesNotExist:
+        print("User does not exist")
+
+Advanced Usage
+==============
+
+Want to use indexes? No problem:
+
+.. code-block:: python
+
+    from aiopynamodb.models import Model
+    from aiopynamodb.indexes import GlobalSecondaryIndex, AllProjection
+    from aiopynamodb.attributes import NumberAttribute, UnicodeAttribute
+
+    class ViewIndex(GlobalSecondaryIndex):
+        class Meta:
+            read_capacity_units = 2
+            write_capacity_units = 1
+            projection = AllProjection()
+        view = NumberAttribute(default=0, hash_key=True)
+
+    class TestModel(Model):
+        class Meta:
+            table_name = "TestModel"
+        forum = UnicodeAttribute(hash_key=True)
+        thread = UnicodeAttribute(range_key=True)
+        view = NumberAttribute(default=0)
+        view_index = ViewIndex()
+
+Now query the index for all items with 0 views:
+
+.. code-block:: python
+
+    async for item in TestModel.view_index.query(0):
+        print("Item queried from index: {0}".format(item))
+
+It's really that simple.

as_aiopynamodb-1.0.1/aiopynamodb/__init__.py

@@ -0,0 +1,11 @@
+"""
+AioPynamoDB Library
+^^^^^^^^^^^^^^^^
+
+A simple async abstraction over DynamoDB
+
+"""
+
+__author__ = "Jharrod LaFon"
+__license__ = "MIT"
+__version__ = "1.0.1"

as_aiopynamodb-1.0.1/aiopynamodb/_schema.py

@@ -0,0 +1,51 @@
+import sys
+from typing import Dict
+from typing import List
+
+if sys.version_info >= (3, 8):
+    from typing import TypedDict
+else:
+    from typing_extensions import TypedDict
+
+if sys.version_info >= (3, 11):
+    from typing import NotRequired
+else:
+    from typing_extensions import NotRequired
+
+
+class SchemaAttrDefinition(TypedDict):
+    AttributeName: str
+    AttributeType: str
+
+
+class KeySchema(TypedDict):
+    AttributeName: str
+    KeyType: str
+
+
+class Projection(TypedDict):
+    ProjectionType: str
+    NonKeyAttributes: NotRequired[List[str]]
+
+
+class IndexSchema(TypedDict):
+    index_name: str
+    key_schema: List[Dict[str, str]]
+    projection: Dict[str, str]
+    attribute_definitions: List[SchemaAttrDefinition]
+
+
+class ProvisionedThroughput(TypedDict, total=False):
+    ReadCapacityUnits: int
+    WriteCapacityUnits: int
+
+
+class GlobalSecondaryIndexSchema(IndexSchema):
+    provisioned_throughput: ProvisionedThroughput
+
+
+class ModelSchema(TypedDict):
+    attribute_definitions: List[SchemaAttrDefinition]
+    key_schema: List[KeySchema]
+    global_secondary_indexes: List[GlobalSecondaryIndexSchema]
+    local_secondary_indexes: List[IndexSchema]

as_aiopynamodb-1.0.1/aiopynamodb/_util.py

@@ -0,0 +1,95 @@
+import json
+from base64 import b64decode
+from base64 import b64encode
+from typing import Any
+from typing import Dict
+
+from aiopynamodb.constants import BINARY
+from aiopynamodb.constants import BINARY_SET
+from aiopynamodb.constants import BOOLEAN
+from aiopynamodb.constants import LIST
+from aiopynamodb.constants import MAP
+from aiopynamodb.constants import NULL
+from aiopynamodb.constants import NUMBER
+from aiopynamodb.constants import NUMBER_SET
+from aiopynamodb.constants import STRING
+from aiopynamodb.constants import STRING_SET
+
+
+def attr_value_to_simple_dict(attribute_value: Dict[str, Any], force: bool) -> Any:
+    attr_type, attr_value = next(iter(attribute_value.items()))
+    if attr_type == LIST:
+        return [attr_value_to_simple_dict(v, force) for v in attr_value]
+    if attr_type == MAP:
+        return {k: attr_value_to_simple_dict(v, force) for k, v in attr_value.items()}
+    if attr_type == NULL:
+        return None
+    if attr_type == BOOLEAN:
+        return attr_value
+    if attr_type == STRING:
+        return attr_value
+    if attr_type == NUMBER:
+        return json.loads(attr_value)
+    if attr_type == BINARY:
+        if force:
+            return b64encode(attr_value).decode()
+        raise ValueError("Binary attributes are not supported")
+    if attr_type == BINARY_SET:
+        if force:
+            return [b64encode(v).decode() for v in attr_value]
+        raise ValueError("Binary set attributes are not supported")
+    if attr_type == STRING_SET:
+        if force:
+            return attr_value
+        raise ValueError("String set attributes are not supported")
+    if attr_type == NUMBER_SET:
+        if force:
+            return [json.loads(v) for v in attr_value]
+        raise ValueError("Number set attributes are not supported")
+    raise ValueError("Unknown attribute type: {}".format(attr_type))
+
+
+def simple_dict_to_attr_value(value: Any) -> Dict[str, Any]:
+    if value is None:
+        return {NULL: True}
+    if value is True or value is False:
+        return {BOOLEAN: value}
+    if isinstance(value, (int, float)):
+        return {NUMBER: json.dumps(value)}
+    if isinstance(value, str):
+        return {STRING: value}
+    if isinstance(value, list):
+        return {LIST: [simple_dict_to_attr_value(v) for v in value]}
+    if isinstance(value, dict):
+        return {MAP: {k: simple_dict_to_attr_value(v) for k, v in value.items()}}
+    raise ValueError("Unknown value type: {}".format(type(value).__name__))
+
+
+def _b64encode(b: bytes) -> str:
+    return b64encode(b).decode()
+
+
+def bin_encode_attr(attr: Dict[str, Any]) -> None:
+    if BINARY in attr:
+        attr[BINARY] = _b64encode(attr[BINARY])
+    elif BINARY_SET in attr:
+        attr[BINARY_SET] = [_b64encode(v) for v in attr[BINARY_SET]]
+    elif MAP in attr:
+        for sub_attr in attr[MAP].values():
+            bin_encode_attr(sub_attr)
+    elif LIST in attr:
+        for sub_attr in attr[LIST]:
+            bin_encode_attr(sub_attr)
+
+
+def bin_decode_attr(attr: Dict[str, Any]) -> None:
+    if BINARY in attr:
+        attr[BINARY] = b64decode(attr[BINARY])
+    elif BINARY_SET in attr:
+        attr[BINARY_SET] = [b64decode(v) for v in attr[BINARY_SET]]
+    elif MAP in attr:
+        for sub_attr in attr[MAP].values():
+            bin_decode_attr(sub_attr)
+    elif LIST in attr:
+        for sub_attr in attr[LIST]:
+            bin_decode_attr(sub_attr)