Skip to content

Commit 0274770

Browse files
authored
Deprecate ModelView(Model, db.session) in favor of ModelView(Model, db) (#2717)
* Allow passing ModelView(Model, db) rather than ModelView(Model, db.session) and deprecate
1 parent 4660b94 commit 0274770

File tree

31 files changed

+1088
-307
lines changed

31 files changed

+1088
-307
lines changed

examples/auth/main.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,8 +224,8 @@ def build_sample_db():
224224

225225

226226
if __name__ == "__main__":
227-
admin.add_view(MyModelView(Role, db.session))
228-
admin.add_view(MyModelView(User, db.session))
227+
admin.add_view(MyModelView(Role, db))
228+
admin.add_view(MyModelView(User, db))
229229

230230
app_dir = os.path.realpath(os.path.dirname(__file__))
231231
database_path = os.path.join(app_dir, app.config["DATABASE_FILE"])

examples/auth_flask_login/main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ def build_sample_db():
280280
theme=Bootstrap4Theme(base_template="my_master.html", fluid=True),
281281
)
282282

283-
admin.add_view(MyModelView(User, db.session))
283+
admin.add_view(MyModelView(User, db))
284284

285285
app_dir = os.path.realpath(os.path.dirname(__file__))
286286
database_path = os.path.join(app_dir, app.config["DATABASE_FILE"])

examples/babel/main.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ def index():
7272

7373
if __name__ == "__main__":
7474
# admin.locale_selector(get_locale)
75-
admin.add_view(ModelView(User, db.session))
76-
admin.add_view(ModelView(Post, db.session))
75+
admin.add_view(ModelView(User, db))
76+
admin.add_view(ModelView(Post, db))
7777

7878
with app.app_context():
7979
db.create_all()

examples/bootstrap4/main.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,28 +122,26 @@ class PageWithModalView(ModelView):
122122
admin.add_view(
123123
UserAdmin(
124124
User,
125-
db.session,
125+
db,
126126
category="Menu",
127127
menu_icon_type="fa",
128128
menu_icon_value="fa-users",
129129
menu_class_name="text-warning",
130130
)
131131
)
132132
admin.add_menu_item(MenuDivider(), target_category="Menu")
133-
admin.add_view(
134-
SimplePageView(Page, db.session, category="Menu", name="Simple Page")
135-
)
133+
admin.add_view(SimplePageView(Page, db, category="Menu", name="Simple Page"))
136134

137135
admin.add_view(
138136
PageWithModalView(
139-
Page, db.session, category="Menu", endpoint="page-modal", name="Page-Modal"
137+
Page, db, category="Menu", endpoint="page-modal", name="Page-Modal"
140138
)
141139
)
142140

143141
admin.add_view(
144142
ModelView(
145143
Page,
146-
db.session,
144+
db,
147145
name="Page-with-icon",
148146
endpoint="page2",
149147
menu_class_name="text-danger",

examples/custom_layout/main.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@ def build_sample_db():
186186

187187

188188
if __name__ == "__main__":
189-
admin.add_view(UserAdmin(User, db.session))
190-
admin.add_view(CustomView(Page, db.session))
189+
admin.add_view(UserAdmin(User, db))
190+
admin.add_view(CustomView(Page, db))
191191

192192
app_dir = op.realpath(os.path.dirname(__file__))
193193
database_path = op.join(app_dir, app.config["DATABASE_FILE"])

examples/datetime_timezone/main.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,11 @@ class BlogModelView(ModelView):
113113
Article(text="Written at 9:00 UTC", last_edit=datetime(2024, 8, 8, 9, 0, 0))
114114
)
115115
db.session.commit()
116-
admin.add_view(
117-
BlogModelView(Article, db.session, name="Article", endpoint="article")
118-
)
116+
admin.add_view(BlogModelView(Article, db, name="Article", endpoint="article"))
119117
admin.add_view(
120118
TimezoneAwareBlogModelView(
121119
Article,
122-
db.session,
120+
db,
123121
name="Timezone Aware Article",
124122
endpoint="timezone_aware_article",
125123
)

examples/forms_files_images/main.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -317,10 +317,10 @@ def build_sample_db():
317317

318318

319319
if __name__ == "__main__":
320-
admin.add_view(FileView(File, db.session))
321-
admin.add_view(ImageView(Image, db.session))
322-
admin.add_view(UserView(User, db.session))
323-
admin.add_view(PageView(Page, db.session))
320+
admin.add_view(FileView(File, db))
321+
admin.add_view(ImageView(Image, db))
322+
admin.add_view(UserView(User, db))
323+
admin.add_view(PageView(Page, db))
324324

325325
app_dir = op.realpath(os.path.dirname(__file__))
326326
database_path = op.join(app_dir, app.config["DATABASE_FILE"])

examples/geo_alchemy/main.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,12 @@ class OSMModelView(ModelView):
8787
app.add_url_rule(rule="/", view_func=index)
8888
db.init_app(app)
8989
admin.init_app(app)
90-
admin.add_view(LeafletModelView(Point, db.session, category="Points"))
91-
admin.add_view(OSMModelView(MultiPoint, db.session, category="Points"))
92-
admin.add_view(LeafletModelView(Polygon, db.session, category="Polygons"))
93-
admin.add_view(OSMModelView(MultiPolygon, db.session, category="Polygons"))
94-
admin.add_view(LeafletModelView(LineString, db.session, category="Lines"))
95-
admin.add_view(OSMModelView(MultiLineString, db.session, category="Lines"))
90+
admin.add_view(LeafletModelView(Point, db, category="Points"))
91+
admin.add_view(OSMModelView(MultiPoint, db, category="Points"))
92+
admin.add_view(LeafletModelView(Polygon, db, category="Polygons"))
93+
admin.add_view(OSMModelView(MultiPolygon, db, category="Polygons"))
94+
admin.add_view(LeafletModelView(LineString, db, category="Lines"))
95+
admin.add_view(OSMModelView(MultiLineString, db, category="Lines"))
9696

9797
with app.app_context():
9898
db.create_all()

examples/sqla/admin/main.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -311,10 +311,10 @@ def render(self, template, **kwargs):
311311

312312
admin = Admin(app, name="Example: SQLAlchemy", theme=Bootstrap4Theme(swatch="default"))
313313

314-
admin.add_view(UserAdmin(User, db.session))
315-
admin.add_view(ModelView(Tag, db.session))
316-
admin.add_view(PostAdmin(db.session))
317-
admin.add_view(TreeView(Tree, db.session, category="Other"))
314+
admin.add_view(UserAdmin(User, db))
315+
admin.add_view(ModelView(Tag, db))
316+
admin.add_view(PostAdmin(db))
317+
admin.add_view(TreeView(Tree, db, category="Other"))
318318
admin.add_sub_category(name="Links", parent_name="Other")
319319
admin.add_link(MenuLink(name="Back Home", url="/", category="Links"))
320320
admin.add_link(

examples/sqla_association_proxy/main.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ class KeywordAdmin(ModelView):
9090

9191

9292
if __name__ == "__main__":
93-
admin.add_view(UserAdmin(User, db.session))
94-
admin.add_view(KeywordAdmin(Keyword, db.session))
93+
admin.add_view(UserAdmin(User, db))
94+
admin.add_view(KeywordAdmin(Keyword, db))
9595

9696
with app.app_context():
9797
db.create_all()

0 commit comments

Comments
 (0)