Add more explicit information about differences between WBI/WDI #466
Conversation
|
Found typo "lack to" -> lack the |
README.md
Outdated
| The main differences between these two libraries are : | ||
|
|
||
| * A complete rewrite of the library with an object-oriented architecture allowing for easy interaction, data validation | ||
| and extended functionality |
There was a problem hiding this comment.
WikdataIntegrator is also object-oriented (e.g. the WDProperty class inherits from WDBaseDataType), how is WikibaseIntegrator more object-oriented? How does WBI allow for easy interaction? What is meant by data validation? I don't think this library implements property constraints or entity schemas? What is meant by extended functionality? Can I implement my own entity type without having to patch WBI?
README.md
Outdated
|
|
||
| * A complete rewrite of the library with an object-oriented architecture allowing for easy interaction, data validation | ||
| and extended functionality | ||
| * Add support for reading and writing Lexeme, MediaInfo and Property datatypes |
There was a problem hiding this comment.
I think you are confusing data types with entity types. WDI according to its README does claim to support the Lexeme and Property data types. Also MediaInfo is not a built-in entity type, it is implemented by the Extension:WikibaseMediaInfo ... I think for everything supported by another extension you should mention which extension that is because users might not be familiar with the extra data/entity types.
There was a problem hiding this comment.
Yes, I mixed up datatype and entity.
WDI support Lexeme and Property as datatypes but not as entities, there's no WDPropertyEngine or WDLexemeEngine (like the WDItemEngine).
README.md
Outdated
| * A complete rewrite of the library with an object-oriented architecture allowing for easy interaction, data validation | ||
| and extended functionality | ||
| * Add support for reading and writing Lexeme, MediaInfo and Property datatypes | ||
| * Add support for [Structured Data on Commons](https://commons.wikimedia.org/wiki/Commons:Structured_data) (SDC) |
There was a problem hiding this comment.
Isn't SDC just another Wikibase instance? How does WBI support SDC specifically?
There was a problem hiding this comment.
SDC makes some changes between "claims" and "statements" fields when you compare with a default Wikibase.
There was a problem hiding this comment.
Interesting! Are these differences documented anywhere?
There was a problem hiding this comment.
You can found more informations and history in this phabricator task:
https://phabricator.wikimedia.org/T149410
But during my search of this information, I found that Andra added SDC support to WDI, with the sdc_core.py
README.md
Outdated
| * Add support for reading and writing Lexeme, MediaInfo and Property datatypes | ||
| * Add support for [Structured Data on Commons](https://commons.wikimedia.org/wiki/Commons:Structured_data) (SDC) | ||
| * Python 3.7 to 3.11 support, validated with unit tests | ||
| * Type hints implementation for arguments and return |
There was a problem hiding this comment.
I see that the library uses **kwargs: Any several times ... this very much negates a big advantage from parameter type hints, since when you mistype a parameter, nothing will complain. I also see json_data: Dict[str, Any] ... I don't think using Any there is necessary either ... you should be able to express a JsonType.
There are several static type checkers for Python, you could mention that you use mypy.
README.md
Outdated
| * Add support for [Structured Data on Commons](https://commons.wikimedia.org/wiki/Commons:Structured_data) (SDC) | ||
| * Python 3.7 to 3.11 support, validated with unit tests | ||
| * Type hints implementation for arguments and return | ||
| * Improved login methods (OAuth 2.0, OAuth 1.0a, bot password and login/password) |
There was a problem hiding this comment.
What do you mean "improved"? Were these newly implemented? Doesn't WBI support these?
There was a problem hiding this comment.
Did you mean WDI? At the point of forking WDI was in another state than it seems to be now.
Maybe this fork sparked changes to WDI or some of the improvements has been ported back?
There was a problem hiding this comment.
Ah yes I meant WDI. Ok the WDI README only mentions username+password and OAuth1, so it seems like it doesn't support OAuth 2.0 ... I think it would make sense to highlight the differences to WDI. I have no clue what OAuth 1.0a is supposed to be.
LeMyst
force-pushed
the
update-readme-wdi
branch
from
0efcac3
to
5553c6c
Compare
|
LGTM 😀 |
|
Typo can found -> can find |
No description provided.