diff --git a/docs/apis/common.md b/docs/apis/common.md index eff2b8d..deed4b1 100644 --- a/docs/apis/common.md +++ b/docs/apis/common.md @@ -1,13 +1 @@ # `common` - - -::: t4_devkit.common.converter - -::: t4_devkit.common.geometry - -::: t4_devkit.common.io - -::: t4_devkit.common.serialize - -::: t4_devkit.common.timestamp - diff --git a/docs/tutorials/customize.md b/docs/tutorials/customize.md index 6e19b9e..5377d1d 100644 --- a/docs/tutorials/customize.md +++ b/docs/tutorials/customize.md @@ -6,7 +6,7 @@ You can crate a schema containing the specified table data with a new token usin ```python >>> from t4_devkit.schema import Attribute ->>> from t4_devkit.common.serialize import serialize_dataclass +>>> from t4_devkit.common import serialize_dataclass >>> >>> # schema data except of the unique identifier token >>> data = { @@ -58,7 +58,7 @@ from __future__ import annotations from attrs import define, field from t4_devkit.schema import SCHEMAS, SchemaName, SchemaBase -from t4_devkit.common.io import load_json +from t4_devkit.common import load_json __all__ = ["CustomAttribute"] diff --git a/docs/tutorials/initialize.md b/docs/tutorials/initialize.md index 8b4a783..449fb65 100644 --- a/docs/tutorials/initialize.md +++ b/docs/tutorials/initialize.md @@ -157,7 +157,7 @@ An `attribute` is a property of an instance that may change throughout different ``` -??? WARNING +!!! WARNING Expected `level` values in `visibility` are as below: diff --git a/docs/tutorials/sanity.md b/docs/tutorials/sanity.md index 3bf9cd4..d804aa4 100644 --- a/docs/tutorials/sanity.md +++ b/docs/tutorials/sanity.md @@ -6,9 +6,8 @@ About the defined rules, please refer to [requirement.md](../schema/requirement.md). -```python -from t4_devkit.common.io import save_json -from t4_devkit.common.serialize import serialize_dataclass +```python title="main.py" +from t4_devkit.common import save_json, serialize_dataclass from t4_devkit.sanity import sanity_check, print_sanity_result @@ -30,7 +29,7 @@ All checkers must follow: - Override the `check() -> list[Reason] | None` method to perform the specific check. - Register the checker using `CHECKERS.register()` decorator. -```python +```python title="str000.py" from __future__ import annotations from typing import TYPE_CHECKING diff --git a/t4_devkit/common/__init__.py b/t4_devkit/common/__init__.py index e69de29..eee35fd 100644 --- a/t4_devkit/common/__init__.py +++ b/t4_devkit/common/__init__.py @@ -0,0 +1,7 @@ +from __future__ import annotations + +from .converter import * # noqa +from .geometry import * # noqa +from .io import * # noqa +from .serialize import * # noqa +from .timestamp import * # noqa diff --git a/t4_devkit/common/serialize.py b/t4_devkit/common/serialize.py index c93d08f..d2e85d1 100644 --- a/t4_devkit/common/serialize.py +++ b/t4_devkit/common/serialize.py @@ -8,6 +8,9 @@ from pyquaternion import Quaternion +__all__ = ["serialize_dataclasses", "serialize_dataclass"] + + def serialize_dataclasses(data: list[Any]) -> list[dict]: """Serialize list of attrs' dataclasses into list of dict. diff --git a/t4_devkit/common/timestamp.py b/t4_devkit/common/timestamp.py index b42324b..281398d 100644 --- a/t4_devkit/common/timestamp.py +++ b/t4_devkit/common/timestamp.py @@ -8,6 +8,9 @@ from t4_devkit.typing import ScalarLike +__all__ = ["microseconds2seconds", "seconds2microseconds"] + + @deprecated("Please use `microseconds2seconds(...)` instead.") def us2sec(timestamp: ScalarLike) -> float: """Convert timestamp from micro seconds [us] to seconds [s].