Skip to content

Conversation

wangzelin007
Copy link
Member

@wangzelin007 wangzelin007 requested review from AllyW, Copilot and jiasli April 7, 2025 03:36
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.

Files not reviewed (1)
  • HISTORY.rst: Language not supported

Release History
===============
0.2.3b1
+++++++
Copy link
Member Author

@wangzelin007 wangzelin007 Apr 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Section title underlines should be at least as long as the text of the section title
image


0.2.0
+++++
++++++
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

@wangzelin007 wangzelin007 requested a review from bebound April 7, 2025 07:32
metadata[low_key] = pkg_info[key]

metadata['metadata_version'] = METADATA_VERSION

Copy link
Contributor

@AllyW AllyW Apr 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be as what pkg_info.metadata_version is? like 2.2 now?

pkg_info = read_pkg_info(path)
except Exception:
with open(path, 'rb') as pkg_info_file:
pkg_info = email.parser.Parser().parsestr(pkg_info_file.read().decode('utf-8'))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another more straightforward way to get pkgInfo is pkginfo.Wheel for dist-info or pkginfo.Develop for egg-info, as az extension list does in azure cli core here: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli-core/azure/cli/core/extension/__init__.py#L154-L157

Copy link
Member

@jiasli jiasli Apr 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it is a good idea to vendor code from wheel library. The code itself may become difficult to maintain.

Besides using pkginfo.Wheel as mentioned by #521 (comment), we may consider decoupling from wheel:

Solution 1: Define our own metadata in azext_metadata.json and add necessary fields, such as

{
    "azext.isPreview": false,
    "azext.minCliCoreVersion": "2.45.0"
    "azext.name": "ssh"
    "azext.description": "SSH into Azure VMs using RBAC and AAD OpenSSH Certificates"
    "azext.long_description": "SSH into Azure VMs using RBAC and AAD OpenSSH Certificates.  The client generates ..."
    ...
}

The content will be merged into metadata automatically:

azext_metadata = _get_azext_metadata(ext_dir)
if azext_metadata:
metadata.update(azext_metadata)

https://github.com/Azure/azure-cli-extensions/blob/f19d4496d88cfb8ceb7e2115e280beb32b646091/src/index.json#L88209-L88211

                "metadata": {
                    "azext.isPreview": false,
                    "azext.minCliCoreVersion": "2.45.0",
                    "classifiers": [
                        "Development Status :: 4 - Beta",

Solution 2: Use regex to extract necessary information directly from setup.py and plug it into a template to generate index.json entries.

This way, we will no longer be affected by wheel's changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants