summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2024-02-04 15:29:37 -0700
committerMichael Merickel <michael@merickel.org>2024-02-04 15:29:37 -0700
commitd3c8d93cfb1282f328ecd133df6565a2df92779f (patch)
treed8dc3c489fa007666476ea38155d9bd24d24525c
parent569f0a53d0bedecceb1365a0159c9fe514f198a9 (diff)
downloadpyramid-d3c8d93cfb1282f328ecd133df6565a2df92779f.tar.gz
pyramid-d3c8d93cfb1282f328ecd133df6565a2df92779f.tar.bz2
pyramid-d3c8d93cfb1282f328ecd133df6565a2df92779f.zip
update the definingviews chapter
-rw-r--r--docs/tutorials/wiki2/definingmodels.rst2
-rw-r--r--docs/tutorials/wiki2/definingviews.rst19
-rw-r--r--docs/tutorials/wiki2/src/models/tutorial/models/page.py2
-rw-r--r--docs/tutorials/wiki2/src/models/tutorial/models/user.py4
-rw-r--r--docs/tutorials/wiki2/src/views/.coveragerc2
-rw-r--r--docs/tutorials/wiki2/src/views/CHANGES.txt4
-rw-r--r--docs/tutorials/wiki2/src/views/MANIFEST.in2
-rw-r--r--docs/tutorials/wiki2/src/views/README.md60
-rw-r--r--docs/tutorials/wiki2/src/views/README.txt44
-rw-r--r--docs/tutorials/wiki2/src/views/development.ini8
-rw-r--r--docs/tutorials/wiki2/src/views/production.ini8
-rw-r--r--docs/tutorials/wiki2/src/views/pyproject.toml60
-rw-r--r--docs/tutorials/wiki2/src/views/pytest.ini6
-rw-r--r--docs/tutorials/wiki2/src/views/setup.py63
-rw-r--r--docs/tutorials/wiki2/src/views/testing.ini8
-rw-r--r--docs/tutorials/wiki2/src/views/tutorial/alembic/versions/20240204_07f9d6b626b2.py52
-rw-r--r--docs/tutorials/wiki2/src/views/tutorial/alembic/versions/20240204_4b6614165904.py33
-rw-r--r--docs/tutorials/wiki2/src/views/tutorial/models/meta.py28
-rw-r--r--docs/tutorials/wiki2/src/views/tutorial/models/page.py20
-rw-r--r--docs/tutorials/wiki2/src/views/tutorial/models/user.py17
-rw-r--r--docs/tutorials/wiki2/src/views/tutorial/views/default.py27
21 files changed, 281 insertions, 188 deletions
diff --git a/docs/tutorials/wiki2/definingmodels.rst b/docs/tutorials/wiki2/definingmodels.rst
index b9b02ed12..45a3167a7 100644
--- a/docs/tutorials/wiki2/definingmodels.rst
+++ b/docs/tutorials/wiki2/definingmodels.rst
@@ -28,7 +28,7 @@ custom application requirements.
We need to add a dependency, the `bcrypt <https://pypi.org/project/bcrypt/>`_ package, to our ``tutorial`` package's ``pyproject.toml`` file.
Dependencies are defined via the ``dependencies`` key in the ``[project]`` section.
-Open ``tutorial/pyproject.toml`` and edit it to look like the following by adding ``bcrypt`` and sorting the packages:
+Open ``pyproject.toml`` and edit it to look like the following by adding ``bcrypt`` and sorting the packages:
.. literalinclude:: src/models/pyproject.toml
:lines: 20-33
diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index c4712faf0..8c397f880 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -24,14 +24,13 @@ Remember in the previous chapter we added a new dependency of the ``bcrypt``
package. Again, the view code in our application will depend on a package which
is not a dependency of the original "tutorial" application.
-We need to add a dependency on the ``docutils`` package to our ``tutorial``
-package's ``setup.py`` file by assigning this dependency to the ``requires``
-list.
+We need to add a dependency on the ``docutils`` package, to our ``tutorial`` package's ``pyproject.toml`` file.
+Dependencies are defined via the ``dependencies`` key in the ``[project]`` section.
-Open ``tutorial/setup.py`` and edit it to look like the following:
+Open ``pyproject.toml`` and edit it to look like the following:
-.. literalinclude:: src/views/setup.py
- :lines: 11-25
+.. literalinclude:: src/views/pyproject.toml
+ :lines: 20-34
:lineno-match:
:emphasize-lines: 4
:language: python
@@ -186,7 +185,7 @@ The ``view_wiki`` view function
Following is the code for the ``view_wiki`` view function and its decorator:
.. literalinclude:: src/views/tutorial/views/default.py
- :lines: 16-19
+ :lines: 17-20
:lineno-match:
:linenos:
:language: python
@@ -211,7 +210,7 @@ The ``view_page`` view function
Here is the code for the ``view_page`` view function and its decorator:
.. literalinclude:: src/views/tutorial/views/default.py
- :lines: 21-41
+ :lines: 22-46
:lineno-match:
:linenos:
:language: python
@@ -264,7 +263,7 @@ The ``edit_page`` view function
Here is the code for the ``edit_page`` view function and its decorator:
.. literalinclude:: src/views/tutorial/views/default.py
- :lines: 43-55
+ :lines: 48-64
:lineno-match:
:linenos:
:language: python
@@ -301,7 +300,7 @@ The ``add_page`` view function
Here is the code for the ``add_page`` view function and its decorator:
.. literalinclude:: src/views/tutorial/views/default.py
- :lines: 57-
+ :lines: 66-
:lineno-match:
:linenos:
:language: python
diff --git a/docs/tutorials/wiki2/src/models/tutorial/models/page.py b/docs/tutorials/wiki2/src/models/tutorial/models/page.py
index 5a1c885c9..6cc9aae3c 100644
--- a/docs/tutorials/wiki2/src/models/tutorial/models/page.py
+++ b/docs/tutorials/wiki2/src/models/tutorial/models/page.py
@@ -13,4 +13,4 @@ class Page(Base):
data: Mapped[str]
creator_id: Mapped[int] = mapped_column(ForeignKey('users.id'))
- creator: Mapped['User'] = relationship('User', back_populates='created_pages')
+ creator: Mapped['User'] = relationship(back_populates='created_pages')
diff --git a/docs/tutorials/wiki2/src/models/tutorial/models/user.py b/docs/tutorials/wiki2/src/models/tutorial/models/user.py
index d85d890c6..926a66e64 100644
--- a/docs/tutorials/wiki2/src/models/tutorial/models/user.py
+++ b/docs/tutorials/wiki2/src/models/tutorial/models/user.py
@@ -1,6 +1,6 @@
import bcrypt
from sqlalchemy.orm import Mapped, mapped_column, relationship
-from typing import Optional
+from typing import List, Optional
from .meta import Base
@@ -24,4 +24,4 @@ class User(Base):
return bcrypt.checkpw(pw.encode('utf8'), expected_hash)
return False
- created_pages: Mapped['Page'] = relationship('Page', back_populates='creator')
+ created_pages: Mapped[List['Page']] = relationship(back_populates='creator')
diff --git a/docs/tutorials/wiki2/src/views/.coveragerc b/docs/tutorials/wiki2/src/views/.coveragerc
deleted file mode 100644
index 5db0e79cf..000000000
--- a/docs/tutorials/wiki2/src/views/.coveragerc
+++ /dev/null
@@ -1,2 +0,0 @@
-[run]
-source = tutorial
diff --git a/docs/tutorials/wiki2/src/views/CHANGES.txt b/docs/tutorials/wiki2/src/views/CHANGES.txt
deleted file mode 100644
index 14b902fd1..000000000
--- a/docs/tutorials/wiki2/src/views/CHANGES.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-0.0
----
-
-- Initial version.
diff --git a/docs/tutorials/wiki2/src/views/MANIFEST.in b/docs/tutorials/wiki2/src/views/MANIFEST.in
index b4624fd1c..201692c1b 100644
--- a/docs/tutorials/wiki2/src/views/MANIFEST.in
+++ b/docs/tutorials/wiki2/src/views/MANIFEST.in
@@ -1,4 +1,4 @@
-include *.txt *.ini *.cfg *.rst
+include *.txt *.ini *.cfg *.rst *.toml
recursive-include tutorial *.ico *.png *.css *.gif *.jpg *.pt *.txt *.mak *.mako *.js *.html *.xml *.jinja2
recursive-include tests *
recursive-exclude * __pycache__
diff --git a/docs/tutorials/wiki2/src/views/README.md b/docs/tutorials/wiki2/src/views/README.md
new file mode 100644
index 000000000..5ac1209d0
--- /dev/null
+++ b/docs/tutorials/wiki2/src/views/README.md
@@ -0,0 +1,60 @@
+# myproj
+
+## Getting Started
+
+- Change directory into your newly created project if not already there. Your
+ current directory should be the same as this `README.md` file and `pyproject.toml`.
+
+ ```
+ cd tutorial
+ ```
+
+- Create a Python virtual environment, if not already created.
+
+ ```
+ python3 -m venv env
+ ```
+
+- Upgrade packaging tools, if necessary.
+
+ ```
+ env/bin/pip install --upgrade pip
+ ```
+
+- Install the project in editable mode with its testing requirements.
+
+ ```
+ env/bin/pip install -e ".[testing]"
+ ```
+
+- Initialize and upgrade the database using Alembic.
+
+ - Generate your first revision.
+
+ ```
+ env/bin/alembic -c development.ini revision --autogenerate -m "init"
+ ```
+
+ - Upgrade to that revision.
+
+ ```
+ env/bin/alembic -c development.ini upgrade head
+ ```
+
+- Load default data into the database using a script.
+
+ ```
+ env/bin/initialize_tutorial_db development.ini
+ ```
+
+- Run your project's tests.
+
+ ```
+ env/bin/pytest
+ ```
+
+- Run your project.
+
+ ```
+ env/bin/pserve development.ini
+ ```
diff --git a/docs/tutorials/wiki2/src/views/README.txt b/docs/tutorials/wiki2/src/views/README.txt
deleted file mode 100644
index ed6b88b49..000000000
--- a/docs/tutorials/wiki2/src/views/README.txt
+++ /dev/null
@@ -1,44 +0,0 @@
-myproj
-======
-
-Getting Started
----------------
-
-- Change directory into your newly created project if not already there. Your
- current directory should be the same as this README.txt file and setup.py.
-
- cd tutorial
-
-- Create a Python virtual environment, if not already created.
-
- python3 -m venv env
-
-- Upgrade packaging tools, if necessary.
-
- env/bin/pip install --upgrade pip setuptools
-
-- Install the project in editable mode with its testing requirements.
-
- env/bin/pip install -e ".[testing]"
-
-- Initialize and upgrade the database using Alembic.
-
- - Generate your first revision.
-
- env/bin/alembic -c development.ini revision --autogenerate -m "init"
-
- - Upgrade to that revision.
-
- env/bin/alembic -c development.ini upgrade head
-
-- Load default data into the database using a script.
-
- env/bin/initialize_tutorial_db development.ini
-
-- Run your project's tests.
-
- env/bin/pytest
-
-- Run your project.
-
- env/bin/pserve development.ini
diff --git a/docs/tutorials/wiki2/src/views/development.ini b/docs/tutorials/wiki2/src/views/development.ini
index f02c4b1b6..e7baeed37 100644
--- a/docs/tutorials/wiki2/src/views/development.ini
+++ b/docs/tutorials/wiki2/src/views/development.ini
@@ -25,16 +25,16 @@ retry.attempts = 3
[pshell]
setup = tutorial.pshell.setup
-###
-# wsgi server configuration
-###
-
[alembic]
# path to migration scripts
script_location = tutorial/alembic
file_template = %%(year)d%%(month).2d%%(day).2d_%%(rev)s
# file_template = %%(rev)s_%%(slug)s
+###
+# wsgi server configuration
+###
+
[server:main]
use = egg:waitress#main
listen = localhost:6543
diff --git a/docs/tutorials/wiki2/src/views/production.ini b/docs/tutorials/wiki2/src/views/production.ini
index f8e83f21f..f636aaba3 100644
--- a/docs/tutorials/wiki2/src/views/production.ini
+++ b/docs/tutorials/wiki2/src/views/production.ini
@@ -19,16 +19,16 @@ retry.attempts = 3
[pshell]
setup = tutorial.pshell.setup
-###
-# wsgi server configuration
-###
-
[alembic]
# path to migration scripts
script_location = tutorial/alembic
file_template = %%(year)d%%(month).2d%%(day).2d_%%(rev)s
# file_template = %%(rev)s_%%(slug)s
+###
+# wsgi server configuration
+###
+
[server:main]
use = egg:waitress#main
listen = *:6543
diff --git a/docs/tutorials/wiki2/src/views/pyproject.toml b/docs/tutorials/wiki2/src/views/pyproject.toml
new file mode 100644
index 000000000..2b054c578
--- /dev/null
+++ b/docs/tutorials/wiki2/src/views/pyproject.toml
@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+version = "0.0"
+name = "tutorial"
+authors = []
+description = "myproj"
+readme = "README.md"
+keywords = ["web", "pyramid", "pylons"]
+classifiers = [
+ "Programming Language :: Python",
+ "Programming Language :: Python :: 3",
+ "Framework :: Pyramid",
+ "Topic :: Internet :: WWW/HTTP",
+ "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
+]
+requires-python = ">=3.8"
+dependencies = [
+ "alembic",
+ "bcrypt",
+ "docutils",
+ "plaster_pastedeploy",
+ "pyramid",
+ "pyramid_debugtoolbar",
+ "pyramid_jinja2",
+ "pyramid_retry",
+ "pyramid_tm",
+ "SQLAlchemy",
+ "transaction",
+ "waitress",
+ "zope.sqlalchemy",
+]
+
+[project.optional-dependencies]
+testing = [
+ "WebTest",
+ "pytest",
+ "pytest-cov",
+]
+
+[project.scripts]
+initialize_tutorial_db = "tutorial.scripts.initialize_db:main"
+
+[project.entry-points."paste.app_factory"]
+main = "tutorial:main"
+
+[tool.setuptools.packages.find]
+exclude = ["tests"]
+
+[tool.coverage.run]
+source = "tutorial"
+
+[tool.pytest.ini_options]
+addopts = "--strict-markers"
+testpaths = [
+ "tutorial",
+ "tests",
+]
diff --git a/docs/tutorials/wiki2/src/views/pytest.ini b/docs/tutorials/wiki2/src/views/pytest.ini
deleted file mode 100644
index 3df78fe9d..000000000
--- a/docs/tutorials/wiki2/src/views/pytest.ini
+++ /dev/null
@@ -1,6 +0,0 @@
-[pytest]
-addopts = --strict-markers
-
-testpaths =
- tutorial
- tests
diff --git a/docs/tutorials/wiki2/src/views/setup.py b/docs/tutorials/wiki2/src/views/setup.py
deleted file mode 100644
index 12eabaff2..000000000
--- a/docs/tutorials/wiki2/src/views/setup.py
+++ /dev/null
@@ -1,63 +0,0 @@
-import os
-
-from setuptools import setup, find_packages
-
-here = os.path.abspath(os.path.dirname(__file__))
-with open(os.path.join(here, 'README.txt')) as f:
- README = f.read()
-with open(os.path.join(here, 'CHANGES.txt')) as f:
- CHANGES = f.read()
-
-requires = [
- 'alembic',
- 'bcrypt',
- 'docutils',
- 'plaster_pastedeploy',
- 'pyramid',
- 'pyramid_debugtoolbar',
- 'pyramid_jinja2',
- 'pyramid_retry',
- 'pyramid_tm',
- 'SQLAlchemy',
- 'transaction',
- 'waitress',
- 'zope.sqlalchemy',
-]
-
-tests_require = [
- 'WebTest',
- 'pytest',
- 'pytest-cov',
-]
-
-setup(
- name='tutorial',
- version='0.0',
- description='myproj',
- long_description=README + '\n\n' + CHANGES,
- classifiers=[
- 'Programming Language :: Python',
- 'Framework :: Pyramid',
- 'Topic :: Internet :: WWW/HTTP',
- 'Topic :: Internet :: WWW/HTTP :: WSGI :: Application',
- ],
- author='',
- author_email='',
- url='',
- keywords='web pyramid pylons',
- packages=find_packages(exclude=['tests']),
- include_package_data=True,
- zip_safe=False,
- extras_require={
- 'testing': tests_require,
- },
- install_requires=requires,
- entry_points={
- 'paste.app_factory': [
- 'main = tutorial:main',
- ],
- 'console_scripts': [
- 'initialize_tutorial_db=tutorial.scripts.initialize_db:main',
- ],
- },
-)
diff --git a/docs/tutorials/wiki2/src/views/testing.ini b/docs/tutorials/wiki2/src/views/testing.ini
index 5caa1a8dc..503cf3018 100644
--- a/docs/tutorials/wiki2/src/views/testing.ini
+++ b/docs/tutorials/wiki2/src/views/testing.ini
@@ -19,16 +19,16 @@ retry.attempts = 3
[pshell]
setup = tutorial.pshell.setup
-###
-# wsgi server configuration
-###
-
[alembic]
# path to migration scripts
script_location = tutorial/alembic
file_template = %%(year)d%%(month).2d%%(day).2d_%%(rev)s
# file_template = %%(rev)s_%%(slug)s
+###
+# wsgi server configuration
+###
+
[server:main]
use = egg:waitress#main
listen = localhost:6543
diff --git a/docs/tutorials/wiki2/src/views/tutorial/alembic/versions/20240204_07f9d6b626b2.py b/docs/tutorials/wiki2/src/views/tutorial/alembic/versions/20240204_07f9d6b626b2.py
new file mode 100644
index 000000000..329c00208
--- /dev/null
+++ b/docs/tutorials/wiki2/src/views/tutorial/alembic/versions/20240204_07f9d6b626b2.py
@@ -0,0 +1,52 @@
+"""use new models Page and User
+
+Revision ID: 07f9d6b626b2
+Revises: 4b6614165904
+Create Date: 2024-02-04 14:39:12.885858
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '07f9d6b626b2'
+down_revision = '4b6614165904'
+branch_labels = None
+depends_on = None
+
+def upgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ op.create_table('users',
+ sa.Column('id', sa.Integer(), nullable=False),
+ sa.Column('name', sa.String(), nullable=False),
+ sa.Column('role', sa.String(), nullable=False),
+ sa.Column('password_hash', sa.String(), nullable=True),
+ sa.PrimaryKeyConstraint('id', name=op.f('pk_users')),
+ sa.UniqueConstraint('name', name=op.f('uq_users_name'))
+ )
+ op.create_table('pages',
+ sa.Column('id', sa.Integer(), nullable=False),
+ sa.Column('name', sa.String(), nullable=False),
+ sa.Column('data', sa.String(), nullable=False),
+ sa.Column('creator_id', sa.Integer(), nullable=False),
+ sa.ForeignKeyConstraint(['creator_id'], ['users.id'], name=op.f('fk_pages_creator_id_users')),
+ sa.PrimaryKeyConstraint('id', name=op.f('pk_pages')),
+ sa.UniqueConstraint('name', name=op.f('uq_pages_name'))
+ )
+ op.drop_index('my_index', table_name='models')
+ op.drop_table('models')
+ # ### end Alembic commands ###
+
+def downgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ op.create_table('models',
+ sa.Column('id', sa.INTEGER(), nullable=False),
+ sa.Column('name', sa.VARCHAR(), nullable=True),
+ sa.Column('value', sa.INTEGER(), nullable=True),
+ sa.PrimaryKeyConstraint('id', name='pk_models')
+ )
+ op.create_index('my_index', 'models', ['name'], unique=1)
+ op.drop_table('pages')
+ op.drop_table('users')
+ # ### end Alembic commands ###
diff --git a/docs/tutorials/wiki2/src/views/tutorial/alembic/versions/20240204_4b6614165904.py b/docs/tutorials/wiki2/src/views/tutorial/alembic/versions/20240204_4b6614165904.py
new file mode 100644
index 000000000..4f7a97d30
--- /dev/null
+++ b/docs/tutorials/wiki2/src/views/tutorial/alembic/versions/20240204_4b6614165904.py
@@ -0,0 +1,33 @@
+"""init
+
+Revision ID: 4b6614165904
+Revises:
+Create Date: 2024-02-04 14:32:46.784813
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '4b6614165904'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+def upgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ op.create_table('models',
+ sa.Column('id', sa.Integer(), nullable=False),
+ sa.Column('name', sa.String(), nullable=True),
+ sa.Column('value', sa.Integer(), nullable=True),
+ sa.PrimaryKeyConstraint('id', name=op.f('pk_models'))
+ )
+ op.create_index('my_index', 'models', ['name'], unique=True, mysql_length=255)
+ # ### end Alembic commands ###
+
+def downgrade():
+ # ### commands auto generated by Alembic - please adjust! ###
+ op.drop_index('my_index', table_name='models', mysql_length=255)
+ op.drop_table('models')
+ # ### end Alembic commands ###
diff --git a/docs/tutorials/wiki2/src/views/tutorial/models/meta.py b/docs/tutorials/wiki2/src/views/tutorial/models/meta.py
index d659c7857..38712bfd2 100644
--- a/docs/tutorials/wiki2/src/views/tutorial/models/meta.py
+++ b/docs/tutorials/wiki2/src/views/tutorial/models/meta.py
@@ -1,16 +1,16 @@
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.schema import MetaData
+from sqlalchemy import MetaData
+from sqlalchemy.orm import DeclarativeBase
-# Recommended naming convention used by Alembic, as various different database
-# providers will autogenerate vastly different names making migrations more
-# difficult. See: https://alembic.sqlalchemy.org/en/latest/naming.html
-NAMING_CONVENTION = {
- "ix": "ix_%(column_0_label)s",
- "uq": "uq_%(table_name)s_%(column_0_name)s",
- "ck": "ck_%(table_name)s_%(constraint_name)s",
- "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
- "pk": "pk_%(table_name)s"
-}
-metadata = MetaData(naming_convention=NAMING_CONVENTION)
-Base = declarative_base(metadata=metadata)
+class Base(DeclarativeBase):
+ # Recommended naming convention used by Alembic, as various different
+ # database providers will autogenerate vastly different names making
+ # migrations more difficult.
+ # See: https://alembic.sqlalchemy.org/en/latest/naming.html
+ metadata = MetaData(naming_convention={
+ "ix": "ix_%(column_0_label)s",
+ "uq": "uq_%(table_name)s_%(column_0_name)s",
+ "ck": "ck_%(table_name)s_`%(constraint_name)s`",
+ "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
+ "pk": "pk_%(table_name)s"
+ })
diff --git a/docs/tutorials/wiki2/src/views/tutorial/models/page.py b/docs/tutorials/wiki2/src/views/tutorial/models/page.py
index 74ff1faf8..6cc9aae3c 100644
--- a/docs/tutorials/wiki2/src/views/tutorial/models/page.py
+++ b/docs/tutorials/wiki2/src/views/tutorial/models/page.py
@@ -1,10 +1,6 @@
-from sqlalchemy import (
- Column,
- ForeignKey,
- Integer,
- Text,
-)
-from sqlalchemy.orm import relationship
+import bcrypt
+from sqlalchemy import ForeignKey
+from sqlalchemy.orm import Mapped, mapped_column, relationship
from .meta import Base
@@ -12,9 +8,9 @@ from .meta import Base
class Page(Base):
""" The SQLAlchemy declarative model class for a Page object. """
__tablename__ = 'pages'
- id = Column(Integer, primary_key=True)
- name = Column(Text, nullable=False, unique=True)
- data = Column(Text, nullable=False)
+ id: Mapped[int] = mapped_column(primary_key=True)
+ name: Mapped[str] = mapped_column(unique=True)
+ data: Mapped[str]
- creator_id = Column(ForeignKey('users.id'), nullable=False)
- creator = relationship('User', backref='created_pages')
+ creator_id: Mapped[int] = mapped_column(ForeignKey('users.id'))
+ creator: Mapped['User'] = relationship(back_populates='created_pages')
diff --git a/docs/tutorials/wiki2/src/views/tutorial/models/user.py b/docs/tutorials/wiki2/src/views/tutorial/models/user.py
index 9228b48f7..926a66e64 100644
--- a/docs/tutorials/wiki2/src/views/tutorial/models/user.py
+++ b/docs/tutorials/wiki2/src/views/tutorial/models/user.py
@@ -1,9 +1,6 @@
import bcrypt
-from sqlalchemy import (
- Column,
- Integer,
- Text,
-)
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from typing import List, Optional
from .meta import Base
@@ -11,11 +8,11 @@ from .meta import Base
class User(Base):
""" The SQLAlchemy declarative model class for a User object. """
__tablename__ = 'users'
- id = Column(Integer, primary_key=True)
- name = Column(Text, nullable=False, unique=True)
- role = Column(Text, nullable=False)
+ id: Mapped[int] = mapped_column(primary_key=True)
+ name: Mapped[str] = mapped_column(unique=True)
+ role: Mapped[str]
- password_hash = Column(Text)
+ password_hash: Mapped[Optional[str]]
def set_password(self, pw):
pwhash = bcrypt.hashpw(pw.encode('utf8'), bcrypt.gensalt())
@@ -26,3 +23,5 @@ class User(Base):
expected_hash = self.password_hash.encode('utf8')
return bcrypt.checkpw(pw.encode('utf8'), expected_hash)
return False
+
+ created_pages: Mapped[List['Page']] = relationship(back_populates='creator')
diff --git a/docs/tutorials/wiki2/src/views/tutorial/views/default.py b/docs/tutorials/wiki2/src/views/tutorial/views/default.py
index df0e4cb9e..7feb6671f 100644
--- a/docs/tutorials/wiki2/src/views/tutorial/views/default.py
+++ b/docs/tutorials/wiki2/src/views/tutorial/views/default.py
@@ -6,6 +6,7 @@ from pyramid.httpexceptions import (
)
from pyramid.view import view_config
import re
+import sqlalchemy as sa
from .. import models
@@ -21,13 +22,17 @@ def view_wiki(request):
@view_config(route_name='view_page', renderer='tutorial:templates/view.jinja2')
def view_page(request):
pagename = request.matchdict['pagename']
- page = request.dbsession.query(models.Page).filter_by(name=pagename).first()
+ page = request.dbsession.scalars(
+ sa.select(models.Page).where(models.Page.name == pagename)
+ ).one_or_none()
if page is None:
raise HTTPNotFound('No such page')
def add_link(match):
word = match.group(1)
- exists = request.dbsession.query(models.Page).filter_by(name=word).all()
+ exists = request.dbsession.execute(
+ sa.select(sa.exists(models.Page)).where(models.Page.name == word)
+ ).scalar()
if exists:
view_url = request.route_url('view_page', pagename=word)
return '<a href="%s">%s</a>' % (view_url, escape(word))
@@ -43,7 +48,11 @@ def view_page(request):
@view_config(route_name='edit_page', renderer='tutorial:templates/edit.jinja2')
def edit_page(request):
pagename = request.matchdict['pagename']
- page = request.dbsession.query(models.Page).filter_by(name=pagename).one()
+ page = request.dbsession.scalars(
+ sa.select(models.Page).where(models.Page.name == pagename)
+ ).one_or_none()
+ if page is None:
+ raise HTTPNotFound('No such page')
if request.method == 'POST':
page.data = request.params['body']
next_url = request.route_url('view_page', pagename=page.name)
@@ -57,14 +66,18 @@ def edit_page(request):
@view_config(route_name='add_page', renderer='tutorial:templates/edit.jinja2')
def add_page(request):
pagename = request.matchdict['pagename']
- if request.dbsession.query(models.Page).filter_by(name=pagename).count() > 0:
+ exists = request.dbsession.execute(
+ sa.select(sa.exists(models.Page)).where(models.Page.name == pagename)
+ ).scalar()
+ if exists:
next_url = request.route_url('edit_page', pagename=pagename)
return HTTPSeeOther(location=next_url)
if request.method == 'POST':
body = request.params['body']
- page = models.Page(name=pagename, data=body)
- page.creator = (
- request.dbsession.query(models.User).filter_by(name='editor').one())
+ creator = request.dbsession.scalars(
+ sa.select(models.User).where(models.User.name == 'editor')
+ ).one()
+ page = models.Page(name=pagename, data=body, creator=creator)
request.dbsession.add(page)
next_url = request.route_url('view_page', pagename=pagename)
return HTTPSeeOther(location=next_url)