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

Rearrange typing tests and docs #210

Merged
merged 1 commit into from
Jan 3, 2025
Merged

Rearrange typing tests and docs #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 15 additions & 11 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,20 +273,20 @@ Undoing a change doesn't remove the change from the document's history, but appl
```py
from pycrdt import Array, Doc

doc: Doc[Array[int]] = Doc()
array0: Array[int] = doc.get("array0", type=Array)
doc = Doc[Array[int]]()
array0 = doc.get("array0", type=Array[int])
array0.append(0)
array0.append("foo") # error: Argument 1 to "append" of "Array" has incompatible type "str"; expected "int" [arg-type]
array1: Array[str] = doc.get("array1", type=Array) # error: Incompatible types in assignment (expression has type "Array[int]", variable has type "Array[str]") [assignment]
array0.append("foo") # error: Argument 1 to "append" of "Array" has incompatible type "str"; expected "int"
array1 = doc.get("array1", type=Array[str]) # error: Argument "type" to "get" of "Doc" has incompatible type "type[pycrdt._array.Array[Any]]"; expected "type[pycrdt._array.Array[int]]"
```

Trying to append a `str` will result in a type check error. Likewise if trying to get a root type of `Array[str]`.

Like an `Array`, a `Map` can be declared as uniform, i.e. with values of the same type. But it can also be declared as a [TypedDict](https://mypy.readthedocs.io/en/stable/typed_dict.html):
Like an `Array`, a `Map` can be declared as uniform, i.e. with values of the same type. If one wants to associate types with specific keys, the `Map` can be cast to a [TypedDict](https://mypy.readthedocs.io/en/stable/typed_dict.html):

```py
from typing import TypedDict
from pycrdt import Doc, Map
from typing import TypedDict, cast
from pycrdt import Array, Doc, Map

doc: Doc[Map] = Doc()

Expand All @@ -299,7 +299,7 @@ MyMap = TypedDict(
},
)

map0: MyMap = doc.get("map0", type=Map) # type: ignore[assignment]
map0 = cast(MyMap, doc.get("map0", type=Map))
map0["name"] = "foo"
map0["toggle"] = False
map0["toggle"] = 3 # error: Value of "toggle" has incompatible type "int"; expected "bool"
Expand All @@ -310,13 +310,15 @@ map0["nested"] = array1
v0: str = map0["name"]
v1: str = map0["toggle"] # error: Incompatible types in assignment (expression has type "bool", variable has type "str")
v2: bool = map0["toggle"]
map0["key0"] # error: TypedDict "MyMap@7" has no key "key0"
map0["key0"] # error: TypedDict "MyMap" has no key "key0"
```

Note however that this solution is not ideal, since a `Map` is not exactly a `dict`, although it behaves similarly. For instance, `map0` may need to be cast again to a `Map` if one wants to access specific methods.

Like a `Map`, a `Doc` can be declared as consisting of uniform root types, or as a `TypedDict`:

```py
from typing import TypedDict
from typing import TypedDict, cast
from pycrdt import Doc, Array, Text

MyDoc = TypedDict(
Expand All @@ -326,8 +328,10 @@ MyDoc = TypedDict(
"array0": Array[int],
}
)
doc: MyDoc = Doc() # type: ignore[assignment]
doc = cast(MyDoc, Doc())
doc["text0"] = Text()
doc["array0"] = Array[bool]() # error: Value of "array0" has incompatible type "Array[bool]"; expected "Array[int]"
doc["array0"] = Array[int]()
```

Here again, beware that a `Doc` has some similarities with a `dict`, but also differences. Cast `doc` back to a `Doc` when needed.
25 changes: 13 additions & 12 deletions tests/test_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
from typing import TypedDict
from typing import TypedDict, cast

import pytest
from pycrdt import Array, Doc, Map, Text


@pytest.mark.mypy_testing
def mypy_test_array():
doc: Doc[Array[int]] = Doc()
array0: Array[int] = doc.get("array0", type=Array)
doc = Doc[Array[int]]()
array0 = doc.get("array0", type=Array)
array0.append(0)
array0.append("foo") # E: Argument 1 to "append" of "Array" has incompatible type "str"; expected "int" [arg-type]
array1: Array[str] = doc.get("array1", type=Array) # E: Incompatible types in assignment (expression has type "Array[int]", variable has type "Array[str]") [assignment]
doc.get("array1", type=Array[str]) # E: Argument "type" to "get" of "Doc" has incompatible type "type[pycrdt._array.Array[Any]]"; expected "type[pycrdt._array.Array[int]]"


@pytest.mark.mypy_testing
def mypy_test_uniform_map():
doc: Doc[Map] = Doc()
map0: Map[bool] = doc.get("map0", type=Map)
doc = Doc[Map[bool]]()
map0 = doc.get("map0", type=Map)
map0["foo"] = True
map0["foo"] = "bar" # E: Incompatible types in assignment (expression has type "str", target has type "bool")
map0["foo"] = 3 # E: Incompatible types in assignment (expression has type "int", target has type "bool")
v0: str = map0.pop("foo") # E: Incompatible types in assignment (expression has type "bool", variable has type "str")
v1: bool = map0.pop("foo")


@pytest.mark.mypy_testing
def mypy_test_typed_map():
doc: Doc[Map] = Doc()
doc = Doc[Map]()

MyMap = TypedDict(
"MyMap",
Expand All @@ -35,7 +35,7 @@ def mypy_test_typed_map():
"nested": Array[bool],
},
)
map0: MyMap = doc.get("map0", type=Map) # type: ignore[assignment]
map0 = cast(MyMap, doc.get("map0", type=Map))
map0["name"] = "foo"
map0["toggle"] = False
map0["toggle"] = 3 # E: Value of "toggle" has incompatible type "int"; expected "bool"
Expand All @@ -51,7 +51,7 @@ def mypy_test_typed_map():

@pytest.mark.mypy_testing
def mypy_test_uniform_doc():
doc: Doc[Text] = Doc()
doc = Doc[Text]()
doc.get("text0", type=Text)
doc.get("array0", type=Array) # E: Argument "type" to "get" of "Doc" has incompatible type "type[pycrdt._array.Array[Any]]"; expected "type[Text]"
doc.get("Map0", type=Map) # E: Argument "type" to "get" of "Doc" has incompatible type "type[pycrdt._map.Map[Any]]"; expected "type[Text]"
Expand All @@ -76,10 +76,11 @@ def mypy_test_typed_doc():
"map0": MyMap,
}
)
doc: MyDoc = Doc() # type: ignore[assignment]
map0: MyMap = Map() # type: ignore[assignment]
doc = cast(MyDoc, Doc())
map0 = cast(MyMap, Map())
doc["map0"] = map0
doc["map0"] = Array() # E: Value of "map0" has incompatible type "Array[Never]"; expected "MyMap@62"
doc["map0"] = Map() # E: Value of "map0" has incompatible type "Map[Never]"; expected "MyMap@62"
doc["text0"] = Text()
doc["array0"] = Array[bool]() # E: Value of "array0" has incompatible type "Array[bool]"; expected "Array[int]"
doc["array0"] = Array()
Loading