clear-skies 2.0.7__py3-none-any.whl → 2.0.9__py3-none-any.whl

clearskies/model.py

@@ -4,7 +4,6 @@ import re
 from abc import abstractmethod
 from typing import TYPE_CHECKING, Any, Callable, Iterator, Self
 
-from clearskies.autodoc.schema import Schema as AutoDocSchema
 from clearskies.di import InjectableProperties, inject
 from clearskies.functional import string
 from clearskies.query import Condition, Join, Query, Sort
@@ -12,6 +11,7 @@ from clearskies.schema import Schema
 
 if TYPE_CHECKING:
     from clearskies import Column
+    from clearskies.autodoc.schema import Schema as AutoDocSchema
     from clearskies.backends import Backend
 
 
@@ -63,6 +63,7 @@ class Model(Schema, InjectableProperties):
     from typing import Self
     import clearskies
 
+
     class Fish(clearskies.Model):
         @classmethod
         def destination_name(cls: type[Self]) -> str:
@@ -86,6 +87,7 @@ class Model(Schema, InjectableProperties):
     ```
     import clearskies
 
+
     class User(clearskies.Model):
         id_column_name = "id"
         backend = clearskies.backends.MemoryBackend()
@@ -93,11 +95,15 @@ class Model(Schema, InjectableProperties):
         id = clearskies.columns.Uuid()
         name = clearskies.columns.String()
 
+
     def my_application(user, users, by_type_hint: User):
         return {
-            "all_are_user_models": isinstance(user, User) and isinstance(users, User) and isinstance(by_type_hint, User)
+            "all_are_user_models": isinstance(user, User)
+            and isinstance(users, User)
+            and isinstance(by_type_hint, User)
         }
 
+
     cli = clearskies.contexts.Cli(my_application, classes=[User])
     cli()
     ```
@@ -149,11 +155,13 @@ class Model(Schema, InjectableProperties):
     import datetime
     import clearskies
 
+
     class SomeClass:
         # Since this will be built by the DI system directly, we can declare dependencies in the __init__
         def __init__(self, some_date):
             self.some_date = some_date
 
+
     class User(clearskies.Model):
         id_column_name = "id"
         backend = clearskies.backends.MemoryBackend()
@@ -167,15 +175,17 @@ class Model(Schema, InjectableProperties):
         def some_date_in_the_past(self):
             return self.some_class.some_date < self.utcnow
 
+
     def my_application(user):
         return user.some_date_in_the_past()
 
+
     cli = clearskies.contexts.Cli(
         my_application,
         classes=[User],
         bindings={
             "some_date": datetime.datetime.now(datetime.timezone.utc) - datetime.timedelta(days=1),
-        }
+        },
     )
     cli()
     ```
@@ -321,6 +331,7 @@ class Model(Schema, InjectableProperties):
         ```python
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -328,12 +339,16 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
+
         def my_application(user):
-            user.save({
-                "name": "Awesome Person",
-            })
+            user.save(
+                {
+                    "name": "Awesome Person",
+                }
+            )
             return {"id": user.id, "name": user.name}
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -346,6 +361,7 @@ class Model(Schema, InjectableProperties):
         ```python
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -353,11 +369,13 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
+
         def my_application(user):
             user.name = "Awesome Person"
             user.save()
             return {"id": user.id, "name": user.name}
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -379,6 +397,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -386,8 +405,8 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
-        def my_application(user):
 
+        def my_application(user):
             if not user:
                 print("We will execute a create operation")
 
@@ -406,6 +425,7 @@ class Model(Schema, InjectableProperties):
 
             return {"id": user.id, "name": user.name}
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -422,6 +442,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -429,6 +450,7 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
+
         def my_application(user):
             # create a record with just an id
             user.save(no_data=True)
@@ -438,6 +460,7 @@ class Model(Schema, InjectableProperties):
 
             return {"id": user.id, "name": user.name}
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -517,6 +540,7 @@ class Model(Schema, InjectableProperties):
         from typing import Any, Self
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -536,6 +560,7 @@ class Model(Schema, InjectableProperties):
                     print("Nothing changed")
                 return data
 
+
         def my_application(users):
             jane = users.create({"name": "Jane"})
             jane.save({"age": 22})
@@ -544,6 +569,7 @@ class Model(Schema, InjectableProperties):
 
             return {"id": jane.id, "name": jane.name}
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -600,6 +626,7 @@ class Model(Schema, InjectableProperties):
         from typing import Any, Self
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -618,11 +645,13 @@ class Model(Schema, InjectableProperties):
                 print("Latest age: " + str(self.latest("age", data)))
                 return data
 
+
         def my_application(users):
             jane = users.create({"name": "Jane"})
             jane.save({"age": 25})
             return {"id": jane.id, "name": jane.name}
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -659,6 +688,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -667,6 +697,7 @@ class Model(Schema, InjectableProperties):
             name = clearskies.columns.String()
             age = clearskies.columns.Integer()
 
+
         def my_application(users):
             jane = users.create({"name": "Jane"})
             return {
@@ -674,6 +705,7 @@ class Model(Schema, InjectableProperties):
                 "age_changed": jane.was_changed("age"),
             }
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -713,6 +745,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -720,11 +753,13 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
+
         def my_application(users):
             jane = users.create({"name": "Jane"})
             jane.save({"name": "Jane Doe"})
             return {"name": jane.name, "previous_name": jane.previous_value("name")}
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -758,6 +793,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -765,6 +801,7 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
+
         def my_application(users):
             alice = users.create({"name": "Alice"})
 
@@ -778,12 +815,12 @@ class Model(Schema, InjectableProperties):
 
             return {"id": alice.id, "name": alice.name}
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
         )
         cli()
-
         ```
         """
         self.no_queries()
@@ -855,7 +892,7 @@ class Model(Schema, InjectableProperties):
 
     def pre_save(self: Self, data: dict[str, Any]) -> dict[str, Any]:
         """
-        A hook to add additional logic in the pre-save step of the save process.
+        Add a hook to add additional logic in the pre-save step of the save process.
 
         The pre/post/finished steps of the model are directly analogous to the pre/post/finished steps for the columns.
 
@@ -873,6 +910,7 @@ class Model(Schema, InjectableProperties):
         from typing import Any, Self
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -889,11 +927,12 @@ class Model(Schema, InjectableProperties):
 
                 return additional_data
 
+
         def my_application(users):
             jane = users.create({"name": "Jane"})
             is_anonymous_after_create = jane.is_anonymous
 
-            jane.save({"name":""})
+            jane.save({"name": ""})
             is_anonymous_after_first_update = jane.is_anonymous
 
             jane.save({"name": "Jane Doe"})
@@ -905,6 +944,7 @@ class Model(Schema, InjectableProperties):
                 "is_anonymous_after_last_update": is_anonymous_after_last_update,
             }
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -923,7 +963,7 @@ class Model(Schema, InjectableProperties):
 
     def post_save(self: Self, data: dict[str, Any], id: str | int) -> None:
         """
-        A hook to add additional logic in the post-save step of the save process.
+        Add  hook to add additional logic in the post-save step of the save process.
 
         It is passed in the data being saved as well as the id of the record.  Keep in mind that the post save
         hook happens after the backend has been updated (but before the model is updated) so if you need to make
@@ -934,6 +974,7 @@ class Model(Schema, InjectableProperties):
         from typing import Any, Self
         import clearskies
 
+
         class History(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -942,6 +983,7 @@ class Model(Schema, InjectableProperties):
             message = clearskies.columns.String()
             created_at = clearskies.columns.Created(date_format="%Y-%m-%d %H:%M:%S.%f")
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -959,6 +1001,7 @@ class Model(Schema, InjectableProperties):
                 age = self.latest("age", data)
                 self.histories.create({"message": f"My name is {name} and I am {age} years old"})
 
+
         def my_application(users, histories):
             jane = users.create({"name": "Jane"})
             jane.save({"age": 25})
@@ -967,6 +1010,7 @@ class Model(Schema, InjectableProperties):
 
             return [history.message for history in histories.sort_by("created_at", "ASC")]
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User, History],
@@ -978,9 +1022,9 @@ class Model(Schema, InjectableProperties):
 
     def save_finished(self: Self) -> None:
         """
-        A hook to add additional logicin the save_finished step of the save process.
+        Add a hook to add additional logic in the save_finished step of the save process.
 
-        It has no retrun value and is passed no data.  By the time this fires the model has already been
+        It has no return value and is passed no data.  By the time this fires the model has already been
         updated with the new data.  You can decide on the necessary actions using the `was_changed` and
         the `previous_value` functions.
 
@@ -988,6 +1032,7 @@ class Model(Schema, InjectableProperties):
         from typing import Any, Self
         import clearskies
 
+
         class History(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -996,6 +1041,7 @@ class Model(Schema, InjectableProperties):
             message = clearskies.columns.String()
             created_at = clearskies.columns.Created(date_format="%Y-%m-%d %H:%M:%S.%f")
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1011,6 +1057,7 @@ class Model(Schema, InjectableProperties):
 
                 self.histories.create({"message": f"My name is {self.name} and I am {self.age} years old"})
 
+
         def my_application(users, histories):
             jane = users.create({"name": "Jane"})
             jane.save({"age": 25})
@@ -1019,6 +1066,7 @@ class Model(Schema, InjectableProperties):
 
             return [history.message for history in histories.sort_by("created_at", "ASC")]
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User, History],
@@ -1054,9 +1102,7 @@ class Model(Schema, InjectableProperties):
         authorization_data: dict[str, Any],
         overrides: dict[str, Column] = {},
     ) -> Self:
-        """
-        A hook to automatically apply filtering whenever the model makes an appearance in a get/update/list/search handler.
-        """
+        """Add a hook to automatically apply filtering whenever the model makes an appearance in a get/update/list/search handler."""
         for column in self.get_columns(overrides=overrides).values():
             models = column.where_for_request(model, input_output, routing_data, authorization_data)  # type: ignore
         return self.where_for_request(
@@ -1072,7 +1118,7 @@ class Model(Schema, InjectableProperties):
         overrides: dict[str, Column] = {},
     ) -> Self:
         """
-        A hook to automatically apply filtering whenever the model makes an appearance in a get/update/list/search handler.
+        Add a hook to automatically apply filtering whenever the model makes an appearance in a get/update/list/search handler.
 
         Note that this automatically affects the behavior of the various list endpoints, but won't be called when you create your
         own queries directly.  Here's an example where the model restricts the list endpoint so that it only returns users with
@@ -1082,6 +1128,7 @@ class Model(Schema, InjectableProperties):
         from typing import Any, Self
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1099,6 +1146,7 @@ class Model(Schema, InjectableProperties):
             ) -> Self:
                 return model.where("age>=18")
 
+
         list_users = clearskies.endpoints.List(
             model_class=User,
             readable_column_names=["id", "name", "age"],
@@ -1144,6 +1192,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1151,6 +1200,7 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
+
         def my_application(users):
             jane = users.create({"name": "Jane"})
             jane_instance_has_query = jane.has_query()
@@ -1170,6 +1220,7 @@ class Model(Schema, InjectableProperties):
                 "invalid_request_error": invalid_request_error,
             }
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -1183,7 +1234,7 @@ class Model(Schema, InjectableProperties):
         {
             "jane_instance_has_query": false,
             "some_search_has_query": true,
-            "invalid_request_error": "You attempted to save/read record data for a model being used to make a query.  This is not allowed, as it is typically a sign of a bug in your application code."
+            "invalid_request_error": "You attempted to save/read record data for a model being used to make a query.  This is not allowed, as it is typically a sign of a bug in your application code.",
         }
         ```
 
@@ -1267,7 +1318,7 @@ class Model(Schema, InjectableProperties):
         return self.with_query(self.get_query().set_select_all(select_all))
 
     def where(self: Self, where: str | Condition) -> Self:
-        """
+        r"""
         Add a condition to a query.
 
         The `where` method (in combination with the `find` method) is typically the starting point for query records in
@@ -1314,6 +1365,7 @@ class Model(Schema, InjectableProperties):
         ```python
         import clearskies
 
+
         class Order(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1323,12 +1375,17 @@ class Model(Schema, InjectableProperties):
             status = clearskies.columns.Select(["Pending", "In Progress"])
             total = clearskies.columns.Float()
 
+
         def my_application(orders):
             orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
             orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
             orders.create({"user_id": "Jane", "status": "Pending", "total": 30})
 
-            return [order.user_id for order in orders.where("status=Pending").where(Order.total.greater_than(25))]
+            return [
+                order.user_id
+                for order in orders.where("status=Pending").where(Order.total.greater_than(25))
+            ]
+
 
         cli = clearskies.contexts.Cli(
             my_application,
@@ -1367,6 +1424,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1374,6 +1432,7 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
+
         class Order(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1384,6 +1443,7 @@ class Model(Schema, InjectableProperties):
             status = clearskies.columns.Select(["Pending", "In Progress"])
             total = clearskies.columns.Float()
 
+
         def my_application(users, orders):
             jane = users.create({"name": "Jane"})
             another_jane = users.create({"name": "Jane"})
@@ -1402,7 +1462,13 @@ class Model(Schema, InjectableProperties):
             orders.create({"user_id": bob.id, "status": "In Progress", "total": 35})
 
             # return all orders for anyone named Jane that have a status of Pending
-            return orders.join("join users on users.id=orders.user_id").where("users.name=Jane").sort_by("total", "asc").where("status=Pending")
+            return (
+                orders.join("join users on users.id=orders.user_id")
+                .where("users.name=Jane")
+                .sort_by("total", "asc")
+                .where("status=Pending")
+            )
+
 
         cli = clearskies.contexts.Cli(
             clearskies.endpoints.Callable(
@@ -1413,7 +1479,6 @@ class Model(Schema, InjectableProperties):
             classes=[Order, User],
         )
         cli()
-
         ```
         """
         self.no_single_model()
@@ -1460,6 +1525,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class Order(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1469,13 +1535,17 @@ class Model(Schema, InjectableProperties):
             status = clearskies.columns.Select(["Pending", "In Progress"])
             total = clearskies.columns.Float()
 
+
         def my_application(orders):
             orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
             orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
             orders.create({"user_id": "Alice", "status": "Pending", "total": 30})
             orders.create({"user_id": "Bob", "status": "Pending", "total": 26})
 
-            return orders.sort_by("user_id", "asc", secondary_column_name="total", secondary_direction="desc")
+            return orders.sort_by(
+                "user_id", "asc", secondary_column_name="total", secondary_direction="desc"
+            )
+
 
         cli = clearskies.contexts.Cli(
             clearskies.endpoints.Callable(
@@ -1502,6 +1572,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class Order(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1511,6 +1582,7 @@ class Model(Schema, InjectableProperties):
             status = clearskies.columns.Select(["Pending", "In Progress"])
             total = clearskies.columns.Float()
 
+
         def my_application(orders):
             orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
             orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
@@ -1519,6 +1591,7 @@ class Model(Schema, InjectableProperties):
 
             return orders.limit(2)
 
+
         cli = clearskies.contexts.Cli(
             clearskies.endpoints.Callable(
                 my_application,
@@ -1548,6 +1621,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class Order(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1557,6 +1631,7 @@ class Model(Schema, InjectableProperties):
             status = clearskies.columns.Select(["Pending", "In Progress"])
             total = clearskies.columns.Float()
 
+
         def my_application(orders):
             orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
             orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
@@ -1565,6 +1640,7 @@ class Model(Schema, InjectableProperties):
 
             return orders.sort_by("total", "asc").pagination(start=2)
 
+
         cli = clearskies.contexts.Cli(
             clearskies.endpoints.Callable(
                 my_application,
@@ -1604,6 +1680,7 @@ class Model(Schema, InjectableProperties):
         ```python
         import clearskies
 
+
         class Order(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1613,6 +1690,7 @@ class Model(Schema, InjectableProperties):
             status = clearskies.columns.Select(["Pending", "In Progress"])
             total = clearskies.columns.Float()
 
+
         def my_application(orders):
             orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
             orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
@@ -1627,6 +1705,7 @@ class Model(Schema, InjectableProperties):
                 "total": jane.total,
             }
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[Order],
@@ -1668,6 +1747,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class Order(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1677,6 +1757,7 @@ class Model(Schema, InjectableProperties):
             status = clearskies.columns.Select(["Pending", "In Progress"])
             total = clearskies.columns.Float()
 
+
         def my_application(orders):
             orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
             orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
@@ -1685,6 +1766,7 @@ class Model(Schema, InjectableProperties):
 
             return orders.limit(1).paginate_all()
 
+
         cli = clearskies.contexts.Cli(
             clearskies.endpoints.Callable(
                 my_application,
@@ -1724,6 +1806,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1731,6 +1814,7 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
+
         def my_application(users):
             jane = users.create({"name": "Jane"})
 
@@ -1741,6 +1825,7 @@ class Model(Schema, InjectableProperties):
 
             return {"id": another_jane_object.id, "name": another_jane_object.name}
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -1754,7 +1839,9 @@ class Model(Schema, InjectableProperties):
 
     def empty(self: Self) -> Self:
         """
-        An alias for self.model({})
+        Create a an empty model instance.
+
+        An alias for self.model({}).
 
         This just provides you a fresh, empty model instance that you can use for populating with data or creating
         a new record.  Here's a simple exmaple.  Both print statements will be printed and it will return the id
@@ -1763,6 +1850,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1770,6 +1858,7 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
+
         def my_application(users):
             alice = users.create({"name": "Alice"})
 
@@ -1783,6 +1872,7 @@ class Model(Schema, InjectableProperties):
 
             return {"alice_id": alice.id, "blank_id": blank.id}
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -1805,6 +1895,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class User(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1812,6 +1903,7 @@ class Model(Schema, InjectableProperties):
             id = clearskies.columns.Uuid()
             name = clearskies.columns.String()
 
+
         def my_application(user):
             # let's create a new record
             user.save({"name": "Alice"})
@@ -1824,6 +1916,7 @@ class Model(Schema, InjectableProperties):
                 "Bob": bob.name,
             }
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[User],
@@ -1847,6 +1940,7 @@ class Model(Schema, InjectableProperties):
         ```
         import clearskies
 
+
         class Order(clearskies.Model):
             id_column_name = "id"
             backend = clearskies.backends.MemoryBackend()
@@ -1856,6 +1950,7 @@ class Model(Schema, InjectableProperties):
             status = clearskies.columns.Select(["Pending", "In Progress"])
             total = clearskies.columns.Float()
 
+
         def my_application(orders):
             orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
             orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
@@ -1870,12 +1965,12 @@ class Model(Schema, InjectableProperties):
                 "total": jane.total,
             }
 
+
         cli = clearskies.contexts.Cli(
             my_application,
             classes=[Order],
         )
         cli()
-
         ```
         """
         self.no_single_model()