pydistcheckダウンロードpydistcheckソースコードのダウンロード

pydistcheck

その他のカテゴリー

v0.8.0

ダウンロード

PydistCheck

githubアクション

`pydistcheck`とは何ですか？

pydistcheckは、Pythonパッケージで実行するコマンドラインインターフェイス（CLI）です。

一般的な移植性の問題を検出します
パッケージのコンテンツの有用な要約を印刷します

RのR CMD checkに触発されています。

サポートされている形式：

Python Sdist
Pythonホイール
condaパッケージ（ .condaと.tar.bz2の両方）
任意の.tar.bz2 、 .tar.gz 、または.zipアーカイブ

pydistcheckキャッチできる問題のタイプの完全なリストについては、「参照をチェック」を参照してください。

「Python Distributionのテスト方法」を参照して、 pydistcheckやauditwheel 、 check-wheel-contents 、 twine checkなどの同様のツールがPython開発ワークフローにどのように適合するかを学びます。

このようなツールの価値に関するより背景については、Scipy 2022 Talk「CSVはPypiに属しているのでしょうか？おそらくそうではない」（ビデオリンク）を参照してください。

インストール

pipでインストールします。

pip install pydistcheck

またはconda 。

conda install -c conda-forge pydistcheck

詳細については、「インストール」（リンク）を参照してください。

クイックスタート

好きなパッケージで試してみてください...

pip download 
  --no-deps 
  -d ./downloads 
  pyarrow

pydistcheck --inspect ./downloads/ * .whl

...それが含まれているものを見るために。

 ----- package inspection summary -----
file size
  * compressed size: 25.9M
  * uncompressed size: 94.0M
  * compression space saving: 72.4%
contents
  * directories: 0
  * files: 809 (30 compiled)
size by extension
  * .dylib - 73.2M (77.9%)
  * .so - 10.8M (11.4%)
  * .h - 4.5M (4.8%)
  * .py - 2.4M (2.5%)
  * .pyx - 0.8M (0.8%)
  * .pxi - 0.7M (0.8%)
  * .cc - 0.4M (0.5%)
  * .cmake - 0.4M (0.4%)
  * .pxd - 0.3M (0.3%)
  * .gz - 0.2M (0.2%)
  * .hpp - 0.1M (0.1%)
  * .txt - 0.1M (0.1%)
  * no-extension - 77.4K (0.1%)
  * .orc - 48.4K (0.1%)
  * .parquet - 14.0K (0.0%)
  * .sh - 7.8K (0.0%)
  * .md - 3.6K (0.0%)
  * .yml - 1.5K (0.0%)
  * .ubuntu - 1.3K (0.0%)
  * .fedora - 1.0K (0.0%)
  * .diff - 1.0K (0.0%)
  * .feather - 0.6K (0.0%)
largest files
  * (49.1M) pyarrow/libarrow.1700.dylib
  * (10.7M) pyarrow/libarrow_flight.1700.dylib
  * (3.8M) pyarrow/lib.cpython-311-darwin.so
  * (3.8M) pyarrow/libparquet.1700.dylib
  * (2.9M) pyarrow/libarrow_substrait.1700.dylib

==================== done running pydistcheck ===============

またはこのレポのテストデータについて...

pydistcheck tests/data/problematic-package- *

...チェックする問題の種類を確認する。

 ------------ check results -----------
1. [files-only-differ-by-case] Found files which differ only by case. Files: problematic-package-0.1.0/problematic_package/Question.py,problematic-package-0.1.0/problematic_package/question.PY,problematic-package-0.1.0/problematic_package/question.py
2. [mixed-file-extensions] Found a mix of file extensions for the same file type: .NDJSON (1), .jsonl (1), .ndjson (1)
3. [mixed-file-extensions] Found a mix of file extensions for the same file type: .yaml (2), .yml (1)
4. [path-contains-non-ascii-characters] Found file path containing non-ASCII characters: 'problematic-package-0.1.0/problematic_package/?veryone-loves-python.py'
5. [path-contains-spaces] Found path with spaces: 'problematic-package-0.1.0/beep boop.ini'
6. [path-contains-spaces] Found path with spaces: 'problematic-package-0.1.0/problematic_package/bad code/'
7. [path-contains-spaces] Found path with spaces: 'problematic-package-0.1.0/problematic_package/bad code/__init__.py'
8. [path-contains-spaces] Found path with spaces: 'problematic-package-0.1.0/problematic_package/bad code/ship-it.py'
9. [unexpected-files] Found unexpected directory 'problematic-package-0.1.0/.git/'.
10. [unexpected-files] Found unexpected file 'problematic-package-0.1.0/.gitignore'.
11. [unexpected-files] Found unexpected file 'problematic-package-0.1.0/.hadolint.yaml'.
12. [unexpected-files] Found unexpected file 'problematic-package-0.1.0/problematic_package/.gitignore'.
errors found while checking: 12

コンパイルされたオブジェクトを含む構築された分布に...

pydistcheck tests/data/debug-baseballmetrics * .whl

... pydistcheck 、デバッグシンボルの含有を検出できます（分布サイズが大きくなります）。

 checking 'tests/data/debug-baseballmetrics-0.1.0-py3-none-macosx_10_15_x86_64.macosx_11_6_x86_64.macosx_12_5_x86_64.whl'
------------ check results -----------
1. [compiled-objects-have-debug-symbols] Found compiled object containing debug symbols. For details, extract the distribution contents and run 'dsymutil -s "lib/lib_baseballmetrics.dylib"'.
errors found while checking: 1

checking 'tests/data/debug-baseballmetrics-py3-none-manylinux_2_28_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.whl'
------------ check results -----------
1. [compiled-objects-have-debug-symbols] Found compiled object containing debug symbols. For details, extract the distribution contents and run 'objdump --all-headers "lib/lib_baseballmetrics.so"'.
errors found while checking: 1

詳細をご覧ください。