Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support metadata 2.1-2.3 #91

Merged
merged 3 commits into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions pyproject_metadata/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@

__version__ = '0.7.1'

KNOWN_METADATA_VERSIONS = {'2.1', '2.2', '2.3'}


class ConfigurationError(Exception):
'''Error in the backend metadata.'''
Expand Down Expand Up @@ -183,6 +185,14 @@ class StandardMetadata:
gui_scripts: dict[str, str] = dataclasses.field(default_factory=dict)
dynamic: list[str] = dataclasses.field(default_factory=list)

_metadata_version: str | None = None

@property
def metadata_version(self) -> str:
if self._metadata_version is None:
return '2.2' if self.dynamic else '2.1'
return self._metadata_version

@property
def canonical_name(self) -> str:
return packaging.utils.canonicalize_name(self.name)
Expand All @@ -192,6 +202,7 @@ def from_pyproject(
cls,
data: Mapping[str, Any],
project_dir: str | os.PathLike[str] = os.path.curdir,
metadata_version: str | None = None,
) -> StandardMetadata:
fetcher = DataFetcher(data)
project_dir = pathlib.Path(project_dir)
Expand Down Expand Up @@ -229,6 +240,10 @@ def from_pyproject(
msg = 'The description must be a single line'
raise ConfigurationError(msg)

if metadata_version and metadata_version not in KNOWN_METADATA_VERSIONS:
henryiii marked this conversation as resolved.
Show resolved Hide resolved
msg = 'The metadata_version must be one of {KNOWN_METADATA_VERSIONS} or None (default)'
raise ConfigurationError(msg)

return cls(
name,
version,
Expand All @@ -247,6 +262,7 @@ def from_pyproject(
fetcher.get_dict('project.scripts'),
fetcher.get_dict('project.gui-scripts'),
dynamic,
metadata_version,
)

def _update_dynamic(self, value: Any) -> None:
Expand All @@ -265,7 +281,7 @@ def as_rfc822(self) -> RFC822Message:
return message

def write_to_rfc822(self, message: RFC822Message) -> None: # noqa: C901
message['Metadata-Version'] = '2.2' if self.dynamic else '2.1'
message['Metadata-Version'] = self.metadata_version
message['Name'] = self.name
if not self.version:
msg = 'Missing version field'
Expand Down Expand Up @@ -297,19 +313,21 @@ def write_to_rfc822(self, message: RFC822Message) -> None: # noqa: C901
for dep in self.dependencies:
message['Requires-Dist'] = str(dep)
for extra, requirements in self.optional_dependencies.items():
message['Provides-Extra'] = extra
norm_extra = extra.replace('.', '-').replace('_', '-').lower()
message['Provides-Extra'] = norm_extra
for requirement in requirements:
message['Requires-Dist'] = str(self._build_extra_req(extra, requirement))
message['Requires-Dist'] = str(self._build_extra_req(norm_extra, requirement))
if self.readme:
if self.readme.content_type:
message['Description-Content-Type'] = self.readme.content_type
message.body = self.readme.text
# Core Metadata 2.2
for field in self.dynamic:
if field in ('name', 'version'):
msg = f'Field cannot be dynamic: {field}'
raise ConfigurationError(msg)
message['Dynamic'] = field
if self.metadata_version != '2.1':
for field in self.dynamic:
if field in ('name', 'version'):
msg = f'Field cannot be dynamic: {field}'
raise ConfigurationError(msg)
message['Dynamic'] = field

def _name_list(self, people: list[tuple[str, str]]) -> str:
return ', '.join(
Expand Down
30 changes: 30 additions & 0 deletions tests/test_standard_metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -698,6 +698,36 @@ def test_as_rfc822_dynamic():
}


@pytest.mark.parametrize('metadata_version', ['2.1', '2.2', '2.3'])
def test_as_rfc822_set_metadata(metadata_version):
metadata = pyproject_metadata.StandardMetadata.from_pyproject(
{
'project': {
'name': 'hi',
'version': '1.2',
'optional-dependencies': {
'under_score': ['some_package'],
'da-sh': ['some-package'],
'do.t': ['some.package'],
},
}
},
metadata_version=metadata_version,
)
assert metadata.metadata_version == metadata_version

rfc822 = str(metadata.as_rfc822())

assert f'Metadata-Version: {metadata_version}' in rfc822

assert 'Provides-Extra: under-score' in rfc822
assert 'Provides-Extra: da-sh' in rfc822
assert 'Provides-Extra: do-t' in rfc822
assert 'Requires-Dist: some_package; extra == "under-score"' in rfc822
assert 'Requires-Dist: some-package; extra == "da-sh"' in rfc822
assert 'Requires-Dist: some.package; extra == "do-t"' in rfc822


def test_as_rfc822_invalid_dynamic():
metadata = pyproject_metadata.StandardMetadata(
name='something',
Expand Down
Loading