chore(tests): Add basic test for litestar example

[sherbang]

Pull Request Checklist

• New code has 100% test coverage
• (If applicable) The prose documentation has been updated to reflect the changes introduced by this PR
• (If applicable) The reference documentation has been updated to reflect the changes introduced by this PR
• [ x ] Pre-Commit Checks were ran and passed
• Tests were ran and passed

Description

• Add test for litestar example

This test was developed to test, and is currently failing due to #147. It seems like it would also be useful in the future to make sure that the documented example is kept up to date.

Close Issue(s)

[sourcery-ai]

Hey @sherbang - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟡 Testing: 3 issues found
• 🟢 Complexity: all looks good
• 🟢 Docstrings: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[cofin]

Thanks for the additional tests.

To make this work on 3.8 we'll have to update the hints used in the example file. Alternately, we could limit this test to only run in the main environment if we didn't want to update the type hints.

I'm good with either solution on this.

Thanks again!

[sherbang]

The litestar example was quite broken. The pydantic models were not able to handle the UUID type from uuid_utils.

I noticed a comment in here about using pydantic models to not add confusion with DTOs, but I think that's only true for someone who is very proficient with Pydantic. There was quite a lot of code that was just converting between model types. To me, this code seems simpler, and DTOs are a good concept to learn if working with Litestar. However, I've pulled out a lot of hair in the past getting Pydantic to properly handle custom types in the past, so adding that would definitely push the Pydantic version over the edge in terms of being more complex.

I'll address the python 3.8 type annotation issue tomorrow. I expect I'll take the option of limiting this test to only run on main, I just need to figure out how to do that.

[github-actions]

Documentation preview will be available shortly at https://jolt-org.github.io/advanced-alchemy-docs-preview/148