Add rye and ruff, and local dependency for CI and development #287

ManiMozaffar · 2024-04-28T14:27:20Z

I'm going to write tests with playwright, but before doing that, I found repo a bit messy.

~~So I used PDM as it's conventional tool in pydantic team~~
Samuel asked to use rye instead.

I added some # type ignore, because this PR was not meant to fix all types.

about Playwright and ui test, since they usually take quite long time to pass, might make more sense to use "pre push hook" instead of pre commit? I find it very annoying to have some browser running on every commit :) (ofc I can ignore it, till last push, but that's also annoying hahaha)

From samuel input, which I also very agree with, we don't need to run playwright tests on any git hooks. Only in CI :) and also a way to execute it manually. Will engineer this in next PR

codecov · 2024-04-28T15:25:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

ManiMozaffar

Only lint ci fails for strange reason.

ManiMozaffar · 2024-04-28T15:28:11Z

@sydney-runkle lmk if you agree with these changes ^ and your ideas about what i just said in my first comment so I can then start working on playwright tests :)

samuelcolvin · 2024-04-28T16:08:29Z

hi @ManiMozaffar thanks so much for contributing.

I have a few thoughts:

please lets not use PDM, we use it on Pydantic due to the complex set of dependencies but I really don't love it - I'd suggest using rye, or sticking to what we have now
Playwright tests, while useful, can be pretty frustrating - let's keep the number to a minimum
let's run playwright tests on CI, and of course via a make command, no need for anything else

(btw, we don't really have a default packaging choice right now - pydantic uses PDM, pydantic-core uses pure pip, internal stuff uses poetry, things we're about to release use rye)

samuelcolvin · 2024-04-28T16:10:05Z

Let's not switch package manager at the same time as adding playwright tests.

ManiMozaffar · 2024-04-28T16:20:04Z

Hey samuel, thanks for quick check.

please lets not use PDM, we use it on Pydantic due to the complex set of dependencies but I really don't love it - I'd suggest using rye, or sticking to what we have now

Agreed. I was wondering why you're not using rye in pydantic. I can rework PR to use rye instead. Makes much more sense. That pip dependency was kinda bad IMO.

Playwright tests, while useful, can be pretty frustrating - let's keep the number to a minimum

I also asked Sydney some days ago, she also agreed to write test. Playwright is much better than selenium and other alternatives as for my experience, being frustrating depends on the what you test, and how much you test. Testing at correct amount with correct approach, wouldn't be frustrating to maintain. frustrating to run? maybe. that's why I was kinda against running it on pre commit hook.

Let's not switch package manager at the same time as adding playwright tests.

That's why I made this PR. To first decide about package manager, then continue with writing test. Sorry for the branch name, should have renamed it.

.github/workflows/ci.yml

sydney-runkle · 2024-04-30T18:25:58Z

Ah also, looks like there are some changes with the __init__.py file with the components, likely due to my docs additions.

ManiMozaffar · 2024-04-30T19:22:16Z

Ok great, I'll rebase the branch tomorrow and do the changes requested @sydney-runkle

ManiMozaffar · 2024-05-01T13:01:23Z

@sydney-runkle build docs fails. I don't have the "PPPR_TOKEN", so I can't test and debug it locally. I'm not even sure why it's failing, it said it requires black to function, so maybe pip install black would solve it? but then why didn't it happen before this PR? i think the diagnostic might be wrong.

sydney-runkle · 2024-05-01T20:04:31Z

@sydney-runkle build docs fails. I don't have the "PPPR_TOKEN", so I can't test and debug it locally.

Ah yes, this is a barrier we need to work on. This is bc of the documentation PR that I merged recently. The local failure makes sense, but I'm not sure why it's failing on CI. I'll look into this!

sydney-runkle · 2024-05-01T20:05:49Z

@ManiMozaffar,

Are you able to repro the lint failure locally at least?

ManiMozaffar · 2024-05-01T20:08:40Z

@ManiMozaffar,

Are you able to repro the lint failure locally at least?

No

sydney-runkle · 2024-05-01T20:09:38Z

What if you try make install first to make sure that your versions are lined up?

sydney-runkle · 2024-05-01T20:10:19Z

Looks like the docs are failing on other PRs as well, so I need to fix that 🤧

sydney-runkle · 2024-05-01T20:27:45Z

Will work on the docs fix tonight. Might end up disabling the typescript docs for now until mkdocstrings-typescript has a public version.

sydney-runkle · 2024-05-01T23:56:11Z

@ManiMozaffar,

This should fix the docs issue (I'm hoping): #299.

sydney-runkle · 2024-05-02T13:00:40Z

@ManiMozaffar,

You should be able to rebase now :).

ManiMozaffar · 2024-05-04T16:52:07Z

@sydney-runkle still lint fails, not sure why. can't reproduce it locally.

Remove old dependency style .txt Add PDM to demo project and linted project with ruff Add PDM to fastui and linted project with ruff Updated gitignore with pdm stuff Fix CI/CD

ManiMozaffar · 2024-06-03T20:55:07Z

Rebased again, still happens, still can't reproduce it :/
What this is actually checking? @sydney-runkle

sydney-runkle

@ManiMozaffar,

Thanks for your initial work on this. A few notes:

Let's make sure that the pyproject.toml files only have information relevant to this project
I want to make sure we don't include any behavioral changes, just linting fixes and settings / dependency management
We might want to bump to the latest ruff version now that some new ones have been released since this PR's opening.

Ping me when you'd like another review 🚀!

sydney-runkle · 2024-06-11T02:20:13Z

demo/pyproject.toml

+    "fastapi>=0.110.2",
+    "httpx>=0.27.0",
+    "openai==1.10.0",
+    "PYjwt>=2.8.0",
+    "pydantic[email]>=2.7.1",


Are these all truly dependencies?

that's not the pyproject for fastui, that's for the demo.
Yes they're all. but it shouldn't affect anyway, because demo itself is "dev" package right? it's not that we ship it to client.

sydney-runkle · 2024-06-11T02:20:52Z

demo/pyproject.toml

+line-length = 120
+target-version = 'py38'
+lint.extend-select = ['Q', 'RUF100', 'C90', 'UP', 'I', 'D', 'T']
+lint.extend-ignore = [
+    'D100',
+    'D101',
+    'D102',
+    'D103',
+    'D104',
+    'D105',
+    'D107',
+    'D205',
+    'D415',
+    'T201',
+]
+lint.flake8-quotes = { inline-quotes = 'single', multiline-quotes = 'double' }
+lint.isort = { known-first-party = ['pydantic', 'tests'] }
+lint.mccabe = { max-complexity = 14 }
+lint.pydocstyle = { convention = 'google' }


I think we should make sure these are consistent with what we're using in pydantic in general - seems like a lot of ignores?

sydney-runkle · 2024-06-11T02:21:21Z

demo/pyproject.toml

+quote-style = 'single'
+
+[tool.coverage.run]
+source = ['pydantic']


This seems off

true my bad, i tried to copy from pydantic's rule, some were dead codes.

sydney-runkle · 2024-06-11T02:21:39Z

demo/pyproject.toml

+'docs/*' = ['D']
+'pydantic/__init__.py' = ['F405', 'F403', 'D']
+'tests/test_forward_ref.py' = ['F821']
+'tests/*' = ['D']
+'pydantic/deprecated/*' = ['D']
+'pydantic/json_schema.py' = ['D']
+
+[tool.ruff.lint.extend-per-file-ignores]
+"docs/**/*.py" = ['T']
+"tests/**/*.py" = ['T', 'E721', 'F811']
+"tests/benchmarks/test_fastapi_startup_generics.py" = ['UP006', 'UP007']
+"tests/benchmarks/test_fastapi_startup_simple.py" = ['UP006', 'UP007']


Same here - we don't need these in this repo

sydney-runkle · 2024-06-11T02:23:00Z

demo/src/tables.py

+    user = users[id - 1] if id <= len(users) else None
+    if user is None:
+        return demo_page(
+            *tabs(),
+            c.Text(text='User not found.'),
+            title='User not found',
+        )
+


I'd prefer if we don't have any behavioral changes in this PR - just linting fixes!

True, but that's also on demo. It doesn't affect the real package.
Side note -> this change was made to fix type check issues Otherwise i'd have to use # type: ignore

sydney-runkle · 2024-06-11T02:24:08Z

demo/pyproject.toml

+description = 'FastUI demo project'
+authors = [{ name = 'Samuel Colvin', email = 's@muelcolvin.com' }]
+classifiers = [
+    'Development Status :: 5 - Production/Stable',


Is it? Haha

sydney-runkle · 2024-06-11T02:24:45Z

src/python-fastui/pyproject.toml

+[tool.ruff.lint.per-file-ignores]
+'docs/*' = ['D']
+'pydantic/__init__.py' = ['F405', 'F403', 'D']
+'tests/test_forward_ref.py' = ['F821']
+'tests/*' = ['D']
+'pydantic/deprecated/*' = ['D']
+'pydantic/json_schema.py' = ['D']
+
+[tool.ruff.lint.extend-per-file-ignores]
+"docs/**/*.py" = ['T']
+"tests/**/*.py" = ['T', 'E721', 'F811']
+"tests/benchmarks/test_fastapi_startup_generics.py" = ['UP006', 'UP007']
+"tests/benchmarks/test_fastapi_startup_simple.py" = ['UP006', 'UP007']


Same thing, we'll want to clean these files up

elephantum · 2024-08-24T09:58:04Z

For completeness I think this link belongs here: astral-sh/rye#1164 (comment)

Seems like rye would be mostly in maintenance mode

ManiMozaffar changed the title ~~Use PDM and local dependency~~ Use PDM and local dependency for demo project Apr 28, 2024

ManiMozaffar force-pushed the add-ui-tests branch 7 times, most recently from 26240c0 to 1c3d6cb Compare April 28, 2024 14:59

ManiMozaffar marked this pull request as draft April 28, 2024 15:02

ManiMozaffar force-pushed the add-ui-tests branch 2 times, most recently from 8b643dc to 7e3fac2 Compare April 28, 2024 15:04

ManiMozaffar marked this pull request as ready for review April 28, 2024 15:04

ManiMozaffar force-pushed the add-ui-tests branch 4 times, most recently from b9a46e3 to 130c0ee Compare April 28, 2024 15:23

ManiMozaffar commented Apr 28, 2024

View reviewed changes

ManiMozaffar marked this pull request as draft April 29, 2024 02:43

ManiMozaffar force-pushed the add-ui-tests branch 3 times, most recently from 130c0ee to faa5697 Compare April 29, 2024 03:00

ManiMozaffar changed the title ~~Use PDM and local dependency for demo project~~ Use rye and local dependency for demo project Apr 29, 2024

ManiMozaffar marked this pull request as ready for review April 29, 2024 03:38

ManiMozaffar force-pushed the add-ui-tests branch from c0207fe to 4df4410 Compare April 29, 2024 03:41

ManiMozaffar commented Apr 29, 2024

View reviewed changes

.github/workflows/ci.yml Show resolved Hide resolved

ManiMozaffar changed the title ~~Use rye and local dependency for python projects~~ Add rye and ruff, and local dependency in CI and development May 1, 2024

ManiMozaffar changed the title ~~Add rye and ruff, and local dependency in CI and development~~ Add rye and ruff, and local dependency forCI and development May 1, 2024

ManiMozaffar changed the title ~~Add rye and ruff, and local dependency forCI and development~~ Add rye and ruff, and local dependency for CI and development May 1, 2024

ManiMozaffar force-pushed the add-ui-tests branch from e71ebb1 to e43e0ed Compare May 1, 2024 12:56

ManiMozaffar requested a review from sydney-runkle May 1, 2024 12:56

ManiMozaffar force-pushed the add-ui-tests branch from e43e0ed to 06888e7 Compare May 3, 2024 14:58

ManiMozaffar added 8 commits June 3, 2024 22:49

Add PDM as dependency manager

ce4294d

Remove old dependency style .txt Add PDM to demo project and linted project with ruff Add PDM to fastui and linted project with ruff Updated gitignore with pdm stuff Fix CI/CD

Skip CI on draft PRs

8afd8bb

Change pdm to rye

d2e76c5

Setup rye on ci/cd

87c7edf

Update ci to pin python version

c5f4736

Add use-uv to the behavior

732c7ad

Clean leftover pdm stuff

c373b88

Fixed type issues and left detailed comments for unresolved issues

fd55b2a

ManiMozaffar force-pushed the add-ui-tests branch from 06888e7 to fd55b2a Compare June 3, 2024 20:49

sydney-runkle reviewed Jun 11, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add rye and ruff, and local dependency for CI and development #287

Add rye and ruff, and local dependency for CI and development #287

ManiMozaffar commented Apr 28, 2024 •

edited

Loading

codecov bot commented Apr 28, 2024

ManiMozaffar left a comment

ManiMozaffar commented Apr 28, 2024

samuelcolvin commented Apr 28, 2024

samuelcolvin commented Apr 28, 2024

ManiMozaffar commented Apr 28, 2024 •

edited

Loading

sydney-runkle commented Apr 30, 2024

ManiMozaffar commented Apr 30, 2024

ManiMozaffar commented May 1, 2024

sydney-runkle commented May 1, 2024

sydney-runkle commented May 1, 2024

ManiMozaffar commented May 1, 2024

sydney-runkle commented May 1, 2024

sydney-runkle commented May 1, 2024

sydney-runkle commented May 1, 2024

sydney-runkle commented May 1, 2024

sydney-runkle commented May 2, 2024

ManiMozaffar commented May 4, 2024

ManiMozaffar commented Jun 3, 2024

sydney-runkle left a comment

sydney-runkle Jun 11, 2024

ManiMozaffar Jun 11, 2024

sydney-runkle Jun 11, 2024

sydney-runkle Jun 11, 2024

ManiMozaffar Jun 11, 2024

sydney-runkle Jun 11, 2024

sydney-runkle Jun 11, 2024

ManiMozaffar Jun 11, 2024

sydney-runkle Jun 11, 2024

sydney-runkle Jun 11, 2024

elephantum commented Aug 24, 2024

Add rye and ruff, and local dependency for CI and development #287

Are you sure you want to change the base?

Add rye and ruff, and local dependency for CI and development #287

Conversation

ManiMozaffar commented Apr 28, 2024 • edited Loading

codecov bot commented Apr 28, 2024

Codecov Report

ManiMozaffar left a comment

Choose a reason for hiding this comment

ManiMozaffar commented Apr 28, 2024

samuelcolvin commented Apr 28, 2024

samuelcolvin commented Apr 28, 2024

ManiMozaffar commented Apr 28, 2024 • edited Loading

sydney-runkle commented Apr 30, 2024

ManiMozaffar commented Apr 30, 2024

ManiMozaffar commented May 1, 2024

sydney-runkle commented May 1, 2024

sydney-runkle commented May 1, 2024

ManiMozaffar commented May 1, 2024

sydney-runkle commented May 1, 2024

sydney-runkle commented May 1, 2024

sydney-runkle commented May 1, 2024

sydney-runkle commented May 1, 2024

sydney-runkle commented May 2, 2024

ManiMozaffar commented May 4, 2024

ManiMozaffar commented Jun 3, 2024

sydney-runkle left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elephantum commented Aug 24, 2024

ManiMozaffar commented Apr 28, 2024 •

edited

Loading

ManiMozaffar commented Apr 28, 2024 •

edited

Loading