Comments (9)
abravalheri
commented on August 16, 2024
Thank you very much @bnavigator for reporting this problem.
Just a quick question, if I change to dist_name = "validate_pyproject", will it solve the problem?
from validate-pyproject.
bnavigator
commented on August 16, 2024
I would have expected so, but it doesn't. My assumption was wrong. There is a difference between the .egg-info and .dist-info. The - vs. _ is irrelevant however:
Dist Info:
>>> import importlib.metadata as _M
>>> from pprint import pprint
>>> pprint(_M.files("validate_pyproject"))
[PackagePath('../../../bin/validate-pyproject'),
PackagePath('validate_pyproject-0.9.dist-info/INSTALLER'),
PackagePath('validate_pyproject-0.9.dist-info/LICENSE.txt'),
PackagePath('validate_pyproject-0.9.dist-info/METADATA'),
PackagePath('validate_pyproject-0.9.dist-info/RECORD'),
PackagePath('validate_pyproject-0.9.dist-info/REQUESTED'),
PackagePath('validate_pyproject-0.9.dist-info/WHEEL'),
PackagePath('validate_pyproject-0.9.dist-info/direct_url.json'),
PackagePath('validate_pyproject-0.9.dist-info/entry_points.txt'),
PackagePath('validate_pyproject-0.9.dist-info/top_level.txt'),
PackagePath('validate_pyproject/__init__.py'),
PackagePath('validate_pyproject/__main__.py'),
PackagePath('validate_pyproject/_vendor/__init__.py'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/LICENSE'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/__init__.py'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/__main__.py'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/draft04.py'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/draft06.py'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/draft07.py'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/exceptions.py'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/generator.py'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/indent.py'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/ref_resolver.py'),
PackagePath('validate_pyproject/_vendor/fastjsonschema/version.py'),
PackagePath('validate_pyproject/_vendor/vendoring_instructions.rst'),
PackagePath('validate_pyproject/api.py'),
PackagePath('validate_pyproject/cli.py'),
PackagePath('validate_pyproject/error_reporting.py'),
PackagePath('validate_pyproject/errors.py'),
PackagePath('validate_pyproject/extra_validations.py'),
PackagePath('validate_pyproject/formats.py'),
PackagePath('validate_pyproject/plugins/__init__.py'),
PackagePath('validate_pyproject/plugins/distutils.schema.json'),
PackagePath('validate_pyproject/plugins/setuptools.schema.json'),
PackagePath('validate_pyproject/pre_compile/NOTICE.template'),
PackagePath('validate_pyproject/pre_compile/__init__.py'),
PackagePath('validate_pyproject/pre_compile/__main__.py'),
PackagePath('validate_pyproject/pre_compile/api-notice.template'),
PackagePath('validate_pyproject/pre_compile/cli-notice.template'),
PackagePath('validate_pyproject/pre_compile/cli.py'),
PackagePath('validate_pyproject/pre_compile/main_file.template'),
PackagePath('validate_pyproject/project_metadata.schema.json'),
PackagePath('validate_pyproject/py.typed'),
PackagePath('validate_pyproject/pyproject_toml.schema.json'),
PackagePath('validate_pyproject/types.py'),
PackagePath('validate_pyproject/vendoring/__init__.py'),
PackagePath('validate_pyproject/vendoring/__main__.py'),
PackagePath('validate_pyproject/vendoring/cli.py')]
egg-info:
>>> pprint(_M.files("validate_pyproject"))
[PackagePath('.cirrus.yml'),
PackagePath('.coveragerc'),
PackagePath('.gitignore'),
PackagePath('.isort.cfg'),
PackagePath('.pre-commit-config.yaml'),
PackagePath('.pre-commit-hooks.yaml'),
PackagePath('.projections.json'),
PackagePath('.readthedocs.yml'),
PackagePath('AUTHORS.rst'),
PackagePath('CHANGELOG.rst'),
PackagePath('CONTRIBUTING.rst'),
PackagePath('LICENSE.txt'),
PackagePath('NOTICE.txt'),
PackagePath('README.rst'),
PackagePath('pyproject.toml'),
PackagePath('setup.cfg'),
PackagePath('setup.py'),
PackagePath('tox.ini'),
PackagePath('.github/workflows/ci.yml'),
PackagePath('docs/Makefile'),
PackagePath('docs/authors.rst'),
PackagePath('docs/changelog.rst'),
PackagePath('docs/conf.py'),
PackagePath('docs/contributing.rst'),
PackagePath('docs/dev-guide.rst'),
PackagePath('docs/embedding.rst'),
PackagePath('docs/faq.rst'),
PackagePath('docs/index.rst'),
PackagePath('docs/json-schemas.rst'),
PackagePath('docs/license.rst'),
PackagePath('docs/readme.rst'),
PackagePath('docs/requirements.txt'),
PackagePath('docs/schemas.rst'),
PackagePath('docs/_static/.gitignore'),
PackagePath('docs/_static/custom-adjustments.css'),
PackagePath('src/validate_pyproject/__init__.py'),
PackagePath('src/validate_pyproject/__main__.py'),
PackagePath('src/validate_pyproject/api.py'),
PackagePath('src/validate_pyproject/cli.py'),
PackagePath('src/validate_pyproject/error_reporting.py'),
PackagePath('src/validate_pyproject/errors.py'),
PackagePath('src/validate_pyproject/extra_validations.py'),
PackagePath('src/validate_pyproject/formats.py'),
PackagePath('src/validate_pyproject/project_metadata.schema.json'),
PackagePath('src/validate_pyproject/py.typed'),
PackagePath('src/validate_pyproject/pyproject_toml.schema.json'),
PackagePath('src/validate_pyproject/types.py'),
PackagePath('src/validate_pyproject.egg-info/PKG-INFO'),
PackagePath('src/validate_pyproject.egg-info/SOURCES.txt'),
PackagePath('src/validate_pyproject.egg-info/dependency_links.txt'),
PackagePath('src/validate_pyproject.egg-info/entry_points.txt'),
PackagePath('src/validate_pyproject.egg-info/not-zip-safe'),
PackagePath('src/validate_pyproject.egg-info/requires.txt'),
PackagePath('src/validate_pyproject.egg-info/top_level.txt'),
PackagePath('src/validate_pyproject/_vendor/__init__.py'),
PackagePath('src/validate_pyproject/_vendor/vendoring_instructions.rst'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/LICENSE'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/__init__.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/__main__.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/draft04.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/draft06.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/draft07.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/exceptions.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/generator.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/indent.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/ref_resolver.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/version.py'),
PackagePath('src/validate_pyproject/plugins/__init__.py'),
PackagePath('src/validate_pyproject/plugins/distutils.schema.json'),
PackagePath('src/validate_pyproject/plugins/setuptools.schema.json'),
PackagePath('src/validate_pyproject/pre_compile/NOTICE.template'),
PackagePath('src/validate_pyproject/pre_compile/__init__.py'),
PackagePath('src/validate_pyproject/pre_compile/__main__.py'),
PackagePath('src/validate_pyproject/pre_compile/api-notice.template'),
PackagePath('src/validate_pyproject/pre_compile/cli-notice.template'),
PackagePath('src/validate_pyproject/pre_compile/cli.py'),
PackagePath('src/validate_pyproject/pre_compile/main_file.template'),
PackagePath('src/validate_pyproject/vendoring/__init__.py'),
PackagePath('src/validate_pyproject/vendoring/__main__.py'),
PackagePath('src/validate_pyproject/vendoring/cli.py'),
PackagePath('tests/__init__.py'),
PackagePath('tests/conftest.py'),
PackagePath('tests/helpers.py'),
PackagePath('tests/test_api.py'),
PackagePath('tests/test_cli.py'),
PackagePath('tests/test_error_reporting.py'),
PackagePath('tests/test_examples.py'),
PackagePath('tests/test_formats.py'),
PackagePath('tests/test_json_schema_summary.py'),
PackagePath('tests/test_plugins.py'),
PackagePath('tests/test_pre_compile.py'),
PackagePath('tests/test_vendoring.py'),
PackagePath('tests/examples/atoml/LICENSE'),
PackagePath('tests/examples/atoml/pyproject.toml'),
PackagePath('tests/examples/flit/LICENSE'),
PackagePath('tests/examples/flit/pyproject.toml'),
PackagePath('tests/examples/pdm/LICENSE'),
PackagePath('tests/examples/pdm/pyproject.toml'),
PackagePath('tests/examples/pep_text/pyproject.toml'),
PackagePath('tests/examples/pretend-setuptools/01-pyproject.toml'),
PackagePath('tests/examples/pretend-setuptools/02-pyproject.toml'),
PackagePath('tests/examples/pretend-setuptools/03-pyproject.toml'),
PackagePath('tests/examples/pretend-setuptools/04-pyproject.toml'),
PackagePath('tests/examples/pretend-setuptools/05-pyproject.toml'),
PackagePath('tests/examples/pretend-setuptools/06-pyproject.toml'),
PackagePath('tests/examples/pretend-setuptools/07-pyproject.toml'),
PackagePath('tests/examples/simple/dynamic-version.toml'),
PackagePath('tests/examples/simple/minimal.toml'),
PackagePath('tests/examples/trampolim/LICENSE'),
PackagePath('tests/examples/trampolim/pyproject.toml'),
PackagePath('tests/invalid-examples/pdm/LICENSE'),
PackagePath('tests/invalid-examples/pdm/invalid-version/errors.txt'),
PackagePath('tests/invalid-examples/pdm/invalid-version/pyproject.toml'),
PackagePath('tests/invalid-examples/pdm/redefining-as-dynamic/errors.txt'),
PackagePath('tests/invalid-examples/pdm/redefining-as-dynamic/pyproject.toml'),
PackagePath('tests/invalid-examples/pep621/missing-fields/missing-version-with-dynamic.errors.txt'),
PackagePath('tests/invalid-examples/pep621/missing-fields/missing-version-with-dynamic.toml'),
PackagePath('tests/invalid-examples/pep621/missing-fields/missing-version.errors.txt'),
PackagePath('tests/invalid-examples/pep621/missing-fields/missing-version.toml'),
PackagePath('tests/invalid-examples/pep621/non-standardised-project-fields/author_instead_of_authors.errors.txt'),
PackagePath('tests/invalid-examples/pep621/non-standardised-project-fields/author_instead_of_authors.toml'),
PackagePath('tests/invalid-examples/pep621/non-standardised-project-fields/requires_instead_of_dependencies.errors.txt'),
PackagePath('tests/invalid-examples/pep621/non-standardised-project-fields/requires_instead_of_dependencies.toml'),
PackagePath('tests/invalid-examples/pretend-setuptools/cmdclass/invalid-value.errors.txt'),
PackagePath('tests/invalid-examples/pretend-setuptools/cmdclass/invalid-value.toml'),
PackagePath('tests/invalid-examples/pretend-setuptools/dependencies/invalid-extra-name.errors.txt'),
PackagePath('tests/invalid-examples/pretend-setuptools/dependencies/invalid-extra-name.toml'),
PackagePath('tests/invalid-examples/pretend-setuptools/package-dir/invalid-name.errors.txt'),
PackagePath('tests/invalid-examples/pretend-setuptools/package-dir/invalid-name.toml'),
PackagePath('tests/invalid-examples/pretend-setuptools/packages/missing-find-arguments.errors.txt'),
PackagePath('tests/invalid-examples/pretend-setuptools/packages/missing-find-arguments.toml'),
PackagePath('tests/invalid-examples/pretend-setuptools/pep621/license/both-text-and-file.errors.txt'),
PackagePath('tests/invalid-examples/pretend-setuptools/pep621/license/both-text-and-file.toml'),
PackagePath('tests/invalid-examples/pretend-setuptools/pep621/license/empty.errors.txt'),
PackagePath('tests/invalid-examples/pretend-setuptools/pep621/license/empty.toml'),
PackagePath('tests/invalid-examples/pretend-setuptools/pep621/readme/readme-as-array.errors.txt'),
PackagePath('tests/invalid-examples/pretend-setuptools/pep621/readme/readme-as-array.toml'),
PackagePath('tests/invalid-examples/pretend-setuptools/pep621/readme/readme-without-content-type.errors.txt'),
PackagePath('tests/invalid-examples/pretend-setuptools/pep621/readme/readme-without-content-type.toml'),
PackagePath('tests/json_schema_summary/array-contains.example'),
PackagePath('tests/json_schema_summary/array-no-items.example'),
PackagePath('tests/json_schema_summary/array-prefix-items.example'),
PackagePath('tests/json_schema_summary/array-simple.example'),
PackagePath('tests/json_schema_summary/if-then-else.example'),
PackagePath('tests/json_schema_summary/if-then-else2.example'),
PackagePath('tests/json_schema_summary/not.example'),
PackagePath('tests/json_schema_summary/object-no-properties.example'),
PackagePath('tests/json_schema_summary/object-pattern-properties.example'),
PackagePath('tests/json_schema_summary/object-property-names.example'),
PackagePath('tests/json_schema_summary/oneof.example'),
PackagePath('tests/pre_compile/test_cli.py')]
Seems like importlib.metadata.files() returns the content of the .dist-info/RECORD or .egg-info/SOURCES.txt. And the latter is not the installed files.
from validate-pyproject.
bnavigator
commented on August 16, 2024
https://docs.python.org/3/library/importlib.metadata.html#distribution-versions and https://setuptools.pypa.io/en/latest/deprecated/python_eggs.html#sources-txt-source-files-manifest seem to contradict each other here.
In line with #50 it might be worth not to rely on importlib.metadata.files() at all.
from validate-pyproject.
bnavigator
commented on August 16, 2024
Update: With importlib_metadata 4.11.4 overriding the importlib.metadata from Python 3.10.5, the filelist changes, but ist still wrong:
abuild@skylab:~> python3
Python 3.10.5 (main, Jun 06 2022, 22:34:44) [GCC] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import importlib_metadata as _M
>>> from pprint import pprint
>>> pprint(_M.files("validate_pyproject"))
[PackagePath('LICENSE.txt'),
PackagePath('README.rst'),
PackagePath('pyproject.toml'),
PackagePath('setup.cfg'),
PackagePath('setup.py'),
PackagePath('src/validate_pyproject/__init__.py'),
PackagePath('src/validate_pyproject/__main__.py'),
PackagePath('src/validate_pyproject/api.py'),
PackagePath('src/validate_pyproject/cli.py'),
PackagePath('src/validate_pyproject/error_reporting.py'),
PackagePath('src/validate_pyproject/errors.py'),
PackagePath('src/validate_pyproject/extra_validations.py'),
PackagePath('src/validate_pyproject/formats.py'),
PackagePath('src/validate_pyproject/types.py'),
PackagePath('src/validate_pyproject.egg-info/PKG-INFO'),
PackagePath('src/validate_pyproject.egg-info/SOURCES.txt'),
PackagePath('src/validate_pyproject.egg-info/dependency_links.txt'),
PackagePath('src/validate_pyproject.egg-info/entry_points.txt'),
PackagePath('src/validate_pyproject.egg-info/not-zip-safe'),
PackagePath('src/validate_pyproject.egg-info/requires.txt'),
PackagePath('src/validate_pyproject.egg-info/top_level.txt'),
PackagePath('src/validate_pyproject/_vendor/__init__.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/__init__.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/__main__.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/draft04.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/draft06.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/draft07.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/exceptions.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/generator.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/indent.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/ref_resolver.py'),
PackagePath('src/validate_pyproject/_vendor/fastjsonschema/version.py'),
PackagePath('src/validate_pyproject/plugins/__init__.py'),
PackagePath('src/validate_pyproject/pre_compile/__init__.py'),
PackagePath('src/validate_pyproject/pre_compile/__main__.py'),
PackagePath('src/validate_pyproject/pre_compile/cli.py'),
PackagePath('src/validate_pyproject/vendoring/__init__.py'),
PackagePath('src/validate_pyproject/vendoring/__main__.py'),
PackagePath('src/validate_pyproject/vendoring/cli.py')]
>>>
from validate-pyproject.
jaraco
commented on August 16, 2024
Ideally, Setuptools would not generate egg-info, and would instead generate dist-info with a RECORD. If it did that, then importlib.metadata.files would provide a consistent experience. The fallback to SOURCES.txt for egg-info is there to give its best effort at the list of files in the project, but as you can see, it's inconsistent.
from validate-pyproject.
bnavigator
commented on August 16, 2024
I wish we would live in an ideal world 😆
from validate-pyproject.
abravalheri
commented on August 16, 2024
@bnavigator what is the motivation behind using the deprecated python setup.py install? (I am imagining that you are using install...).
It should be possible to support this use case, however there will be an increase in complexity and maintenance effort, which I would like to avoid...
It non trivial to satisfy these constraints simultaneously: a) my desire to avoid double bookkeeping, b) (potential) lack of symlinks on Windows, c) Legacy installation methods like python setup.py, d) Github discovery/gui of/for license files.
from validate-pyproject.
bnavigator
commented on August 16, 2024
No motivation at all. It's the legacy way of packaging and so far the default when generating recipes for a rpm build. I switched to PEP517 and made the error go away.
The easiest way to avoid future errors like this is to remove the setup.py completely and force your users to use PEP517.
Ironically I only stumbled over this because I am updating the setuptools package itself and validate-pyproject is in the dependency graph for the test suite.
from validate-pyproject.
abravalheri
commented on August 16, 2024
The easiest way to avoid future errors like this is to remove the setup.py completely and force your users to use PEP517.
Thank you very much for the information @bnavigator. I think I will follow this direction.
from validate-pyproject.
Related Issues (20)
- Support for SchemaStore HOT 21
- JSON Schema string is inconsistent (no trailing #) HOT 3
- Speed up `--store` support HOT 11
- [FR] Add the ability to load schemas that can be referenced in other schemas HOT 3
- [FR] Relax validation of `py-modules`
- schema-store: Failing on valid hatch toml HOT 5
- [FR] Allow `--tool` to overwrite? OR option to disable all plugins loaded by entry-points?
- Bug? `tool.poetry.packages[0]` must not contain {'to'} properties HOT 4
- feature request: strict pep440 check
- Request: traversing into `enum` for failure message
- Comment for formats.py in the wrong place
- tool ruff can't validate lint subsection HOT 1
- Please install `tomli` (TOML parser) HOT 7
- CI failing for `freebsd`
- Report likely mistakes as warnings HOT 3
- vendoring of fastjsonschema HOT 2
- `tool.setuptools.packages` should allow `*-stub` name.
- Validate fields pointing to paths HOT 5
- CLI hangs when no arguments provided HOT 1
- Crash on first commit when adding a pre-commit hook HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from validate-pyproject.