sqlalchemy-postgres-point 0.1.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

sqlalchemy_postgres_point/alembic_integration.py

@@ -0,0 +1,56 @@
+"""
+Alembic integration to automatically add imports for PointType in migration files.
+
+This module hooks into Alembic's autogenerate system to automatically include
+the necessary import statement when PointType is detected in models.
+
+Usage:
+    Add this import to your alembic/env.py file:
+
+    import sqlalchemy_postgres_point.alembic_integration
+
+Once added, `from sqlalchemy_postgres_point import PointType` will be automatically
+included in generated migration files.
+"""
+
+import alembic.autogenerate
+import alembic.operations.ops
+from sqlalchemy.types import UserDefinedType
+
+from .point import PointType
+
+
+def render_point_type(type_, object_, autogen_context):
+    """Render PointType in migration files with proper import."""
+    # Add the import to the migration file
+    autogen_context.imports.add("from sqlalchemy_postgres_point import PointType")
+    return "PointType()"
+
+
+# Register the renderer for PointType
+alembic.autogenerate.render.renderers.dispatch_for(PointType, replace=True)(
+    render_point_type
+)
+
+
+# Also register for UserDefinedType as a fallback if the class doesn't match exactly
+@alembic.autogenerate.render.renderers.dispatch_for(UserDefinedType, replace=True)
+def render_user_defined_type(type_, object_, autogen_context):
+    if type(object_).__name__ == "PointType":
+        return render_point_type(type_, object_, autogen_context)
+    return False
+
+
+@alembic.autogenerate.comparators.dispatch_for("schema")
+def compare_point_types(
+    autogen_context: alembic.autogenerate.api.AutogenContext,
+    upgrade_ops: alembic.operations.ops.UpgradeOps,
+    schema_names,
+):
+    """
+    Hook into Alembic's schema comparison to detect PointType usage.
+
+    This ensures the import is added even if PointType is used in existing
+    columns that might not trigger the render hook directly.
+    """
+    pass

{sqlalchemy_postgres_point-0.1.1.dist-info → sqlalchemy_postgres_point-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sqlalchemy-postgres-point
-Version: 0.1.1
+Version: 0.2.0
 Summary: Lightweight SQLAlchemy custom type for PostgreSQL POINT columns with tuple binding and an earth-distance comparator.
 Keywords: sqlalchemy,postgresql,point,geometry,geospatial,gis,database,types,earthdistance
 Author: Michael Bianco
@@ -139,6 +139,33 @@ Run the test suite with:
 uv run pytest -q
 ```
 
+## Alembic Integration
+
+When using `PointType` in your models, you can automatically include the necessary imports in migration files by updating your `alembic/env.py` file.
+
+First, import the integration module:
+
+```python
+import sqlalchemy_postgres_point.alembic_integration
+```
+
+Then, ensure your `context.configure` call includes a `render_item` hook to handle the `PointType`:
+
+```python
+def render_item(type_, obj, autogen_context):
+    if type_ == "type" and type(obj).__name__ == "PointType":
+        return sqlalchemy_postgres_point.alembic_integration.render_point_type(obj, obj, autogen_context)
+    return False
+
+# ... in run_migrations_online and run_migrations_offline ...
+context.configure(
+    # ... other options ...
+    render_item=render_item,
+)
+```
+
+Once added, `from sqlalchemy_postgres_point import PointType` will be automatically included in generated migration files whenever a `PointType` column is detected.
+
 Development
 -----------
 

sqlalchemy_postgres_point-0.2.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+sqlalchemy_postgres_point/__init__.py,sha256=BWlOd4qbAt4fM4cclR7ZrzZ-aib0f13KD3HIKmod2_s,208
+sqlalchemy_postgres_point/alembic_integration.py,sha256=qaMk733hniatgGHwJXl0S5cKIsu_tno4JRvJ_MDLtPs,1840
+sqlalchemy_postgres_point/point.py,sha256=pb_aoNKwMOaKJ_xDvaIhfE-4VZKzyiPgOWmM6_z6xXo,2888
+sqlalchemy_postgres_point/utils.py,sha256=Loc9Q-xkntEKP3WSw48rZr64aqPWdM9huBlJnGuZa_8,1340
+sqlalchemy_postgres_point-0.2.0.dist-info/WHEEL,sha256=QnGI6l9Psotmz6XrseXTYT5jnZRJeTk4SwJP4aLtfdI,80
+sqlalchemy_postgres_point-0.2.0.dist-info/METADATA,sha256=4haIARMrgBsJi5JKaBp01PZ5Cuv8EnHr-ocd6XUL4hA,6367
+sqlalchemy_postgres_point-0.2.0.dist-info/RECORD,,

sqlalchemy_postgres_point-0.1.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-sqlalchemy_postgres_point/__init__.py,sha256=BWlOd4qbAt4fM4cclR7ZrzZ-aib0f13KD3HIKmod2_s,208
-sqlalchemy_postgres_point/point.py,sha256=pb_aoNKwMOaKJ_xDvaIhfE-4VZKzyiPgOWmM6_z6xXo,2888
-sqlalchemy_postgres_point/utils.py,sha256=Loc9Q-xkntEKP3WSw48rZr64aqPWdM9huBlJnGuZa_8,1340
-sqlalchemy_postgres_point-0.1.1.dist-info/WHEEL,sha256=QnGI6l9Psotmz6XrseXTYT5jnZRJeTk4SwJP4aLtfdI,80
-sqlalchemy_postgres_point-0.1.1.dist-info/METADATA,sha256=X09nA3dHVTKB-wh3aratxcrxjdhtwnPJgHegIwzU7eA,5431
-sqlalchemy_postgres_point-0.1.1.dist-info/RECORD,,