Skip to content

Update type hints for Python 3.10+ #5

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

Merged
adrianjarvis merged 1 commit into from
Oct 16, 2025
Merged

Update type hints for Python 3.10+ #5

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
4 changes: 2 additions & 2 deletions docs/managers/account-move.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ All specified records will be processed in a single request.
```python
send_openstack_invoice_email(
account_move: int | AccountMove,
email_ctx: Optional[Mapping[str, Any]] = None,
email_ctx: Mapping[str, Any] | None = None,
) -> None
```

Expand Down Expand Up @@ -291,7 +291,7 @@ Change this draft account move (invoice) into "posted" state.

```python
send_openstack_invoice_email(
email_ctx: Optional[Mapping[str, Any]] = None,
email_ctx: Mapping[str, Any] | None = None,
) -> None
```

Expand Down
97 changes: 43 additions & 54 deletions docs/managers/custom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,12 +180,12 @@ the type hint should be defined as shown below.
```python
from __future__ import annotations

from typing import Literal, Union
from typing import Literal

from openstack_odooclient import RecordBase

class CustomRecord(RecordBase["CustomRecordManager"]):
custom_field: Union[str, Literal[False]]
custom_field: str | Literal[False]
"""Description of the field."""
```

Expand All @@ -197,12 +197,10 @@ the type hint should be defined as shown below instead.
```python
from __future__ import annotations

from typing import Optional

from openstack_odooclient import RecordBase

class CustomRecord(RecordBase["CustomRecordManager"]):
custom_field: Optional[str]
custom_field: str | None
"""Description of the field."""
```

Expand All @@ -223,8 +221,9 @@ The type of the alias **must** match the type of the target field.
```python
from __future__ import annotations

from typing import Annotated

from openstack_odooclient import FieldAlias, RecordBase
from typing_extensions import Annotated

class CustomRecord(RecordBase["CustomRecordManager"]):
custom_field: str
Expand Down Expand Up @@ -265,8 +264,9 @@ The first is to expose the record's ID directly as an integer.
```python
from __future__ import annotations

from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase, User
from typing_extensions import Annotated

class CustomRecord(RecordBase["CustomRecordManager"]):
user_id: Annotated[int, ModelRef("user_id", User)]
Expand All @@ -278,8 +278,9 @@ The second is to expose the target record's display name as a string.
```python
from __future__ import annotations

from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase, User
from typing_extensions import Annotated

class CustomRecord(RecordBase["CustomRecordManager"]):
user_name: Annotated[str, ModelRef("user_id", User)]
Expand All @@ -291,8 +292,9 @@ The third and final one is to define the target record itself as a record object
```python
from __future__ import annotations

from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase, User
from typing_extensions import Annotated

class CustomRecord(RecordBase["CustomRecordManager"]):
user: Annotated[User, ModelRef("user_id", User)]
Expand All @@ -315,8 +317,9 @@ The final result should be the following fields defined on your record class.
```python
from __future__ import annotations

from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase, User
from typing_extensions import Annotated

class CustomRecord(RecordBase["CustomRecordManager"]):
user_id: Annotated[int, ModelRef("user_id", User)]
Expand All @@ -339,25 +342,24 @@ and [creating new records](index.md#create).
The record ID or the record object can be passed directly to those methods
(the record display name is not guaranteed to be unique, and thus, not accepted).

Record references can be made optional by encasing the type hint with `Optional`.
Record references can be made optional by unioning with `None`.
If the record reference is not set, `None` will be returned.

```python
from __future__ import annotations

from typing import Optional
from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase, User
from typing_extensions import Annotated

class CustomRecord(RecordBase["CustomRecordManager"]):
user_id: Annotated[Optional[int], ModelRef("user_id", User)]
user_id: Annotated[int | None, ModelRef("user_id", User)]
"""ID for the user that owns this record."""

user_name: Annotated[Optional[str], ModelRef("user_id", User)]
user_name: Annotated[str | None, ModelRef("user_id", User)]
"""Name of the user that owns this record."""

user: Annotated[Optional[User], ModelRef("user_id", User)]
user: Annotated[User | None, ModelRef("user_id", User)]
"""The user that owns this record.

This fetches the full record from Odoo once,
Expand All @@ -371,19 +373,19 @@ In the below example, `Self` resolves to `CustomRecord`.
```python
from __future__ import annotations

from typing import Optional
from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase
from typing_extensions import Annotated, Self
from typing_extensions import Self

class CustomRecord(RecordBase["CustomRecordManager"]):
record_id: Annotated[Optional[int], ModelRef("user_id", Self)]
record_id: Annotated[int | None, ModelRef("user_id", Self)]
"""ID for the record related to this one, if set.."""

record_name: Annotated[Optional[str], ModelRef("user_id", Self)]
record_name: Annotated[str | None, ModelRef("user_id", Self)]
"""Name of the record related to this one, if set."""

record: Annotated[Optional[Self], ModelRef("user_id", Self)]
record: Annotated[Self | None, ModelRef("user_id", Self)]
"""The record related to this one, if set.

This fetches the full record from Odoo once,
Expand All @@ -408,13 +410,12 @@ The first is to expose the record IDs directly as a list of integers.
```python
from __future__ import annotations

from typing import List
from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase, Product
from typing_extensions import Annotated

class CustomRecord(RecordBase["CustomRecordManager"]):
product_ids: Annotated[List[int], ModelRef("product_id", Product)]
product_ids: Annotated[list[int], ModelRef("product_id", Product)]
"""The list of IDs for the products to use."""
```

Expand All @@ -423,13 +424,12 @@ The second and final one is to expose the records as a list of record objects.
```python
from __future__ import annotations

from typing import List
from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase, Product
from typing_extensions import Annotated

class CustomRecord(RecordBase["CustomRecordManager"]):
products: Annotated[List[Product], ModelRef("product_id", Product)]
products: Annotated[list[Product], ModelRef("product_id", Product)]
"""The list of products to use.

This fetches the full records from Odoo once,
Expand All @@ -449,16 +449,15 @@ The final result should be the following fields defined on your record class.
```python
from __future__ import annotations

from typing import List
from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase, Product
from typing_extensions import Annotated

class CustomRecord(RecordBase["CustomRecordManager"]):
product_ids: Annotated[List[int], ModelRef("product_id", Product)]
product_ids: Annotated[list[int], ModelRef("product_id", Product)]
"""The list of IDs for the products to use."""

products: Annotated[List[Product], ModelRef("product_id", Product)]
products: Annotated[list[Product], ModelRef("product_id", Product)]
"""The list of products to use.

This fetches the full records from Odoo once,
Expand All @@ -478,16 +477,16 @@ In the below example, `Self` resolves to `CustomRecord`.
```python
from __future__ import annotations

from typing import List
from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase
from typing_extensions import Annotated, Self
from typing_extensions import Self

class CustomRecord(RecordBase["CustomRecordManager"]):
child_ids: Annotated[List[int], ModelRef("child_id", Self)]
child_ids: Annotated[list[int], ModelRef("child_id", Self)]
"""The list of IDs for the child records."""

children: Annotated[List[Self], ModelRef("child_id", Self)]
children: Annotated[list[Self], ModelRef("child_id", Self)]
"""The list of child records.

This fetches the full records from Odoo once,
Expand All @@ -511,16 +510,15 @@ Below is an example of two record classes that correctly reference each other.
```python title="parent.py"
from __future__ import annotations

from typing import List
from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase, RecordManagerBase
from typing_extensions import Annotated

class Parent(RecordBase["ParentManager"]):
child_ids: Annotated[List[int], ModelRef("child_id", Child)]
child_ids: Annotated[list[int], ModelRef("child_id", Child)]
"""The list of IDs for the children records."""

children: Annotated[List[Parent], ModelRef("child_id", Child)]
children: Annotated[list[Parent], ModelRef("child_id", Child)]
"""The list of children records.

This fetches the full records from Odoo once,
Expand All @@ -537,19 +535,18 @@ from .child import Child # noqa: E402
```python title="child.py"
from __future__ import annotations

from typing import Optional
from typing import Annotated

from openstack_odooclient import ModelRef, RecordBase, RecordManagerBase
from typing_extensions import Annotated

class Child(RecordBase["ChildManager"]):
parent_id: Annotated[Optional[int], ModelRef("parent_id", Parent)]
parent_id: Annotated[int | None, ModelRef("parent_id", Parent)]
"""ID for the parent record, if it has one."""

parent_name: Annotated[Optional[str], ModelRef("parent_id", Parent)]
parent_name: Annotated[str | None, ModelRef("parent_id", Parent)]
"""Name of the parent record, if it has one."""

parent: Annotated[Optional[Parent], ModelRef("parent_id", Parent)]
parent: Annotated[Parent | None, ModelRef("parent_id", Parent)]
"""The parent record, if it has one.

This fetches the full record from Odoo once,
Expand Down Expand Up @@ -686,8 +683,6 @@ Below is a simple example of a custom record type and its manager class.
```python
from __future__ import annotations

from typing import List, Union

from openstack_odooclient import RecordBase, RecordManagerBase

class CustomRecord(RecordBase["CustomRecordManager"]):
Expand All @@ -710,8 +705,6 @@ This will allow manager methods to be used by calling them on the manager object
```python
from __future__ import annotations

from typing import List, Union

from openstack_odooclient import Client, RecordBase, RecordManagerBase

class CustomRecord(RecordBase["CustomRecordManager"]):
Expand All @@ -736,8 +729,6 @@ custom manager class.
```python
from __future__ import annotations

from typing import List, Union

from openstack_odooclient import RecordBase, RecordManagerBase

class CustomRecord(RecordBase["CustomRecordManager"]):
Expand Down Expand Up @@ -768,8 +759,6 @@ Methods can be defined on manager classes to provide additional functionality.
```python
from __future__ import annotations

from typing import List, Union

from openstack_odooclient import RecordBase, RecordManagerBase

class CustomRecord(RecordBase["CustomRecordManager"]):
Expand All @@ -780,10 +769,10 @@ class CustomRecordManager(RecordManagerBase[CustomRecord]):
env_name = "custom.record"
record_class = CustomRecord

def search_by_custom_field(self, custom_field: str) -> List[Record]:
def search_by_custom_field(self, custom_field: str) -> list[Record]:
return self.search([("custom_field", "ilike", custom_field)])

def perform_action(self, custom_record: Union[int, CustomRecord]) -> None:
def perform_action(self, custom_record: int | CustomRecord) -> None:
self._env.perform_action(
(
custom_record.id
Expand Down
8 changes: 4 additions & 4 deletions docs/managers/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ a ``dict`` object, instead of a record object.

```python
search(
filters: Sequence[Tuple[str, str, Any] | Sequence[Any] | str] | None = None,
filters: Sequence[tuple[str, str, Any] | Sequence[Any] | str] | None = None,
fields: Iterable[str] | None = None,
order: str | None = None,
as_id: bool = False,
Expand All @@ -334,7 +334,7 @@ search(

```python
search(
filters: Sequence[Tuple[str, str, Any] | Sequence[Any] | str] | None = None,
filters: Sequence[tuple[str, str, Any] | Sequence[Any] | str] | None = None,
fields: Iterable[str] | None = None,
order: str | None = None,
as_id: bool = True,
Expand All @@ -344,7 +344,7 @@ search(

```python
search(
filters: Sequence[Tuple[str, str, Any] | Sequence[Any] | str] | None = None,
filters: Sequence[tuple[str, str, Any] | Sequence[Any] | str] | None = None,
fields: Iterable[str] | None = None,
order: str | None = None,
as_id: bool = False,
Expand Down Expand Up @@ -564,7 +564,7 @@ a list of `dict` objects, instead of record objects.

| Name | Type | Description | Default |
|-----------|---------------------------------------------------------------|---------------------------------------------------|---------|
| `filters` | `Sequence[Tuple[str, str, Any] | Sequence[Any] | str] | None` | Filters to query by (or `None` for no filters) | `None` |
| `filters` | `Sequence[tuple[str, str, Any] | Sequence[Any] | str] | None` | Filters to query by (or `None` for no filters) | `None` |
| `fields` | `Iterable[str] | None` | Fields to select (or `None` to select all fields) | `None` |
| `order` | `str | None` | Field to order results by, if ordering results | `None` |
| `as_id` | `bool` | Return the record IDs only | `False` |
Expand Down
Loading