Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make FTM cross-compatible with SQLAlchemy 1.4 and 2+ #1181

Merged
merged 7 commits into from
Aug 10, 2023
Merged

Make FTM cross-compatible with SQLAlchemy 1.4 and 2+ #1181

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4874aa8
Set server side cursors (compat. 1/4+)
catileptic Jul 21, 2023
9cf5829
Fixes mypy error
catileptic Jul 27, 2023
b3753c9
Bump versions for normality and banal
catileptic Aug 8, 2023
f5efc75
Set minimum version for SQLAlchemy to be the same as for dataset
catileptic Aug 8, 2023
5008062
Merge branch 'main' into chore/sqlalchemy-crosscompatibility
catileptic Aug 8, 2023
33c53e1
Restore max version for click to a version beyond the latest one publ…
catileptic Aug 9, 2023
0c6402d
Increase minimum version of SQLAlchemy to 1.4.49
catileptic Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Copy link
Contributor

@tillprochaska tillprochaska Aug 9, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a particular reason why the version constraints for normality, banal, click had to change? I don’t mind the version bumps being included in this PR, I was just wondering about the reason behind it…

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed click, that was a mistake (not a terrible one, it current constraint just crapped click below the latest version).

banal and normality are libs we created. I bumped the minimum version to the latest version. Both of these were giving me dependency clashes with memorious.

Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"requests >= 2.21.0, < 3.0.0",
"python-levenshtein >= 0.12.0, < 1.0.0",
"normality >= 2.4.0, < 3.0.0",
"sqlalchemy >= 1.2.0, < 3.0.0",
"sqlalchemy >= 1.3.2, < 3.0.0",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn’t this require at least 1.4 (which is the first version that supports the 2.0 API)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't increase it yet to 1.4 because I still have the lingering issue of tests in dataset failing for SQLAlchemy version 1.4.49. Not knowing the reason behind it yet, I didn't want to break these libs for anyone using them in a way that triggers this issue.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaving it at >= 1.3.2 can cause runtime errors though:

pip install "SQLAlchemy==1.3.2" "git+https://github.com/alephdata/followthemoney.git@chore/sqlalchemy-crosscompatibility"
ftm map mapping.yml

Traceback (most recent call last):
  File "/Users/tillprochaska/git/ftm-sqa-test/venv/bin/ftm", line 33, in <module>
    sys.exit(load_entry_point('followthemoney==3.5.1', 'console_scripts', 'ftm')())
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/tillprochaska/git/ftm-sqa-test/venv/bin/ftm", line 25, in importlib_load_entry_point
    return next(matches).load()
           ^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/python@3.11/3.11.4_1/Frameworks/Python.framework/Versions/3.11/lib/python3.11/importlib/metadata/__init__.py", line 202, in load
    module = import_module(match.group('module'))
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/python@3.11/3.11.4_1/Frameworks/Python.framework/Versions/3.11/lib/python3.11/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1204, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1176, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1126, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1204, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1176, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1126, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1204, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1176, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1147, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 690, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 940, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "/Users/tillprochaska/git/ftm-sqa-test/venv/lib/python3.11/site-packages/followthemoney/__init__.py", line 3, in <module>
    from followthemoney.model import Model
  File "/Users/tillprochaska/git/ftm-sqa-test/venv/lib/python3.11/site-packages/followthemoney/model.py", line 9, in <module>
    from followthemoney.mapping import QueryMapping
  File "/Users/tillprochaska/git/ftm-sqa-test/venv/lib/python3.11/site-packages/followthemoney/mapping/__init__.py", line 1, in <module>
    from followthemoney.mapping.query import QueryMapping
  File "/Users/tillprochaska/git/ftm-sqa-test/venv/lib/python3.11/site-packages/followthemoney/mapping/query.py", line 6, in <module>
    from followthemoney.mapping.sql import SQLSource
  File "/Users/tillprochaska/git/ftm-sqa-test/venv/lib/python3.11/site-packages/followthemoney/mapping/sql.py", line 7, in <module>
    from sqlalchemy.future import select
ModuleNotFoundError: No module named 'sqlalchemy.future'

Whereas with SQLAlchemy >= 1.4, < 2 this works as expected. I don’t think this would affect us, as far as I can see the pipelines image for example already resolves SQLAlchemy to 1.4.x. So if you think it’s necessary to keep 1.3 go ahead, but it still feels a bit wrong publishing dependency constraints that could cause runtime errors.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the minimum SQLAlchemy version. I think you're right, this might affect anyone running FTM on its own, or in conjuncture with other scripts. I re-build memorious and it builds fine, I re-ran a memorious test and it works.

"countrynames >= 1.13.0, < 2.0.0",
"languagecodes >= 1.1.0, < 2.0.0",
"prefixdate >= 0.4.0, < 1.0.0",
Expand Down