activemodel 0.10.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

{activemodel-0.10.0.dist-info → activemodel-0.12.0.dist-info}/METADATA

@@ -1,15 +1,15 @@
 Metadata-Version: 2.4
 Name: activemodel
-Version: 0.10.0
+Version: 0.12.0
 Summary: Make SQLModel more like an a real ORM
 Project-URL: Repository, https://github.com/iloveitaly/activemodel
 Author-email: Michael Bianco <iloveitaly@gmail.com>
 License-File: LICENSE
 Keywords: activemodel,activerecord,orm,sqlalchemy,sqlmodel
 Requires-Python: >=3.10
-Requires-Dist: pydash>=8.0.4
 Requires-Dist: python-decouple-typed>=3.11.0
 Requires-Dist: sqlmodel>=0.0.22
+Requires-Dist: textcase>=0.4.0
 Requires-Dist: typeid-python>=0.3.1
 Description-Content-Type: text/markdown
 
@@ -59,15 +59,17 @@ from sqlmodel import SQLModel
 
 SQLModel.metadata.create_all(get_engine())
 
-# now you can create a user!
+# now you can create a user! without managing sessions!
 User(a_field="a").save()
 ```
 
 Maybe you like JSON:
 
 ```python
-from activemodel import BaseModel
+from sqlalchemy.dialects.postgresql import JSONB
 from pydantic import BaseModel as PydanticBaseModel
+
+from activemodel import BaseModel
 from activemodel.mixins import PydanticJSONMixin, TypeIDMixin, TimestampsMixin
 
 class SubObject(PydanticBaseModel):
@@ -81,11 +83,28 @@ class User(
     TypeIDMixin("user"),
     table=True
 ):
-    list_field: list[SubObject] = Field(sa_type=JSONB())
+    list_field: list[SubObject] = Field(sa_type=JSONB)
 ```
 
+You'll probably want to query the model. Look ma, no sessions!
+
+```python
+User.where(id="user_123").all()
+
+# or, even better, for this case
+User.one("user_123")
+```
+
+Magically creating sessions for DB operations is one of the main problems this project tackles. Even better, you can set
+a single session object to be used for all DB operations. This is helpful for DB transactions, [specifically rolling back
+DB operations on each test.](#pytest)
+
 ## Usage
 
+### Pytest
+
+TODO detail out truncation and transactions
+
 ### Integrating Alembic
 
 `alembic init` will not work out of the box. You need to mutate a handful of files:
@@ -110,14 +129,14 @@ index 0d07420..a63631c 100644
  # Use forward slashes (/) also on windows to provide an os agnostic path
 -script_location = .
 +script_location = migrations
- 
+
  # template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
  # Uncomment the line below if you want the files to be prepended with date and time
  # see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
  # for all available tokens
  # file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
 +file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(rev)s_%%(slug)s
- 
+
  # sys.path path, will be prepended to sys.path if present.
  # defaults to the current working directory.
 diff --git i/test/migrations/env.py w/test/migrations/env.py
@@ -129,12 +148,12 @@ index 36112a3..a1e15c2 100644
 +# isort: off
 +
  from logging.config import fileConfig
- 
+
  from sqlalchemy import engine_from_config
 @@ -14,11 +17,17 @@ config = context.config
  if config.config_file_name is not None:
      fileConfig(config.config_file_name)
- 
+
 +from sqlmodel import SQLModel
 +from test.models import *
 +from test.utils import database_url
@@ -147,7 +166,7 @@ index 36112a3..a1e15c2 100644
  # target_metadata = mymodel.Base.metadata
 -target_metadata = None
 +target_metadata = SQLModel.metadata
- 
+
  # other values from the config, defined by the needs of env.py,
  # can be acquired:
 diff --git i/test/migrations/script.py.mako w/test/migrations/script.py.mako
@@ -155,13 +174,13 @@ index fbc4b07..9dc78bb 100644
 --- i/test/migrations/script.py.mako
 +++ w/test/migrations/script.py.mako
 @@ -9,6 +9,8 @@ from typing import Sequence, Union
- 
+
  from alembic import op
  import sqlalchemy as sa
 +import sqlmodel
 +import activemodel
  ${imports if imports else ""}
- 
+
  # revision identifiers, used by Alembic.
 ```
 
@@ -178,7 +197,7 @@ This tool is added to all `BaseModel`s and makes it easy to write SQL queries. S
 
 ### Easy Database Sessions
 
-I hate the idea f 
+I hate the idea f
 
 * Behavior should be intuitive and easy to understand. If you run `save()`, it should save, not stick the save in a transaction.
 * Don't worry about dead sessions. This makes it easy to lazy-load computed properties and largely eliminates the need to think about database sessions.
@@ -186,7 +205,7 @@ I hate the idea f
 There are a couple of thorny problems we need to solve for here:
 
 * In-memory fastapi servers are not the same as a uvicorn server, which is threaded *and* uses some sort of threadpool model for handling async requests. I don't claim to understand the entire implementation. For global DB session state (a) we can't use global variables (b) we can't use thread-local variables.
-* 
+*
 
 https://github.com/tomwojcik/starlette-context
 
@@ -202,8 +221,12 @@ https://github.com/tomwojcik/starlette-context
 SQLModel & SQLAlchemy are tricky. Here are some useful internal tricks:
 
 * `__sqlmodel_relationships__` is where any `RelationshipInfo` objects are stored. This is used to generate relationship fields on the object.
-* `ModelClass.relationship_name.property.local_columns` 
+* `ModelClass.relationship_name.property.local_columns`
 * Get cached fields from a model `object_state(instance).dict.get(field_name)`
+* Set the value on a field, without marking it as dirty `attributes.set_committed_value(instance, field_name, val)`
+* Is a model dirty `instance_state(instance).modified`
+* `select(Table).outerjoin??` won't work in a ipython session, but `Table.__table__.outerjoin??` will. `__table__` is a reference to the underlying SQLAlchemy table record.
+* `get_engine().pool.stats()` is helpful for inspecting connection pools and limits\
 
 ### TypeID
 
@@ -267,6 +290,7 @@ https://github.com/DarylStark/my_data/blob/a17b8b3a8463b9953821b89fee895e272f94d
 
 * https://github.com/woofz/sqlmodel-basecrud
 * https://github.com/0xthiagomartins/sqlmodel-controller
+* https://github.com/litestar-org/advanced-alchemy?tab=readme-ov-file
 
 ## Inspiration
 
@@ -279,4 +303,4 @@ https://github.com/DarylStark/my_data/blob/a17b8b3a8463b9953821b89fee895e272f94d
 
 ## Upstream Changes
 
-- [ ] https://github.com/fastapi/sqlmodel/pull/1293
+- [ ] https://github.com/fastapi/sqlmodel/pull/1293

activemodel-0.12.0.dist-info/RECORD

@@ -0,0 +1,30 @@
+activemodel/__init__.py,sha256=q_lHQyIM70ApvjduTo9GtenQjJXsfYZsAAquD_51kF4,137
+activemodel/base_model.py,sha256=zku7nKOcN4_YpIpHjP3_sWeJWGTf141gUYtPPilY0MU,17359
+activemodel/celery.py,sha256=L1vKcO_HoPA5ZCfsXjxgPpDUMYDuoQMakGA9rppN7Lo,897
+activemodel/errors.py,sha256=wycWYmk9ws4TZpxvTdtXVy2SFESb8NqKgzdivBoF0vw,115
+activemodel/get_column_from_field_patch.py,sha256=wAEDm_ZvSqyJwfgkXVpxsevw11hd-7VLy7zuJG8Ak7Y,4986
+activemodel/logger.py,sha256=vU7QiGSy_AJuJFmClUocqIJ-Ltku_8C24ZU8L6fLJR0,53
+activemodel/query_wrapper.py,sha256=gXpEAAFpRqQNUbTubTX-qkMNHeztFnyxtjdJbplCkKA,2867
+activemodel/session_manager.py,sha256=Aqc96ByAgrcuRRPsMZiTN3tlSXUFZvM3U7N8vCO2TIk,6720
+activemodel/utils.py,sha256=tZlAk0G46g6dwYuN7dIr8xU9QC_aLZYqjDXYkGiCtUg,888
+activemodel/cli/__init__.py,sha256=HrgJjB5pRuE6hbwgy0Dw4oHvGZ47kH0LPVAdG9l6-vw,5021
+activemodel/mixins/__init__.py,sha256=05EQl2u_Wgf_wkly-GTaTsR7zWpmpKcb96Js7r_rZTw,160
+activemodel/mixins/pydantic_json.py,sha256=0pprGZA95BGZL4WOh--NJcvxLWey4YW85lLk4GGTjFM,3530
+activemodel/mixins/soft_delete.py,sha256=Ax4mGsQI7AVTE8c4GiWxpyB_W179-dDct79GtjP0owU,461
+activemodel/mixins/timestamps.py,sha256=C6QQNnzrNUOW1EAsMpEVpImEeTIYDMPP0wocEw2RDQw,1078
+activemodel/mixins/typeid.py,sha256=777btWRUW6YBGPApeaEdHQaoKmwblehukHzmkKoXv6o,1340
+activemodel/pytest/__init__.py,sha256=IJpD-BwJuPii5IxTJoOCryaq4_oyXNRj4RjlS5Plmc8,112
+activemodel/pytest/factories.py,sha256=d4Mt9Lto8Pqd2bXuxDSt92IeEzTM5VGL3rQwG8jY4x4,3475
+activemodel/pytest/plugin.py,sha256=QsHnaKmkFZjR_pUHLaU7tb47vrfcNU0zsvfBaN0g2f0,2509
+activemodel/pytest/transaction.py,sha256=KMQ7jHSU9Bf14rPwdVAFxxR9mZ41uRAXwiSQ3HAzkw0,5801
+activemodel/pytest/truncate.py,sha256=LeuG2fSq92oR-S1_gE-1Y3DhO48jw4ubMIRh2tb6U08,4780
+activemodel/types/__init__.py,sha256=y5fiGVtPJxGEhuf-TvyrkhM2yaKRcIWo6XAx-CFFjM8,31
+activemodel/types/sqlalchemy_protocol.py,sha256=2MSuGIp6pcIyiy8uK7qX3FLWABBMQOJGlIC969WRQdY,277
+activemodel/types/sqlalchemy_protocol.pyi,sha256=SP4Z50SGcw6qSexGgNd_4g6E_sQwpIE44vgNT4ncmeI,5667
+activemodel/types/typeid.py,sha256=qycqklKv5nKuCqjJRnxA-6MjtcWJ4vFUsAVBc1ySwfg,7865
+activemodel/types/typeid_patch.py,sha256=y6kiCJQ_NzeKfuI4UtRAs7QW_nEog5RIA_-k4HUBMkU,575
+activemodel-0.12.0.dist-info/METADATA,sha256=j9sLMrYMP-2pnGE5yFFYELUqgbO-H8uKNCFrpHgw-8Q,10724
+activemodel-0.12.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+activemodel-0.12.0.dist-info/entry_points.txt,sha256=rytVrsNgUT4oDiW9RvRH6JBTHQn0hPZLK-jzQt3dY9s,51
+activemodel-0.12.0.dist-info/licenses/LICENSE,sha256=L8mmpX47rB-xtJ_HsK0zpfO6viEjxbLYGn70BMp8os4,1071
+activemodel-0.12.0.dist-info/RECORD,,

activemodel-0.12.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+activemodel = activemodel.pytest.plugin

activemodel-0.10.0.dist-info/RECORD

@@ -1,24 +0,0 @@
-activemodel/__init__.py,sha256=q_lHQyIM70ApvjduTo9GtenQjJXsfYZsAAquD_51kF4,137
-activemodel/base_model.py,sha256=VSItKKMxP-g-en_v16VnR9W6ueSLlWqmxn7I2-TgpGk,16646
-activemodel/celery.py,sha256=L1vKcO_HoPA5ZCfsXjxgPpDUMYDuoQMakGA9rppN7Lo,897
-activemodel/errors.py,sha256=wycWYmk9ws4TZpxvTdtXVy2SFESb8NqKgzdivBoF0vw,115
-activemodel/get_column_from_field_patch.py,sha256=wAEDm_ZvSqyJwfgkXVpxsevw11hd-7VLy7zuJG8Ak7Y,4986
-activemodel/logger.py,sha256=vU7QiGSy_AJuJFmClUocqIJ-Ltku_8C24ZU8L6fLJR0,53
-activemodel/query_wrapper.py,sha256=rNdvueppMse2MIi-RafTEC34GPGRal_wqH2CzhmlWS8,2520
-activemodel/session_manager.py,sha256=ltmUyBsYCNNddoilLWrh3HX9QY9eQSZiRsyFf0awevs,4835
-activemodel/utils.py,sha256=g17UqkphzTmb6YdpmYwT1TM00eDiXXuWn39-xNiu0AA,2112
-activemodel/mixins/__init__.py,sha256=05EQl2u_Wgf_wkly-GTaTsR7zWpmpKcb96Js7r_rZTw,160
-activemodel/mixins/pydantic_json.py,sha256=0pprGZA95BGZL4WOh--NJcvxLWey4YW85lLk4GGTjFM,3530
-activemodel/mixins/soft_delete.py,sha256=Ax4mGsQI7AVTE8c4GiWxpyB_W179-dDct79GtjP0owU,461
-activemodel/mixins/timestamps.py,sha256=Q-IFljeVVJQqw3XHdOi7dkqzefiVg1zhJvq_bldpmjg,992
-activemodel/mixins/typeid.py,sha256=WBZwnryF2QkI1ki0fW-jEbE8cIqMIldwkaeJdGT01S4,841
-activemodel/pytest/__init__.py,sha256=W9KKQHbPkyq0jrMXaiL8hG2Nsbjy_LN9HhvgGm8W_7g,98
-activemodel/pytest/transaction.py,sha256=ln-3N5tXHT0fqy6a8m_NIYg5AXAeA2hDuftQtFxNqi4,2600
-activemodel/pytest/truncate.py,sha256=IGiPLkUm2yyOKww6c6CKcVbwi2xAAFBopx9q2ABfu8w,1582
-activemodel/types/__init__.py,sha256=y5fiGVtPJxGEhuf-TvyrkhM2yaKRcIWo6XAx-CFFjM8,31
-activemodel/types/typeid.py,sha256=1xB79DGIC5-P-PcLpeZW9Ed_WjFOmmVW1yl2Q3pPJis,7250
-activemodel-0.10.0.dist-info/METADATA,sha256=rin3Edbj6CFW8-cj6fcL6S6GU8a1Qn0Sl9tGOLM-_rw,9652
-activemodel-0.10.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-activemodel-0.10.0.dist-info/entry_points.txt,sha256=YLX62TP_hR-n3HMBkdBex4W7XRiyOtIPkwy22puIjjQ,61
-activemodel-0.10.0.dist-info/licenses/LICENSE,sha256=L8mmpX47rB-xtJ_HsK0zpfO6viEjxbLYGn70BMp8os4,1071
-activemodel-0.10.0.dist-info/RECORD,,

activemodel-0.10.0.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-activemodel = python_package_template:main