Types in examples

[ivanthewebber]

Some of the example code blocks in the README.md are unclear because either some identifiers are not defined in the code block or the types are not explicit.

For example in this code block:

def load_database(**kwargs):
    connection = f"postgresql+psycopg2://{kwargs['user']}:@{kwargs['host']}:{kwargs['port']}/{kwargs['dbname']}"
    engine = create_engine(connection)
    Base.metadata.create_all(engine)
    session = scoped_session(sessionmaker(bind=engine))
    # add things to session
    session.commit()

postgresql_proc = factories.postgresql_proc(load=[load_database])

postgresql = factories.postgresql('postgresql_proc') # still need to check if this is actually needed or not

@pytest.fixture
def dbsession(postgresql): # FIXME what type hint here?
    connection = f'postgresql+psycopg2://{postgresql.info.user}:@{postgresql.info.host}:{postgresql.info.port}/{postgresql.info.dbname}'
    engine = create_engine(connection)

    session = scoped_session(sessionmaker(bind=engine))

    yield session
    # 'Base.metadata.drop_all(engine)' here specifically does not work. It is also not needed. If you leave out the session.close()
    # all the tests still run, but you get a warning/error at the end of the tests.
    session.close()

What would be a proper type hint for the postgresql parameter?
Also, some more imports could make it more clear.

[ivanthewebber]

It's also be great if some of the recommended settings for tests could be applied: https://stackoverflow.com/questions/9407442/optimise-postgresql-for-fast-testing

[ivanthewebber]

As a note; the links to examples for sqlalchemy (pyramid) do not use pytest_postgresql anymore. I'm guessing the lack of async support was prohibitive. So when updating the docs it'd be good to link to a new example.

[fizyk]

As a note; the links to examples for sqlalchemy (pyramid) do not use pytest_postgresql anymore. I'm guessing the lack of async support was prohibitive. So when updating the docs it'd be good to link to a new example.

Which links?

[fizyk]

It's also be great if some of the recommended settings for tests could be applied: https://stackoverflow.com/questions/9407442/optimise-postgresql-for-fast-testing

That should be possible to configure, see startparams and postgres_options configuration options.

[ivanthewebber]

Awesome, thanks. I think the annotation as Iterator not Generator threw me off, but having the Connection type hint will make it clear and easy to inspect in the IDE

[fizyk]

Awesome, thanks. I think the annotation as Iterator not Generator threw me off, but having the Connection type hint will make it clear and easy to inspect in the IDE

Can't remember why I used Iterator, maybe because generators are iterators and it's a bit clearer with only single type defined....