Ensure wheel distribution includes pydantic shim #243
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…chance
The pydantic shim we provide alongside the dbt-semantic-interfaces package is
installed outside of the dbt-semantif-interfaces by pip. That is when the
wheel is installed the venv lib looks something like
```
venv/
...
lib/
...other packages
dbt-semantic-interfaces
...other packages
pydantic_shim.py
...
```
The problem with this is that if another package is installed which also provides
a pydantic shim, we risk a name collision. Put another way if `package_foo` and
`dbt-semantic-interfaces` both provide a `pydantic_shim.py` alongside their package,
then pip will likely be unhappy. To avoid this we've renamed our shim to
`dsi_pydantic_shim.py` to denote our shim as being specific to dbt-semantic-interfaces.
…building Previously we weren't specifying what was to be included in the wheel build, thus the wheel distribution was going through the default paths, which were as documented [here](https://hatch.pypa.io/1.9/plugins/builder/wheel/#default-file-selection) * <NAME>/__init__.py * src/<NAME>/__init__.py * <NAME>.py * <NAMESPACE>/<NAME>/__init__.py This meant that our pydantic shim was being excluded. This commit alters the pyproject.toml to now begin specifying the packages to be included in the wheel distribution, and notably adds our pydantic shim to it.
QMalcolm
changed the title
MichelleArk
approved these changes
Jan 4, 2024
QMalcolm
deleted the
qmalcolm--241-ensure-wheel-distribution-includes-pydantic-shim
branch
QMalcolm
added a commit
that referenced
this pull request
Jan 8, 2024
[BACKPORT] #243 to 0.4.latest (wheel distribution fix)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #241
Description
To ensure the pydantic shim was included in the wheel distribution we had to explicitly set what packages we wanted to be included for the wheel in the
pyproject.toml.Manual Testing
Basic testing
hatch buildin my localdbt_semantic_interfacesrepositorypip uninstall dbt-semantic-interfacespip install /Users/quigleymalcolm/Developer/dbt-labs/dbt-semantic-interfaces/dist/dbt_semantic_interfaces-0.5.0a2-py3-none-any.whldbt-semantic-interfacesanddsi_pydantic_shim.pywere present indbt-core/venv/lib/python3.8/site-packages/Functionally testing
(This requires at least step 1 from the basic testing)
core/setup.pyto use my local dbt-semantic interfaces wheela. update the dependency from
"dbt-semantic-interfaces~=0.5.0a2"to"dbt-semantic-interfaces"in theinstall_requiresparamb. added the following param/value
dependency_links=["/Users/quigleymalcolm/Developer/dbt-labs/dbt-semantic-interfaces/dist/dbt_semantic_interfaces-0.5.0a2-py3-none-any.whl"]to the setup configrm -rf .toxin dbt-coremake testdbt-semantic-interfacesanddsi_pydantic_shim.pywere in the tox cache.tox/py/lib/python3.8/site-packages/Checklist
changie newto create a changelog entry