polypheny-polynom 0.1.0__py3-none-any.whl

polynom/application.py

@@ -0,0 +1,285 @@
+import polypheny
+import docker
+import logging
+import socket
+import time
+import polynom.config as cfg
+from polynom.schema.migration import Migrator
+from polynom.session import Session
+from docker.errors import DockerException, NotFound, ImageNotFound
+from polynom.schema.schema_registry import _get_ordered_schemas, _to_json
+from polynom.schema.field import PrimaryKeyField, ForeignKeyField
+from polynom.reflection import SchemaSnapshot, SchemaSnapshotSchema
+
+logger = logging.getLogger(__name__)
+
+class Application:
+    def __init__(
+            self,
+            app_uuid: str,
+            address,
+            user: str = cfg.get(cfg.DEFAULT_USER),
+            password: str = cfg.get(cfg.DEFAULT_PASS),
+            transport: str = cfg.get(cfg.DEFAULT_TRANSPORT),
+            use_docker: bool = True,
+            migrate: bool = False,
+            stop_container: bool = False,
+            remove_container: bool = False
+        ):
+        cfg.lock()
+
+        self._app_uuid = app_uuid
+        self._address = address
+        self._user = user
+        self._password = password
+        self._transport = transport
+        self._use_docker = use_docker
+        self._migrate = migrate
+        self._stop_container = stop_container
+        self._remove_container = remove_container
+
+        self._conn = None
+        self._cursor = None
+        self._initialized = False
+
+    def __enter__(self):
+        if self._initialized:
+            raise ValueError("Application must only be initialized once.")
+        self._initialized = True
+        
+        if self._use_docker:
+            self._deploy_polypheny()
+
+        self._conn = polypheny.connect(
+            self._address,
+            username=self._user,
+            password=self._password,
+            transport=self._transport
+        )
+        self._cursor = self._conn.cursor()
+
+        self._verify_schema()
+        self._create_schema()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if self._cursor:
+            self._cursor.close()
+        if self._conn:
+            self._conn.close()
+        
+        if not self._use_docker:
+            return
+        if self._stop_container:
+            self._stop_container_by_name(cfg.get(cfg.POLYPHENY_CONTAINER_NAME))
+        if self._remove_container:
+            self._remove_container_by_name(cfg.get(cfg.POLYPHENY_CONTAINER_NAME))
+        cfg.unlock()
+
+    def _wait_for_prism(self, timeout=60):
+        start_time = time.time()
+        while time.time() - start_time < timeout:
+            try:
+                conn = polypheny.connect(
+                    self._address,
+                    username=self._user,
+                    password=self._password,
+                    transport=self._transport
+                )
+                conn.close()
+                return
+            except EOFError:
+                time.sleep(1)
+            except Exception as e:
+                raise RuntimeError(f"Unexpected error while connecting to Polypheny: {e}") from e
+        raise TimeoutError("Timed out waiting for Polypheny to become available.")
+
+    def _deploy_polypheny(self):
+        logger.info("Establishing connection to Docker...")
+        try:
+            client = docker.from_env()
+            client.ping()
+        except DockerException as e:
+            logger.error("Docker is not running or not accessible.")
+            raise RuntimeError("Docker is not running or not accessible.") from e
+
+        container_name = cfg.get(cfg.POLYPHENY_CONTAINER_NAME)
+        image_name = cfg.get(cfg.POLYPHENY_IMAGE_NAME)
+        ports = cfg.get(cfg.POLYPHENY_PORTS)
+
+        try:
+            logger.info(f"Checking for presence of Polypheny container '{container_name}'...")
+            container = client.containers.get(container_name)
+            container.start()
+            logger.info(f"Container '{container_name}' found and started.")
+        except NotFound:
+            logger.info("Polypheny container not found. Deploying a new container. This may take a moment...")
+            try:
+                client.images.pull(image_name)
+                container = client.containers.run(
+                    image_name,
+                    name=container_name,
+                    ports=ports,
+                    detach=True
+                )
+                logger.info(f"New Polypheny container '{container_name}' deployed and started.")
+            except DockerException as e:
+                logger.error(f"Failed to create or run the Polypheny container: {e}")
+                raise RuntimeError("Failed to create or run the Polypheny container.") from e
+
+        logger.info(f"Waiting for Polypheny Prism to become available at {self._address,}...")
+        try:
+            self._wait_for_prism()
+            logger.info("Polypheny Prism is now responsive.")
+        except TimeoutError as e:
+            logger.error(str(e))
+            raise RuntimeError("Polypheny container did not become ready in time.") from e
+
+    def _verify_schema(self):
+        self._process_schema(SchemaSnapshotSchema)
+
+        session = Session(self)
+        with session:
+            logger.debug(f"Reading schema snapshot from database for application {self._app_uuid}.")
+            previous = SchemaSnapshot.query(session).get(self._app_uuid)
+            current_snapshot = _to_json()
+
+            if not previous:
+                logger.debug(f"No schema snapshot found for application {self._app_uuid}. Creating a first one.")
+                previous = SchemaSnapshot(current_snapshot, _entry_id=self._app_uuid)
+                session.add(previous)
+                session.commit()
+                return
+
+            logger.debug(f"Checking for schema changes for application {self._app_uuid}.")
+            diff = self._compare_snapshots(previous.snapshot, current_snapshot)
+
+            if diff and self._migrate:
+                logger.debug(f"Schema changes for application {self._app_uuid} found.")
+                migrator = Migrator()
+                migrator.run(session, diff)
+
+            previous.snapshot = current_snapshot
+            session.commit()
+
+    def _create_schema(self):
+        for schema in _get_ordered_schemas():
+            self._process_schema(schema)
+
+    def _compare_snapshots(self, previous, current):
+        diff = {}
+
+        current_schemas = {s['entity_name']: s for s in current['schemas']}
+        previous_schemas = {s['entity_name']: s for s in previous['schemas']}
+
+        for entity_name, prev_entity in previous_schemas.items():
+            curr_entity = current_schemas.get(entity_name)
+
+            entity_diff = {
+                'namespace_name': prev_entity.get('namespace_name'),
+                'changes': {}
+            }
+
+            if not curr_entity:
+                diff[entity_name] = entity_diff
+                continue
+
+            prev_fields = {f['name']: f for f in prev_entity.get('fields', [])}
+            curr_fields = {f['name']: f for f in curr_entity.get('fields', [])}
+            handled_prev_fields = set()
+
+            for curr_name, curr_field in curr_fields.items():
+                prev_name = curr_field.get('previous_name')
+                if prev_name and prev_name in prev_fields:
+                    entity_diff['changes'][curr_name] = [prev_fields[prev_name], curr_field]
+                    handled_prev_fields.add(prev_name)
+                    continue
+                if curr_name not in prev_fields:
+                    entity_diff['changes'][curr_name] = [None, curr_field]
+
+            for prev_name, prev_field in prev_fields.items():
+                if prev_name in handled_prev_fields:
+                    continue
+                if prev_name not in curr_fields:
+                    entity_diff['changes'][prev_name] = [prev_field, None]
+                elif prev_fields[prev_name] != curr_fields[prev_name]:
+                    entity_diff['changes'][prev_name] = [prev_field, curr_fields[prev_name]]
+
+            if entity_diff['changes']:
+                diff[entity_name] = entity_diff
+
+        return diff
+
+    def _process_schema(self, schema_class):
+        entity = schema_class.entity_name
+        namespace = schema_class.namespace_name
+        fields = schema_class._get_fields()
+
+        logger.info(f"Initializing entity {entity} in namespace {namespace}.")
+
+        self._cursor.execute(f'CREATE RELATIONAL NAMESPACE IF NOT EXISTS "{namespace}"')
+        logger.debug(f"Created namespace {namespace} if absent.")
+
+        column_defs = []
+        foreign_keys = []
+        unique_columns = []
+        primary_key_columns = []
+
+        for field in fields:
+            col_def = f'"{field._db_field_name}" {field._polytype._type_string}'
+            if not getattr(field, 'nullable', False):
+                col_def += " NOT NULL"
+            default_value = getattr(field, 'default', None)
+            if default_value is not None:
+                col_def += f" DEFAULT {field._polytype._to_sql_expression(default_value)}"
+            if getattr(field, 'unique', False):
+                unique_columns.append(field._db_field_name)
+            if isinstance(field, PrimaryKeyField):
+                primary_key_columns.append(field._db_field_name)
+            column_defs.append(col_def)
+
+            if isinstance(field, ForeignKeyField):
+                fk = (
+                    f'FOREIGN KEY ("{field._db_field_name}") '
+                    f'REFERENCES "{field.referenced_entity_name}"("{field.referenced_db_field_name}")'
+                )
+                foreign_keys.append(fk)
+
+        constraints = foreign_keys[:]
+        if primary_key_columns:
+            constraints.append(f"PRIMARY KEY ({', '.join(primary_key_columns)})")
+        constraints += [f'UNIQUE ("{col}")' for col in unique_columns]
+
+        create_stmt = f'CREATE TABLE IF NOT EXISTS "{namespace}"."{entity}" ({", ".join(column_defs + constraints)});'
+        self._cursor.executeany('sql', create_stmt, namespace=namespace)
+        self._conn.commit()
+
+        logger.debug(f"Created entity {entity} if absent.")
+
+    def _stop_container_by_name(self, container_name):
+        try:
+            client = docker.from_env()
+            client.ping()
+            container = client.containers.get(container_name)
+            if container.status == 'running':
+                container.stop()
+            logger.info(f"Container '{container_name}' stopped.")
+        except NotFound:
+            logger.warning(f"No container named '{container_name}' found.")
+        except DockerException as e:
+            logger.error(f"Failed to stop the container '{container_name}': {e}")
+            raise RuntimeError(f"Failed to stop the container '{container_name}'") from e
+
+    def _remove_container_by_name(self, container_name):
+        try:
+            client = docker.from_env()
+            client.ping()
+            container = client.containers.get(container_name)
+            container.remove()
+            logger.info(f"Container '{container_name}' removed.")
+        except NotFound:
+            logger.warning(f"No container named '{container_name}' found.")
+        except DockerException as e:
+            logger.error(f"Failed to remove the container '{container_name}': {e}")
+            raise RuntimeError(f"Failed to remove the container '{container_name}'") from e
+

polynom/config.py

@@ -0,0 +1,89 @@
+# keys
+INTERNAL_NAMESPACE = 'INTERNAL_NAMESPACE'
+CHANGE_LOG_TABLE = 'CHANGE_LOG_TABLE'
+SYSTEM_USER_NAME = 'SYSTEM_USER_NAME'
+SNAPSHOT_TABLE = 'SNAPSHOT_TABLE'
+
+DEFAULT_NAMESPACE = 'DEFAULT_NAMESPACE'
+POLYPHENY_CONTAINER_NAME = 'POLYPHENY_CONTAINER_NAME'
+POLYPHENY_IMAGE_NAME = 'POLYPHENY_IMAGE_NAME'
+POLYPHENY_PORTS = 'POLYPHENY_PORTS'
+DEFAULT_TRANSPORT = 'DEFAULT_TRANSPORT'
+DEFAULT_USER = 'DEFAULT_USER'
+DEFAULT_PASS = 'DEFAULT_PASS'
+
+CHANGE_LOG_IDENTIFIER = 'CHANGE_LOG_IDENTIFIER'
+
+# constants
+_internals = {
+    INTERNAL_NAMESPACE: 'internal',
+    CHANGE_LOG_TABLE: 'change_log',
+    SYSTEM_USER_NAME: 'SYSTEM',
+    SNAPSHOT_TABLE: 'snapshot',
+}
+
+# user configurables
+_config = {
+    DEFAULT_NAMESPACE: 'public',
+    POLYPHENY_CONTAINER_NAME: 'polypheny',
+    POLYPHENY_IMAGE_NAME: 'vogti/polypheny',
+    POLYPHENY_PORTS: {
+        "20590/tcp": 20590,
+        "7659/tcp": 7659,
+        "80/tcp": 80,
+        "8081/tcp": 8081,
+        "8082/tcp": 8082,
+    },
+    DEFAULT_TRANSPORT: 'plain',
+    DEFAULT_USER: 'pa',
+    DEFAULT_PASS: '',
+}
+
+# derived options
+_derived = {}
+
+def _refresh_derived():
+    _derived[CHANGE_LOG_IDENTIFIER] = f"{_internals[INTERNAL_NAMESPACE]}.{_internals[CHANGE_LOG_TABLE]}"
+
+_refresh_derived()
+
+USER_CONFIGURABLE_KEYS = set(_config.keys())
+
+_lock_count = 0
+
+def lock():
+    global _lock_count
+    _lock_count += 1
+
+def unlock():
+    global _lock_count
+    if _lock_count == 0:
+        raise RuntimeError("Unlock called more times than lock")
+    _lock_count -= 1
+
+def get(key: str):
+    if key in _config:
+        return _config[key]
+    elif key in _internals:
+        return _internals[key]
+    elif key in _derived:
+        return _derived[key]
+    else:
+        raise KeyError(f"Unknown config key: {key}")
+
+def set(key: str, value):
+    if key not in USER_CONFIGURABLE_KEYS:
+        raise KeyError(f"Cannot set config key: {key}")
+    if _lock_count > 0:
+        raise RuntimeError("Configuration is locked. No updates are allowed.")
+    _config[key] = value
+    _refresh_derived()
+
+def set_config(overrides: dict):
+    if _lock_count > 0:
+        raise RuntimeError("Configuration is locked. No updates are allowed.")
+    for key, value in overrides.items():
+        set(key, value)
+
+def all_config():
+    return {**_internals, **_config, **_derived}

polynom/joined_load.py

@@ -0,0 +1,15 @@
+from typing import Any, Tuple
+from polynom.query import Query
+
+"""
+Encapsulates content to eagerly load a relationship 
+"""
+class JoinedLoad:
+    def __init__(self, relationship_attr: Any):
+        self.attr = relationship_attr  # e.g. Bike.user
+
+    def apply(self, query: Query):
+        related_model = self.attr.get_target_model()
+        query.join(related_model)
+        alias = f"{related_model.schema.entity_name}_{len(query._joins)}"
+        query._eager_loads.append((self.attr._key, related_model, alias))

polynom/model.py

@@ -0,0 +1,88 @@
+import logging
+import uuid as uuidlib
+from typing import Any, Type, TypeVar
+from copy import deepcopy
+from polynom.query import Query
+
+T = TypeVar("T")
+logger = logging.getLogger(__name__)
+
+class BaseModel:
+    schema: Type[Any]
+
+    def __init__(self, _entry_id: str = None):
+        if _entry_id is None:
+            _entry_id = str(uuidlib.uuid4())
+        self._entry_id = _entry_id
+        self._is_active = True
+        self._update_snapshot()
+
+    def __setattr__(self, name, value):
+        if name == '_is_active':
+            object.__setattr__(self, name, value)
+            return
+
+        if getattr(self, "_is_active", True):
+            object.__setattr__(self, name, value)
+            return
+
+        self._throw_invalid()
+        
+    def _throw_invalid(self):
+        message = f"This instance of entry {self._entry_id} is no longer mapped: it is either outside its session, deleted within its session, or replaced by a query result"
+        logger.debug(message)
+        raise AttributeError(message)
+        
+    def _update_snapshot(self):
+        self._snapshot = {
+            field._python_field_name: deepcopy(self.__dict__.get(field._python_field_name))
+            for field in self.schema._get_fields()
+        }
+
+    def _diff(self) -> dict[str, tuple]:
+        if not self._is_active:
+            self._throw_invalid()
+
+        changelog = {}
+        for field in self.schema._get_fields():
+            key = field._python_field_name
+            old = self._snapshot.get(key)
+            new = self.__dict__.get(key)
+            if old != new:
+                changelog[key] = (old, new)
+        return changelog
+        
+    def __repr__(self):
+        field_map = self.schema._get_field_map()
+        field_values = {
+            name: getattr(self, name, None)
+            for name in field_map.keys()
+        }
+        return f"<{self.__class__.__name__} {field_values}>"
+
+    @classmethod
+    def query(cls, session):
+        return Query(cls, session)
+
+    @classmethod
+    def _from_row(cls: Type[T], row: dict[str, Any]) -> T:
+        obj_data = {
+            field._python_field_name: field._polytype._from_prism_serializable(row[field._db_field_name])
+            for field in cls.schema._get_fields()
+        }
+        return cls(**obj_data)
+
+    def _to_update_dict(self) -> dict[str, Any]:
+        return {
+            field._db_field_name: field._polytype._to_prism_serializable(getattr(self, field._python_field_name))
+            for field in self.schema._get_fields()
+            if hasattr(self, field._python_field_name)
+     }
+
+    def _to_insert_dict(self) -> dict[str, Any]:
+        return {
+            field._db_field_name: field._polytype._to_prism_serializable(getattr(self, field._python_field_name))
+            for field in self.schema._get_fields()
+            if hasattr(self, field._python_field_name)
+        }
+