arcade-mongodb 0.1.0__tar.gz

arcade_mongodb-0.1.0/.gitignore

@@ -0,0 +1,175 @@
+.DS_Store
+credentials.yaml
+docker/credentials.yaml
+
+*.lock
+
+# example data
+examples/data
+scratch
+
+
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# 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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

arcade_mongodb-0.1.0/Makefile

@@ -0,0 +1,53 @@
+.PHONY: help
+
+help:
+	@echo "🛠️ github Commands:\n"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: install
+install: ## Install the uv environment and install all packages with dependencies
+	@echo "🚀 Creating virtual environment and installing all packages using uv"
+	@uv sync --active --all-extras --no-sources
+	@uv run pre-commit install
+	@echo "✅ All packages and dependencies installed via uv"
+
+.PHONY: install-local
+install-local: ## Install the uv environment and install all packages with dependencies with local Arcade sources
+	@echo "🚀 Creating virtual environment and installing all packages using uv"
+	@uv sync --active --all-extras
+	@uv run pre-commit install
+	@echo "✅ All packages and dependencies installed via uv"
+
+.PHONY: build
+build: clean-build ## Build wheel file using poetry
+	@echo "🚀 Creating wheel file"
+	uv build
+
+.PHONY: clean-build
+clean-build: ## clean build artifacts
+	@echo "🗑️ Cleaning dist directory"
+	rm -rf dist
+
+.PHONY: test
+test: ## Test the code with pytest
+	@echo "🚀 Testing code: Running pytest"
+	@uv run pytest -W ignore -v --cov --cov-config=pyproject.toml --cov-report=xml
+
+.PHONY: coverage
+coverage: ## Generate coverage report
+	@echo "coverage report"
+	coverage report
+	@echo "Generating coverage report"
+	coverage html
+
+.PHONY: bump-version
+bump-version: ## Bump the version in the pyproject.toml file by a patch version
+	@echo "🚀 Bumping version in pyproject.toml"
+	uv version --bump patch
+
+.PHONY: check
+check: ## Run code quality tools.
+	@echo "🚀 Linting code: Running pre-commit"
+	@uv run pre-commit run -a
+	@echo "🚀 Static type checking: Running mypy"
+	@uv run mypy --config-file=pyproject.toml

arcade_mongodb-0.1.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: arcade_mongodb
+Version: 0.1.0
+Summary: Tools to query and explore a MongoDB database
+Author-email: evantahler <support@arcade.dev>
+Requires-Python: >=3.10
+Requires-Dist: arcade-tdk<3.0.0,>=2.0.0
+Requires-Dist: motor>=3.6.0
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: pymongo>=4.10.1
+Provides-Extra: dev
+Requires-Dist: arcade-ai[evals]<3.0.0,>=2.0.0; extra == 'dev'
+Requires-Dist: arcade-serve<3.0.0,>=2.0.0; extra == 'dev'
+Requires-Dist: mypy<1.6.0,>=1.5.1; extra == 'dev'
+Requires-Dist: pre-commit<3.5.0,>=3.4.0; extra == 'dev'
+Requires-Dist: pytest-asyncio<0.25.0,>=0.24.0; extra == 'dev'
+Requires-Dist: pytest-cov<4.1.0,>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-mock<3.12.0,>=3.11.1; extra == 'dev'
+Requires-Dist: pytest<8.4.0,>=8.3.0; extra == 'dev'
+Requires-Dist: ruff<0.8.0,>=0.7.4; extra == 'dev'
+Requires-Dist: tox<4.12.0,>=4.11.1; extra == 'dev'

arcade_mongodb-0.1.0/arcade_mongodb/database_engine.py

@@ -0,0 +1,118 @@
+from typing import Any, ClassVar
+
+from arcade_tdk.errors import RetryableToolError
+from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorDatabase
+from pymongo.errors import ServerSelectionTimeoutError
+
+MAX_RECORDS_RETURNED = 1000
+TEST_QUERY = {"ping": 1}
+
+
+class DatabaseEngine:
+    _instance: ClassVar[None] = None
+    _clients: ClassVar[dict[str, AsyncIOMotorClient]] = {}
+
+    @classmethod
+    async def get_instance(cls, connection_string: str) -> AsyncIOMotorClient:
+        key = connection_string
+        if key not in cls._clients:
+            cls._clients[key] = AsyncIOMotorClient(connection_string)
+
+        # try a simple query to see if the connection is valid
+        try:
+            admin_db = cls._clients[key].admin
+            await admin_db.command(TEST_QUERY)
+            return cls._clients[key]
+        except ServerSelectionTimeoutError:
+            # close and try again
+            cls._clients[key].close()
+            cls._clients[key] = AsyncIOMotorClient(connection_string)
+
+            try:
+                admin_db = cls._clients[key].admin
+                await admin_db.command(TEST_QUERY)
+                return cls._clients[key]
+            except Exception as e:
+                raise RetryableToolError(
+                    f"Connection failed: {e}",
+                    developer_message="Connection to MongoDB failed.",
+                    additional_prompt_content="Check the connection string and try again.",
+                ) from e
+
+    @classmethod
+    async def get_database(cls, connection_string: str, database_name: str) -> Any:
+        client = await cls.get_instance(connection_string)
+
+        class DatabaseContextManager:
+            def __init__(self, client: AsyncIOMotorClient, database_name: str) -> None:
+                self.client = client
+                self.database_name = database_name
+                self.database = client[database_name]
+
+            async def __aenter__(self) -> AsyncIOMotorDatabase:
+                return self.database
+
+            async def __aexit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+                # Connection cleanup is handled by the client cache
+                pass
+
+        return DatabaseContextManager(client, database_name)
+
+    @classmethod
+    async def cleanup(cls) -> None:
+        """Clean up all cached clients. Call this when shutting down."""
+        for client in cls._clients.values():
+            client.close()
+        cls._clients.clear()
+
+    @classmethod
+    def clear_cache(cls) -> None:
+        """Clear the client cache without closing clients. Use with caution."""
+        cls._clients.clear()
+
+    @classmethod
+    def sanitize_query_params(
+        cls,
+        database_name: str,
+        collection_name: str,
+        filter_dict: dict[str, Any] | None,
+        projection: dict[str, Any] | None,
+        sort: list[dict[str, Any]] | None,
+        limit: int,
+        skip: int,
+    ) -> tuple[
+        str, str, dict[str, Any], dict[str, Any] | None, list[dict[str, Any]] | None, int, int
+    ]:
+        if not database_name:
+            raise RetryableToolError(
+                "Database name is required.",
+                developer_message="Database name cannot be empty.",
+            )
+
+        if not collection_name:
+            raise RetryableToolError(
+                "Collection name is required.",
+                developer_message="Collection name cannot be empty.",
+            )
+
+        if filter_dict is None:
+            filter_dict = {}
+
+        if limit > MAX_RECORDS_RETURNED:
+            raise RetryableToolError(
+                f"Limit is too high. Maximum is {MAX_RECORDS_RETURNED}.",
+            )
+
+        if skip < 0:
+            raise RetryableToolError(
+                "Skip must be greater than or equal to 0.",
+                developer_message="Skip must be greater than or equal to 0.",
+            )
+
+        if limit <= 0:
+            raise RetryableToolError(
+                "Limit must be greater than 0.",
+                developer_message="Limit must be greater than 0.",
+            )
+
+        return database_name, collection_name, filter_dict, projection, sort, limit, skip