Azure CLI wheels includes __init__.py files that should not be there

[lmazuel]

A given wheel should only be responsible for one file, and only one. It means no other packages should contain this file too: if two wheels contains the same file, installing them side by side will break the uninstallation scenario.

Concrete example:

• azure/__init__.py is owned by azure-nspkg, and only this wheel should contain it
• azure/cli/__init__.py is owned by azure-cli-nspkg, and only this wheel should contain it

This means the current wheel content of a package like azure-cli is wrong, since it contains both copy of these files.

To make things worse, the copies of these files use a "pkg_resource" format that is a performance killer. See also #13293

CLI packages MUST NOT contains files that are owned by any nspkg (applies to azure-cli-core, etc.)

[yonzhan]

@fengzhou-msft please take a look

[lmazuel]

@fengzhou-msft if you're unsure what this means in term of setup.py magic feel free to ping me ;)

[fengzhou-msft]

@lmazuel For azure/__init__.py, we should use import pkgutil;__path__ = pkgutil.extend_path(__path__, __name__) for development and remove the file in the package. Is that correct? How can we remove it?

[lmazuel]

That's correct. You remove those lines from your wheel using this:
https://github.com/Azure/azure-sdk-for-python/blob/7aecf6ffa4f886df25f40cc2cd2ea451dfea7e08/sdk/storage/azure-mgmt-storage/setup.py#L78-L80

See also:
https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/packaging.md

[arrownj]

Hi @lmazuel , as CLI does not support python 2 anymore. So we think we can remove the init.py in both dev and whl environment. Is that right ?

[lmazuel]

@arrownj

• it should not be in the wheel ever, whatever py2 or py3
• sdist is more interesting, I'm not sure it matters anymore that much if you target just py3 (keep it or leave it, same). Most of all the complex easy-install/dev install/etc. scenarios are gone. If you remove it you should be fine.