issue_comments

I did a bunch of work on this in #266. The library is now pretty thoroughly typed, and I even found a couple of bugs using mypy along the way: #313 and #315.

Maybe I could release a separate Python package types-sqlite-utils-numpy which adds an over-ridden type definition that includes the numpy types?

Twitter conversation about how to add types to the .create_table(columns=) parameter: https://twitter.com/simonw/status/1408532867592818693

Anyone know how to write a mypy type definition for this?

{"id": int, "name": str, "image": bytes, "weight": float}

It's a dict where keys are strings and values are one of int/str/bytes/float (weird API design I know, but I designed this long before I was thinking about mypy)

Looks like this could work:

python def create_table( self, name, columns: Dict[str, Union[Type[int], Type[bytes], Type[str], Type[float]]], pk=None, foreign_keys=None, column_order=None, not_null=None, defaults=None, hash_id=None, extracts=None, ): Except... that method can optionally also accept numpy types if numpy is installed. I don't know if it's possible to dynamically change a signature based on an import, since mypy is a static type analyzer and doesn't ever execute the code.

Here's a magic incantation for generating types detected through running the tests with https://github.com/Instagram/MonkeyType

pip install pytest-monkeytype pytest --monkeytype-output=./monkeytype.sqlite3 monkeytype list-modules monkeytype apply sqlite_utils.utils monkeytype apply sqlite_utils.cli monkeytype apply sqlite_utils.db

Here's the result: https://github.com/simonw/sqlite-utils/commit/d18c694fc25b7dd3d76e250c77ddf56d10ddf935

Interestingly if I run that against my monkeytype branch I get the following errors (subset): _______________________________________________________________________________________ mypy db.py ________________________________________________________________________________________ sqlite_utils/db.py:15: error: No library stub file for module 'numpy' sqlite_utils/db.py:15: note: (Stub files are from https://github.com/python/typeshed) sqlite_utils/db.py:197: error: Incompatible types in assignment (expression has type "Union[Dict[str, int], Dict[str, Union[int, str]], Dict[str, str], Dict[<nothing>, <nothing>]]", variable has type "Union[Dict[str, int], Dict[str, Union[int, str]], Dict[str, str], None]") sqlite_utils/db.py:204: error: Item "None" of "Union[Dict[str, int], Dict[str, Union[int, str]], Dict[str, str], None]" has no attribute "__iter__" (not iterable) sqlite_utils/db.py:206: error: Argument 1 to "set" has incompatible type "Union[Dict[str, int], Dict[str, Union[int, str]], Dict[str, str], None]"; expected "Iterable[str]" sqlite_utils/db.py:211: error: Item "None" of "Optional[Tuple[str, str, str]]" has no attribute "index" sqlite_utils/db.py:211: error: Unsupported right operand type for in ("Optional[Tuple[str, str, str]]") sqlite_utils/db.py:232: error: Unsupported right operand type for in ("Union[Dict[str, int], Dict[str, Union[int, str]], Dict[str, str], None]") sqlite_utils/db.py:234: error: Value of type "Union[Dict[str, int], Dict[str, Union[int, str]], Dict[str, str], None]" is not indexable sqlite_utils/db.py:307: error: Need type annotation for 'table_sql' (hint: "table_sql: Dict[<type>, <type>] = ...") sqlite_utils/db.py:427: error: Item "int" of "Union[int, None, str]" has no attribute "startswith" sqlite_utils/db.py:427: error: Item "None" of "Union[int, None, str]" has no attribute "startswith" sqlite_utils/db.py:434: error: Incompatible types in assignment (expression has type "List[Any]", target has type "int") sqlite_utils/db.py:438: error: Incompatible types in assignment (expression has type "object", target has type "int") sqlite_utils/db.py:670: error: Need type annotation for 'all_column_types' (hint: "all_column_types: Dict[<type>, <type>] = ...") sqlite_utils/db.py:757: error: Incompatible types in assignment (expression has type "List[Any]", variable has type "chain[Any]") sqlite_utils/db.py:761: error: Argument 1 to "create" of "Table" has incompatible type "Dict[str, Union[Type[str], Type[int], Type[bool], Type[time], Type[float]]]"; expected "Dict[str, Union[Type[str], Type[int], Type[bool], Type[time]]]" sqlite_utils/db.py:770: error: Need type annotation for 'all_columns' (hint: "all_columns: Set[<type>] = ...") sqlite_utils/db.py:773: error: Incompatible types in assignment (expression has type "List[Any]", variable has type "Set[Any]") sqlite_utils/db.py:775: error: "Set[Any]" has no attribute "insert" sqlite_utils/db.py:797: error: Need type annotation for 'values' (hint: "values: List[<type>] = ...") sqlite_utils/db.py:811: error: Argument 1 to "add_missing_columns" of "Table" has incompatible type "chain[Any]"; expected "Union[List[Union[Dict[str, Union[int, str]], Dict[str, Union[int, str, List[str]]]]], List[Dict[str, Union[str, int, float]]], List[Dict[str, Union[int, str]]]]"

Also interesting: pip install pytest-mypy pytest --mypy