annofabapi-3dpc-extensions 0.2.0__tar.gz → 0.2.2__tar.gz

{annofabapi-3dpc-extensions-0.2.0 → annofabapi_3dpc_extensions-0.2.2}/PKG-INFO

@@ -1,40 +1,39 @@
 Metadata-Version: 2.1
 Name: annofabapi-3dpc-extensions
-Version: 0.2.0
+Version: 0.2.2
 Summary: annofabapiの3DPC Editor用の拡張機能です。
 Home-page: https://github.com/kurusugawa-computer/annofabapi-3dpc-extensions
-Author: yuji38kwmt
-Requires-Python: >=3.7,<4.0
+Author: Kurusugawa Computer Inc.
+Requires-Python: >=3.8,<4.0
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Utilities
 Requires-Dist: dataclasses-json
-Requires-Dist: numpy
+Requires-Dist: numpy (<1.25) ; python_version == "3.8"
+Requires-Dist: numpy (>=1.26) ; python_version >= "3.9"
 Project-URL: Repository, https://github.com/kurusugawa-computer/annofabapi-3dpc-extensions
 Description-Content-Type: text/markdown
 
 # annofabapi-3dpc-extensions
-[![Build Status](https://travis-ci.com/kurusugawa-computer/annofabapi-3dpc-extensions.svg?branch=master)](https://travis-ci.com/kurusugawa-computer/annofabapi-3dpc-extensions)
+[![Build Status](https://app.travis-ci.com/kurusugawa-computer/annofabapi-3dpc-extensions.svg?branch=main)](https://app.travis-ci.com/kurusugawa-computer/annofabapi-3dpc-extensions)
 [![PyPI version](https://badge.fury.io/py/annofabapi-3dpc-extensions.svg)](https://badge.fury.io/py/annofabapi-3dpc-extensions)
 [![Python Versions](https://img.shields.io/pypi/pyversions/annofabapi-3dpc-extensions.svg)](https://pypi.org/project/annofabapi-3dpc-extensions/)
 [![Documentation Status](https://readthedocs.org/projects/annofabapi-3dpc-extensions/badge/?version=latest)](https://annofabapi-3dpc-extensions.readthedocs.io/en/latest/?badge=latest)
 
 
 
-[annofabapi](https://github.com/kurusugawa-computer/annofab-api-python-client)の3DPC（3D Point Cloud） Editor用の拡張機能です。
+[annofabapi](https://github.com/kurusugawa-computer/annofab-api-python-client)の3次元アノテーション用の拡張機能です。
 
 # Install
 
-* Python 3.7+
+* Python 3.8+
 
 # Install
 
@@ -91,6 +90,13 @@ with parser.open_outer_file(Path(segment_annotation_data.data_uri).name) as f:
     segment_data = SegmentData.from_dict(dict_segmenta_data)
     assert type(segment_data) == SegmentData
     assert len(segment_data.points) > 0
+    print(segment_data.points)
+    # => [130439, 130442, ... ]
 
 ```
 
+
+# 開発者向けドキュメント
+
+https://github.com/kurusugawa-computer/annofabapi-3dpc-extensions/blob/main/README_for_developer.md 参照
+

{annofabapi-3dpc-extensions-0.2.0 → annofabapi_3dpc_extensions-0.2.2}/README.md

@@ -1,16 +1,16 @@
 # annofabapi-3dpc-extensions
-[![Build Status](https://travis-ci.com/kurusugawa-computer/annofabapi-3dpc-extensions.svg?branch=master)](https://travis-ci.com/kurusugawa-computer/annofabapi-3dpc-extensions)
+[![Build Status](https://app.travis-ci.com/kurusugawa-computer/annofabapi-3dpc-extensions.svg?branch=main)](https://app.travis-ci.com/kurusugawa-computer/annofabapi-3dpc-extensions)
 [![PyPI version](https://badge.fury.io/py/annofabapi-3dpc-extensions.svg)](https://badge.fury.io/py/annofabapi-3dpc-extensions)
 [![Python Versions](https://img.shields.io/pypi/pyversions/annofabapi-3dpc-extensions.svg)](https://pypi.org/project/annofabapi-3dpc-extensions/)
 [![Documentation Status](https://readthedocs.org/projects/annofabapi-3dpc-extensions/badge/?version=latest)](https://annofabapi-3dpc-extensions.readthedocs.io/en/latest/?badge=latest)
 
 
 
-[annofabapi](https://github.com/kurusugawa-computer/annofab-api-python-client)の3DPC（3D Point Cloud） Editor用の拡張機能です。
+[annofabapi](https://github.com/kurusugawa-computer/annofab-api-python-client)の3次元アノテーション用の拡張機能です。
 
 # Install
 
-* Python 3.7+
+* Python 3.8+
 
 # Install
 
@@ -67,5 +67,12 @@ with parser.open_outer_file(Path(segment_annotation_data.data_uri).name) as f:
     segment_data = SegmentData.from_dict(dict_segmenta_data)
     assert type(segment_data) == SegmentData
     assert len(segment_data.points) > 0
+    print(segment_data.points)
+    # => [130439, 130442, ... ]
 
 ```
+
+
+# 開発者向けドキュメント
+
+https://github.com/kurusugawa-computer/annofabapi-3dpc-extensions/blob/main/README_for_developer.md 参照

annofabapi_3dpc_extensions-0.2.2/annofab_3dpc/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.2.2"  # `poetry-dynamic-versioning`を使ってGitHubのバージョンタグを取得している。変更不要

{annofabapi-3dpc-extensions-0.2.0 → annofabapi_3dpc_extensions-0.2.2}/annofab_3dpc/annotation.py

@@ -19,14 +19,14 @@ class Location(DataClassJsonMixin):
     y: float
     z: float
 
-    def __add__(self, other):
+    def __add__(self, other: "Location") -> "Location":
         return self.__class__(
             x=self.x + other.x,
             y=self.y + other.y,
             z=self.z + other.z,
         )
 
-    def __sub__(self, other):
+    def __sub__(self, other: "Location") -> "Location":
         return self.__class__(
             x=self.x - other.x,
             y=self.y - other.y,
@@ -51,10 +51,10 @@ class _Quaternion:
         https://github.com/KieranWynn/pyquaternion/blob/99025c17bab1c55265d61add13375433b35251af/pyquaternion/quaternion.py#L138
     """
 
-    def __init__(self, array: Union[Sequence[float], numpy.ndarray]):
+    def __init__(self, array: Union[Sequence[float], numpy.ndarray]) -> None:
         self.q = numpy.array(array)
 
-    def _q_matrix(self):
+    def _q_matrix(self) -> numpy.ndarray:
         """Matrix representation of quaternion for multiplication purposes."""
         return numpy.array(
             [
@@ -65,7 +65,7 @@ class _Quaternion:
             ]
         )
 
-    def _q_bar_matrix(self):
+    def _q_bar_matrix(self) -> numpy.ndarray:
         """Matrix representation of quaternion for multiplication purposes."""
         return numpy.array(
             [
@@ -77,13 +77,13 @@ class _Quaternion:
         )
 
     @property
-    def rotation_matrix(self):
+    def rotation_matrix(self) -> numpy.ndarray:
         """Get the 3x3 rotation matrix equivalent of the quaternion rotation.
         Returns:
             A 3x3 orthogonal rotation matrix as a 3x3 Numpy array
         Note:
-            This feature only makes sense when referring to a unit quaternion. Calling this method will implicitly normalise the Quaternion object to a unit quaternion if it is not already one.  # noqa: E501
-        """
+            This feature only makes sense when referring to a unit quaternion. Calling this method will implicitly normalise the Quaternion object to a unit quaternion if it is not already one.
+        """  # noqa: E501
         product_matrix = numpy.dot(self._q_matrix(), self._q_bar_matrix().conj().transpose())
         return product_matrix[1:][:, 1:]
 
@@ -298,7 +298,7 @@ class CuboidAnnotationDetailDataV1(DataClassJsonMixin):
         return {"data": str_data, "_type": ANNOTATION_TYPE_UNKNOWN}
 
 
-def convert_annotation_detail_data(dict_data: Dict[str, Any]) -> Any:
+def convert_annotation_detail_data(dict_data: Dict[str, Any]) -> Any:  # noqa: ANN401
     """
     SimpleAnnotationDetailクラスのdict型であるdataプロパティを、3DPC Editor用のDataclassに変換します。
     3DPC Editor用のDataclassに変換できない場合は、引数をそのまま返します。

annofabapi_3dpc_extensions-0.2.2/pyproject.toml

@@ -0,0 +1,125 @@
+[tool.poetry]
+name = "annofabapi-3dpc-extensions"
+version = "0.2.2"  # `poetry-dynamic-versioning`を使ってGitHubのバージョンタグを取得している。変更不要
+description = "annofabapiの3DPC Editor用の拡張機能です。"
+authors = ["Kurusugawa Computer Inc."]
+packages = [
+    { include = "annofab_3dpc" }
+]
+readme="README.md"
+repository="https://github.com/kurusugawa-computer/annofabapi-3dpc-extensions"
+classifiers = [
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Developers",
+        "Topic :: Utilities",
+        "Operating System :: OS Independent",
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+dataclasses-json="*"
+
+# Pythonバージョンでnumpyのバージョンを変えている理由
+# https://qiita.com/yuji38kwmt/items/7ce857bb8698536bfa36
+numpy = [
+  {version = ">=1.26", python = ">=3.9"},
+  {version = "<1.25", python = "=3.8"}
+]
+
+
+[tool.poetry.group.test.dependencies]
+pytest = "^7"
+pytest-xdist = "*"
+# テストコードで利用するため
+annofabapi = ">=0.47.0"
+
+
+[tool.poetry.group.linter.dependencies]
+# pythonバージョンを指定している理由：Python3.11（開発環境）でしかlintを実行していないため
+ruff = {version="^0.2", python=">=3.11"}
+mypy = {version="^1", python=">=3.11"}
+pylint = {version="^3", python=">=3.11"}
+
+
+[tool.poetry.group.documentation.dependencies]
+# ドキュメント生成用のライブラリ
+# `python=">=3.11"`を指定している理由：Pytyhon3.11を利用している開発環境かReadTheDocsでしかドキュメントを生成しないため
+sphinx = {version="^7", python=">=3.11"}
+pydata-sphinx-theme = {version=">=0.13", python=">=3.11"}
+
+
+[tool.mypy]
+ignore_missing_imports = true
+
+check_untyped_defs = true
+
+plugins = "numpy.typing.mypy_plugin"
+
+[tool.ruff]
+target-version = "py38"
+line-length = 120
+
+
+[tool.ruff.lint]
+ignore = [
+    "G004", # `logging-f-string` : loggingでf-stringを使いたいので無視する
+    "PD901", #すでに`df`という変数をいろんなところで使っているため
+    "PD002", #すでにpandasで`inplace=True`はいろんなところで使っているため
+    "RUF001", # 全角記号など`ambiguous unicode character`も使いたいため
+    "RUF002",# 全角記号など`ambiguous unicode character`も使いたいため
+    "RUF003",# 全角記号など`ambiguous unicode character`も使いたいため
+    "PLC1901", # compare-to-empty-string : `if a == "`のように空文字列で直接比較したいときがあるため
+    "PLR2004", # magic-value-comparison: listのサイズで判定するときがよくあるため
+    "ANN101", # missing-type-self: 引数selfには型ヒントは付けていないため
+    "ANN102", # missing-type-cls: 引数clsには型ヒントは付けていないため
+    "ERA", # : 役立つこともあるが、コメントアウトしていないコードも警告されるので無視する
+    "PERF203", # try-except-in-loop: ループ内でtry-exceptを使うこともあるため無視する。
+    "FIX", # TODOやFIXMEを使うため無視する
+    "TD", # TODOコメントの書き方に気にしていないので無視する
+
+    # 以下のルールはannofabcliのコードに合っていないので無効化した
+    "RSE", # flake8-raise
+    "D", # pydocstyle, Docstringを中途半端にしか書いていないので、除外する
+    "C90", # mccabe
+    "T20", # flake8-print
+    "SLF", #  flake8-self
+    "BLE", # flake8-blind-except
+    "FBT", # flake8-boolean-trap
+    "TRY", # tryceratops
+    "COM", # flake8-commas
+    "S", # flake8-bandit
+    "EM",#flake8-errmsg
+    "EXE", # flake8-executable
+    "ICN", # flake8-import-conventions
+    "RET",#flake8-return
+    "SIM",#flake8-simplify
+    "TCH", # flake8-type-checking
+    "PTH", #pathlibを使わないコードが多いので、除外する
+    "ISC", #flake8-implicit-str-concat
+    "N", # pep8-naming
+    "PT", # flake8-pytest-style
+]
+
+select = [
+    "ALL"
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.pyupgrade]
+# Python3.8をサポートしているため、`typing.List`などの型ヒントは警告しないようにする
+# https://beta.ruff.rs/docs/settings/#keep-runtime-typing
+keep-runtime-typing = true
+
+[tool.ruff.lint.pylint]
+max-args = 10
+
+[tool.poetry-dynamic-versioning]
+enable = false
+format = "{base}"
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
+build-backend = "poetry_dynamic_versioning.backend"
+

annofabapi-3dpc-extensions-0.2.0/annofab_3dpc/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.2.0"

annofabapi-3dpc-extensions-0.2.0/pyproject.toml

@@ -1,73 +0,0 @@
-[tool.poetry]
-name = "annofabapi-3dpc-extensions"
-version = "0.2.0"
-description = "annofabapiの3DPC Editor用の拡張機能です。"
-authors = ["yuji38kwmt"]
-packages = [
-    { include = "annofab_3dpc" }
-]
-readme="README.md"
-repository="https://github.com/kurusugawa-computer/annofabapi-3dpc-extensions"
-classifiers = [
-        "Development Status :: 4 - Beta",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: MIT License",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3 :: Only",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Topic :: Utilities",
-        "Operating System :: OS Independent",
-]
-
-[tool.poetry.dependencies]
-python = "^3.7"
-dataclasses-json="*"
-numpy = "*"
-
-[tool.poetry.dev-dependencies]
-# テストコードで利用するため
-annofabapi = ">=0.47.0"
-
-# test library
-pytest = "*"
-pytest-xdist = "*"
-pytest-cov = "*"
-
-# format library
-isort = "*" # import文をsortするために利用する
-autoflake = "*" # 未使用のimport文を削除するために利用する
-black = "*"
-
-# lint library
-flake8 = "*"
-mypy = "*"
-pylint = "*"
-
-# document library
-sphinx = "*"
-docutils = "*"
-# pandasのdocumentationページに近いレイアウトにするためのパッケージ
-pydata-sphinx-theme = "*"
-
-
-
-[tool.black]
-line-length = 120
-
-[tool.isort]
-profile = "black"
-line_length = 120
-# `__init__.py`の順番が変わるとエラーになる可能性があるので、スキップする
-skip="annofab_3dpc/__init__.py"
-
-[tool.mypy]
-# スタブが無いパッケージのエラーは無視させる.サードパーティのライブラリに型情報がないケースもあるため
-ignore_missing_imports = true
-
-[build-system]
-requires = ["poetry>=0.12"]
-build-backend = "poetry.masonry.api"
-
-

annofabapi-3dpc-extensions-0.2.0/setup.py

@@ -1,30 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['annofab_3dpc']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['dataclasses-json', 'numpy']
-
-setup_kwargs = {
-    'name': 'annofabapi-3dpc-extensions',
-    'version': '0.2.0',
-    'description': 'annofabapiの3DPC Editor用の拡張機能です。',
-    'long_description': '# annofabapi-3dpc-extensions\n[![Build Status](https://travis-ci.com/kurusugawa-computer/annofabapi-3dpc-extensions.svg?branch=master)](https://travis-ci.com/kurusugawa-computer/annofabapi-3dpc-extensions)\n[![PyPI version](https://badge.fury.io/py/annofabapi-3dpc-extensions.svg)](https://badge.fury.io/py/annofabapi-3dpc-extensions)\n[![Python Versions](https://img.shields.io/pypi/pyversions/annofabapi-3dpc-extensions.svg)](https://pypi.org/project/annofabapi-3dpc-extensions/)\n[![Documentation Status](https://readthedocs.org/projects/annofabapi-3dpc-extensions/badge/?version=latest)](https://annofabapi-3dpc-extensions.readthedocs.io/en/latest/?badge=latest)\n\n\n\n[annofabapi](https://github.com/kurusugawa-computer/annofab-api-python-client)の3DPC（3D Point Cloud） Editor用の拡張機能です。\n\n# Install\n\n* Python 3.7+\n\n# Install\n\n```\n$ pip install annofabapi-3dpc-extensions\n```\n\n\n# Usage\n\ncuboidアノテーションやセグメントアノテーションに対応したデータクラスを利用できます。\n\n```python\nfrom annofabapi.parser import SimpleAnnotationDirParser\n\nfrom annofab_3dpc.annotation import (\n    CuboidAnnotationDetailDataV2,\n    EulerAnglesZXY,\n    SegmentAnnotationDetailData,\n    SegmentData,\n    convert_annotation_detail_data,\n)\n\nparser = SimpleAnnotationDirParser("tests/data/task1/input1.json")\nresult = parser.parse(convert_annotation_detail_data)\n\nsegment_annotation_data = result.details[0].data\ncuboid_annotation_data = result.details[1].data\nassert type(segment_annotation_data) == SegmentAnnotationDetailData\nassert type(cuboid_annotation_data) == CuboidAnnotationDetailDataV2\n\n\n### cuboid annotation\n\nprint(cuboid_annotation_data)\n# => CuboidAnnotationDetailDataV2(shape=CuboidShapeV2(dimensions=Size(width=6.853874863204751, height=0.2929844409227371, depth=4.092537841193188), location=Location(x=-11.896872014598989, y=-3.0571381239812996, z=0.3601047024130821), rotation=EulerAnglesZXY(x=0, y=0, z=0), direction=CuboidDirection(front=Vector3(x=1, y=0, z=0), up=Vector3(x=0, y=0, z=1))), kind=\'CUBOID\', version=\'2\')\n\n# オイラー角をクォータニオンに変換\nprint(cuboid_annotation_data.shape.rotation.to_quaternion())\n# => [1.0, 0.0, 0.0, 0.0]\n\n# クォータニオンからオイラー角に変換\nprint(EulerAnglesZXY.from([1.0, 0.0, 0.0, 0.0]))\n# => EulerAnglesZXY(x=-0.0, y=0.0, z=0.0)\n\n\n### segment annotation\nprint(segment_annotation_data)\n# => SegmentAnnotationDetailData(data_uri=\'./input1/7ba51c15-f07a-4e29-8584-a4eaf3a6812a\')\n\n# セグメント情報が格納されたファイルを読み込む\nwith parser.open_outer_file(Path(segment_annotation_data.data_uri).name) as f:\n    dict_segmenta_data = json.load(f)\n    segment_data = SegmentData.from_dict(dict_segmenta_data)\n    assert type(segment_data) == SegmentData\n    assert len(segment_data.points) > 0\n\n```\n',
-    'author': 'yuji38kwmt',
-    'author_email': None,
-    'maintainer': None,
-    'maintainer_email': None,
-    'url': 'https://github.com/kurusugawa-computer/annofabapi-3dpc-extensions',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'python_requires': '>=3.7,<4.0',
-}
-
-
-setup(**setup_kwargs)