search

aleph-im / aleph-sdk-python

Python SDK library for the Aleph.im network
MIT License
2 stars 4 forks source link

[Feature] Deprecation messages for invalid imports #94

Closed MHHukiewitz closed 5 months ago

MHHukiewitz commented 5 months ago

Update Aleph SDK client to raise ImportError with appropriate error message for deprecated classes and types.

github-actions[bot] commented 5 months ago

The PR introduces a significant amount of changes to the aleph-sdk-python library, including deprecation and removal of several classes and methods. This is likely to have a high impact on the codebase as it involves major refactoring and potential breaking changes.

Here are some key points:

  1. The AlephClient and AuthenticatedAlephClient classes have been deprecated, with suggested replacements being AlephHttpClient and AuthenticatedAlephHttpClient respectively. This could potentially break existing code that directly imports these classes.
  2. The synchronous and asynchronous types have also been removed from the library.
  3. Several methods in the AbstractAlephClient class are now raising an ImportError suggesting they should be imported as AlephHttpClient or AuthenticatedAlephHttpClient instead.
  4. The PR introduces a new method ipfs_push(self, content: Mapping) -> str which is likely to have implications for the IPFS integration in the library.
  5. There are also several tests added and existing ones modified, suggesting that thorough testing has been considered before merging this PR.

Given these points, it's recommended to review this PR carefully and consider its potential impact on other parts of the codebase or future development. The PR author should be consulted for any specific rules or guidelines related to this categorization.

Please note that while I have provided a general assessment based on the diff and the changes, it's always best to discuss these changes with the team responsible for maintaining the library to ensure they are compatible with your project's needs.

hoh commented 5 months ago

Needs squashing ;-)

MHHukiewitz commented 5 months ago

A shit, I merged it with the GitHub Mobile App, and it just went the lazy route T.T