diff options
Diffstat (limited to 'docs/tutorials/wiki2/src/models')
17 files changed, 251 insertions, 170 deletions
diff --git a/docs/tutorials/wiki2/src/models/.coveragerc b/docs/tutorials/wiki2/src/models/.coveragerc deleted file mode 100644 index 5db0e79cf..000000000 --- a/docs/tutorials/wiki2/src/models/.coveragerc +++ /dev/null @@ -1,2 +0,0 @@ -[run] -source = tutorial diff --git a/docs/tutorials/wiki2/src/models/CHANGES.txt b/docs/tutorials/wiki2/src/models/CHANGES.txt deleted file mode 100644 index 14b902fd1..000000000 --- a/docs/tutorials/wiki2/src/models/CHANGES.txt +++ /dev/null @@ -1,4 +0,0 @@ -0.0 ---- - -- Initial version. diff --git a/docs/tutorials/wiki2/src/models/MANIFEST.in b/docs/tutorials/wiki2/src/models/MANIFEST.in index b4624fd1c..201692c1b 100644 --- a/docs/tutorials/wiki2/src/models/MANIFEST.in +++ b/docs/tutorials/wiki2/src/models/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/models/README.md b/docs/tutorials/wiki2/src/models/README.md new file mode 100644 index 000000000..5ac1209d0 --- /dev/null +++ b/docs/tutorials/wiki2/src/models/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/models/README.txt b/docs/tutorials/wiki2/src/models/README.txt deleted file mode 100644 index ed6b88b49..000000000 --- a/docs/tutorials/wiki2/src/models/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/models/development.ini b/docs/tutorials/wiki2/src/models/development.ini index f02c4b1b6..e7baeed37 100644 --- a/docs/tutorials/wiki2/src/models/development.ini +++ b/docs/tutorials/wiki2/src/models/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/models/production.ini b/docs/tutorials/wiki2/src/models/production.ini index f8e83f21f..f636aaba3 100644 --- a/docs/tutorials/wiki2/src/models/production.ini +++ b/docs/tutorials/wiki2/src/models/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/models/pyproject.toml b/docs/tutorials/wiki2/src/models/pyproject.toml new file mode 100644 index 000000000..973944f98 --- /dev/null +++ b/docs/tutorials/wiki2/src/models/pyproject.toml @@ -0,0 +1,59 @@ +[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", + "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/models/pytest.ini b/docs/tutorials/wiki2/src/models/pytest.ini deleted file mode 100644 index 3df78fe9d..000000000 --- a/docs/tutorials/wiki2/src/models/pytest.ini +++ /dev/null @@ -1,6 +0,0 @@ -[pytest] -addopts = --strict-markers - -testpaths = - tutorial - tests diff --git a/docs/tutorials/wiki2/src/models/setup.py b/docs/tutorials/wiki2/src/models/setup.py deleted file mode 100644 index fbd848136..000000000 --- a/docs/tutorials/wiki2/src/models/setup.py +++ /dev/null @@ -1,62 +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', - '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/models/testing.ini b/docs/tutorials/wiki2/src/models/testing.ini index 5caa1a8dc..503cf3018 100644 --- a/docs/tutorials/wiki2/src/models/testing.ini +++ b/docs/tutorials/wiki2/src/models/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/models/tutorial/alembic/versions/20240204_07f9d6b626b2.py b/docs/tutorials/wiki2/src/models/tutorial/alembic/versions/20240204_07f9d6b626b2.py new file mode 100644 index 000000000..329c00208 --- /dev/null +++ b/docs/tutorials/wiki2/src/models/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/models/tutorial/alembic/versions/20240204_4b6614165904.py b/docs/tutorials/wiki2/src/models/tutorial/alembic/versions/20240204_4b6614165904.py new file mode 100644 index 000000000..4f7a97d30 --- /dev/null +++ b/docs/tutorials/wiki2/src/models/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/models/tutorial/models/meta.py b/docs/tutorials/wiki2/src/models/tutorial/models/meta.py index d659c7857..38712bfd2 100644 --- a/docs/tutorials/wiki2/src/models/tutorial/models/meta.py +++ b/docs/tutorials/wiki2/src/models/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/models/tutorial/models/page.py b/docs/tutorials/wiki2/src/models/tutorial/models/page.py index 74ff1faf8..6cc9aae3c 100644 --- a/docs/tutorials/wiki2/src/models/tutorial/models/page.py +++ b/docs/tutorials/wiki2/src/models/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/models/tutorial/models/user.py b/docs/tutorials/wiki2/src/models/tutorial/models/user.py index 9228b48f7..926a66e64 100644 --- a/docs/tutorials/wiki2/src/models/tutorial/models/user.py +++ b/docs/tutorials/wiki2/src/models/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/models/tutorial/views/default.py b/docs/tutorials/wiki2/src/models/tutorial/views/default.py index a0f654d38..3eeb7f26d 100644 --- a/docs/tutorials/wiki2/src/models/tutorial/views/default.py +++ b/docs/tutorials/wiki2/src/models/tutorial/views/default.py @@ -1,6 +1,6 @@ from pyramid.view import view_config from pyramid.response import Response -from sqlalchemy.exc import SQLAlchemyError +import sqlalchemy as sa from .. import models @@ -8,9 +8,9 @@ from .. import models @view_config(route_name='home', renderer='tutorial:templates/mytemplate.jinja2') def my_view(request): try: - query = request.dbsession.query(models.MyModel) - one = query.filter(models.MyModel.name == 'one').one() - except SQLAlchemyError: + query = sa.select(models.MyModel).where(models.MyModel.name == 'one') + one = request.dbsession.execute(query).scalar_one() + except sa.exc.SQLAlchemyError: return Response(db_err_msg, content_type='text/plain', status=500) return {'one': one, 'project': 'myproj'} |