eng: fix up project configuration - BNCH-112051 #221
Conversation
eli-bl
changed the title
eli-bl
force-pushed
the
eli.bishop/BNCH-112051-packageid
branch
2 times, most recently
from
c17d5b7 to
f9d3461
Compare
| # our fork (benchling-openapi-python-client) deliberately does not match the base module name (see | ||
| # pyproject.toml) | ||
| INSTALLED_PACKAGE = "benchling-openapi-python-client" | ||
| __version__ = version(INSTALLED_PACKAGE) |
There was a problem hiding this comment.
As noted in a comment I added to pyproject.toml, we want our installable package to be called benchling-openapi-python-client, but we deliberately did not change the base module name to benchling_openapi_python_client, because for our own internal purposes we want to be able to treat this as a drop-in replacement for the upstream package. That means version(__package__) will not work because __package__ actually returns the base module name in this scenario, but version wants the installed package name.
| repository = "https://github.com/openapi-generators/openapi-python-client" | ||
|
|
||
| [project.scripts] | ||
| [tool.poetry.dependencies] |
There was a problem hiding this comment.
The dependencies in this section are exactly equivalent to the ones that the upstream package was declaring with pdm.
| ruff = ">=0.2,<0.8" | ||
| typing-extensions = ">=4.8.0,<5.0.0" | ||
|
|
||
| [tool.poetry.group.dev.dependencies] |
There was a problem hiding this comment.
The dependencies in this section are almost the same as the ones in the upstream project, except that I added python-dotenv in order to work around an issue with the test task - see old line 125.
| @@ -76,6 +91,10 @@ disallow_any_generics = true | |||
| disallow_untyped_defs = true | |||
| warn_redundant_casts = true | |||
| strict_equality = true | |||
| exclude = [ | |||
| # For unknown reasons, mypy complains about this file but doesn't complain in the upstream repo | |||
| "openapi_python_client/schema/openapi_schema_pydantic/schema.py", | |||
There was a problem hiding this comment.
This one is weird - I'm using the same version of mypy and there are no code changes, no idea why it's suddenly showing an error on this file (which I think is a spurious error, the type hint looks fine to me). But that code is old and not under active development so I'm OK with adding an exclude.
| [tool.pdm.scripts.test] | ||
| cmd = "pytest tests end_to_end_tests/test_end_to_end.py end_to_end_tests/functional_tests --basetemp=tests/tmp" | ||
| [tool.pdm.scripts.test.env] | ||
| "TEST_RELATIVE" = "true" |
There was a problem hiding this comment.
This is the reason I added python-dotenv as a dev dependency. There are some extra unit tests that only get run in CI which are enabled by setting this env var. However, we're now using taskipy instead of pdm tasks, and taskipy unfortunately has no built-in way to set env vars. So I added a .env file in the tests and added dotenv run in the test_with_coverage task below.
eli-bl
force-pushed
the
eli.bishop/BNCH-112051-packageid
branch
2 times, most recently
from
5a8524c to
f1b5332
Compare
| @@ -131,40 +131,40 @@ jobs: | |||
| - name: Set up Python | |||
| uses: actions/[email protected] | |||
| with: | |||
| python-version: "3.8" | |||
| python-version: "3.9" | |||
There was a problem hiding this comment.
The other CI jobs were already updated to 3.9 but I missed this one.
eli-bl
force-pushed
the
eli.bishop/BNCH-112051-packageid
branch
from
f1b5332 to
5a4c239
Compare
These changes are only for Benchling's internal use of the package and will not be submitted to the upstream repo. They're the prerequisites for us to be able to publish versions of the
prod/2.xfork.A couple of other, more obscure adjustments are noted in PR comments.
Note that there are still some references to pdm in the repo, but those are all related to the option of using pdm in the generated client package (the tool allows you to create packages that use poetry, pdm, or setup.py).