【OCR Issue No.12】Modify the setuptools configuration from SETUP.py into PYPROJECT.toml #12013

Liyulingyue · 2024-04-26T11:57:47Z

The push request changes the packaging profile from setup.py to pyproject.toml, and this push request is only used to synchronize the progress of the change.

There is currently no need to review and merge.

related projects:
#11906

refs:
https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#configuring-setuptools-using-pyproject-toml-files

paddle-bot · 2024-04-26T11:57:52Z

Thanks for your contribution!

pyproject.toml

setup_backup.py

pyproject.toml

jzhang533 · 2024-04-29T03:22:09Z

VERSION_NUMBER

加了这个文件的话，就得对 paddleocr.py 进行改造了。
可以试试，在 pyproject.toml 中用 setuptools_scm 自动生成一个 version.py ，然后让 paddleocr.py 从这里获取版本号。可以参考一下 paddle2onnx 里的做法。

.github/workflows/python-publish.yml
这个也要改

如果希望setuptools_scm 生成version，则需要在ppocr/init.py中import这个version.py，打包就会采用默认生成的编号了。这样做将会彻底撇开VERSION_NUMBER。
按照pp2onnx的写法，最终应该还是在读VERSION_NUMBER的版本号。

jzhang533 · 2024-05-07T09:14:58Z

paddleocr.py

@@ -78,7 +78,8 @@ def _import_file(module_name, file_path, make_importable=False):
 ]

 SUPPORT_DET_MODEL = ["DB"]
-VERSION = "2.8.0"
+with open("VERSION_NUMBER", 'r') as file:


这么做还是太 tircky 了。
另外不确定，打包的时候会不会把 VERSION_NUMBER 文件打包进去。

这个我打包的做法是把版本号和tag名称绑定。指定tag时，自动触发打包action，自动读取tag号，打到包里。
可以参考我这个：

https://github.com/RapidAI/RapidOCR/blob/a5a8eb30e82ae578574f2cba38aaba4269be9c00/.github/workflows/gen_whl_to_pypi_rapidocr_ort.yml#L91

GreatV · 2024-05-15T14:36:44Z

paddleocr.py

@@ -78,7 +78,8 @@ def _import_file(module_name, file_path, make_importable=False):
 ]

 SUPPORT_DET_MODEL = ["DB"]
-VERSION = "2.8.0"
+with open("VERSION_NUMBER", 'r') as file:


ppocr/__init__.py 可不可以在这里加一个 __version__

# Copyright (c) 2019 PaddlePaddle Authors. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import importlib.metadata as importlib_metadata try: __version__ = importlib_metadata.version(__package__ or __name__) except importlib_metadata.PackageNotFoundError: __version__ = '0.0.0'

这样 paddleocr.py 文件里就不需要VERSION变量了

GreatV · 2024-05-15T14:39:27Z

setup.py

-        "Topic :: Utilities",
-    ],
-)
+setup()


这个文件应该不需要了吧

这个可以留着，用来兼容以前的在命令行下运行 python setup.py 的使用习惯。

GreatV

需要merge一下最新的代码

jzhang533 · 2024-05-21T11:39:54Z

paddleocr.py

@@ -78,7 +79,7 @@ def _import_file(module_name, file_path, make_importable=False):
 ]

 SUPPORT_DET_MODEL = ["DB"]
-VERSION = "2.8.0"
+VERSION = __version__


这行我觉得不需要了。
只是会 break 原来有极少的人用 paddleocr.VERSION 的用法。

jzhang533 · 2024-05-21T11:45:27Z

ppocr/__init__.py

@@ -11,3 +11,9 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+import importlib.metadata as importlib_metadata


这个文件，我觉得不需要改动。
可以在 pyproject.toml 里配置 setuptools_scm 自动生成实现类似功能的代码。

如果这个文件不需要改动，其实也不需要使用setuptools_scm

我意思是不要自己实现这个功能，而是用 setuptools_scm 这样的标准化工具来实现。

jzhang533 · 2024-05-21T11:46:27Z

pyproject.toml

+
+[tool.setuptools.dynamic]
+version = {file = "VERSION_NUMBER"}
+


在这里添加类似

[tool.setuptools_scm] version_file = "pkg/_version.py"

的配置。

详情： https://github.com/pypa/setuptools_scm

paddleocr.py

jzhang533

LGTM, let's merge this.
Future work:

correct the whole codebase's linting errors
upgrade versioning mechanism

Liyulingyue added 3 commits April 25, 2024 23:01

init toml

f8672be

Merge branch 'refs/heads/main' into setup2toml

29eab17

init toml

47dcf25

paddle-bot bot added the contributor label Apr 26, 2024

paddle-bot bot assigned zhangyubo0722 Apr 26, 2024

Liyulingyue added 3 commits April 26, 2024 20:35

init toml

8d37b93

init toml

17ea8dc

init toml

53e1a0a

Liyulingyue changed the title ~~【Don't Review】Modify the setuptools configuration from SETUP.py into PYPROJECT.toml~~ 【OCR Issue No.12】Modify the setuptools configuration from SETUP.py into PYPROJECT.toml Apr 27, 2024

Liyulingyue commented Apr 27, 2024

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

GreatV requested a review from jzhang533 April 27, 2024 10:49

jzhang533 reviewed Apr 28, 2024

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

setup_backup.py Outdated Show resolved Hide resolved

pyproject.toml Outdated Show resolved Hide resolved

pyproject.toml Outdated Show resolved Hide resolved

Liyulingyue added 4 commits April 28, 2024 21:51

Update pyproject.toml

3a232d9

Update and rename setup_backup.py to setup.py

fd15c1a

Update pyproject.toml

59fbdf0

Create VERSION_NUMBER

941dbdd

Liyulingyue requested a review from jzhang533 April 28, 2024 14:01

jzhang533 reviewed Apr 29, 2024

View reviewed changes

Liyulingyue added 2 commits May 2, 2024 16:25

同步version_number

d58ba0f

update build yml

5ed0c62

jzhang533 reviewed May 7, 2024

View reviewed changes

GreatV reviewed May 15, 2024

View reviewed changes

Liyulingyue and others added 3 commits May 16, 2024 21:21

Merge branch 'PaddlePaddle:main' into setup2toml

8ec404a

Merge branch 'PaddlePaddle:main' into setup2toml

144f31f

init toml

b6ab5d4

Liyulingyue requested review from jzhang533 and GreatV May 20, 2024 13:24

jzhang533 reviewed May 21, 2024

View reviewed changes

Liyulingyue commented May 21, 2024

View reviewed changes

paddleocr.py Outdated Show resolved Hide resolved

Apply suggestions from code review

2e02b16

Liyulingyue commented May 21, 2024

View reviewed changes

paddleocr.py Outdated Show resolved Hide resolved

Liyulingyue and others added 5 commits May 21, 2024 21:35

Apply suggestions from code review

11b7406

init toml

4299680

fix version

99e6086

fix version

9baed76

Merge branch 'PaddlePaddle:main' into setup2toml

9e5e2c7

jzhang533 approved these changes May 24, 2024

View reviewed changes

jzhang533 merged commit 3a66efc into PaddlePaddle:main May 24, 2024
3 of 4 checks passed

Liyulingyue deleted the setup2toml branch May 25, 2024 05:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

【OCR Issue No.12】Modify the setuptools configuration from SETUP.py into PYPROJECT.toml #12013

【OCR Issue No.12】Modify the setuptools configuration from SETUP.py into PYPROJECT.toml #12013

Liyulingyue commented Apr 26, 2024 •

edited

paddle-bot bot commented Apr 26, 2024

jzhang533 Apr 29, 2024

jzhang533 Apr 29, 2024

Liyulingyue May 2, 2024

jzhang533 May 7, 2024

SWHL May 13, 2024

GreatV May 15, 2024 •

edited

GreatV May 15, 2024

jzhang533 May 16, 2024

GreatV left a comment

jzhang533 May 21, 2024

jzhang533 May 21, 2024

Liyulingyue May 21, 2024

jzhang533 May 22, 2024

jzhang533 May 21, 2024

jzhang533 left a comment


		[tool.setuptools.dynamic]
		version = {file = "VERSION_NUMBER"}

【OCR Issue No.12】Modify the setuptools configuration from SETUP.py into PYPROJECT.toml #12013

【OCR Issue No.12】Modify the setuptools configuration from SETUP.py into PYPROJECT.toml #12013

Conversation

Liyulingyue commented Apr 26, 2024 • edited

paddle-bot bot commented Apr 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GreatV May 15, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GreatV left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jzhang533 left a comment

Choose a reason for hiding this comment

Liyulingyue commented Apr 26, 2024 •

edited

GreatV May 15, 2024 •

edited