dynamo-pydantic 0.1.1__tar.gz

dynamo_pydantic-0.1.1/.gitignore

@@ -0,0 +1,357 @@
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# For now, just ignore all .idea files
+.idea
+
+/api
+/scripts
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+.env.production
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+/lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+# bit components
+.bit
+
+# Unit test reporting used by CodeFresh
+allure-results/
+
+# Additional build directories
+_build/
+builds/
+build-*
+web
+
+# DB and other data files
+data/
+
+# local environment settings
+.env*.local
+.env.dynamic
+
+# Root tomlVersionUpdater as repo install puts it in place and keeps it updated
+/tomlVersionUpdater.js

dynamo_pydantic-0.1.1/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

dynamo_pydantic-0.1.1/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: dynamo-pydantic
+Version: 0.1.1
+Summary: Pydantic base models for DynamoDB, with easy to use save/delete/query/get.
+Project-URL: Repository, https://github.com/joshorr/dynamo-pydantic
+Author-email: Josh Orr <josh@orr.blue>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <4,>=3.14
+Requires-Dist: pydantic<3,>=2.9.2
+Requires-Dist: xbool<2,>=1.1.0
+Requires-Dist: xboto<2,>=1.1.1
+Requires-Dist: xinject<2,>=1.4.0
+Requires-Dist: xloop<2,>=1.0.1
+Requires-Dist: xsentinels<2,>=1.2.1
+Requires-Dist: xurls<2,>=1.2.1
+Description-Content-Type: text/markdown
+
+![PythonSupport](https://img.shields.io/static/v1?label=python&message=3.14&color=blue?style=flat-square&logo=python)
+![PyPI version](https://badge.fury.io/py/dynamo_pydantic.svg?)
+
+(documentation below is a work in progress)
+
+- [Quick Start](#quick-start)
+- [Detail Docs](#detail-docs)
+- [Overview](#overview)
+    * [Quick high-level overview of features](#quick-high-level-overview-of-features)
+- [More Docs Soon To Come](#more-docs-soon-to-come)
+
+# Quick Start
+
+> [!WARNING]
+> This is pre-release Beta software, based on another code base and
+> the needed changes to make a final release version are not yet
+> completed. Everything is subject to change!
+
+
+```shell
+uv add dynamo-pydantic
+```
+
+or
+
+```shell
+pip install dynamo-pydantic
+```
+
+Very basic example:
+
+```python
+from dynamo_pydantic import DynamoModel, HashField, SortField
+
+class MyModel(DynamoModel):
+    some_attr: HashField[str]
+    another_attr: str
+
+obj = MyModel(some_attr='a-value', another_attr='b-value')
+
+# Saves into a dynamo table called `myModel`.
+# (See DynObjManager, accessed via DynamoModel.dyn_objs; for more docs around table naming options)
+obj.dyn_save()
+
+# Query for object
+assert MyModel.dyn_objs.get_first({'some_attr': 'a-value'}).another_attr == 'b-value'
+
+# Delete Object
+obj.dyn_delete()
+
+# Not There Anymore.
+assert next(MyModel.dyn_objs.get({'some_attr': 'a-value'}), None) is None
+
+```
+
+
+# Detail Docs
+
+**[📄 Detailed Documentation](https://joshorr.github.io/dynamo-pydantic/latest/)** | **[🐍 PyPi](https://pypi.org/project/dynamo-pydantic/)**
+
+# Overview
+
+This is a port of my old `xdynamo` library to use pydantic.
+
+Allows easy use of Pydantic models with DynamoDB using a Django-like query syntax.
+
+Right now you use a dict to communicate query filtering:
+
+`MyModel.dyn_objs.get({'some_hash_field': 'some-value'})`
+
+In the future, I'll have a simple QuerySet like object/class for filtering,
+modeled somewhat on Django's QuerySet class.
+
+But for now, I am starting with `.get(...)`, with the objective being you can
+directly communicate url-query params into this get to grab desired objects.
+
+The `dyn_objs` manager object will figure out the best way to query DynamoDB
+based on the query attributes/values you provide. Sort of a much simplified
+version of a relational-database query planner.
+
+This allows for one to focus on querying your model and dynamo in various ways
+without having to figure out exactly the best way in every possible case
+when you have the potential for both simple and more complex queries.
+
+Right now, secondary/global indexes are not supported.
+They will be added in a future update.
+When indexes get added, the plan is for the simplified query planner
+to automatically use the index as needed.
+
+The `get` method also by default won't do scans when given a query.
+Unless you tell it via a parameter `allow_scan=True` to tell query-panner
+if it's ok to automatically drop down into a scan if it's the only way 
+to do a query.
+
+In addition to the general `get` method that does query-planning,
+there are also a set of explicit methods for ensuring you always do a
+query, scan, etc.; as other manager methods `.query(...)`, `.scan(...)`, etc.
+
+You can bulk-save objects via `MyModel.dyn_objs.save([obj1, obj2, ...])`,
+or single-save them via `my_obj.dyn_save()` or `MyModel.dyn_objs.save(my_obj)`.
+
+## Quick high-level overview of features
+
+- Supports multiple hash/sort fields
+  - Hash/Sort fields are defined on class, the hash/sort-key is defined on table.
+  - If there are multiple hash or sort fields, they are combined into their respective hash/sort key via a deliminator.
+  - The deliminator does not have to be unique/unused in field data because it won't need to be parsed later,
+    it is only used to make the key properly unique to object.
+  - By default, these key-fields are inherited, so you can add more hash/sort fields in subclasses,
+    and these will be combined with any defined in the parent-class.
+  - The individual hahs/sort fields are still stored separately into their own attribute in the dynamo table item.
+  - When querying for an item, provide a value for each hash field (and optionally any sort fields).
+    - They will automatically be combined and used for the final hash/sort key for table query.
+
+- Use `dynamo_pydantic.UtcDateTime` type to force a datetime to always be and serialize into utc.
+  - You can use this with hash and/or sort keys with datetime in them, so they can reliably be queried for.
+  - Because we must use a string for a datetime, so if format and timezone are always the same it can be reliably sorted and queried for.
+  - Use `UtcDateTimeNow` to default value to now in utc.
+  - Example Field: `created_at: UtcDateTimeNow`
+
+- Can Auto-create tables lazy, on first use if desired.
+  - By default, this won't happen.
+  - If you set `dynamo_pydantic.dyn_settings.create_tables_if_needed = True`, it will create the tables lazily.
+
+# More Docs Soon To Come
+
+I'll have more, detailed documentation soon, along with examples.
+
+I need to rewrite my old docs from the old library for the new way of doing things as I took this opportunity
+to simplify and rearranged things (compared to old library).
+
+For now, I have a basic outline above, and some refrence documentation here:
+
+**[📄 Detailed Documentation](https://joshorr.github.io/dynamo-pydantic/latest/)**
+

dynamo_pydantic-0.1.1/README.md

@@ -0,0 +1,135 @@
+![PythonSupport](https://img.shields.io/static/v1?label=python&message=3.14&color=blue?style=flat-square&logo=python)
+![PyPI version](https://badge.fury.io/py/dynamo_pydantic.svg?)
+
+(documentation below is a work in progress)
+
+- [Quick Start](#quick-start)
+- [Detail Docs](#detail-docs)
+- [Overview](#overview)
+    * [Quick high-level overview of features](#quick-high-level-overview-of-features)
+- [More Docs Soon To Come](#more-docs-soon-to-come)
+
+# Quick Start
+
+> [!WARNING]
+> This is pre-release Beta software, based on another code base and
+> the needed changes to make a final release version are not yet
+> completed. Everything is subject to change!
+
+
+```shell
+uv add dynamo-pydantic
+```
+
+or
+
+```shell
+pip install dynamo-pydantic
+```
+
+Very basic example:
+
+```python
+from dynamo_pydantic import DynamoModel, HashField, SortField
+
+class MyModel(DynamoModel):
+    some_attr: HashField[str]
+    another_attr: str
+
+obj = MyModel(some_attr='a-value', another_attr='b-value')
+
+# Saves into a dynamo table called `myModel`.
+# (See DynObjManager, accessed via DynamoModel.dyn_objs; for more docs around table naming options)
+obj.dyn_save()
+
+# Query for object
+assert MyModel.dyn_objs.get_first({'some_attr': 'a-value'}).another_attr == 'b-value'
+
+# Delete Object
+obj.dyn_delete()
+
+# Not There Anymore.
+assert next(MyModel.dyn_objs.get({'some_attr': 'a-value'}), None) is None
+
+```
+
+
+# Detail Docs
+
+**[📄 Detailed Documentation](https://joshorr.github.io/dynamo-pydantic/latest/)** | **[🐍 PyPi](https://pypi.org/project/dynamo-pydantic/)**
+
+# Overview
+
+This is a port of my old `xdynamo` library to use pydantic.
+
+Allows easy use of Pydantic models with DynamoDB using a Django-like query syntax.
+
+Right now you use a dict to communicate query filtering:
+
+`MyModel.dyn_objs.get({'some_hash_field': 'some-value'})`
+
+In the future, I'll have a simple QuerySet like object/class for filtering,
+modeled somewhat on Django's QuerySet class.
+
+But for now, I am starting with `.get(...)`, with the objective being you can
+directly communicate url-query params into this get to grab desired objects.
+
+The `dyn_objs` manager object will figure out the best way to query DynamoDB
+based on the query attributes/values you provide. Sort of a much simplified
+version of a relational-database query planner.
+
+This allows for one to focus on querying your model and dynamo in various ways
+without having to figure out exactly the best way in every possible case
+when you have the potential for both simple and more complex queries.
+
+Right now, secondary/global indexes are not supported.
+They will be added in a future update.
+When indexes get added, the plan is for the simplified query planner
+to automatically use the index as needed.
+
+The `get` method also by default won't do scans when given a query.
+Unless you tell it via a parameter `allow_scan=True` to tell query-panner
+if it's ok to automatically drop down into a scan if it's the only way 
+to do a query.
+
+In addition to the general `get` method that does query-planning,
+there are also a set of explicit methods for ensuring you always do a
+query, scan, etc.; as other manager methods `.query(...)`, `.scan(...)`, etc.
+
+You can bulk-save objects via `MyModel.dyn_objs.save([obj1, obj2, ...])`,
+or single-save them via `my_obj.dyn_save()` or `MyModel.dyn_objs.save(my_obj)`.
+
+## Quick high-level overview of features
+
+- Supports multiple hash/sort fields
+  - Hash/Sort fields are defined on class, the hash/sort-key is defined on table.
+  - If there are multiple hash or sort fields, they are combined into their respective hash/sort key via a deliminator.
+  - The deliminator does not have to be unique/unused in field data because it won't need to be parsed later,
+    it is only used to make the key properly unique to object.
+  - By default, these key-fields are inherited, so you can add more hash/sort fields in subclasses,
+    and these will be combined with any defined in the parent-class.
+  - The individual hahs/sort fields are still stored separately into their own attribute in the dynamo table item.
+  - When querying for an item, provide a value for each hash field (and optionally any sort fields).
+    - They will automatically be combined and used for the final hash/sort key for table query.
+
+- Use `dynamo_pydantic.UtcDateTime` type to force a datetime to always be and serialize into utc.
+  - You can use this with hash and/or sort keys with datetime in them, so they can reliably be queried for.
+  - Because we must use a string for a datetime, so if format and timezone are always the same it can be reliably sorted and queried for.
+  - Use `UtcDateTimeNow` to default value to now in utc.
+  - Example Field: `created_at: UtcDateTimeNow`
+
+- Can Auto-create tables lazy, on first use if desired.
+  - By default, this won't happen.
+  - If you set `dynamo_pydantic.dyn_settings.create_tables_if_needed = True`, it will create the tables lazily.
+
+# More Docs Soon To Come
+
+I'll have more, detailed documentation soon, along with examples.
+
+I need to rewrite my old docs from the old library for the new way of doing things as I took this opportunity
+to simplify and rearranged things (compared to old library).
+
+For now, I have a basic outline above, and some refrence documentation here:
+
+**[📄 Detailed Documentation](https://joshorr.github.io/dynamo-pydantic/latest/)**
+

dynamo_pydantic-0.1.1/dynamo_pydantic/__init__.py

@@ -0,0 +1,7 @@
+from .obj_manager import DynObjManager
+from .settings import dyn_settings
+from .types import KeyType, HashField, SortField, DynField
+from .dynamo_model import DynamoModel
+from .dates import UtcDateTime
+
+__version__ = "0.1.1"

dynamo_pydantic-0.1.1/dynamo_pydantic/_internal/__init__.py

@@ -0,0 +1,8 @@
+from .query_criteria import QueryCriteria, DynKey
+from .internal_types import get_dynamo_type_from_python_type
+from .dynamic_subclass import create_generic_submodel
+from . import batching
+from .pydantic_utils import serialize_dyn_field, serialize_dyn_field__from_model
+from .client_subclass_mapping import get_client_for_model_type, set_client_for_model_type, get_or_create_client_for_model_type
+from .find_annotated import find_annotated_metadata_for_iterative
+from .batching import DynBatch